Classical UTIL propagation protocol. More...

Inheritance diagram for frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >:

[legend]

Classes
class	SolutionMessage
	A message holding the optimal assignments to a variable, conditioned on the assignments to the variables in its separator. More...
class	SeparatorMessage
	A message holding the separator of a given child variable. More...
class	OptUtilMessage
	Message sent by roots containing the optimal utility value of their DFS tree. More...
class	StatsMessage
	Message containing statistics. More...
class	VariableInfo
	A convenience class used to store information about a variable. More...

Public Member Functions
	CountSolutionsUTIL (DCOPProblemInterface< Val, U > problem)
	Constructor.
	CountSolutionsUTIL (DCOPProblemInterface< Val, U > problem, Element parameters) throws ClassNotFoundException
	Constructor from XML descriptions.
void	reset ()
	CountSolutionsUTIL (Element parameters, DCOPProblemInterface< Val, U > problem)
	The constructor called in "statistics gatherer" mode.
Collection< MessageType >	getMsgTypes ()
void	notifyIn (Message msg)
	The algorithm.
void	setQueue (Queue queue)
void	getStatsFromQueue (Queue queue)
void	setSilent (boolean silent)
Integer	getMaxMsgDim ()
U	getOptUtil ()
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 MessageType	DFS_MSG_TYPE = DFSgeneration.OUTPUT_MSG_TYPE
	The type of the messages containing information about the DFS.
static final MessageType	UTIL_MSG_TYPE = UTILpropagation.UTIL_MSG_TYPE
	The type of the messages containing utilities.
static final MessageType	OUTPUT_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "UTILoutput")
	The type of the messages containing conditional optimal assignments.
static final MessageType	SEPARATOR_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "Separator")
	The type of the messages containing separators.
static final MessageType	OPT_UTIL_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "OptUtil")
	The type of the messages containing optimal utility values sent by roots.
static final MessageType	UTIL_STATS_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "UTILstats")
	The type of messages sent to the statistics monitor.

Protected Member Functions
void	init ()
	Parses the problem.
void	sendSeparator (String sender, String dest, String[] separator)
	Sends a message to the VALUEpropagation module containing the separator of a variable.
ProjOutput< Val, U >	project (UtilitySolutionSpace< Val, U > space, String var)
	Projects the input variable from the input space.
void	sendToParent (String var, String parent, UtilitySolutionSpace< Val, U > space)
	Sends a UTIL message.
