Algorithm that generates samples for the random variables in the problem. More...

Inheritance diagram for frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >:

[legend]

Classes
class	RandVarsProjMsg
	Message telling what random variables should be projected out at given decision variable. More...
enum	WhereToProject
	Where the random variables should be projected out. More...
class	AtLeaves
	The version of the SamplingPhase that samples at the leaves. More...
class	AtLCAs
	The version of the SamplingPhase that samples at the lcas. More...
class	AtRoots
	A version of the SamplingPhase in which the sampling for all random variables is performed at the roots. More...

Public Member Functions
	SamplingPhase (DCOPProblemInterface< V, U > problem, Element parameters)
	Constructor.
void	reset ()
	SamplingPhase (Element parameters, DCOPProblemInterface< V, U > problem)
	Constructor in stats gatherer mode.
Collection< MessageType >	getMsgTypes ()
void	notifyIn (Message msg)
void	getStatsFromQueue (Queue queue)
void	setSilent (boolean silent)
String	dfsToString ()
Public Member Functions inherited from frodo2.algorithms.dpop.stochastic.LowestCommonAncestors
	LowestCommonAncestors (Map< String, Set< String > > flags, Map< String, String > owners)
	Constructor.
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 Member Functions
static String	dfsToString (Map< String, ? extends DFSview<?, ?> > dfs, Map< String, Set< String > > randVars, Map< String, Set< String > > randVarsProj, final boolean projAtLeaves)
	Prints the input dfs in DOT format.

Static Public Attributes
static MessageType	START_MSG_TYPE = AgentInterface.START_AGENT
	The type of the start message.
static final MessageType	RAND_VARS_PROJ_MSG_TYPE = new MessageType ("E[DPOP]", "SamplingPhase", "Where to project random variables")
	The type of the messages telling what random variables should be projected out at given decision variable.
Static Public Attributes inherited from frodo2.algorithms.dpop.stochastic.LowestCommonAncestors
static MessageType	DFS_MSG_TYPE = DFSgeneration.OUTPUT_MSG_TYPE
	The type of the message containing information about the DFS.
static final MessageType	PHASE1_MSG_TYPE = new MessageType ("E[DPOP]", "LowestCommonAncestors", "LCAmsg1")
	The type of a phase 1 message.
static final MessageType	PHASE2_MSG_TYPE = new MessageType ("E[DPOP]", "LowestCommonAncestors", "LCAmsg2")
	The type of a phase 2 message.
static final MessageType	OUTPUT_MSG_TYPE = new MessageType ("E[DPOP]", "LowestCommonAncestors", "LCAoutput")
	The type of the output messages.

Protected Member Functions
	SamplingPhase ()
	Nullary constructor.
void	init ()
	Parses the problem.
Protected Member Functions inherited from frodo2.algorithms.dpop.stochastic.LowestCommonAncestors
	LowestCommonAncestors ()
	Empty constructor with no specified flags.
void	setFlags (Map< String, ? extends Set< String > > flags)
	Adds flags.
LCAmsg1	newPhase1msg (String node, NodeInfo nodeInfo)
	Creates a new Phase 1 message.
void	terminatePhase2 (String node, NodeInfo nodeInfo, Set< String > pendingFlags)
	Sends messages to children and the output message.
void	sendOutput (String node, NodeInfo nodeInfo)
	Sends the output message.

Protected Attributes
DCOPProblemInterface< V, U >	problem
	The problem.
boolean	started = false
	Whether the execution of the algorithm has started.
int	nbrSamples
	The number of samples for each random variable.
HashMap< String, UtilitySolutionSpace< V, U > >	probLaws = new HashMap< String, UtilitySolutionSpace<V, U> > ()
	For each random variable, its non-sampled probability law.
boolean	reportStats = true
	Whether to report stats.
WhereToProject	proj
	Where the random variables should be projected out.
Protected Attributes inherited from frodo2.algorithms.dpop.stochastic.LowestCommonAncestors
Queue	queue
	The queue.
