View Javadoc
1   //******************************************************************************
2   //
3   // File:    Schedule.java
4   // Package: edu.rit.pj
5   // Unit:    Class edu.rit.pj.Schedule
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 Schedule provides an object that determines how to schedule the
44   * iterations of a {@linkplain ParallelForLoop} among the threads in a
45   * {@linkplain ParallelTeam}. To create a schedule object, call one of the
46   * following static methods in class {@linkplain IntegerSchedule} or class
47   * {@linkplain LongSchedule}:
48   * <UL>
49   * <LI><code>IntegerSchedule.fixed()</code>
50   * <LI><code>IntegerSchedule.dynamic()</code>
51   * <LI><code>IntegerSchedule.guided()</code>
52   * <LI><code>IntegerSchedule.runtime()</code>
53   * <LI><code>IntegerSchedule.parse()</code>
54   * <LI><code>LongSchedule.fixed()</code>
55   * <LI><code>LongSchedule.dynamic()</code>
56   * <LI><code>LongSchedule.guided()</code>
57   * <LI><code>LongSchedule.runtime()</code>
58   * <LI><code>LongSchedule.parse()</code>
59   * </UL>
60   *
61   * @author Alan Kaminsky
62   * @version 20-Dec-2007
63   */
64  public abstract class Schedule {
65  
66  // Hidden data members.
67      // 128 bytes of extra padding to avert cache interference.
68      private long p0, p1, p2, p3, p4, p5, p6, p7;
69      private long p8, p9, pa, pb, pc, pd, pe, pf;
70  
71      // True to break out of the parallel for loop.
72      boolean myBreak;
73  
74  // Hidden constructors.
75      /**
76       * Construct a new schedule object.
77       */
78      Schedule() {
79      }
80  
81  }