void	sendOutput (UtilitySolutionSpace< Val, U > space, String root)
	Sends the output optimal utility to itself (i.e.

Protected Attributes
boolean	withAnonymVars = false
	Whether the parser should consider variables with no specified owner.
DCOPProblemInterface< Val, U >	problem
	The problem.
boolean	started = false
	Whether the execution of the algorithm has been started.
boolean	maximize = true
	`true` if we want to maximize utility, `false` if we want to minimize cost
Queue	queue
	The queue on which it should call sendMessage().
Map< String, VariableInfo >	infos = new HashMap<String, VariableInfo> ()
	For each variable this agent owns, its relevant information.
Map< String, String >	owners = new HashMap<String, String> ()
	For each known variable, the name of the agent that owns it.
U	optUtil
	The optimal utility found to the problem.

Private Member Functions
void	record (UtilitySolutionSpace< Val, U > space, VariableInfo info)
	Records the input space until spaces from all children have been received.
void	projectAndSend (VariableInfo info)
	Projects out a variable and sends the result to its parent (if any) or to itself (to initiate VALUE propagation).

Private Attributes
boolean	reportStats = true
	Whether to report stats.
Integer	maxMsgDim = 0
	In stats gatherer mode, the maximum number of variables in a UTIL message.

Detailed Description

Classical UTIL propagation protocol.

Author: Thomas Leaute, Brammert Ottens

Parameters

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

Todo: Extremely high code redundancy with UTILpropagation; we should be inheriting this class.

Constructor & Destructor Documentation

◆ CountSolutionsUTIL() [1/3]

frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.CountSolutionsUTIL ( DCOPProblemInterface< Val, U > problem )

Constructor.

Parameters

problem the problem description

References problem.

◆ CountSolutionsUTIL() [2/3]

frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.CountSolutionsUTIL	(	DCOPProblemInterface< Val, U >	problem,
		Element	parameters ) throws ClassNotFoundException

Constructor from XML descriptions.

Parameters

problem	description of the problem
parameters	description of the parameters of UTILpropagation

Exceptions

ClassNotFoundException if the module parameters specify an unknown class for utility values

References problem.

◆ CountSolutionsUTIL() [3/3]

frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.CountSolutionsUTIL	(	Element	parameters,
		DCOPProblemInterface< Val, U >	problem )

The constructor called in "statistics gatherer" mode.

Parameters

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

References problem.

Member Function Documentation

◆ getMaxMsgDim()

Integer frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.getMaxMsgDim ( )

Returns: the maximum number of variables in a UTIL message (in stats gatherer mode only)

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.dpop.count.CountSolutionsUTIL< 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, DFS_MSG_TYPE, START_MSG_TYPE, and UTIL_MSG_TYPE.

◆ getOptUtil()

U frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.getOptUtil ( )

Returns: the optimal utility found to the problem

Warning: Only works if the module is instantiated in stats gatherer mode.

Referenced by frodo2.algorithms.dpop.count.SolutionCounter< V extends Addable< V >, U extends Addable >.count().

◆ getStatsFromQueue()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.getStatsFromQueue ( Queue queue )

See also: StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References OPT_UTIL_MSG_TYPE, queue, and UTIL_STATS_MSG_TYPE.

◆ init()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.init ( )

protected

Parses the problem.

References problem.

◆ notifyIn()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.notifyIn ( Message msg )

The algorithm.

For each variable that it owns, the agent waits for the reception of all UTIL messages from all child variables, plus one corresponding to a private constraint sent by the DPOP agent.

Parameters

msg	the message received

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.communication.MessageType.equals(), notifyIn(), and OPT_UTIL_MSG_TYPE.

Referenced by notifyIn().

Here is the call graph for this function:

◆ project()

ProjOutput< Val, U > frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.project	(	UtilitySolutionSpace< Val, U >	space,
		String	var )

protected

Projects the input variable from the input space.

Parameters

space	the space
var	the variable to project out

Returns: the result of the projection

References maximize, and frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable >.project().

Here is the call graph for this function:

◆ projectAndSend()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.projectAndSend ( VariableInfo info )

private

Projects out a variable and sends the result to its parent (if any) or to itself (to initiate VALUE propagation).

Parameters

info	information about the variable to be projected out

References projectAndSend(), queue, and sendOutput().

Referenced by projectAndSend().

Here is the call graph for this function:

◆ record()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.record	(	UtilitySolutionSpace< Val, U >	space,
		VariableInfo	info )

private

Records the input space until spaces from all children have been received.

Parameters

space	the space to be recorded
info	the variable info

References frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.VariableInfo.space.

◆ reset()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

◆ sendOutput()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.sendOutput	(	UtilitySolutionSpace< Val, U >	space,
		String	root )

protected

Sends the output optimal utility to itself (i.e.

the VALUEpropagation listener) and to the statistics monitor

Parameters

space	the final frontier
root	the root of the DFS

References infos, frodo2.output, queue, and frodo2.algorithms.AgentInterface< V extends Addable< V > >.STATS_MONITOR.

Referenced by projectAndSend().

◆ sendSeparator()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.sendSeparator	(	String	sender,
		String	dest,
		String[]	separator )

protected

Sends a message to the VALUEpropagation module containing the separator of a variable.

Parameters

sender	sender variable
dest	destination variable
separator	the separator of the destination variable

References queue.

◆ sendToParent()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable< U > >.sendToParent	(	String	var,
		String	parent,
		UtilitySolutionSpace< Val, U >	space )

protected

Sends a UTIL message.

Parameters

var	the sender of the message
parent	the destination of the message
space	the content of the message

References infos, owners, queue, and frodo2.algorithms.AgentInterface< V extends Addable< V > >.STATS_MONITOR.

◆ setQueue()

void frodo2.algorithms.dpop.count.CountSolutionsUTIL< 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.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.setSilent ( boolean silent )

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

Referenced by frodo2.algorithms.dpop.count.SolutionCounter< V extends Addable< V >, U extends Addable >.count().

Member Data Documentation

◆ DFS_MSG_TYPE

MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.DFS_MSG_TYPE = DFSgeneration.OUTPUT_MSG_TYPE

static

The type of the messages containing information about the DFS.

Referenced by getMsgTypes().

◆ infos

Map<String, VariableInfo> frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.infos = new HashMap<String, VariableInfo> ()

protected

For each variable this agent owns, its relevant information.

Referenced by sendOutput(), and sendToParent().

◆ maximize

boolean frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.maximize = true

protected

true if we want to maximize utility, false if we want to minimize cost

Referenced by project().

◆ maxMsgDim

Integer frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.maxMsgDim = 0

private

In stats gatherer mode, the maximum number of variables in a UTIL message.

◆ OPT_UTIL_MSG_TYPE

final MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.OPT_UTIL_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "OptUtil")