HashMap< String, NodeInfo >	infos
	The known information about each node.
Map< String, String >	owners = new HashMap<String, String> ()
	For each known node, the name of the agent that owns it.

Private Attributes
int	nbrStatsMsgs
	The total number messages to expect in "statistics gatherer" mode.
HashMap< String, DFSview< V, ?> >	relationships
	For every variable this agent owns, its view of the DFS.
String	dotRendererClass
	Renderer to display DOT code.
HashMap< String, Set< String > >	randVars
	For each variable, the random variables it is linked to (only used in stats gatherer mode).
HashMap< String, Set< String > >	randVarsProj
	For each variable, the random variables it must project out (only used in stats gatherer mode).

Detailed Description

Algorithm that generates samples for the random variables in the problem.

The samples for a given random variable are chosen by the Lowest Common Ancestor of all decision variables responsible for enforcing a constraint involving that random variable.

Author: Thomas Leaute

Parameters

<V>	the type used for random variable values
<U>	the type used for probabilities

Todo: Improve garbage collection.

Constructor & Destructor Documentation

◆ SamplingPhase() [1/3]

frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.SamplingPhase ( )

protected

Nullary constructor.

Referenced by notifyIn().

◆ SamplingPhase() [2/3]

frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.SamplingPhase	(	DCOPProblemInterface< V, U >	problem,
		Element	parameters )

Constructor.

Parameters

problem	this agent's problem
parameters	the parameters for SamplingPhase

References frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.LCAS, frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.LEAVES, problem, and frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.ROOTS.

◆ SamplingPhase() [3/3]

frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.SamplingPhase	(	Element	parameters,
		DCOPProblemInterface< V, U >	problem )

Constructor in stats gatherer mode.

Parameters

problem	the overall problem
parameters	parameters of the stats gatherer

References frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.LCAS, frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.LEAVES, problem, relationships, and frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.ROOTS.

Member Function Documentation

◆ dfsToString() [1/2]

String frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.dfsToString ( )

Returns: a DOT-formated representation of the DFS, including random variables

References dfsToString(), and frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.WhereToProject.LEAVES.

Referenced by frodo2.algorithms.dpop.stochastic.E_DPOPsolver< V extends Addable< V >, U extends Addable >.buildSolution(), dfsToString(), and notifyIn().

Here is the call graph for this function:

◆ dfsToString() [2/2]

String frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable< U > >.dfsToString	(	Map< String, ? extends DFSview<?, ?> >	dfs,
		Map< String, Set< String > >	randVars,
		Map< String, Set< String > >	randVarsProj,
		final boolean	projAtLeaves )

static

Prints the input dfs in DOT format.

Parameters

dfs	for each variable, a map associating a list of neighbors to each type of relationship
randVars	for each variable, the set of random variables it is linked to
randVarsProj	for each variable, which random variables it must project out
projAtLeaves	whether projection of random variables is performed at the leaves

Returns: a DOT-formated representation of the DFS, including random variables

References randVars, randVarsProj, and relationships.

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.getMsgTypes ( )

See also: LowestCommonAncestors.getMsgTypes()

Reimplemented from frodo2.algorithms.dpop.stochastic.LowestCommonAncestors.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, and START_MSG_TYPE.

◆ getStatsFromQueue()

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

See also: StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References frodo2.algorithms.dpop.stochastic.LowestCommonAncestors.queue, RAND_VARS_PROJ_MSG_TYPE, and frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.STATS_MSG_TYPE.

◆ init()

void frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.init ( )

protected

Parses the problem.

References problem.

Referenced by notifyIn().

◆ notifyIn()

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

See also: LowestCommonAncestors.notifyIn(Message)

Reimplemented from frodo2.algorithms.dpop.stochastic.LowestCommonAncestors.

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

References probLaws, problem, and relationships.

