frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo Class Reference

Convenience class that contains information for a specific variable. More...

Public Member Functions
	VariableInfo (String variableID, String parent, String[] children, GoodsTree< Val, U, L > tree)
	Constructor.
void	setNewVariable (boolean newVariable)
	Setter method for newVariable.
boolean	getNewVariable ()
ASKmsg	getAskMessage (int child)
ASKmsg	getAskMessage (String child)
String	toString ()

Protected Attributes
String	variableID
	The ID of the variable.
boolean	root
	true if this variable is the root node of the DFS tree
GoodsTree< Val, U, L >	tree
	The goods tree, containing the goods received from the children.
String[]	children
	A list of the children.
HashMap< String, Integer >	childrenPointer
	Maps a child's ID to an integer.
String	parent
	The parent of this variable.
boolean	responded
	false if an ASK message needs answering, true otherwise
boolean	infeasible
	true when the remain part of the local problem has become infeasible
boolean[]	done
	Records, for each child, whether it is done or not.
boolean	terminated
	If the root, true when the optimal utility has been found and false otherwise.
boolean	newVariable
	true when this variable must report a new variable in his separator to his parent
ASKmsg[]	askMessages
	A list of precreated ask messages, one for each child.

Detailed Description

Convenience class that contains information for a specific variable.

Author

brammert

Constructor & Destructor Documentation

VariableInfo()

frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.VariableInfo	(	String	variableID,
		String	parent,
		String[]	children,
		GoodsTree< Val, U, L >	tree )

Constructor.

Parameters

variableID	The ID of the variable
parent	The parent of the variable
children	The children of the variable
tree	The GoodsTree containing utility information

References askMessages, children, childrenPointer, done, frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.LOG, frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.log(), newVariable, parent, tree, and variableID.

Here is the call graph for this function:

Member Function Documentation

getAskMessage() [1/2]

ASKmsg frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.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.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.startProcess().

getAskMessage() [2/2]

ASKmsg frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.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.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.getNewVariable

(

)

Author

Brammert Ottens, 21 aug 2009

Returns

returns the value of newVariable

References newVariable.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD().

setNewVariable()

void frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.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.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD().

toString()

String frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.toString

(

)

See also

java.lang.Object#toString()

References tree.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE().

Member Data Documentation

askMessages

ASKmsg [] frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.askMessages

protected

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

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

children

String [] frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.children

protected

A list of the children.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.startProcess(), and VariableInfo().

childrenPointer

HashMap<String, Integer> frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.childrenPointer

protected

Maps a child's ID to an integer.

Referenced by getAskMessage(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), and VariableInfo().

done

boolean [] frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.done

protected

Records, for each child, whether it is done or not.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.startProcess(), and VariableInfo().

infeasible

boolean frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.infeasible

protected

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

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE().

newVariable

boolean frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.newVariable

protected

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

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

parent

String frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.parent

protected

The parent of this variable.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), and VariableInfo().

responded

boolean frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.responded

protected

false if an ASK message needs answering, true otherwise

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD().

root

boolean frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.root

protected

true if this variable is the root node of the DFS tree

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.startProcess().

terminated

boolean frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.terminated

protected

If the root, true when the optimal utility has been found and false otherwise.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), and frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD().

tree

GoodsTree<Val, U, L> frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.tree

protected

The goods tree, containing the goods received from the children.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.startProcess(), toString(), and VariableInfo().

variableID

String frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.VariableInfo.variableID

protected

The ID of the variable.

Referenced by frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processASK(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processDONE(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.processGOOD(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable< U >, L extends LeafNode< U > >.startProcess(), and VariableInfo().

---

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

• src/frodo2/algorithms/odpop/UTILpropagationFullDomain.java