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	setNewValue (V value)
AddableConflicts< U >	calculateCurrentUtility ()
	Given the current agent view, the current utility is calculated.
AddableConflicts< U >	calculateCurrentUtility (String variable)
	Given the current agent view, the current utility is calculated, ignoring constraints that contain the variable.
AddableConflicts< U >	calculateGain (BinaryAssignment< V > assignment, String variable)
	Calculate the utility gain of the assignment.
AddableConflicts< U >	calculateGain (V ownValue, V neighborValue, String variable)
	Calculate the utility gain of the assignment.
AddableConflicts< U >	calculateGain (V ownValue, V neighborValue, int neighborIndex, String variable)
	Calculate the utility gain of the assignment.
OFFER< V, U >	calculateOffer (int neighborIndex)
	Creates the offer to be made to the chosen neighbor.
boolean	determinePossibleImprovement ()
	Given the current context (agent_view), this method determines the maximal improvement that can be made.
void	reset ()
	Resets the fields.
String	toString ()

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.
boolean	terminated
	`true` when this variable has terminated
int	number_of_neighbors
	The number of neighboring variables.
String[]	neighbors
	List of neighbors.
V[][]	neighborDomains
	The domains of not this variable and all the neighbors.
AddableConflicts< U >	infeasibleUtility
	The utility value used for an infeasible utility.
AddableConflicts< U >	zeroConflicts
	The utility value used to denote zero with no conflicts.
U	zeroUtility
	The utility value used to denote zero.
int	okMsgsReceived
	Counts the number of OK messages received.
List< OK< V > >	okMsgsToProcess
	List of OK messages to process.
V[]	agent_view
	The current context.
List< OFFER< V, U > >	offerMsgsToProcess
	List of OFFER messages to process.
int	improveMsgReceived
	Counts the number of IMPROVE messages received.
List< IMPROVE< U > >	improveMsgsToProcess
	List of IMPROVE messages to process.
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
AddableConflicts< U >	currentUtility
	The current utiliyt, give the current context.
AddableConflicts< U >	improve
	The value with which this variable can improve its utility, given the context.
int	termination_counter
	Used to determine when to terminate.
Message	goMsgToProcess
	Stores a GO message when the variable is not yet ready to process it.

Private Attributes
List< UtilitySolutionSpace< V, U > >	spaces
	The variable's local problem.
HashMap< String, Integer >	neighborPointer
	gives the position of a neighboring variable in the array
int	offersReceived
	Counts the number of OFFER messages received.
BinaryAssignment< V >	bestOffer
	The neighbor that made the best offer so far.
String	bestOfferer
	The best offer received in the current round so far.
HashMap< BinaryAssignment< V >, AddableConflicts< U > >	submittedOffers
	Maps submitted offer to private gain.
boolean	offer
	When `true` this variable is offering, otherwise it is receiving.
HashSet< String >	offeringVariables
	The neighboring variables that have submitted an offer.
boolean	committed
	`true` if at least one offer has been accepted, `false` otherwise

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.mgm2.MGM2< 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 currentValueIndex, improveMsgsToProcess, infeasibleUtility, maximize, offeringVariables, offerMsgsToProcess, frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.StateValue.OK, okMsgsToProcess, frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.problem, spaces, submittedOffers, variableID, VariableInfo(), and zeroUtility.

Referenced by VariableInfo().

Here is the call graph for this function:

Member Function Documentation

◆ calculateCurrentUtility() [1/2]

AddableConflicts frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.calculateCurrentUtility ( )

Given the current agent view, the current utility is calculated.

Author: Brammert Ottens, 6 apr. 2011

Returns: the current 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 calculateGain(), determinePossibleImprovement(), and frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processOK().

Here is the call graph for this function:

◆ calculateCurrentUtility() [2/2]

AddableConflicts frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.calculateCurrentUtility ( String variable )

Given the current agent view, the current utility is calculated, ignoring constraints that contain the variable.

Author: Brammert Ottens, 6 apr. 2011

Parameters

variable the variable that needs to be ignored

Returns: the current 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.

Here is the call graph for this function:

◆ calculateGain() [1/3]

AddableConflicts< U > frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.VariableInfo< V extends Addable< V >, U extends Addable< U > >.calculateGain	(	BinaryAssignment< V >	assignment,
		String	variable )

Calculate the utility gain of the assignment.

Author: Brammert Ottens, 29 mrt. 2011

Parameters

assignment	the assignment
variable	the offering variable

Returns: the utility gain this assignment gives (can be negative)

References calculateGain(), frodo2.algorithms.localSearch.mgm.mgm2.BinaryAssignment< Val extends Addable< Val > >.getOwnValue(), and frodo2.algorithms.localSearch.mgm.mgm2.BinaryAssignment< Val extends Addable< Val > >.neighborValue.

Referenced by calculateGain(), calculateGain(), calculateOffer(), and frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.storeOffer().

Here is the call graph for this function:

◆ calculateGain() [2/3]

AddableConflicts< U > frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.VariableInfo< V extends Addable< V >, U extends Addable< U > >.calculateGain	(	V	ownValue,
		V	neighborValue,
		int	neighborIndex,
		String	variable )

Calculate the utility gain of the assignment.

Author: Brammert Ottens, 29 mrt. 2011

Parameters

ownValue	the variables own value in the offer
neighborValue	the value of the offering variable
neighborIndex	the index of the offering variable
variable	the offering variable

Returns: the utility gain this assignment gives (can be negative)

References agent_view, calculateCurrentUtility(), currentUtility, currentValue, infeasibleUtility, and frodo2.solutionSpaces.AddableConflicts >.subtract().

Here is the call graph for this function:

◆ calculateGain() [3/3]

AddableConflicts< U > frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.VariableInfo< V extends Addable< V >, U extends Addable< U > >.calculateGain	(	V	ownValue,
		V	neighborValue,
		String	variable )

Calculate the utility gain of the assignment.

Author: Brammert Ottens, 29 mrt. 2011

Parameters

ownValue	the variables own value in the offer
neighborValue	the value of the offering variable
variable	the offering variable

Returns: the utility gain this assignment gives (can be negative)

References calculateGain().

Here is the call graph for this function:

◆ calculateOffer()

OFFER< V, U > frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.calculateOffer ( int neighborIndex )

Creates the offer to be made to the chosen neighbor.

Author: Brammert Ottens, 1 apr. 2011

Parameters

neighborIndex the index of the chosen neighbor

Returns: the offer to be made

References calculateGain(), frodo2.solutionSpaces.AddableConflicts >.compareTo(), maximize, neighborDomains, neighbors, offer, submittedOffers, and zeroConflicts.

Referenced by frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processOK().

Here is the call graph for this function:

◆ determinePossibleImprovement()

boolean frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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

Returns: true when the maximal improvement is positive, and false otherwise

References agent_view, calculateCurrentUtility(), currentUtility, currentValue, improve, maximize, neighborDomains, and zeroConflicts.

Referenced by frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processOFFER().

Here is the call graph for this function:

◆ reset()

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

Resets the fields.

Author: Brammert Ottens, 6 apr. 2011

References agent_view, frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.StateValue.OK, and state.

Referenced by frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processGO(), and frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processIMPROVE().

◆ setNeighborValue()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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 frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processOK().

◆ setNewValue()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.setNewValue ( V value )

Author: Brammert Ottens, 20 mei 2011

Parameters

value the new value for the variable

References newValue.

Referenced by frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processOFFER().

◆ toString()

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