Referenced by notifyIn().

◆ setSilent()

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

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

Member Data Documentation

◆ dotRendererClass

String frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.dotRendererClass

private

Renderer to display DOT code.

Referenced by notifyIn().

◆ nbrSamples

int frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.nbrSamples

protected

The number of samples for each random variable.

◆ nbrStatsMsgs

int frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.nbrStatsMsgs

private

The total number messages to expect in "statistics gatherer" mode.

◆ probLaws

HashMap< String, UtilitySolutionSpace<V, U> > frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.probLaws = new HashMap< String, UtilitySolutionSpace<V, U> > ()

protected

For each random variable, its non-sampled probability law.

Referenced by reset().

◆ problem

DCOPProblemInterface<V, U> frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.problem

protected

The problem.

Referenced by frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.AtRoots< V extends Addable< V >, U extends Addable >.AtRoots(), frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.AtRoots< V extends Addable< V >, U extends Addable >.AtRoots(), init(), reset(), SamplingPhase(), and SamplingPhase().

◆ proj

WhereToProject frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.proj

protected

Where the random variables should be projected out.

◆ RAND_VARS_PROJ_MSG_TYPE

final MessageType frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.RAND_VARS_PROJ_MSG_TYPE = new MessageType ("E[DPOP]", "SamplingPhase", "Where to project random variables")

static

The type of the messages telling what random variables should be projected out at given decision variable.

Referenced by frodo2.algorithms.dpop.stochastic.test.ExpectedUTILtest.Listener.getMsgTypes(), frodo2.algorithms.dpop.stochastic.test.SamplingPhaseTest.getMsgTypes(), getStatsFromQueue(), notifyIn(), frodo2.algorithms.dpop.stochastic.test.ExpectedUTILtest.Listener.notifyIn(), frodo2.algorithms.dpop.stochastic.test.SamplingPhaseTest.notifyIn(), and frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.RandVarsProjMsg.RandVarsProjMsg().

◆ randVars

HashMap< String, Set<String> > frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.randVars

private

For each variable, the random variables it is linked to (only used in stats gatherer mode).

Referenced by dfsToString(), notifyIn(), and frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.RandVarsProjMsg.RandVarsProjMsg().

◆ randVarsProj

HashMap< String, Set<String> > frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.randVarsProj

private

For each variable, the random variables it must project out (only used in stats gatherer mode).

Referenced by dfsToString().

◆ relationships

HashMap< String, DFSview<V, ?> > frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.relationships

private

For every variable this agent owns, its view of the DFS.

Used only in stats gatherer mode.

Referenced by dfsToString(), notifyIn(), reset(), and SamplingPhase().

◆ reportStats

boolean frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.reportStats = true

protected

Whether to report stats.

◆ START_MSG_TYPE

MessageType frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.START_MSG_TYPE = AgentInterface.START_AGENT

static

The type of the start message.

Referenced by getMsgTypes().

◆ started

boolean frodo2.algorithms.dpop.stochastic.SamplingPhase< V extends Addable< V >, U extends Addable >.started = false

protected

Whether the execution of the algorithm has started.

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

src/frodo2/algorithms/dpop/stochastic/SamplingPhase.java

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SamplingPhase() [1/3]

◆ SamplingPhase() [2/3]

◆ SamplingPhase() [3/3]

Member Function Documentation

◆ dfsToString() [1/2]

◆ dfsToString() [2/2]

◆ getMsgTypes()

◆ getStatsFromQueue()

◆ init()

◆ notifyIn()

◆ reset()

◆ setSilent()

Member Data Documentation

◆ dotRendererClass

◆ nbrSamples

◆ nbrStatsMsgs

◆ probLaws

◆ problem

◆ proj

◆ RAND_VARS_PROJ_MSG_TYPE

◆ randVars

◆ randVarsProj

◆ relationships

◆ reportStats

◆ START_MSG_TYPE

◆ started