O-DPOP's VALUE propagation module. More...

Inheritance diagram for frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >:

[legend]

Classes
class	AssignmentMessage
	A message holding an assignment to a variable. More...

Public Member Functions
	VALUEpropagation (Element parameters, DCOPProblemInterface< Val, U > problem)
	Constructor used for stats reporter.
	VALUEpropagation (DCOPProblemInterface< Val, U > problem, Element parameters)
	Constructor used in the AgentFactory.
void	getStatsFromQueue (Queue queue)
long	getFinalTime ()
	Returns the time at which this module has finished, determined by looking at the timestamp of the stat messages.
double	getAverageFillTreePercentage ()
double	getAverageDummyFillTreePercentage ()
double	getAverageNumberOfDummies ()
double	getPercentageOfGoodsSent ()
U	getMaximalCutSum ()
void	setSilent (boolean silent)
Collection< MessageType >	getMsgTypes ()
void	notifyIn (Message msg)
void	reset ()
void	setQueue (Queue queue)
Public Member Functions inherited from frodo2.communication.IncomingMsgPolicyInterface< T >
default void	notifyIn (Message msg, Object toAgent)
	Notifies the listener of an incoming message.

Static Public Attributes
static MessageType	START_MSG_TYPE = AgentInterface.START_AGENT
	The type of the message telling the module to start.
static final MessageType	VALUE_MSG_TYPE = new MessageType ("O-DPOP", "VALUEpropagation", "VALUE")
	The type of the value message.
static final MessageType	GOODS_TREE_REQUEST_MESSAGE = new MessageType ("O-DPOP", "VALUEpropagation", "Goodstree request")
	The type of the message used to request the GoodsTree from the UTIL propagation module.
static final MessageType	OUTPUT_MSG_TYPE = new MessageType ("O-DPOP", "VALUEpropagation", "OutputVALUEpropagation")
	The type of the output messages containing the optimal assignment to a variable.

Protected Member Functions
void	sendMessageToVariable (String receiver, Message msg)
	Sends a message to a variable.
void	log (String variableID, String message)
	Log function used to print the variables state during debugging.

Protected Attributes
Val[][]	domains
	For each variable owned by this agent, its domain.
HashMap< String, BufferedWriter >	loggers
	A list of buffered writers used to log information during debugging.

Static Protected Attributes
static final boolean	LOG = false
	To log or not to log.

Private Member Functions
void	init ()
	Initializes the agent's variables.
void	findOptimalAssignmentAndSend (String varID, int varIndex, GoodsTree< Val, U, LeafNode< U > > tree)
	Given the GoodsTree and the context, this method determines the value a variable should take.

Private Attributes
boolean	reportStats = true
	Whether to report stats.
DCOPProblemInterface< Val, U >	problem
	The agent's problem.
HashMap< String, Integer >	variablePointer
	For each variable its index in the arrays.
Map< String, String >	owners
	For each variable the agent that owns it.
ArrayList< List< String > >	children
	Per variable a list of its children.
boolean[]	root
	For each variable whether it is a root.
ArrayList< HashMap< String, Val > >	contextMap
	For each variable its context.
boolean	started
	`true` when this agent has been initialized
Queue	queue
	This agent's queue.
int	variablesReadyCounter
	Counts the number of variables that have not yet terminated, 0 if all variables have terminated.
boolean	agentFinished
	`true` when the agent has finished, and false otherwise
double	cumulativeFillPercentage
	The percentage of the problem that has been stored.
double	cumulativeDummyFillPercentage
	The cumulative dummy fill percentage.
long	cumulativeNumberOfDummies
	The total number of dummie present in the problem.
int	fillPercentageCounter
	Represents to what extent the trees owned by this agent are filled.
long	finalTime
	The time all modules of the type VALUE propagation have finished.
long	numberOfGoodsSent
	The number of goods that has been sent.
long	spaceSize
	The total size of the space.
U	maximalCutSum
	The sum of maximal cuts.
