src/jsr166y/RecursiveAction.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/licenses/publicdomain
 */

package jsr166y;

/**
 * A recursive resultless {@link ForkJoinTask}.  This class
 * establishes conventions to parameterize resultless actions as
 * {@code Void} {@code ForkJoinTask}s. Because {@code null} is the
 * only valid value of type {@code Void}, methods such as join always
 * return {@code null} upon completion.
 *
 * <p><b>Sample Usages.</b> Here is a sketch of a ForkJoin sort that
 * sorts a given {@code long[]} array:
 *
 *  <pre> {@code
 * class SortTask extends RecursiveAction {
 *   final long[] array; final int lo; final int hi;
 *   SortTask(long[] array, int lo, int hi) {
 *     this.array = array; this.lo = lo; this.hi = hi;
 *   }
 *   protected void compute() {
 *     if (hi - lo < THRESHOLD)
 *       sequentiallySort(array, lo, hi);
 *     else {
 *       int mid = (lo + hi) >>> 1;
 *       invokeAll(new SortTask(array, lo, mid),
 *                 new SortTask(array, mid, hi));
 *       merge(array, lo, hi);
 *     }
 *   }
 * }}</pre>
 *
 * You could then sort {@code anArray} by creating {@code new
 * SortTask(anArray, 0, anArray.length-1) } and invoking it in a
 * ForkJoinPool.  As a more concrete simple example, the following
 * task increments each element of an array:
 *  <pre> {@code
 * class IncrementTask extends RecursiveAction {
 *   final long[] array; final int lo; final int hi;
 *   IncrementTask(long[] array, int lo, int hi) {
 *     this.array = array; this.lo = lo; this.hi = hi;
 *   }
 *   protected void compute() {
 *     if (hi - lo < THRESHOLD) {
 *       for (int i = lo; i < hi; ++i)
 *         array[i]++;
 *     }
 *     else {
 *       int mid = (lo + hi) >>> 1;
 *       invokeAll(new IncrementTask(array, lo, mid),
 *                 new IncrementTask(array, mid, hi));
 *     }
 *   }
 * }}</pre>
 *
 * <p>The following example illustrates some refinements and idioms
 * that may lead to better performance: RecursiveActions need not be
 * fully recursive, so long as they maintain the basic
 * divide-and-conquer approach. Here is a class that sums the squares
 * of each element of a double array, by subdividing out only the
 * right-hand-sides of repeated divisions by two, and keeping track of
 * them with a chain of {@code next} references. It uses a dynamic
 * threshold based on method {@code getSurplusQueuedTaskCount}, but
 * counterbalances potential excess partitioning by directly
 * performing leaf actions on unstolen tasks rather than further
 * subdividing.
 *
 *  <pre> {@code
 * double sumOfSquares(ForkJoinPool pool, double[] array) {
 *   int n = array.length;
 *   int seqSize = 1 + n / (8 * pool.getParallelism());
 *   Applyer a = new Applyer(array, 0, n, seqSize, null);
 *   pool.invoke(a);
 *   return a.result;
 * }
 *
 * class Applyer extends RecursiveAction {
 *   final double[] array;
 *   final int lo, hi, seqSize;
 *   double result;
 *   Applyer next; // keeps track of right-hand-side tasks
 *   Applyer(double[] array, int lo, int hi, int seqSize, Applyer next) {
 *     this.array = array; this.lo = lo; this.hi = hi;
 *     this.seqSize = seqSize; this.next = next;
 *   }
 *
 *   double atLeaf(int l, int r) {
 *     double sum = 0;
 *     for (int i = l; i < h; ++i) // perform leftmost base step
 *       sum += array[i] * array[i];
 *     return sum;
 *   }
 *
 *   protected void compute() {
 *     int l = lo;
 *     int h = hi;
 *     Applyer right = null;
 *     while (h - l > 1 && getSurplusQueuedTaskCount() <= 3) {
 *        int mid = (l + h) >>> 1;
 *        right = new Applyer(array, mid, h, seqSize, right);
 *        right.fork();
 *        h = mid;
 *     }
 *     double sum = atLeaf(l, h);
 *     while (right != null) {
 *        if (right.tryUnfork()) // directly calculate if not stolen
 *          sum += right.atLeaf(right.lo, right.hi);
 *       else {
 *          right.helpJoin();
 *          sum += right.result;
 *        }
 *        right = right.next;
 *      }
 *     result = sum;
 *   }
 * }}</pre>
 *
 * @since 1.7
 * @author Doug Lea
 */
