A convenience class that contains the following information for a variable. More...

Public Member Functions
	VariableInfo (boolean root, String variableID, String parent, String[] children, String[] pseudo_children, List< String > pseudo_parents, int numberOfPseudoParents, GoodsTree< Val, U, LeafNode< U > > tree)
	A constructor.
Good< Val, U >	getAmax ()
	Method to return the next good to send.
Val	getRandomValue ()
void	setCurrentContext (HashMap< String, Val > context, boolean isConfirmed)
	Set the current context.
void	updateCurrentContext (String variable, Val value)
	Updates the value of variable in the current context.
void	setNewVariable (boolean newVariable)
	Setter method for newVariable.
boolean	getNewVariable ()
ASKmsg	getAskMessage (int child)
ASKmsg	getAskMessage (String child)
ACKmsg	getAckMessage (int child)
boolean	valuesAreConsistent (Val[] values, String child)
	Checks whether the number of values in `values` is consistent with the reported separator size of the child.
String	toString ()
	Method to print out state of the variable.

Public Attributes
boolean	root
	Denotes whether the variable is the root or not.
boolean	isDone
	Stores whether this variable already send a DONE message.
boolean	terminated
	When the optimal assignment is known, this variable is set to true.
String	variableID
	The variables ID.
String	parent
	The parents ID.
String[]	children
	The children's IDs.
String[]	pseudo_children
	The pseudo children of this variable.
HashSet< String >	pseudo_parents
	A list of pseudo parents.
HashMap< String, Integer >	childrenPointer
	Maps a child's ID to an integer.
int	numberOfChildren
	The number of children this variable has.
boolean	infeasible
	`true` when the remain part of the local problem has become infeasible
GoodsTree< Val, U, LeafNode< U > >	tree
	This data structure contains all the information for this variable.
boolean[]	done
	For each child it stores whether it is done or not.
Good< Val, U >	lastSent
	The last good that has been sent.
boolean	notResponded
	True if the agent has not yet responded to an ASK message.
HashMap< String, Val >	currentContextMap
	The currentContextMap.
LinkedList< Message >	goodsToSend
	list of goods that are still to be send

Private Attributes
ASKmsg[]	askMessages
	A list of precreated ask messages, one for each child.
ACKmsg[]	ackMessages
	A list of precreated ack messages, one for each child.
boolean	newVariable
	`true` when this variable must report a new variable in his separator to his parent
boolean	acknowledged = true
	`true` when the last utility message with variable info has been acknowledge, and `false` otherwise.

Detailed Description

A convenience class that contains the following information for a variable.

information on this variables separator
a list of assignments
Author
brammert

Constructor & Destructor Documentation

◆ VariableInfo()

frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo.VariableInfo	(	boolean	root,
		String	variableID,
		String	parent,
		String[]	children,
		String[]	pseudo_children,
		List< String >	pseudo_parents,
		int	numberOfPseudoParents,
		GoodsTree< Val, U, LeafNode< U > >	tree )

A constructor.

Parameters

root	`true` when this variable is a root
variableID	The ID of this variable
parent	The parent of this variable
children	The children of this variable
pseudo_children	A list of pseudo children
pseudo_parents	A list of pseudo parents
numberOfPseudoParents	the size of the list of pseudo children
tree	The GoodsTree

References ackMessages, askMessages, children, childrenPointer, currentContextMap, done, newVariable, notResponded, numberOfChildren, parent, pseudo_children, pseudo_parents, root, tree, and variableID.

Member Function Documentation

◆ getAckMessage()

ACKmsg frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.getAckMessage ( int child )

Author: Brammert Ottens, 3 sep 2009

Parameters

child child of the variable

Returns: pre-created ACK message for child

References ackMessages.

◆ getAmax()

Good< Val, U > frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.getAmax ( )

Method to return the next good to send.

Returns: aMax

References tree.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage().

◆ getAskMessage() [1/2]

ASKmsg frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.getAskMessage ( int child )

Author: Brammert Ottens, 2 sep 2009

Parameters

child child of the variable

Returns: pre-created ASK message for child

References askMessages.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendASK().

◆ getAskMessage() [2/2]

ASKmsg frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.getAskMessage ( String child )

Author: Brammert Ottens, 2 sep 2009

Parameters

child child of the variable

Returns: pre-created ASK message for child

References askMessages, and childrenPointer.

◆ getNewVariable()

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.getNewVariable ( )

Author: Brammert Ottens, 21 aug 2009

Returns: returns the value of newVariable

References newVariable.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), and frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood().

◆ getRandomValue()

Val frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.getRandomValue ( )

Author: Brammert Ottens, 26 mei 2010

Returns: a random value from the variables domain

References tree.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent().

◆ setCurrentContext()

void frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo.setCurrentContext	(	HashMap< String, Val >	context,
		boolean	isConfirmed )

Set the current context.

Parameters

context	the current context
isConfirmed	`true` when the received VALUE message is confirmed

References currentContextMap, and pseudo_parents.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent().

◆ setNewVariable()

void frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.setNewVariable ( boolean newVariable )

Setter method for newVariable.