HashMap< String, List< VALUEmsgWithVars< Val > > >	postponed = new HashMap< String, List< VALUEmsgWithVars<Val> > > ()
	For each variable, a list of VALUE messages that are waiting to be processed until the DFS output has been received.

Detailed Description

O-DPOP's VALUE propagation module.

Author: brammert

Parameters

<Val>	The type used for domain values
<U>	The type used for utility values

Constructor & Destructor Documentation

◆ VALUEpropagation() [1/2]

frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable< U > >.VALUEpropagation	(	Element	parameters,
		DCOPProblemInterface< Val, U >	problem )

Constructor used for stats reporter.

Parameters

problem	the overall problem
parameters	the description of what statistics should be reported (currently unused)

References problem.

Referenced by findOptimalAssignmentAndSend().

◆ VALUEpropagation() [2/2]

frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable< U > >.VALUEpropagation	(	DCOPProblemInterface< Val, U >	problem,
		Element	parameters )

Constructor used in the AgentFactory.

Parameters

problem	The problem definition
parameters	Parameters to the listener

References problem.

Member Function Documentation

◆ findOptimalAssignmentAndSend()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable< U > >.findOptimalAssignmentAndSend	(	String	varID,
		int	varIndex,
		GoodsTree< Val, U, LeafNode< U > >	tree )

private

Given the GoodsTree and the context, this method determines the value a variable should take.

Parameters

varID	The variable ID
varIndex	The index of the variable
tree	The GoodsTree containing all relevant information to determine the value of the variable

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, children, contextMap, domains, LOG, log(), problem, queue, reportStats, sendMessageToVariable(), frodo2.algorithms.AgentInterface< V extends Addable< V > >.STATS_MONITOR, VALUEpropagation(), and variablesReadyCounter.

Here is the call graph for this function:

◆ getAverageDummyFillTreePercentage()

double frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getAverageDummyFillTreePercentage ( )

Author: Brammert Ottens, 25 feb 2010

Returns: the average dummy fill percentage

◆ getAverageFillTreePercentage()

double frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getAverageFillTreePercentage ( )

Author: Brammert Ottens, 7 jan 2010

Returns: the average of all reported treeFillPercentages

◆ getAverageNumberOfDummies()

double frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getAverageNumberOfDummies ( )

Author: Brammert Ottens, 25 feb 2010

Returns: the average number of dummies

◆ getFinalTime()

long frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getFinalTime ( )

Returns the time at which this module has finished, determined by looking at the timestamp of the stat messages.

Author: Brammert Ottens, 22 feb 2010

Returns: the time at which this module has finished

References finalTime.

◆ getMaximalCutSum()

U frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getMaximalCutSum ( )

Author: Brammert Ottens, 7 feb. 2011

Returns: the maximal value with which a utility value has been cut

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getMsgTypes ( )

See also: frodo2.communication.IncomingMsgPolicyInterface.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.GOODS_TREE_MSG_TYPE, frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.OUTPUT_MSG_TYPE, START_MSG_TYPE, and VALUE_MSG_TYPE.

◆ getPercentageOfGoodsSent()

double frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getPercentageOfGoodsSent ( )

Author: Brammert Ottens, 7 feb. 2011

Returns: the percentage of possible goods that have been sent

◆ getStatsFromQueue()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.getStatsFromQueue ( Queue queue )

See also: frodo2.algorithms.StatsReporter.getStatsFromQueue(frodo2.communication.Queue)

Implements frodo2.algorithms.StatsReporter.

References OUTPUT_MSG_TYPE, and queue.

◆ init()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.init ( )

private

Initializes the agent's variables.

References children, contextMap, domains, init(), loggers, owners, problem, root, variablePointer, and variablesReadyCounter.

Referenced by init(), and notifyIn().

Here is the call graph for this function:

◆ log()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable< U > >.log	(	String	variableID,
		String	message )

protected

Log function used to print the variables state during debugging.

