1 //******************************************************************************
2 //
3 // File: ParallelForLoop.java
4 // Package: edu.rit.pj
5 // Unit: Class edu.rit.pj.ParallelForLoop
6 //
7 // This Java source file is copyright (C) 2007 by Alan Kaminsky. All rights
8 // reserved. For further information, contact the author, Alan Kaminsky, at
9 // ark@cs.rit.edu.
10 //
11 // This Java source file is part of the Parallel Java Library ("PJ"). PJ is free
12 // software; you can redistribute it and/or modify it under the terms of the GNU
13 // General Public License as published by the Free Software Foundation; either
14 // version 3 of the License, or (at your option) any later version.
15 //
16 // PJ is distributed in the hope that it will be useful, but WITHOUT ANY
17 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 // A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 //
20 // Linking this library statically or dynamically with other modules is making a
21 // combined work based on this library. Thus, the terms and conditions of the GNU
22 // General Public License cover the whole combination.
23 //
24 // As a special exception, the copyright holders of this library give you
25 // permission to link this library with independent modules to produce an
26 // executable, regardless of the license terms of these independent modules, and
27 // to copy and distribute the resulting executable under terms of your choice,
28 // provided that you also meet, for each linked independent module, the terms
29 // and conditions of the license of that module. An independent module is a module
30 // which is not derived from or based on this library. If you modify this library,
31 // you may extend this exception to your version of the library, but you are not
32 // obligated to do so. If you do not wish to do so, delete this exception
33 // statement from your version.
34 //
35 // A copy of the GNU General Public License is provided in the file gpl.txt. You
36 // may also obtain a copy of the GNU General Public License on the World Wide
37 // Web at http://www.gnu.org/licenses/gpl.html.
38 //
39 //******************************************************************************
40 package edu.rit.pj;
41
42 /**
43 * Class ParallelForLoop is the abstract base class for a parallel for loop that
44 * is executed inside a {@linkplain ParallelRegion}. There are four variations
45 * of a parallel for loop, depending on the loop index data type and on whether
46 * the loop stride is implicit or explicit. There is a subclass for each
47 * variation; see the subclasses for further information. The subclasses are:
48 * <UL>
49 * <LI>
50 * Class {@linkplain IntegerForLoop} -- loop index is type <code>int</code>, loop
51 * stride is implicit (+1).
52 * <BR>
53 * <LI>
54 * Class {@linkplain IntegerStrideForLoop} -- loop index is type <code>int</code>,
55 * loop stride is explicitly specified.
56 * <BR>
57 * <LI>
58 * Class {@linkplain LongForLoop} -- loop index is type <code>long</code>, loop
59 * stride is implicit (+1).
60 * <BR>
61 * <LI>
62 * Class {@linkplain LongStrideForLoop} -- loop index is type <code>long</code>,
63 * loop stride is explicitly specified.
64 * <BR>
65 * </UL>
66 *
67 * @author Alan Kaminsky
68 * @version 31-May-2007
69 */
70 public abstract class ParallelForLoop
71 extends ParallelConstruct {
72
73 // Exported constructors.
74 /**
75 * Construct a new parallel for loop.
76 */
77 public ParallelForLoop() {
78 super();
79 }
80
81 }