The original adopt version. More...

Inheritance diagram for frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >:

[legend]

Public Member Functions
	Original (ADOPT< Val, U > adopt)
	Constructor.
void	init (VariableInfo< Val, U > variable)
void	handleTERMINATEmessage (VariableInfo< Val, U > variable, ENDmsg< Val > msg)
	Handle the reception of a terminate message.
void	handleVALUEmessage (VariableInfo< Val, U > variable, VALUEmsg< Val, U > msg)
	Handle the reception of a value message.
void	handleCOSTmessage (VariableInfo< Val, U > variable, COSTmsg< Val, U > msg)
	Handle the reception of a cost message.
void	reset (VariableInfo< Val, U > variable)
	Resets the bounds, child thresholds and context of any child whose context does not match the current context.
boolean	checkChildInfo (VariableInfo< Val, U > variable)
	This function checks whether the info from all children is consistent with the current context.
void	notify (Message msg)
Collection< MessageType >	getMsgTypes ()
Public Member Functions inherited from frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Version< Val, U >
void	init (VariableInfo< Val, U > variable)
	This function is called when we received both the HEURISTICS_MSG_TYPE and the DFSgeneration.OUTPUT_MSG_TYPE message for the variable.
void	notify (Message msg)
	Tells ADOPT how to respond to certain messages specific to this version.
Collection< MessageType >	getMsgTypes ()
	Returns a collection with messages this version is interested in.

Static Public Attributes
static final MessageType	VALUE_MSG_TYPE = new MessageType ("ADOPT", "VALUE")
	The message type for the value message.
static final MessageType	THRESHOLD_MSG_TYPE = new MessageType ("ADOPT", "Threshold")
	The message type for the threshold message.
static final MessageType	COST_MSG_TYPE = new MessageType ("ADOPT", "COST")
	The message type for the cost message.
static final MessageType	TERMINATE_MSG_TYPE = new MessageType ("ADOPT", "TERMINATE")
	The message type for the terminate message.

Private Member Functions
void	maintainChildThresholdInvariant (VariableInfo< Val, U > variable)
	Maintains the child threshold invariant, i.e.
void	maintainThresholdInvariant (VariableInfo< Val, U > variable)
	Maintains the threshold invariant, i.e.
void	maintainAllocationInvariant (VariableInfo< Val, U > variable)
	Maintains the allocation invariant.
void	backTrack (VariableInfo< Val, U > variable)
	Backtrack method.

Private Attributes
ADOPT< Val, U >	adopt
	A link to the outer class.

Detailed Description

The original adopt version.

Parameters

<Val>	the type used for variable values
<U>	the type used for utility values

Constructor & Destructor Documentation

◆ Original()

frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.Original ( ADOPT< Val, U > adopt )

Constructor.

Parameters

adopt the ADOPT module

References frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.ADOPT(), and adopt.

Here is the call graph for this function:

Member Function Documentation

◆ backTrack()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.backTrack ( VariableInfo< Val, U > variable )

private

Backtrack method.

Parameters

variable the variable info

Bug: In Modi's pseudocode, this is called only after sending VALUE messages

References frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.ADOPT(), adopt, backTrack(), frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.LOG, and maintainAllocationInvariant().

Referenced by backTrack(), handleCOSTmessage(), handleTERMINATEmessage(), handleVALUEmessage(), and init().

Here is the call graph for this function:

◆ checkChildInfo()

boolean frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.checkChildInfo ( VariableInfo< Val, U > variable )

This function checks whether the info from all children is consistent with the current context.

Parameters

variable the variable info

Returns: true when consistent and false otherwise

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.getMsgTypes ( )

See also: ADOPT.Version.getMsgTypes()

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.ALL_AGENTS_IDLE, COST_MSG_TYPE, TERMINATE_MSG_TYPE, THRESHOLD_MSG_TYPE, and VALUE_MSG_TYPE.

◆ handleCOSTmessage()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleCOSTmessage	(	VariableInfo< Val, U >	variable,
		COSTmsg< Val, U >	msg )

Handle the reception of a cost message.

Parameters

variable	the recipient variable's info
msg	the message

Here is the call graph for this function:

◆ handleTERMINATEmessage()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleTERMINATEmessage	(	VariableInfo< Val, U >	variable,
		ENDmsg< Val >	msg )

Handle the reception of a terminate message.

Parameters

variable	the recipient variable's info
msg	the message

Todo: check what happens when the terminate message does not contain a new context

Bug: This is not in Modi's pseudocode