static

The type of the messages containing optimal utility values sent by roots.

Referenced by getStatsFromQueue(), notifyIn(), and frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.OptUtilMessage >.OptUtilMessage().

◆ optUtil

U frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.optUtil

protected

The optimal utility found to the problem.

◆ OUTPUT_MSG_TYPE

final MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.OUTPUT_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "UTILoutput")

static

The type of the messages containing conditional optimal assignments.

Referenced by frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.SolutionMessage< Val extends Addable< Val >, U extends Addable >.SolutionMessage().

◆ owners

Map<String, String> frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.owners = new HashMap<String, String> ()

protected

For each known variable, the name of the agent that owns it.

Referenced by sendToParent().

◆ problem

DCOPProblemInterface<Val, U> frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.problem

protected

The problem.

Referenced by CountSolutionsUTIL(), CountSolutionsUTIL(), CountSolutionsUTIL(), and init().

◆ queue

Queue frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.queue

protected

The queue on which it should call sendMessage().

Referenced by getStatsFromQueue(), projectAndSend(), sendOutput(), sendSeparator(), sendToParent(), and setQueue().

◆ reportStats

boolean frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.reportStats = true

private

Whether to report stats.

◆ SEPARATOR_MSG_TYPE

final MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.SEPARATOR_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "Separator")

static

The type of the messages containing separators.

Referenced by frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.SeparatorMessage.SeparatorMessage().

◆ START_MSG_TYPE

MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< 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.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.started = false

protected

Whether the execution of the algorithm has been started.

◆ UTIL_MSG_TYPE

final MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.UTIL_MSG_TYPE = UTILpropagation.UTIL_MSG_TYPE

static

The type of the messages containing utilities.

Referenced by getMsgTypes().

◆ UTIL_STATS_MSG_TYPE

final MessageType frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.UTIL_STATS_MSG_TYPE = new MessageType ("Count-DPOP", "UTIL", "UTILstats")

static

The type of messages sent to the statistics monitor.

Referenced by getStatsFromQueue(), and frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.StatsMessage.StatsMessage().

◆ withAnonymVars

boolean frodo2.algorithms.dpop.count.CountSolutionsUTIL< Val extends Addable< Val >, U extends Addable >.withAnonymVars = false

protected

Whether the parser should consider variables with no specified owner.

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

src/frodo2/algorithms/dpop/count/CountSolutionsUTIL.java

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CountSolutionsUTIL() [1/3]

◆ CountSolutionsUTIL() [2/3]

◆ CountSolutionsUTIL() [3/3]

Member Function Documentation

◆ getMaxMsgDim()

◆ getMsgTypes()

◆ getOptUtil()

◆ getStatsFromQueue()

◆ init()

◆ notifyIn()

◆ project()

◆ projectAndSend()

◆ record()

◆ reset()

◆ sendOutput()

◆ sendSeparator()

◆ sendToParent()

◆ setQueue()

◆ setSilent()

Member Data Documentation

◆ DFS_MSG_TYPE

◆ infos

◆ maximize

◆ maxMsgDim

◆ OPT_UTIL_MSG_TYPE

◆ optUtil

◆ OUTPUT_MSG_TYPE

◆ owners

◆ problem

◆ queue

◆ reportStats

◆ SEPARATOR_MSG_TYPE

◆ START_MSG_TYPE

◆ started

◆ UTIL_MSG_TYPE

◆ UTIL_STATS_MSG_TYPE

◆ withAnonymVars