edu.rice.hj.experimental

Class ModuleZ

java.lang.Object

edu.rice.hj.Module0

edu.rice.hj.Module1

edu.rice.hj.Module2

edu.rice.hj.ModuleE

edu.rice.hj.ModuleN

edu.rice.hj.experimental.ModuleY

edu.rice.hj.experimental.ModuleZ

public class ModuleZ
extends ModuleY

A facade to all the Habanero-Java operations like asyncWhen(). The calls delegate to the actual HjRuntime instance.

Author:

Shams Imam (shams@rice.edu)

Field Summary

Fields inherited from class edu.rice.hj.Module0

runtimeInitialized

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ModuleZ() Private constructor to disallow instance creation.

Method Summary

Modifier and Type	Method and Description
static <T> void	abort() Aborts the currently executing task.
static void	asyncFastPhased(HjPhasedBody... phases) Launches an async which participates in a fast barrier computation where individual phase computation can be skipped if a sibling task already signals (offers a eureka) for that phase.
static void	asyncWhen(HjExpression.HjAwaitExpression expression, HjRunnable runnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
static void	asyncWhen(HjExpression.HjBooleanExpression expression, HjRunnable runnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
static void	asyncWhen(HjFuture<?> future, HjRunnable runnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
static <T> void	checkEureka(T eurekaValue) Associates a value with the registered eureka.
static void	finish(HjEureka<?,?,?> hjEureka, HjSuspendable suspendable) Registers a HjEureka with the finish scope and continues to execute the body of the finish scope.
static <V> HjFuture<V>	futureWhen(HjExpression.HjAwaitExpression expression, HjCallable<V> runnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
static <V> HjFuture<V>	futureWhen(HjExpression.HjBooleanExpression expression, HjCallable<V> runnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
static <V> HjFuture<V>	futureWhen(HjFuture<?> future, HjCallable<V> runnable) Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.
static <L,R> HjBinaryEureka<L,R>	newBinaryEureka(HjLogicalOperator operator, HjEureka<L,Object,L> leftEureka, HjEureka<R,Object,R> rightEureka) Factory method to create a new HjBinaryEureka instance.
static <T> HjConvergenceEureka<T>	newConvergenceEureka(T initialValue, java.util.function.BiPredicate<T,T> checker) Factory method to create a new HjConvergenceEureka instance.
static <T> HjConvergenceEureka<T>	newConvergenceEureka(T initialValue, java.util.function.BiPredicate<T,T> checker, HjProcedure<T> convergenceCallback) Factory method to create a new HjConvergenceEureka instance.
static <T> HjCountEureka<T>	newCountEureka(long maxCount, int spaceForResult) Factory method to create a new HjCountEureka instance.
static <T> HjEngineEureka<T>	newEngineEureka(int maxUnits) Factory method to create a new HjEngineEureka instance.
static <T> HjSearchEureka<T>	newEureka() Factory method to create a new HjSearchEureka instance.
static <T> HjExtremaEureka<T>	newExtremaEureka(T initialValue, Comparator<T> comparator) Factory method to create a new HjExtremaEureka instance.
static <T> HjExtremaEureka<T>	newExtremaEureka(T initialValue, Comparator<T> comparator, boolean shouldAbortOnOffer) Factory method to create a new HjExtremaEureka instance.
static HjFastBarrierEureka	newFastBarrierEureka(int numPhases) Factory method to create a new HjFastBarrierEureka instance.
static <T> HjSearchEureka<T>	newSearchEureka(T initialValue) Factory method to create a new HjSearchEureka instance.
static <T> HjTimerEureka<T>	newTimerEureka(int timeUnitsInMillis) Factory method to create a new HjTimerEureka instance.
static <T> HjVersionEureka<T>	newVersionEureka(int n) Factory method to create a new HjVersionEureka instance.
static <T> void	offerEureka(T eurekaValue) Associates a value with the registered eureka.
static <T1,T2> void	offerEurekaPair(T1 leftValue, T2 rightValue) Associates a value with the registered eureka.
static <T> T	readEureka() Return the current value stored on the registered eureka.
static <T> HjEureka<T,T,T>	retrieveEureka() Return the eureka to be registered in the finish scope.

Methods inherited from class edu.rice.hj.experimental.ModuleY

forallItems, forallItems, forallItems, forallItemsSusp, forallItemsSusp, forallItemsSusp, forasyncItems, forasyncItems, forasyncItems, forasyncItemsSusp, forasyncItemsSusp, forasyncItemsSusp

Methods inherited from class edu.rice.hj.ModuleN

newDoubleArrayView1D, newDoubleArrayView1D, newDoubleArrayView2D, newDoubleArrayView2D, newDoubleArrayView3D, newDoubleArrayView3D, newIntArrayView1D, newIntArrayView1D, newIntArrayView2D, newIntArrayView2D, newIntArrayView3D, newIntArrayView3D

Methods inherited from class edu.rice.hj.ModuleE

newEventCount, newEventCount

Methods inherited from class edu.rice.hj.Module2

isolated, isolated, isolated, isolated, isolated, isolatedWithReturn, isolatedWithReturn, isolatedWithReturn, isolatedWithReturn, isolatedWithReturn, newActor, readMode, writeMode

Methods inherited from class edu.rice.hj.Module1

async, asyncAwait, asyncAwait, asyncAwait, asyncAwait, forall, forall, forall, forall, forall, forall, forallChunked, forallChunked, forallChunked, forallChunked, forallChunked, forallChunked, forasync, forasync, forasync, forasync, forasync, forasync, forasyncChunked, forasyncChunked, forasyncChunked, forasyncChunked, forasyncChunked, forseq, forseq, forseq, forseq, forseq, forseq, future, futureAwait, futureAwait, futureAwait, futureAwait

Methods inherited from class edu.rice.hj.Module0

abstractMetrics, asyncNb, asyncNbAt, asyncNbAwait, asyncNbAwait, asyncNbAwait, asyncNbAwait, asyncNbSeq, asyncNbSeq, asyncPhased, asyncPhased, asyncPhased, computeDefaultChunkSize, doWait, doWork, dumpEventLog, emergencyShutdown, finalizeHabanero, finish, finish, finish, finish, finish, forallNb, forallNb, forallNb, forallNb, forallNb, forallNb, forallNbChunked, forallNbChunked, forallNbChunked, forallNbChunked, forallNbChunked, forallNbChunked, forallPhased, forallPhased, forasync, forasyncChunked, forasyncNb, forasyncNb, forasyncNb, forasyncNb, forasyncNb, forasyncNbChunked, forasyncNbChunked, forasyncNbChunked, forasyncNbChunked, forasyncPhased, forasyncPhased, forasyncPhased, forseqNb, forseqNb, forseqNb, forseqNb, forseqNb, forseqNb, futureNb, futureNbAwait, futureNbAwait, futureNbAwait, futureNbAwait, futureNbSeq, futureNbSeq, group, group, here, initializeHabanero, launchHabaneroApp, launchHabaneroApp, myGroup, myGroup, newDataDrivenFuture, newDataDrivenFuture, newDDF, newDDF, newFinishAccumulator, newPhaser, newPhaser, newPoint, newRectangularRegion1D, newRectangularRegion2D, newRectangularRegion3D, next, numPlaces, numWorkerThreads, place, printBuildInfo, signal, waitAll, waitAny

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModuleZ

protected ModuleZ()

Private constructor to disallow instance creation.

Method Detail

asyncWhen

public static void asyncWhen(HjFuture<?> future,
                             HjRunnable runnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.

Delegates to asyncWhen(HjExpression.leaf(expression), runnable)

Parameters:

future - The futureNb whose resolution that controls when the async is ready for execution.

runnable - The body of the async.

See Also:

asyncWhen(edu.rice.hj.experimental.api.HjExpression.HjBooleanExpression, edu.rice.hj.api.HjRunnable)

asyncWhen

public static void asyncWhen(HjExpression.HjBooleanExpression expression,
                             HjRunnable runnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.

Delegates to asyncWhen(HjExpression.awaitExpr(expression), runnable)

Parameters:

expression - The expression that controls when the async is ready for execution.

runnable - The body of the async.

See Also:

asyncWhen(edu.rice.hj.experimental.api.HjExpression.HjAwaitExpression, edu.rice.hj.api.HjRunnable)

asyncWhen

public static void asyncWhen(HjExpression.HjAwaitExpression expression,
                             HjRunnable runnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.

The body of this async is only executed when the expression evaluates to true, the expression can only be safely evaluated after all the futures involved in the expression have been resolved when in strict mode (expression contains a NOT). There is also a short-circuit mode (expression contains only AND and OR) where the expression is evaluated early and the asynchronous computation triggered even when some of the other dependent tasks may not yet have completed execution.

The semantics of

   asyncWhen(awaitExpr, () -> S1)
 

are as follows:

   async(() -> {
     boolean exprVal = expr.evaluate();
     if (exprVal) {
       S1;
     }
   });
 

Parameters:

expression - The expression that controls when the async is ready for execution.

runnable - The body of the async.

See Also:

HjRuntime.asyncWhen(edu.rice.hj.experimental.api.HjExpression.HjAwaitExpression, edu.rice.hj.api.HjRunnable)

futureWhen

public static <V> HjFuture<V> futureWhen(HjFuture<?> future,
                                         HjCallable<V> runnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.

Delegates to asyncWhen(HjExpression.leaf(expression), runnable)

Parameters:

future - The futureNb whose resolution that controls when the async is ready for execution.

runnable - The body of the async.

See Also:

futureWhen(edu.rice.hj.experimental.api.HjExpression.HjBooleanExpression, edu.rice.hj.api.HjCallable)

futureWhen

public static <V> HjFuture<V> futureWhen(HjExpression.HjBooleanExpression expression,
                                         HjCallable<V> runnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles.

Delegates to futureWhen(HjExpression.awaitExpr(expression), runnable)

Parameters:

expression - The expression that controls when the async is ready for execution.

runnable - The body of the async.

See Also:

futureWhen(edu.rice.hj.experimental.api.HjExpression.HjAwaitExpression, edu.rice.hj.api.HjCallable)

futureWhen

public static <V> HjFuture<V> futureWhen(HjExpression.HjAwaitExpression expression,
                                         HjCallable<V> runnable)

Mechanism to create an asynchronous task where the await expression is designed to coordinate relationships of this parallel tasks with other tasks (using the HjFuture handles. Also returns the futureNb object representing the value of the computation.

The body of this async is only executed when the expression evaluates to true, the expression can only be safely evaluated after all the futures involved in the expression have been resolved when in strict mode (expression contains a NOT). There is also a short-circuit mode (expression contains only AND and OR) where the expression is evaluated early and the asynchronous computation triggered even when some of the other dependent tasks may not yet have completed execution.

The semantics of

   futureWhen(awaitExpr, () -> S1)
 

are as follows:

   async(() -> {
     boolean exprVal = expr.evaluate();
     if (exprVal) {
       S1;
     } else {
       throw new RuntimeException("clause failed!");
     }
   });
 

Parameters:

expression - The expression that controls when the async is ready for execution.

runnable - The body of the async.

See Also:

HjRuntime.futureWhen(edu.rice.hj.experimental.api.HjExpression.HjAwaitExpression, edu.rice.hj.api.HjCallable)

finish

public static void finish(HjEureka<?,?,?> hjEureka,
                          HjSuspendable suspendable)
                   throws SuspendableException

Registers a HjEureka with the finish scope and continues to execute the body of the finish scope.

Parameters:

hjEureka - the eureka to be registered

suspendable - the body of the finish scope

Throws:

SuspendableException

See Also:

HjRuntime.finish(edu.rice.hj.experimental.api.HjEureka, edu.rice.hj.api.HjSuspendable)

newEureka

public static <T> HjSearchEureka<T> newEureka()

Factory method to create a new HjSearchEureka instance.

It delegates the call to HjRuntime.newSearchEureka(Object).

Type Parameters:

T - The type of value stored inside the Eureka event.

Returns:

A new HjSearchEureka instance

See Also:

HjRuntime.newSearchEureka(Object)

newSearchEureka

public static <T> HjSearchEureka<T> newSearchEureka(T initialValue)

Factory method to create a new HjSearchEureka instance.

Type Parameters:

T - The type of value stored inside the Eureka event.

Parameters:

initialValue - The initial value of the search eureka object

Returns:

A new HjSearchEureka instance

See Also:

HjRuntime.newSearchEureka(Object)

newExtremaEureka

public static <T> HjExtremaEureka<T> newExtremaEureka(T initialValue,
                                                      Comparator<T> comparator)

Factory method to create a new HjExtremaEureka instance.

Parameters:

initialValue - The initial value of the extrema, it should be smaller than expected result.

comparator - The comparator used to maximize the extrema value.

Returns:

a new HjExtremaEureka instance.

See Also:

HjRuntime.newExtremaEureka(Object, java.util.Comparator, boolean)

newExtremaEureka

public static <T> HjExtremaEureka<T> newExtremaEureka(T initialValue,
                                                      Comparator<T> comparator,
                                                      boolean shouldAbortOnOffer)

Factory method to create a new HjExtremaEureka instance.

Parameters:

initialValue - The initial value of the extrema, it should be smaller than expected result.

comparator - The comparator used to maximize the extrema value.

shouldAbortOnOffer - Whether a successful offer should abort the current task

Returns:

a new HjExtremaEureka instance.

See Also:

HjRuntime.newExtremaEureka(Object, java.util.Comparator, boolean)

newConvergenceEureka

public static <T> HjConvergenceEureka<T> newConvergenceEureka(T initialValue,
                                                              java.util.function.BiPredicate<T,T> checker)

Factory method to create a new HjConvergenceEureka instance.

Parameters:

initialValue - The initial value of the eureka.

checker - The predicate used to check for convergence.

Returns:

a new HjConvergenceEureka instance.

See Also:

HjRuntime.newConvergenceEureka(Object, java.util.function.BiPredicate, edu.rice.hj.api.HjProcedure)

newConvergenceEureka

public static <T> HjConvergenceEureka<T> newConvergenceEureka(T initialValue,
                                                              java.util.function.BiPredicate<T,T> checker,
                                                              HjProcedure<T> convergenceCallback)

Factory method to create a new HjConvergenceEureka instance.

Parameters:

initialValue - The initial value of the eureka.

checker - The predicate used to check for convergence.

convergenceCallback - A callback invoked once the eureka has converged.

Returns:

a new HjConvergenceEureka instance.

See Also:

HjRuntime.newConvergenceEureka(Object, java.util.function.BiPredicate, edu.rice.hj.api.HjProcedure)

newFastBarrierEureka

public static HjFastBarrierEureka newFastBarrierEureka(int numPhases)

Factory method to create a new HjFastBarrierEureka instance.

Parameters:

numPhases - The number of phases in the fast barrier.

Returns:

a new HjFastBarrierEureka instance.

See Also:

HjRuntime.newFastBarrierEureka(int)

newCountEureka

public static <T> HjCountEureka<T> newCountEureka(long maxCount,
                                                  int spaceForResult)

Factory method to create a new HjCountEureka instance.

Parameters:

maxCount - The maximum number of eureka events before the eureka is resolved.

spaceForResult - The maximum number of results to store in the eureka.

Returns:

a new HjCountEureka instance.

See Also:

HjRuntime.newCountEureka(long, int)

newVersionEureka

public static <T> HjVersionEureka<T> newVersionEureka(int n)

Factory method to create a new HjVersionEureka instance.

Parameters:

n - The number of items that need to match before the eureka is resolved.

Returns:

a new HjVersionEureka instance.

See Also:

HjRuntime.newVersionEureka(int)

newEngineEureka

public static <T> HjEngineEureka<T> newEngineEureka(int maxUnits)

Factory method to create a new HjEngineEureka instance.

Parameters:

maxUnits - The maximum number of time units in the eureka.

Returns:

a new HjEngineEureka instance.

See Also:

HjRuntime.newEngineEureka(int)

newTimerEureka

public static <T> HjTimerEureka<T> newTimerEureka(int timeUnitsInMillis)

Factory method to create a new HjTimerEureka instance.

Parameters:

timeUnitsInMillis - The maximum number of milliseconds before the eureka is considered resolved.

Returns:

a new HjTimerEureka instance.

See Also:

HjRuntime.newTimerEureka(int)

newBinaryEureka

public static <L,R> HjBinaryEureka<L,R> newBinaryEureka(HjLogicalOperator operator,
                                                        HjEureka<L,Object,L> leftEureka,
                                                        HjEureka<R,Object,R> rightEureka)

Factory method to create a new HjBinaryEureka instance.

Parameters:

operator - The maximum number of milliseconds before the eureka is considered resolved.

leftEureka - The left eureka instance.

rightEureka - The right eureka instance.

Returns:

a new HjBinaryEureka instance.

See Also:

(int)

asyncFastPhased

public static void asyncFastPhased(HjPhasedBody... phases)

Launches an async which participates in a fast barrier computation where individual phase computation can be skipped if a sibling task already signals (offers a eureka) for that phase.

Parameters:

phases - The bodies of the different phases in the computation

retrieveEureka

public static <T> HjEureka<T,T,T> retrieveEureka()

Return the eureka to be registered in the finish scope.

Returns:

the eureka to be registered in the finish scope.

See Also:

HjRuntime.retrieveEureka()

offerEureka

public static <T> void offerEureka(T eurekaValue)
                            throws SuspendableException

Associates a value with the registered eureka.

Type Parameters:

T - The type of value stored in the Eureka

Parameters:

eurekaValue - The value to be associated with the eureka

Throws:

SuspendableException

See Also:

HjRuntime.offerEureka(Object)

offerEurekaPair

public static <T1,T2> void offerEurekaPair(T1 leftValue,
                                           T2 rightValue)
                                    throws SuspendableException

Associates a value with the registered eureka.

Type Parameters:

T1 - The type of value stored in the first Eureka

T2 - The type of value stored in the second Eureka

Parameters:

leftValue - The value to be associated with the eureka

rightValue - The value to be associated with the eureka

Throws:

SuspendableException

See Also:

HjRuntime.offerEureka(Object)

checkEureka

public static <T> void checkEureka(T eurekaValue)
                            throws SuspendableException

Associates a value with the registered eureka.

Type Parameters:

T - The type of value stored in the Eureka

Parameters:

eurekaValue - The value to be associated with the eureka

Throws:

SuspendableException

See Also:

HjRuntime.checkEureka(Object)

readEureka

public static <T> T readEureka()

Return the current value stored on the registered eureka.

Type Parameters:

T - The type of value stored in the Eureka

Returns:

the current value stored on the registered eureka.

See Also:

HjRuntime.readEureka()

abort

public static <T> void abort()
                      throws SuspendableException

Aborts the currently executing task.

Throws:

SuspendableException

See Also:

HjRuntime.abort()