public abstract class RecursiveAction extends ForkJoinTask<Void> {
    private static final long serialVersionUID = 5232453952276485070L;

    /**
     * The main computation performed by this task.
     */
    protected abstract void compute();

    /**
     * Always returns null.
     */
    public final Void getRawResult() { return null; }

    /**
     * Requires null completion value.
     */
    protected final void setRawResult(Void mustBeNull) { }

    /**
     * Implements execution conventions for RecursiveActions.
     */
    protected final boolean exec() {
        compute();
        return true;
    }

}
Revision:	1.12
Committed:	Tue Aug 4 22:47:08 2009 UTC (14 years, 9 months ago) by dl
Branch:	MAIN
Changes since 1.11:	+1 -1 lines
Log Message:	Doc fixes
#	User	Rev	Content
1	dl	1.1	/*
2			* Written by Doug Lea with assistance from members of JCP JSR-166
3			* Expert Group and released to the public domain, as explained at
4			* http://creativecommons.org/licenses/publicdomain
5			*/
6
7			package jsr166y;
8
9			/**
10	jsr166	1.10	* A recursive resultless {@link ForkJoinTask}. This class
11			* establishes conventions to parameterize resultless actions as
12			* {@code Void} {@code ForkJoinTask}s. Because {@code null} is the
13			* only valid value of type {@code Void}, methods such as join always
14			* return {@code null} upon completion.
15	jsr166	1.2	*
16	dl	1.1	* <p><b>Sample Usages.</b> Here is a sketch of a ForkJoin sort that
17	jsr166	1.3	* sorts a given {@code long[]} array:
18	dl	1.1	*
19	jsr166	1.4	* <pre> {@code
20	dl	1.1	* class SortTask extends RecursiveAction {
21			* final long[] array; final int lo; final int hi;
22			* SortTask(long[] array, int lo, int hi) {
23			* this.array = array; this.lo = lo; this.hi = hi;
24			* }
25			* protected void compute() {
26	jsr166	1.4	* if (hi - lo < THRESHOLD)
27	dl	1.1	* sequentiallySort(array, lo, hi);
28			* else {
29	jsr166	1.4	* int mid = (lo + hi) >>> 1;
30	dl	1.1	* invokeAll(new SortTask(array, lo, mid),
31			* new SortTask(array, mid, hi));
32			* merge(array, lo, hi);
33			* }
34			* }
35	jsr166	1.4	* }}</pre>
36	dl	1.1	*
37	jsr166	1.7	* You could then sort {@code anArray} by creating {@code new
38			* SortTask(anArray, 0, anArray.length-1) } and invoking it in a
39			* ForkJoinPool. As a more concrete simple example, the following
40			* task increments each element of an array:
41	jsr166	1.4	* <pre> {@code
42	dl	1.1	* class IncrementTask extends RecursiveAction {
43			* final long[] array; final int lo; final int hi;
44			* IncrementTask(long[] array, int lo, int hi) {
45			* this.array = array; this.lo = lo; this.hi = hi;
46			* }
47			* protected void compute() {
48	jsr166	1.4	* if (hi - lo < THRESHOLD) {
49			* for (int i = lo; i < hi; ++i)
50	dl	1.1	* array[i]++;
51			* }
52			* else {
53	jsr166	1.4	* int mid = (lo + hi) >>> 1;
54	dl	1.1	* invokeAll(new IncrementTask(array, lo, mid),
55			* new IncrementTask(array, mid, hi));
56			* }
57			* }
58	jsr166	1.4	* }}</pre>
59	dl	1.1	*
60			* <p>The following example illustrates some refinements and idioms
61			* that may lead to better performance: RecursiveActions need not be
62			* fully recursive, so long as they maintain the basic
63			* divide-and-conquer approach. Here is a class that sums the squares
64			* of each element of a double array, by subdividing out only the
65			* right-hand-sides of repeated divisions by two, and keeping track of
66	jsr166	1.3	* them with a chain of {@code next} references. It uses a dynamic
67	dl	1.12	* threshold based on method {@code getSurplusQueuedTaskCount}, but
68	dl	1.11	* counterbalances potential excess partitioning by directly
69			* performing leaf actions on unstolen tasks rather than further
70			* subdividing.
71	dl	1.1	*
72	jsr166	1.4	* <pre> {@code
73	dl	1.1	* double sumOfSquares(ForkJoinPool pool, double[] array) {
74			* int n = array.length;
75			* int seqSize = 1 + n / (8 * pool.getParallelism());
76			* Applyer a = new Applyer(array, 0, n, seqSize, null);
77			* pool.invoke(a);
78			* return a.result;
79			* }
80			*
81			* class Applyer extends RecursiveAction {
82			* final double[] array;
83			* final int lo, hi, seqSize;
84			* double result;
85			* Applyer next; // keeps track of right-hand-side tasks
86			* Applyer(double[] array, int lo, int hi, int seqSize, Applyer next) {
87			* this.array = array; this.lo = lo; this.hi = hi;
88			* this.seqSize = seqSize; this.next = next;
89			* }
90			*
91			* double atLeaf(int l, int r) {
92			* double sum = 0;
93	jsr166	1.4	* for (int i = l; i < h; ++i) // perform leftmost base step
94	dl	1.1	* sum += array[i] * array[i];
95			* return sum;
96			* }
97			*
98			* protected void compute() {
99			* int l = lo;
100			* int h = hi;
101			* Applyer right = null;
102	dl	1.8	* while (h - l > 1 && getSurplusQueuedTaskCount() <= 3) {
103	jsr166	1.4	* int mid = (l + h) >>> 1;
104	dl	1.1	* right = new Applyer(array, mid, h, seqSize, right);
105			* right.fork();
106			* h = mid;
107			* }
108			* double sum = atLeaf(l, h);
109			* while (right != null) {
110			* if (right.tryUnfork()) // directly calculate if not stolen
111			* sum += right.atLeaf(right.lo, right.hi);
112			* else {
113			* right.helpJoin();
114			* sum += right.result;
115			* }
116			* right = right.next;
117			* }
118			* result = sum;
119			* }
120	jsr166	1.4	* }}</pre>
121	jsr166	1.6	*
122			* @since 1.7
123			* @author Doug Lea
124	dl	1.1	*/
125			public abstract class RecursiveAction extends ForkJoinTask<Void> {
126	dl	1.9	private static final long serialVersionUID = 5232453952276485070L;
127	dl	1.1
128			/**
129	jsr166	1.2	* The main computation performed by this task.
130	dl	1.1	*/
131			protected abstract void compute();
132
133			/**
134	jsr166	1.5	* Always returns null.
135	dl	1.1	*/
136			public final Void getRawResult() { return null; }
137
138			/**
139			* Requires null completion value.
140			*/
141			protected final void setRawResult(Void mustBeNull) { }
142
143			/**
144	jsr166	1.5	* Implements execution conventions for RecursiveActions.
145	dl	1.1	*/
146			protected final boolean exec() {
147			compute();
148			return true;
149			}
150
151			}