edu.rice.hj.runtime.eureka

Class HjBinaryEurekaImpl<L,R>

java.lang.Object

edu.rice.hj.runtime.eureka.HjBinaryEurekaImpl<L,R>

All Implemented Interfaces:

HjBinaryEureka<L,R>, HjEureka<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

Direct Known Subclasses:

HjBinaryEurekaImpl.HjConjunctiveEurekaImpl, HjBinaryEurekaImpl.HjDisjunctiveEurekaImpl

public abstract class HjBinaryEurekaImpl<L,R>
extends Object
implements HjBinaryEureka<L,R>

Represents an binary logical expression between two Eureka instances. The implementation does not support short-circuiting.

Author:

Shams Imam (shams@rice.edu)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HjBinaryEurekaImpl.HjConjunctiveEurekaImpl<L,R> Represents an binary logical AND expression between two Eureka instances.
static class	HjBinaryEurekaImpl.HjDisjunctiveEurekaImpl<L,R> Represents an binary logical OR expression between two Eureka instances.

Field Summary

Fields

Modifier and Type	Field and Description
protected HjEureka<L,Object,L>	leftEureka
protected HjEureka<R,Object,R>	rightEureka

Method Summary

Modifier and Type	Method and Description
boolean	check(Pair<Object,Object> localValue, boolean triggerAbort) Checks whether the locally known value can lead to a better estimate than the globally known value.
protected abstract boolean	expressionValue(boolean leftValue, boolean rightValue)
Pair<L,R>	get() Return the value stored in the eureka object.
L	getLeft()
R	getRight()
boolean	offer(Pair<L,R> 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.

Methods inherited from class java.lang.Object

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

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

check, offer

Field Detail

leftEureka

protected final HjEureka<L,Object,L> leftEureka

rightEureka

protected final HjEureka<R,Object,R> rightEureka

Method Detail

onRegistration

public void onRegistration()

Description copied from interface: HjEureka

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

Specified by:

onRegistration in interface HjEureka<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

onCleanup

public void onCleanup()

Description copied from interface: HjEureka

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

Specified by:

onCleanup in interface HjEureka<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

resolved

public boolean resolved()

Description copied from interface: HjEureka

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<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

Returns:

true if the eureka has been resolved.

shouldAbortOnOffer

public boolean shouldAbortOnOffer(boolean offerResult)

Description copied from interface: HjEureka

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

Specified by:

shouldAbortOnOffer in interface HjEureka<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

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 Pair<L,R> get()

Description copied from interface: HjEureka

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

Specified by:

get in interface HjEureka<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

Returns:

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

getLeft

public L getLeft()

Specified by:

getLeft in interface HjBinaryEureka<L,R>

getRight

public R getRight()

Specified by:

getRight in interface HjBinaryEureka<L,R>

offer

public boolean offer(Pair<L,R> newValue,
                     boolean triggerAbort)
              throws SuspendableException

Description copied from interface: HjEureka

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<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

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(Pair<Object,Object> localValue,
                     boolean triggerAbort)
              throws SuspendableException

Description copied from interface: HjEureka

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<Pair<L,R>,Pair<Object,Object>,Pair<L,R>>

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

expressionValue

protected abstract boolean expressionValue(boolean leftValue,
                                           boolean rightValue)