References backTrack(), frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.getContext(), maintainThresholdInvariant(), reset(), and frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Serializable &Addable >.setDelta().

Here is the call graph for this function:

◆ handleVALUEmessage()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleVALUEmessage	(	VariableInfo< Val, U >	variable,
		VALUEmsg< Val, U >	msg )

Handle the reception of a value message.

Parameters

variable	the recipient variable's info
msg	the message

Here is the call graph for this function:

◆ init()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.init ( VariableInfo< Val, U > variable )

See also: ADOPT.Version#init(VariableInfo)

Here is the call graph for this function:

◆ maintainAllocationInvariant()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.maintainAllocationInvariant ( VariableInfo< Val, U > variable )

private

Maintains the allocation invariant.

That is, makes sure that the threshold for currentAssignment is properly distributed over the variable's children

Parameters

variable the variable info

Referenced by backTrack().

Here is the call graph for this function:

◆ maintainChildThresholdInvariant()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.maintainChildThresholdInvariant ( VariableInfo< Val, U > variable )

private

Maintains the child threshold invariant, i.e.

makes sure that the threshold for each child is between its last reported upper and lower bounds

Parameters

variable the variable info

Referenced by handleCOSTmessage().

◆ maintainThresholdInvariant()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.maintainThresholdInvariant ( VariableInfo< Val, U > variable )

private

Maintains the threshold invariant, i.e.

makes sure the threshold is always between LB and UB.

Parameters

variable the variable info

References frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Serializable &Addable >.LB, frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Serializable &Addable >.threshold, and frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Serializable &Addable >.UB.

Referenced by handleCOSTmessage(), handleTERMINATEmessage(), handleVALUEmessage(), and init().

◆ notify()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.notify ( Message msg )

See also: ADOPT.Version.notify(Message)

Todo: Avoid this busy-wait to improve performance

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.ALL_AGENTS_IDLE, COST_MSG_TYPE, frodo2.communication.MessageType.equals(), and notify().

Referenced by notify().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.reset ( VariableInfo< Val, U > variable )

Resets the bounds, child thresholds and context of any child whose context does not match the current context.

Parameters

variable the variable info

Referenced by handleCOSTmessage(), handleTERMINATEmessage(), and handleVALUEmessage().

Here is the call graph for this function:

Member Data Documentation

◆ adopt

ADOPT<Val, U> frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.adopt

private

A link to the outer class.

Referenced by backTrack(), checkChildInfo(), handleCOSTmessage(), init(), maintainAllocationInvariant(), Original(), and reset().

◆ COST_MSG_TYPE

final MessageType frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.COST_MSG_TYPE = new MessageType ("ADOPT", "COST")

static

The message type for the cost message.

Referenced by frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable >.COSTmsg(), frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable >.COSTmsg(), getMsgTypes(), and notify().

◆ TERMINATE_MSG_TYPE

final MessageType frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.TERMINATE_MSG_TYPE = new MessageType ("ADOPT", "TERMINATE")

static

The message type for the terminate message.

Referenced by frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.ENDmsg(), frodo2.algorithms.adopt.ENDmsg< Val extends Addable< Val > >.ENDmsg(), and getMsgTypes().

◆ THRESHOLD_MSG_TYPE

final MessageType frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.THRESHOLD_MSG_TYPE = new MessageType ("ADOPT", "Threshold")

static

The message type for the threshold message.

Referenced by getMsgTypes().

◆ VALUE_MSG_TYPE

final MessageType frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable >.Original< Val extends Addable< Val >, U extends Addable >.VALUE_MSG_TYPE = new MessageType ("ADOPT", "VALUE")

static

The message type for the value message.

Referenced by getMsgTypes(), frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable >.VALUEmsg(), and frodo2.algorithms.adopt.VALUEmsg< Val extends Addable< Val >, U extends Addable >.VALUEmsg().

The documentation for this class was generated from the following file:

src/frodo2/algorithms/adopt/ADOPT.java

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Original()

Member Function Documentation

◆ backTrack()

◆ checkChildInfo()

◆ getMsgTypes()

◆ handleCOSTmessage()

◆ handleTERMINATEmessage()

◆ handleVALUEmessage()

◆ init()

◆ maintainAllocationInvariant()

◆ maintainChildThresholdInvariant()

◆ maintainThresholdInvariant()

◆ notify()

◆ reset()

Member Data Documentation

◆ adopt

◆ COST_MSG_TYPE

◆ TERMINATE_MSG_TYPE

◆ THRESHOLD_MSG_TYPE

◆ VALUE_MSG_TYPE