Convenience class that contains all necessary information on a single variable. More...

Public Member Functions
	VariableInfo (String variableID, DCOPProblemInterface< V, U > problem, List<? extends UtilitySolutionSpace< V, U > > spaces, boolean maximize)
	Constructor.
void	setNeighborValue (String neighbor, V value)
	Stores the value reported by a neighbor.
void	calculateCurrentUtility ()
	Given the current agent view, calculate the current utility.
void	determinePossibleImprovement ()
	Given the current context (agent_view), this method determines the maximal improvement that can be made.
boolean	processOK (OK< V > msg)
	Method to process an OK message.
boolean	processStoredIMPROVEMessages ()
	Process already received IMPROVE messages.
boolean	processIMPROVE (IMPROVE< U > msg)
	Method to process an IMPROVE message.
boolean	processStoredOKMessages ()
	Process already received OK messages.
void	reset ()
	reset the agent view
String	toString ()

Protected Member Functions
AddableConflicts< U >	calculateUtility ()
	Given the current context and variable assignment, this method calculates the utility for the local problem.

Protected Attributes
String	variableID
	The name of the variable.
final boolean	maximize
	`true` when maximizing, and `false` when minimizing
StateValue	state
	The current state of the variable.
V[]	domain
	The domain of the variable.
List< UtilitySolutionSpace< V, U > >	spaces
	The variable's local problem.
V	currentValue
	The variable's current value.
int	currentValueIndex
	The index of the current value.
int	newValue
	The possible new value of this variable, given the context.
boolean	can_move
	`true` when this variable is allowed to change value, and `false` otherwise
int	counter
	Counts the number of received messages.
int	number_of_neighbors
	The number of neighboring variables.
AddableConflicts< U >	currentUtility
	The current utility, give the current context.
AddableConflicts< U >	improve
	The value with which this variable can improve its utility, given the context.
AddableConflicts< U >	infeasibleUtility
	The utility value used for an infeasible utility.
AddableConflicts< U >	zeroConflicts
	The utility value used to denote zero with zero conflicts.
U	zeroUtility
	The utility value used to denote zero.
HashMap< String, Integer >	neighborPointer
	gives the position of a neighboring variable in the array
String[]	neighbors
	List of neighbors.
V[]	agent_view
	The current context.
int	termination_counter
	Used to determine when to terminate.
List< OK< V > >	okMsgsToProcess
	List of OK messages to process.
List< IMPROVE< U > >	improveMsgsToProcess
	List of IMPROVE messages to process.
boolean	terminated
	`true` when this variable has terminated

Detailed Description

Convenience class that contains all necessary information on a single variable.

Parameters

<V>	type used for domain values
<U>	type used for utility values

Constructor & Destructor Documentation

◆ VariableInfo()

frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.VariableInfo< V extends Addable< V >, U extends Addable< U > >.VariableInfo	(	String	variableID,
		DCOPProblemInterface< V, U >	problem,
		List<? extends UtilitySolutionSpace< V, U > >	spaces,
		boolean	maximize )

Constructor.

Parameters

variableID	the ID of the variable
problem	the local problem definition
spaces	list of all spaces owned by the agent
maximize	`true` when the problem is a maximization problem, and `false` otherwise

References domain, improveMsgsToProcess, maximize, okMsgsToProcess, frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.problem, spaces, variableID, and VariableInfo().

Referenced by VariableInfo().

Here is the call graph for this function:

Member Function Documentation

◆ calculateCurrentUtility()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.calculateCurrentUtility ( )

Given the current agent view, calculate the current utility.

Author: Brammert Ottens, 1 apr. 2011

References frodo2.solutionSpaces.AddableDelayed< T extends Addable< T > >.addDelayed(), currentUtility, frodo2.solutionSpaces.AddableConflicts >.getUtility(), frodo2.solutionSpaces.AddableDelayed< T extends Addable< T > >.resolve(), spaces, and zeroUtility.

Referenced by processOK().

Here is the call graph for this function:

◆ calculateUtility()

AddableConflicts frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.calculateUtility ( )

protected

Given the current context and variable assignment, this method calculates the utility for the local problem.

Author: Brammert Ottens, 19 aug 2009

Returns: the current local utility

References frodo2.solutionSpaces.AddableDelayed< T extends Addable< T > >.addDelayed(), frodo2.solutionSpaces.AddableConflicts >.getUtility(), frodo2.solutionSpaces.AddableDelayed< T extends Addable< T > >.resolve(), spaces, and zeroUtility.

Referenced by determinePossibleImprovement().

Here is the call graph for this function:

◆ determinePossibleImprovement()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.determinePossibleImprovement ( )

Given the current context (agent_view), this method determines the maximal improvement that can be made.

Author: Brammert Ottens, 21 feb. 2011

References agent_view, calculateUtility(), can_move, currentUtility, domain, improve, maximize, and zeroConflicts.

Referenced by frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.sendIMPROVE().

Here is the call graph for this function:

◆ processIMPROVE()

boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.processIMPROVE ( IMPROVE msg )

Method to process an IMPROVE message.

Author: Brammert Ottens, 21 feb. 2011

Parameters

msg	the message to be processed

Returns: true when the message needs to be stored for later processing, and false otherwise

References can_move, frodo2.solutionSpaces.AddableConflicts >.compareTo(), counter, frodo2.algorithms.localSearch.mgm.IMPROVE >.getImprove(), frodo2.algorithms.localSearch.mgm.IMPROVE >.getSender(), frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.StateValue.IMPROVE, improve, maximize, number_of_neighbors, frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.StateValue.OK, state, terminated, and variableID.

Referenced by processStoredIMPROVEMessages().

Here is the call graph for this function:

◆ processOK()

boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.processOK ( OK< V > msg )

Method to process an OK message.

Author: Brammert Ottens, 21 feb. 2011

Parameters

msg	the message to be processed

Returns: true when the message needs to be stored for later processing, and false otherwise

References calculateCurrentUtility(), counter, frodo2.algorithms.localSearch.mgm.OK< V extends Addable< V > >.getSender(), frodo2.algorithms.localSearch.mgm.OK< V extends Addable< V > >.getValue(), frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.StateValue.IMPROVE, number_of_neighbors, frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.StateValue.OK, setNeighborValue(), state, and terminated.

Referenced by processStoredOKMessages().

Here is the call graph for this function:

◆ processStoredIMPROVEMessages()

boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.processStoredIMPROVEMessages ( )

Process already received IMPROVE messages.

Author: Brammert Ottens, 18 apr. 2011

Returns: true when switched to OK state

References improveMsgsToProcess, and processIMPROVE().

Here is the call graph for this function:

◆ processStoredOKMessages()

boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.processStoredOKMessages ( )

Process already received OK messages.

Author: Brammert Ottens, 18 apr. 2011

Returns: true when switched to IMPROVE state

References okMsgsToProcess, and processOK().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.reset ( )

reset the agent view

Author: Brammert Ottens, 18 apr. 2011

References agent_view, and currentValue.

◆ setNeighborValue()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.VariableInfo< V extends Addable< V >, U extends Addable< U > >.setNeighborValue	(	String	neighbor,
		V	value )

Stores the value reported by a neighbor.

Author: Brammert Ottens, 21 feb. 2011

Parameters

neighbor	the neighbor that reported the value
value	the reported value

References agent_view, and neighborPointer.

Referenced by processOK().

◆ toString()

String frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.toString ( )