util/concurrent/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/publicdomain/zero/1.0/
 */

package java.util.concurrent;

/**
 * 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;
 *   Applyer a = new Applyer(array, 0, n, null);
 *   pool.invoke(a);
 *   return a.result;
 * }
 *
 * class Applyer extends RecursiveAction {
 *   final double[] array;
 *   final int lo, hi;
 *   double result;
 *   Applyer next; // keeps track of right-hand-side tasks
 *   Applyer(double[] array, int lo, int hi, Applyer next) {
 *     this.array = array; this.lo = lo; this.hi = hi;
 *     this.next = next;
 *   }
 *
 *   double atLeaf(int l, int h) {
 *     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, 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.join();
 *          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 {@code null}.
     *
     * @return {@code null} always
     */
    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.11
Committed:	Tue Mar 15 19:47:03 2011 UTC (13 years, 2 months ago) by jsr166
Branch:	MAIN
CVS Tags:	release-1_7_0
Changes since 1.10:	+1 -1 lines
Log Message:	Update Creative Commons license URL in legal notices
#	User	Rev	Content
1	jsr166	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	jsr166	1.11	* http://creativecommons.org/publicdomain/zero/1.0/
5	jsr166	1.1	*/
6
7			package java.util.concurrent;
8
9			/**
10	jsr166	1.5	* 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.1	*
16			* <p><b>Sample Usages.</b> Here is a sketch of a ForkJoin sort that
17			* sorts a given {@code long[]} array:
18			*
19			* <pre> {@code
20			* 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			* if (hi - lo < THRESHOLD)
27			* sequentiallySort(array, lo, hi);
28			* else {
29			* int mid = (lo + hi) >>> 1;
30			* invokeAll(new SortTask(array, lo, mid),
31			* new SortTask(array, mid, hi));
32			* merge(array, lo, hi);
33			* }
34			* }
35			* }}</pre>
36			*
37	jsr166	1.2	* 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.1	* <pre> {@code
42			* 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			* if (hi - lo < THRESHOLD) {
49			* for (int i = lo; i < hi; ++i)
50			* array[i]++;
51			* }
52			* else {
53			* int mid = (lo + hi) >>> 1;
54			* invokeAll(new IncrementTask(array, lo, mid),
55			* new IncrementTask(array, mid, hi));
56			* }
57			* }
58			* }}</pre>
59			*
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			* them with a chain of {@code next} references. It uses a dynamic
67	jsr166	1.7	* threshold based on method {@code getSurplusQueuedTaskCount}, but
68	jsr166	1.6	* counterbalances potential excess partitioning by directly
69			* performing leaf actions on unstolen tasks rather than further
70			* subdividing.
71	jsr166	1.1	*
72			* <pre> {@code
73			* double sumOfSquares(ForkJoinPool pool, double[] array) {
74			* int n = array.length;
75	jsr166	1.8	* Applyer a = new Applyer(array, 0, n, null);
76	jsr166	1.1	* pool.invoke(a);
77			* return a.result;
78			* }
79			*
80			* class Applyer extends RecursiveAction {
81			* final double[] array;
82	jsr166	1.8	* final int lo, hi;
83	jsr166	1.1	* double result;
84			* Applyer next; // keeps track of right-hand-side tasks
85	jsr166	1.8	* Applyer(double[] array, int lo, int hi, Applyer next) {
86	jsr166	1.1	* this.array = array; this.lo = lo; this.hi = hi;
87	jsr166	1.8	* this.next = next;
88	jsr166	1.1	* }
89			*
90	jsr166	1.8	* double atLeaf(int l, int h) {
91	jsr166	1.1	* double sum = 0;
92			* for (int i = l; i < h; ++i) // perform leftmost base step
93			* sum += array[i] * array[i];
94			* return sum;
95			* }
96			*
97			* protected void compute() {
98			* int l = lo;
99			* int h = hi;
100			* Applyer right = null;
101	jsr166	1.3	* while (h - l > 1 && getSurplusQueuedTaskCount() <= 3) {
102	jsr166	1.1	* int mid = (l + h) >>> 1;
103	jsr166	1.8	* right = new Applyer(array, mid, h, right);
104	jsr166	1.1	* right.fork();
105			* h = mid;
106			* }
107			* double sum = atLeaf(l, h);
108			* while (right != null) {
109			* if (right.tryUnfork()) // directly calculate if not stolen
110			* sum += right.atLeaf(right.lo, right.hi);
111			* else {
112	dl	1.9	* right.join();
113	jsr166	1.1	* sum += right.result;
114			* }
115			* right = right.next;
116			* }
117			* result = sum;
118			* }
119			* }}</pre>
120			*
121			* @since 1.7
122			* @author Doug Lea
123			*/
124			public abstract class RecursiveAction extends ForkJoinTask<Void> {
125	jsr166	1.4	private static final long serialVersionUID = 5232453952276485070L;
126	jsr166	1.1
127			/**
128			* The main computation performed by this task.
129			*/
130			protected abstract void compute();
131
132			/**
133	jsr166	1.10	* Always returns {@code null}.
134			*
135			* @return {@code null} always
136	jsr166	1.1	*/
137			public final Void getRawResult() { return null; }
138
139			/**
140			* Requires null completion value.
141			*/
142			protected final void setRawResult(Void mustBeNull) { }
143
144			/**
145			* Implements execution conventions for RecursiveActions.
146			*/
147			protected final boolean exec() {
148			compute();
149			return true;
150			}
151
152			}