Author: Brammert Ottens, 21 aug 2009

Parameters

newVariable the value for newVariable

References newVariable.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), and frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood().

◆ toString()

String frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.toString ( )

Method to print out state of the variable.

See also: java.lang.Object#toString()

References currentContextMap, done, numberOfChildren, and tree.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), and frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent().

◆ updateCurrentContext()

void frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo.updateCurrentContext	(	String	variable,
		Val	value )

Updates the value of variable in the current context.

Parameters

variable	The variable whos value must be updated
value	The new value of the variable

References currentContextMap.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent().

◆ valuesAreConsistent()

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo.valuesAreConsistent	(	Val[]	values,
		String	child )

Checks whether the number of values in values is consistent with the reported separator size of the child.

Author: Brammert Ottens, 2 sep 2009

Parameters

values	the set of values reported by the child
child	the child who reported the values

Returns: true when the reported separator is consistent with the reported values

References childrenPointer, and tree.

Member Data Documentation

◆ ackMessages

ACKmsg [] frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.ackMessages

private

A list of precreated ack messages, one for each child.

Referenced by getAckMessage(), and VariableInfo().

◆ acknowledged

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.acknowledged = true

private

true when the last utility message with variable info has been acknowledge, and false otherwise.

The acknowledgements are there to enable the algorithm to function when the order of messages is not garuanteed.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood().

◆ askMessages

ASKmsg [] frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.askMessages

private

A list of precreated ask messages, one for each child.

Referenced by getAskMessage(), getAskMessage(), and VariableInfo().

◆ children

String [] frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.children

The children's IDs.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.startProcess(), and VariableInfo().

◆ childrenPointer

HashMap<String, Integer> frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.childrenPointer

Maps a child's ID to an integer.

Referenced by getAskMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendVALUEChild(), valuesAreConsistent(), and VariableInfo().

◆ currentContextMap

HashMap<String, Val> frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.currentContextMap

The currentContextMap.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), setCurrentContext(), toString(), updateCurrentContext(), and VariableInfo().

◆ done

boolean [] frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.done

For each child it stores whether it is done or not.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), toString(), and VariableInfo().

◆ goodsToSend

LinkedList<Message> frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.goodsToSend

list of goods that are still to be send

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood().

◆ infeasible

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.infeasible

true when the remain part of the local problem has become infeasible

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage().

◆ isDone

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.isDone

Stores whether this variable already send a DONE message.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage().

◆ lastSent

Good<Val, U> frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.lastSent

The last good that has been sent.

Should be set to null after a confirmed good has been sent.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood().

◆ newVariable

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.newVariable

private

true when this variable must report a new variable in his separator to his parent

Referenced by getNewVariable(), setNewVariable(), and VariableInfo().

◆ notResponded

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.notResponded

True if the agent has not yet responded to an ASK message.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), and VariableInfo().

◆ numberOfChildren

int frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.numberOfChildren

The number of children this variable has.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), toString(), and VariableInfo().

◆ parent

String frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.parent

The parents ID.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.startProcess(), and VariableInfo().

◆ pseudo_children

String [] frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.pseudo_children

The pseudo children of this variable.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), and VariableInfo().

◆ pseudo_parents

HashSet<String> frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.pseudo_parents

A list of pseudo parents.

Referenced by setCurrentContext(), and VariableInfo().

◆ root

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.root

Denotes whether the variable is the root or not.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), and VariableInfo().

◆ terminated

boolean frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.terminated

When the optimal assignment is known, this variable is set to true.

It is used to ignore messages received after termination

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), and frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage().

◆ tree

GoodsTree<Val, U, LeafNode > frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.tree

This data structure contains all the information for this variable.

Referenced by getAmax(), getRandomValue(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendVALUEChild(), toString(), valuesAreConsistent(), and VariableInfo().

◆ variableID

String frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.VariableInfo.variableID

The variables ID.

Referenced by frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processASKMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processUTILMessage(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessageParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.processVALUEmessagePseudoParent(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendASK(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendGood(), frodo2.algorithms.asodpop.ASODPOP< Val extends Addable< Val >, U extends Addable >.sendVALUEChild(), and VariableInfo().

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

src/frodo2/algorithms/asodpop/ASODPOP.java

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VariableInfo()

Member Function Documentation

◆ getAckMessage()

◆ getAmax()

◆ getAskMessage() [1/2]

◆ getAskMessage() [2/2]

◆ getNewVariable()

◆ getRandomValue()

◆ setCurrentContext()

◆ setNewVariable()

◆ toString()

◆ updateCurrentContext()

◆ valuesAreConsistent()

Member Data Documentation

◆ ackMessages

◆ acknowledged

◆ askMessages

◆ children

◆ childrenPointer

◆ currentContextMap

◆ done

◆ goodsToSend

◆ infeasible

◆ isDone

◆ lastSent

◆ newVariable

◆ notResponded

◆ numberOfChildren

◆ parent

◆ pseudo_children

◆ pseudo_parents

◆ root

◆ terminated

◆ tree

◆ variableID