edu.rice.hj.runtime.eureka

Class HjConvergenceEurekaImpl<T>

java.lang.Object

edu.rice.hj.runtime.eureka.HjConvergenceEurekaImpl<T>

All Implemented Interfaces:

HjConvergenceEureka<T>, HjEureka<T,T,T>

public final class HjConvergenceEurekaImpl<T>
extends Object
implements HjConvergenceEureka<T>

Author:

Shams Imam (shams@rice.edu)

Constructor Summary

Constructors

Constructor and Description
HjConvergenceEurekaImpl(T initialValue, java.util.function.BiPredicate<T,T> checker, HjProcedure<T> convergenceCallback)

Method Summary

Modifier and Type	Method and Description
boolean	check(T localValue, boolean triggerAbort) Checks whether the locally known value can lead to a better estimate than the globally known value.
T	get() Return the value stored in the eureka object.
boolean	offer(T 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.
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.
String	toString()

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

HjConvergenceEurekaImpl

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

Method Detail

onRegistration

public void onRegistration()

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

Specified by:

onRegistration in interface HjEureka<T,T,T>

onCleanup

public void onCleanup()

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

Specified by:

onCleanup in interface HjEureka<T,T,T>

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.

Specified by:

resolved in interface HjEureka<T,T,T>

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.

Specified by:

shouldAbortOnOffer in interface HjEureka<T,T,T>

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 T get()

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

Specified by:

get in interface HjEureka<T,T,T>

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(T 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.

Specified by:

offer in interface HjEureka<T,T,T>

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(T 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.

Specified by:

check in interface HjEureka<T,T,T>

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

toString

public String toString()

Overrides:

toString in class Object