Container class for information needed for each variable. More...

Public Member Functions
	VariableInfo (String variableID, Val[] domain, String[] neighbours, DCOPProblemInterface< Val, U > problem, DSA< Val, U > listener)
	Constructor.
VarAssignment< Val, U >	bestAssignment ()
	Method used to determine the best assignment to the variable given the current context.
boolean	setCurrentValue (VarAssignment< Val, U > ass)
	Sets the current value to the value in ass.
boolean	setContext (VALUEmsg< Val > msg)
	Method to update the context of this variable.
void	resetReportedNeighbours ()
	Resets the reported neighbours counter.
void	processPendingMessages ()
	Method to process the already received, but not yet processed messages.
Val	getCurrentValue ()
	Getter method.
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 variable's ID.
Map< String, Val >	context
	The values of its neighbours, i.e.
String[]	neighbours
	The ID's of its neighbours.
HashMap< String, Integer >	neighbourPointers
	A map that maps neighbours to positions in an array.
int	numberOfNeighbours
	The number of neighbours this variable has.
Val	currentValue
	Its current value.
U	currentUtility
	Its current utility.
Set< String >	reportedNeighbours
	The set of neighbours that have reported a value.
U	zero
	the zero utility
final boolean	maximize
	`true` when the problem is a maximization problem and `false` otherwise
int	cycleCounter
	Contains the current cycle the variable is in.
HashMap< String, LinkedList< VALUEmsg< Val > > >	pendingMessages
	Received messages that one cannot yet process.
HashMap< String, VALUEmsg< Val > >	lastSentMsgs = new HashMap< String, VALUEmsg<Val> > ()
	For each neighbor of this variable, the last message sent to it.
DSA< Val, U >	listener
	pointer to the listener that owns this object

Private Attributes
Val[]	domain
	The variable's domain.
int	domainSize
	The size of the domain.
List< ? extends UtilitySolutionSpace< Val, U > >	spaces
	The variable's local problem.
U	infeasibleUtil
	The utility value used for infeasible solutions.

Detailed Description

Container class for information needed for each variable.

Author: Brammert Ottens, 10 aug 2009

Parameters

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

Constructor & Destructor Documentation

◆ VariableInfo()

frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo< Val extends Addable< Val >, U extends Addable< U > >.VariableInfo	(	String	variableID,
		Val[]	domain,
		String[]	neighbours,
		DCOPProblemInterface< Val, U >	problem,
		DSA< Val, U >	listener )

Constructor.

Parameters

variableID	The ID of the variable
domain	The domain of the variable
neighbours	The neighbouring variables
problem	The local problem
listener	The listener that owns this object

Todo: All spaces should be joined to make use of the power of the local solver, but then we can't count constraint violations anymore...

References bestAssignment(), context, currentUtility, currentValue, domain, domainSize, frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.DSA(), listener, maximize, neighbourPointers, neighbours, numberOfNeighbours, pendingMessages, frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.problem, reportedNeighbours, spaces, frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VarAssignment< Val extends Addable< Val >, U extends Addable >.util, frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VarAssignment< Val extends Addable< Val >, U extends Addable >.value, variableID, and zero.

Here is the call graph for this function:

Member Function Documentation

◆ bestAssignment()

VarAssignment< Val, U > frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.bestAssignment ( )

Method used to determine the best assignment to the variable given the current context.

Author: Brammert Ottens, 10 aug 2009

Returns: the currently best variable value

References calculateUtility(), frodo2.solutionSpaces.AddableConflicts >.compareTo(), context, currentValue, domain, domainSize, frodo2.solutionSpaces.AddableConflicts >.getUtility(), maximize, and variableID.

Referenced by frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.A< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.C< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.E< Val extends Addable< Val >, U extends Addable >.determineAssignment(), and VariableInfo().

Here is the call graph for this function:

◆ calculateUtility()

AddableConflicts frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, 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(), calculateUtility(), context, frodo2.solutionSpaces.AddableDelayed< T extends Addable< T > >.resolve(), spaces, and zero.

Referenced by bestAssignment(), calculateUtility(), and setContext().

Here is the call graph for this function:

◆ getCurrentValue()

Val frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.getCurrentValue ( )

Getter method.

Author: Brammert Ottens, 12 aug 2009

Returns: the current value of this variable

References currentValue.

◆ processPendingMessages()

void frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.processPendingMessages ( )

Method to process the already received, but not yet processed messages.

There should be at most one message per neighbour

Author: Brammert Ottens, 19 aug 2009

References listener, and pendingMessages.

◆ resetReportedNeighbours()

void frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.resetReportedNeighbours ( )

Resets the reported neighbours counter.

Author: Brammert Ottens, 14 aug 2009

References reportedNeighbours.

◆ setContext()

boolean frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.setContext ( VALUEmsg< Val > msg )

Method to update the context of this variable.

Author: Brammert Ottens, 10 aug 2009

Parameters

msg	the message that needs to be processed

Returns: true when all neighbours have reported their states

