Container for information belonging to a specific variable. More...

Public Member Functions
	VariableInfo (String variableID, Preprocessing< Val, U > p)
	Constructor.
void	setParent (String parent)
	Set the parent of this variable, in this very general version of the class, nothing should happen.
boolean	isInfoReady ()
	Returns true when this variable is ready to send info to its parent.
boolean	isHeuristicReady ()
	Returns true when this variable is ready to send the heuristic.
void	setNumberOfChildren (int numberOfChildren)
	Set the infoCounter to the number of children.

Public Attributes
String	variableID
	The ID of this variable.
String	parent
	The variables parent.
int	infoCounter
	Counts the number of children from whom information has been received.
int	numberOfChildren
	The number of children of this variable.
boolean	infoSent
	`true` when info has sent to ones parent
boolean	heuristicSent
	`true` when the heuristics has been calculated

Package Attributes
UtilitySolutionSpace< Val, U >	h
	Stores the minimal utilities received by the children.
UtilitySolutionSpace< Val, U >	c
	the constraints owned by this variable

Detailed Description

Container for information belonging to a specific variable.

Author: Brammert Ottens, 20 mei 2009

Parameters

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

Constructor & Destructor Documentation

◆ VariableInfo()

frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable< U > >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo	(	String	variableID,
		Preprocessing< Val, U >	p )

Constructor.

Parameters

variableID	The ID of this variable
p	A link to the Preprocessing class

References frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.createUtilitySpace(), h, numberOfChildren, frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.Preprocessing(), variableID, frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.variables, and frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.zeroObject.

Here is the call graph for this function:

Member Function Documentation

◆ isHeuristicReady()

boolean frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.isHeuristicReady ( )

Returns true when this variable is ready to send the heuristic.

By default the variable is always ready

Author: Brammert Ottens, 27 mei 2009

Returns: true when ready

◆ isInfoReady()

boolean frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.isInfoReady ( )

Returns true when this variable is ready to send info to its parent.

By default the variable is never ready

Author: Brammert Ottens, 27 mei 2009

Returns: true when ready

◆ setNumberOfChildren()

void frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.setNumberOfChildren ( int numberOfChildren )

Set the infoCounter to the number of children.

The value should be decreased everytime information from a child is received

Author: Brammert Ottens, 27 mei 2009

Parameters

numberOfChildren The number of children of this variable

References numberOfChildren.

◆ setParent()

void frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.setParent ( String parent )

Set the parent of this variable, in this very general version of the class, nothing should happen.

Author: Brammert Ottens, 27 mei 2009

Parameters

parent The parent of this variable

References parent.

Member Data Documentation

◆ c

UtilitySolutionSpace<Val, U> frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.c

package

the constraints owned by this variable

◆ h

UtilitySolutionSpace<Val, U> frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.h

package

Stores the minimal utilities received by the children.

◆ heuristicSent

boolean frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.heuristicSent

true when the heuristics has been calculated

◆ infoCounter

int frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.infoCounter

Counts the number of children from whom information has been received.

Referenced by frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.DP0< Val extends Addable< Val >, U extends Addable >.processHeuristicsInfoMessage(), frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.DP1< Val extends Addable< Val >, U extends Addable >.processHeuristicsInfoMessage(), and frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.DP2< Val extends Addable< Val >, U extends Addable >.processHeuristicsInfoMessage().

◆ infoSent

boolean frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.infoSent

true when info has sent to ones parent

◆ numberOfChildren

int frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.numberOfChildren

The number of children of this variable.

Referenced by setNumberOfChildren(), and VariableInfo().

◆ parent

String frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.parent

The variables parent.

◆ variableID

String frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.PreprocessingHeuristic< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.variableID

The ID of this variable.

Referenced by frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.DP0< Val extends Addable< Val >, U extends Addable >.createHeuristicInfoMessage(), frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.DP1< Val extends Addable< Val >, U extends Addable >.createHeuristicInfoMessage(), frodo2.algorithms.adopt.Preprocessing< Val extends Addable< Val >, U extends Addable >.DP2< Val extends Addable< Val >, U extends Addable >.createHeuristicInfoMessage(), and VariableInfo().

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

src/frodo2/algorithms/adopt/Preprocessing.java

Public Member Functions

Public Attributes

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VariableInfo()

Member Function Documentation

◆ isHeuristicReady()

◆ isInfoReady()

◆ setNumberOfChildren()

◆ setParent()

Member Data Documentation

◆ c

◆ h

◆ heuristicSent

◆ infoCounter

◆ infoSent

◆ numberOfChildren

◆ parent

◆ variableID