A StatsReporter that collects the generic solution to a DCOP. More...

Inheritance diagram for frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >:

[legend]

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

Public Member Functions
Map< String, V >	getSolution ()
U	getUtility ()
long	getFinalTime ()
	SolutionCollector (DCOPProblemInterface< V, U > problem, Element params)
	Constructor for the module added to the agents' queues.
	SolutionCollector (Element params, DCOPProblemInterface< V, U > problem)
	Constructor in StatsReporter mode.
void	notifyIn (Message msg)
void	setQueue (Queue queue)
ArrayList< MessageType >	getMsgTypes ()
void	getStatsFromQueue (Queue queue)
void	setSilent (boolean silent)
void	reset ()
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 final MessageType	ASSIGNMENTS_MSG_TYPE = new MessageType ("SolutionCollector", "VariableValueAssignments")
	The type of the messages containing assignments to variables.
static final MessageType	ASSIGNMENT_MSG_TYPE = new MessageType ("SolutionCollector", "VariableValueAssignment")
	The type of the messages containing an assignment to a variable.

Protected Attributes
boolean	maximize = true
	`true` if we are maximizing utility, `false` if we are minimizing cost

Private Attributes
Queue	queue
	The queue form which this module collects solution messages.
boolean	silent
	Whether this module should print out its solution.
DCOPProblemInterface< V, U >	problem
	The problem.
HashMap< String, V >	solution
	For each variable, its reported value.
U	utility
	The true utility of the reported solution.
Long	finalTime
	The time at which the final solution was reported.

Detailed Description

A StatsReporter that collects the generic solution to a DCOP.

Author: Thomas Leaute

Parameters

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

Constructor & Destructor Documentation

◆ SolutionCollector() [1/2]

frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable< U > >.SolutionCollector	(	DCOPProblemInterface< V, U >	problem,
		Element	params )

Constructor for the module added to the agents' queues.

Parameters

problem	problem instance
params	module parameters

Note: This is unused, since this module will not take part in the algorithm execution

References problem.

Referenced by notifyIn().

◆ SolutionCollector() [2/2]

frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable< U > >.SolutionCollector	(	Element	params,
		DCOPProblemInterface< V, U >	problem )

Constructor in StatsReporter mode.

Parameters

params	module parameters
problem	problem instance

References problem.

Member Function Documentation

◆ getFinalTime()

long frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.getFinalTime ( )

Returns: The time at which the final solution was reported

Referenced by frodo2.algorithms.adopt.ADOPTsolver< V extends Addable< V >, U extends Addable >.buildSolution(), and frodo2.algorithms.dpop.DPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution().

◆ getMsgTypes()

ArrayList< MessageType > frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.getMsgTypes ( )

See also: StatsReporter.getMsgTypes()

Returns: an empty list, since this module does not participate in algorithm execution

Implements frodo2.communication.MessageListener< T >.

◆ getSolution()

Map< String, V > frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.getSolution ( )

Returns: for each variable, its assignment in the solution reported to the problem

Referenced by frodo2.algorithms.asodpop.ASODPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.dpop.DPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.duct.DUCTsolver< V extends Addable< V > >.buildSolution(), frodo2.algorithms.mpc_discsp.MPC_DisWCSP4solver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.odpop.ODPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.dpop.test.DPOPagentTest< V extends Addable< V >, U extends Addable >.checkOutput(), frodo2.algorithms.adopt.test.testADOPT.test(), and frodo2.algorithms.AgentFactory< V extends Addable< V >, U extends Addable >.writeSol().

◆ getStatsFromQueue()

void frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.getStatsFromQueue ( Queue queue )

See also: StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References ASSIGNMENT_MSG_TYPE, ASSIGNMENTS_MSG_TYPE, and queue.

Referenced by frodo2.algorithms.AgentFactory< V extends Addable< V >, U extends Addable >.init(), frodo2.algorithms.afb.test.AFBagentTest< V extends Addable< V >, U extends Addable >.setUp(), and frodo2.algorithms.adopt.test.testADOPT.test().

◆ getUtility()

U frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.getUtility ( )

Returns: true utility of the reported solution

References utility.

Referenced by frodo2.algorithms.asodpop.ASODPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.dpop.DPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.mpc_discsp.MPC_DisWCSP4solver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.odpop.ODPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), frodo2.algorithms.afb.test.AFBagentTest< V extends Addable< V >, U extends Addable >.checkOutput(), frodo2.algorithms.adopt.test.testADOPT.test(), and frodo2.algorithms.AgentFactory< V extends Addable< V >, U extends Addable >.writeSol().

◆ notifyIn()

void frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.notifyIn ( Message msg )

See also: StatsReporter.notifyIn(Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.communication.MessageType.equals(), frodo2.communication.Message.getType(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getUtility(), frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.AssignmentMessage< V extends Addable< V > >.getValue(), frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.AssignmentsMessage< V >.getValues(), frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.AssignmentMessage< V extends Addable< V > >.getVariable(), frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.AssignmentsMessage< V >.getVariables(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.maximize(), queue, solution, and SolutionCollector().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

◆ setQueue()

void frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.setQueue ( Queue queue )

See also: StatsReporter.setQueue(Queue)

Implements frodo2.communication.MessageListener< T >.

References queue.

◆ setSilent()

void frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.setSilent ( boolean silent )

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

References silent.

Member Data Documentation

◆ ASSIGNMENT_MSG_TYPE

final MessageType frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.ASSIGNMENT_MSG_TYPE = new MessageType ("SolutionCollector", "VariableValueAssignment")

static

The type of the messages containing an assignment to a variable.

◆ ASSIGNMENTS_MSG_TYPE

final MessageType frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.ASSIGNMENTS_MSG_TYPE = new MessageType ("SolutionCollector", "VariableValueAssignments")

static

The type of the messages containing assignments to variables.

Referenced by frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.AssignmentsMessage< V >.AssignmentsMessage(), frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.getMsgTypes(), frodo2.algorithms.dpop.stochastic.CompleteUTIL< Val extends Addable< Val >, U extends Addable >.getStatsFromQueue(), frodo2.algorithms.dpop.stochastic.ExpectedUTIL< Val extends Addable< Val >, U extends Addable >.getStatsFromQueue(), frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.getStatsFromQueue(), getStatsFromQueue(), frodo2.algorithms.dpop.stochastic.CompleteUTIL< Val extends Addable< Val >, U extends Addable >.notifyIn(), and frodo2.algorithms.dpop.stochastic.ExpectedUTIL< Val extends Addable< Val >, U extends Addable >.notifyIn().

◆ finalTime

Long frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.finalTime

private

The time at which the final solution was reported.

◆ maximize

boolean frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.maximize = true

protected

true if we are maximizing utility, false if we are minimizing cost

◆ problem

DCOPProblemInterface<V, U> frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.problem

private

The problem.

Referenced by SolutionCollector(), and SolutionCollector().

◆ queue

Queue frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.queue

private

The queue form which this module collects solution messages.

Referenced by getStatsFromQueue(), notifyIn(), and setQueue().

◆ silent

boolean frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.silent

private

Whether this module should print out its solution.

Referenced by setSilent().

◆ solution

HashMap<String, V> frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.solution

private

For each variable, its reported value.

Referenced by notifyIn().

◆ utility

U frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.utility

private

The true utility of the reported solution.

Referenced by getUtility().

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

src/frodo2/algorithms/SolutionCollector.java

Classes

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SolutionCollector() [1/2]

◆ SolutionCollector() [2/2]

Member Function Documentation

◆ getFinalTime()

◆ getMsgTypes()

◆ getSolution()

◆ getStatsFromQueue()

◆ getUtility()

◆ notifyIn()

◆ reset()

◆ setQueue()

◆ setSilent()

Member Data Documentation

◆ ASSIGNMENT_MSG_TYPE

◆ ASSIGNMENTS_MSG_TYPE

◆ finalTime

◆ maximize

◆ problem

◆ queue

◆ silent

◆ solution

◆ utility