References calculateUtility(), context, currentUtility, frodo2.algorithms.localSearch.dsa.VALUEmsg< Val extends Addable< Val > >.getSender(), frodo2.algorithms.localSearch.dsa.VALUEmsg< Val extends Addable< Val > >.getValue(), numberOfNeighbours, pendingMessages, and reportedNeighbours.

Here is the call graph for this function:

◆ setCurrentValue()

boolean frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.setCurrentValue ( VarAssignment< Val, U > ass )

Sets the current value to the value in ass.

Author: Brammert Ottens, 10 aug 2009

Parameters

ass	The new assignment

Returns: returns false if the assignment does not change, and true otherwise

References context, currentUtility, currentValue, frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VarAssignment< Val extends Addable< Val >, U extends Addable >.util, frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VarAssignment< Val extends Addable< Val >, U extends Addable >.value, and variableID.

Referenced by frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.A< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.C< Val extends Addable< Val >, U extends Addable >.determineAssignment(), and frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.E< Val extends Addable< Val >, U extends Addable >.determineAssignment().

◆ toString()

String frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.toString ( )

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

Member Data Documentation

◆ context

Map<String, Val> frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.context

protected

The values of its neighbours, i.e.

its context. For efficiency reasons there should also be an entry for this variable.

Referenced by bestAssignment(), calculateUtility(), setContext(), setCurrentValue(), and VariableInfo().

◆ currentUtility

U frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.currentUtility

protected

Its current utility.

Referenced by frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.A< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.C< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.E< Val extends Addable< Val >, U extends Addable >.determineAssignment(), setContext(), setCurrentValue(), and VariableInfo().

◆ currentValue

Val frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.currentValue

protected

Its current value.

Referenced by bestAssignment(), getCurrentValue(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.init(), setCurrentValue(), and VariableInfo().

◆ cycleCounter

int frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.cycleCounter

protected

Contains the current cycle the variable is in.

Referenced by frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.init().

◆ domain

Val [] frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.domain

private

The variable's domain.

Referenced by bestAssignment(), and VariableInfo().

◆ domainSize

int frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.domainSize

private

The size of the domain.

Referenced by bestAssignment(), and VariableInfo().

◆ infeasibleUtil

U frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.infeasibleUtil

private

The utility value used for infeasible solutions.

◆ lastSentMsgs

HashMap< String, VALUEmsg<Val> > frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.lastSentMsgs = new HashMap< String, VALUEmsg<Val> > ()

protected

For each neighbor of this variable, the last message sent to it.

Referenced by frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.init().

◆ listener

DSA<Val, U> frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.listener

protected

pointer to the listener that owns this object

Referenced by processPendingMessages(), and VariableInfo().

◆ maximize

final boolean frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.maximize

protected

true when the problem is a maximization problem and false otherwise

Referenced by bestAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.A< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.C< Val extends Addable< Val >, U extends Addable >.determineAssignment(), frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.E< Val extends Addable< Val >, U extends Addable >.determineAssignment(), and VariableInfo().

◆ neighbourPointers

HashMap<String, Integer> frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.neighbourPointers

protected

A map that maps neighbours to positions in an array.

Referenced by VariableInfo().

◆ neighbours

String [] frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.neighbours

protected

The ID's of its neighbours.

For efficiency reasons there should also be a slot for this variable

Referenced by VariableInfo().

◆ numberOfNeighbours

int frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.numberOfNeighbours

protected

The number of neighbours this variable has.

Referenced by setContext(), and VariableInfo().

◆ pendingMessages

HashMap<String, LinkedList<VALUEmsg<Val> > > frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.pendingMessages

protected

Received messages that one cannot yet process.

Referenced by processPendingMessages(), setContext(), and VariableInfo().

◆ reportedNeighbours

Set<String> frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.reportedNeighbours

protected

The set of neighbours that have reported a value.

Referenced by resetReportedNeighbours(), setContext(), and VariableInfo().

◆ spaces

List< ? extends UtilitySolutionSpace<Val, U> > frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.spaces

private

The variable's local problem.

Referenced by calculateUtility(), and VariableInfo().

◆ variableID

String frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.variableID

protected

The variable's ID.

Referenced by bestAssignment(), setCurrentValue(), and VariableInfo().

◆ zero

U frodo2.algorithms.localSearch.dsa.DSA< Val extends Addable< Val >, U extends Addable >.VariableInfo< Val extends Addable< Val >, U extends Addable >.zero

protected

the zero utility

Referenced by calculateUtility(), and VariableInfo().

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

src/frodo2/algorithms/localSearch/dsa/DSA.java

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VariableInfo()

Member Function Documentation

◆ bestAssignment()

◆ calculateUtility()

◆ getCurrentValue()

◆ processPendingMessages()

◆ resetReportedNeighbours()

◆ setContext()

◆ setCurrentValue()

◆ toString()

Member Data Documentation

◆ context

◆ currentUtility

◆ currentValue

◆ cycleCounter

◆ domain

◆ domainSize

◆ infeasibleUtil

◆ lastSentMsgs

◆ listener

◆ maximize

◆ neighbourPointers

◆ neighbours

◆ numberOfNeighbours

◆ pendingMessages

◆ reportedNeighbours

◆ spaces

◆ variableID

◆ zero