Parameters

variableID	The ID of the variable that is logging
message	The message that must be logged

References LOG, and loggers.

Referenced by findOptimalAssignmentAndSend().

◆ notifyIn()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.notifyIn ( Message msg )

See also: StatsReporter.notifyIn(Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.communication.MessageType.equals(), frodo2.algorithms.odpop.UTILpropagationFullDomain< Val extends Addable< Val >, U extends Addable, L extends LeafNode >.GOODS_TREE_MSG_TYPE, init(), notifyIn(), OUTPUT_MSG_TYPE, frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.OUTPUT_MSG_TYPE, and started.

Referenced by notifyIn().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

◆ sendMessageToVariable()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable< U > >.sendMessageToVariable	(	String	receiver,
		Message	msg )

protected

Sends a message to a variable.

Parameters

receiver	The recipient of the message
msg	The message to be sent

References owners, and queue.

Referenced by findOptimalAssignmentAndSend().

◆ setQueue()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.setQueue ( Queue queue )

See also: frodo2.communication.IncomingMsgPolicyInterface.setQueue(frodo2.communication.Queue)

Implements frodo2.communication.MessageListener< T >.

References queue.

◆ setSilent()

void frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.setSilent ( boolean silent )

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

Member Data Documentation

◆ agentFinished

boolean frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.agentFinished

private

true when the agent has finished, and false otherwise

◆ children

ArrayList<List<String> > frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.children

private

Per variable a list of its children.

Referenced by findOptimalAssignmentAndSend(), and init().

◆ contextMap

ArrayList<HashMap<String, Val> > frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.contextMap

private

For each variable its context.

Referenced by findOptimalAssignmentAndSend(), and init().

◆ cumulativeDummyFillPercentage

double frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.cumulativeDummyFillPercentage

private

The cumulative dummy fill percentage.

◆ cumulativeFillPercentage

double frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.cumulativeFillPercentage

private

The percentage of the problem that has been stored.

◆ cumulativeNumberOfDummies

long frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.cumulativeNumberOfDummies

private

The total number of dummie present in the problem.

◆ domains

Val [][] frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.domains

protected

For each variable owned by this agent, its domain.

Referenced by findOptimalAssignmentAndSend(), and init().

◆ fillPercentageCounter

int frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.fillPercentageCounter

private

Represents to what extent the trees owned by this agent are filled.

◆ finalTime

long frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.finalTime

private

The time all modules of the type VALUE propagation have finished.

Referenced by getFinalTime().

◆ GOODS_TREE_REQUEST_MESSAGE

final MessageType frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.GOODS_TREE_REQUEST_MESSAGE = new MessageType ("O-DPOP", "VALUEpropagation", "Goodstree request")

static

The type of the message used to request the GoodsTree from the UTIL propagation module.

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

◆ LOG

final boolean frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.LOG = false

staticprotected

To log or not to log.

Referenced by findOptimalAssignmentAndSend(), and log().

◆ loggers

HashMap<String, BufferedWriter> frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.loggers

protected

A list of buffered writers used to log information during debugging.

Referenced by init(), and log().

◆ maximalCutSum

U frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.maximalCutSum

private

The sum of maximal cuts.

◆ numberOfGoodsSent

long frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.numberOfGoodsSent

private

The number of goods that has been sent.

◆ OUTPUT_MSG_TYPE

final MessageType frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.OUTPUT_MSG_TYPE = new MessageType ("O-DPOP", "VALUEpropagation", "OutputVALUEpropagation")

static

The type of the output messages containing the optimal assignment to a variable.

Referenced by frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.AssignmentMessage< Val extends Addable< Val >, U extends Addable >.AssignmentMessage(), frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.AssignmentMessage< Val extends Addable< Val >, U extends Addable >.AssignmentMessage(), getStatsFromQueue(), and notifyIn().

◆ owners

Map<String, String> frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.owners

private

For each variable the agent that owns it.

Referenced by init(), and sendMessageToVariable().

◆ postponed

HashMap< String, List< VALUEmsgWithVars<Val> > > frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.postponed = new HashMap< String, List< VALUEmsgWithVars<Val> > > ()

private

For each variable, a list of VALUE messages that are waiting to be processed until the DFS output has been received.

◆ problem

DCOPProblemInterface<Val, U> frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.problem

private

The agent's problem.

Referenced by findOptimalAssignmentAndSend(), init(), VALUEpropagation(), and VALUEpropagation().

◆ queue

Queue frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.queue

private

This agent's queue.

Referenced by findOptimalAssignmentAndSend(), getStatsFromQueue(), sendMessageToVariable(), and setQueue().

◆ reportStats

boolean frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.reportStats = true

private

Whether to report stats.

Referenced by findOptimalAssignmentAndSend().

◆ root

boolean [] frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.root

private

For each variable whether it is a root.

Referenced by init().

◆ spaceSize

long frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.spaceSize

private

The total size of the space.

◆ START_MSG_TYPE

MessageType frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.START_MSG_TYPE = AgentInterface.START_AGENT

static

The type of the message telling the module to start.

Referenced by getMsgTypes().

◆ started

boolean frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.started

private

true when this agent has been initialized

Referenced by notifyIn().

◆ VALUE_MSG_TYPE

final MessageType frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.VALUE_MSG_TYPE = new MessageType ("O-DPOP", "VALUEpropagation", "VALUE")

static

The type of the value message.

Referenced by getMsgTypes(), frodo2.algorithms.odpop.VALUEmsg< Val extends Addable< Val > >.VALUEmsg(), frodo2.algorithms.odpop.VALUEmsg< Val extends Addable< Val > >.VALUEmsg(), frodo2.algorithms.odpop.VALUEmsgWithVars< Val extends Addable< Val > >.VALUEmsgWithVars(), and frodo2.algorithms.odpop.VALUEmsgWithVars< Val extends Addable< Val > >.VALUEmsgWithVars().

◆ variablePointer

HashMap<String, Integer> frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.variablePointer

private

For each variable its index in the arrays.

Referenced by init().

◆ variablesReadyCounter

int frodo2.algorithms.odpop.VALUEpropagation< Val extends Addable< Val >, U extends Addable >.variablesReadyCounter

private

Counts the number of variables that have not yet terminated, 0 if all variables have terminated.

Referenced by findOptimalAssignmentAndSend(), and init().

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

src/frodo2/algorithms/odpop/VALUEpropagation.java

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ VALUEpropagation() [1/2]

◆ VALUEpropagation() [2/2]

Member Function Documentation

◆ findOptimalAssignmentAndSend()

◆ getAverageDummyFillTreePercentage()

◆ getAverageFillTreePercentage()

◆ getAverageNumberOfDummies()

◆ getFinalTime()

◆ getMaximalCutSum()

◆ getMsgTypes()

◆ getPercentageOfGoodsSent()

◆ getStatsFromQueue()

◆ init()

◆ log()

◆ notifyIn()

◆ reset()

◆ sendMessageToVariable()

◆ setQueue()

◆ setSilent()

Member Data Documentation

◆ agentFinished

◆ children

◆ contextMap

◆ cumulativeDummyFillPercentage

◆ cumulativeFillPercentage

◆ cumulativeNumberOfDummies

◆ domains

◆ fillPercentageCounter

◆ finalTime

◆ GOODS_TREE_REQUEST_MESSAGE

◆ LOG

◆ loggers

◆ maximalCutSum

◆ numberOfGoodsSent

◆ OUTPUT_MSG_TYPE

◆ owners

◆ postponed

◆ problem

◆ queue

◆ reportStats

◆ root

◆ spaceSize

◆ START_MSG_TYPE

◆ started

◆ VALUE_MSG_TYPE

◆ variablePointer

◆ variablesReadyCounter