edu.rice.hj.runtime.eureka

Class HjFastBarrierEurekaImpl

java.lang.Object

edu.rice.hj.experimental.api.HjFastBarrierEureka

edu.rice.hj.runtime.eureka.HjFastBarrierEurekaImpl

All Implemented Interfaces:

HjEureka<Boolean,Boolean,Boolean>

public class HjFastBarrierEurekaImpl
extends HjFastBarrierEureka

Author:

Shams Imam (shams@rice.edu)

Constructor Summary

Constructors

Constructor and Description
HjFastBarrierEurekaImpl(int numPhases)

Method Summary

Modifier and Type	Method and Description
boolean	check(Boolean localValue, boolean triggerAbort) Checks whether the locally known value can lead to a better estimate than the globally known value.
int	curPhase()
Boolean	get() Return the value stored in the eureka object.
int	numPhases()
boolean	offer(Boolean newValue, boolean triggerAbort) Attempts to update the eureka object with a new value.
void	onCleanup() Invoked by the runtime at the end of the finish scope in which the eureka has been registered.
void	onRegistration() Invoked by the runtime at the start of the finish scope in which the eureka has been registered.
protected void	register()
boolean	resolved() Return true if the eureka has been resolved.
boolean	shouldAbortOnOffer(boolean offerResult) Return true if the eureka should abort the current task on a successful update.
protected void	signal()
String	toString()

Methods inherited from class edu.rice.hj.experimental.api.HjFastBarrierEureka

asyncFastPhased

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.rice.hj.experimental.api.HjEureka

check, offer

Constructor Detail

HjFastBarrierEurekaImpl

public HjFastBarrierEurekaImpl(int numPhases)

Method Detail

curPhase

public int curPhase()

Specified by:

curPhase in class HjFastBarrierEureka

numPhases

public int numPhases()

Specified by:

numPhases in class HjFastBarrierEureka

register

protected void register()

Specified by:

register in class HjFastBarrierEureka

onRegistration

public void onRegistration()

Invoked by the runtime at the start of the finish scope in which the eureka has been registered.

onCleanup

public void onCleanup()

Invoked by the runtime at the end of the finish scope in which the eureka has been registered.

resolved

public boolean resolved()

Return true if the eureka has been resolved. If there are finish scopes registered on a eureka, all tasks executing under the finish scope are canceled or aborted once the eureka has been resolved.

Returns:

true if the eureka has been resolved.

shouldAbortOnOffer

public boolean shouldAbortOnOffer(boolean offerResult)

Return true if the eureka should abort the current task on a successful update.

Parameters:

offerResult - The result of offer() if this method is called from inside the offer() method.

Returns:

true if the eureka should abort the current task on a successful update.

get

public Boolean get()

Return the value stored in the eureka object. It can be interpreted as the current 'best' known value.

Returns:

the value stored in the eureka object. If nothing has been set, return the default value with which the eureka object was created.

offer

public boolean offer(Boolean newValue,
                     boolean triggerAbort)
              throws SuspendableException

Attempts to update the eureka object with a new value.
If shouldAbortOnOffer() returns true and triggerAbort is true, the task will abort instead of returning true.

Parameters:

newValue - The new value to try and update the eureka object with.

triggerAbort - Boolean value that conmfigures whether task is aborted inside this method call.

Returns:

true if the call to offer should trigger task abortion.

Throws:

SuspendableException - Marker to notify that this method is suspendable

check

public boolean check(Boolean localValue,
                     boolean triggerAbort)
              throws SuspendableException

Checks whether the locally known value can lead to a better estimate than the globally known value. If true, then the method returns normally. If the locally known value is guaranteed to produce a worse result than the globally known value, then the method aborts the current task.

Parameters:

localValue - The local value used to compare with the globally known eureka value

triggerAbort - Boolean value that conmfigures whether task is aborted inside this method call.

Returns:

true if the call to offer should trigger task abortion.

Throws:

SuspendableException - Marker to notify that this method is suspendable

signal

protected void signal()
               throws SuspendableException

Specified by:

signal in class HjFastBarrierEureka

Throws:

SuspendableException

toString

public String toString()

Overrides:

toString in class Object