frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > > Class Template Reference

A factor graph generator. More...

Inheritance diagram for frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >:

Public Member Functions
	FactorGraphGen (DCOPProblemInterface< V, U > problem, Element params)
	Constructor.
	FactorGraphGen (Element params, DCOPProblemInterface< V, U > problem)
	Constructor in stats gatherer mode.
void	notifyIn (Message msg)
void	setQueue (Queue queue)
Collection< 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	OUTPUT_MSG_TYPE = new MessageType ("VarOrdering", "FactorGraphGen", "FactorGraph")
	The type of the output message.

Private Member Functions
String	factorGraphToDOT (final boolean addUnaryConstraints)

Private Attributes
DCOPProblemInterface< V, U >	problem
	The problem.
Queue	queue
	This agent's queue.
final boolean	compile
	Whether the agent must compile all its function nodes into one.
final double	maxPerturb
	The maximum amplitude of the perturbation unary constraints.
final String	VAR_PREFIX = "var_"
	The prefix appended to variable node names to avoid name clashes with function node names.
final String	FUNC_PREFIX = "func_"
	The prefix appended to function node names to avoid name clashes with variable node names.

Detailed Description

A factor graph generator.

Author

Thomas Leaute

Parameters

<V>	the type used for variable values
<U>	the type used for utility values in stats gatherer mode

Constructor & Destructor Documentation

FactorGraphGen() [1/2]

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

Constructor.

Parameters

problem	this agent's problem
params	the parameters for this module

References problem.

FactorGraphGen() [2/2]

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

Constructor in stats gatherer mode.

Parameters

params	the parameters
problem	the overall problem

References factorGraphToDOT(), and problem.

Here is the call graph for this function:

Member Function Documentation

factorGraphToDOT()

String frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.factorGraphToDOT ( final boolean addUnaryConstraints )

private

Parameters

addUnaryConstraints

whether to add unary perturbation constraints

Returns

a DOT-formatted representation of the factor graph

References FUNC_PREFIX, frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getAgentNeighborhoods(), frodo2.solutionSpaces.ProblemInterface< V extends Addable< V >, U extends Addable< U > >.getAgents(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getOwner(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getSolutionSpaces(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getVariables(), and VAR_PREFIX.

Referenced by FactorGraphGen().

Here is the call graph for this function:

getMsgTypes()

Collection< MessageType > frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.getMsgTypes

(

)

See also

StatsReporter.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.START_AGENT.

getStatsFromQueue()

void frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.getStatsFromQueue

(

Queue

queue

)

See also

StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References queue.

notifyIn()

void frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.notifyIn

(

Message

msg

)

See also

StatsReporter.notifyIn(Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.addFunction(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.addUnarySpace(), frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.solutionSpaces.ProblemInterface< V extends Addable< V >, U extends Addable< U > >.getAgent(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getAgentNeighborhoods(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getDomain(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getOwner(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable< U > >.getSolutionSpaces(), frodo2.solutionSpaces.ProblemInterface< V extends Addable< V >, U extends Addable< U > >.getZeroUtility(), frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable< U > >.join(), OUTPUT_MSG_TYPE, and frodo2.communication.Queue.sendMessageToSelf().

Here is the call graph for this function:

reset()

void frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.reset

(

)

See also

StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

setQueue()

void frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.setQueue

(

Queue

queue

)

See also

StatsReporter.setQueue(Queue)

Implements frodo2.communication.MessageListener< T >.

References queue.

setSilent()

void frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.setSilent

(

boolean

silent

)

See also

frodo2.algorithms.StatsReporter.setSilent(boolean)

Todo

Auto-generated method stub

Implements frodo2.algorithms.StatsReporter.

Member Data Documentation

compile

final boolean frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.compile

private

Whether the agent must compile all its function nodes into one.

FUNC_PREFIX

final String frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.FUNC_PREFIX = "func_"

private

The prefix appended to function node names to avoid name clashes with variable node names.

Referenced by factorGraphToDOT().

maxPerturb

final double frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.maxPerturb

private

The maximum amplitude of the perturbation unary constraints.

OUTPUT_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.OUTPUT_MSG_TYPE = new MessageType ("VarOrdering", "FactorGraphGen", "FactorGraph")

static

The type of the output message.

Referenced by frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.getMsgTypes(), frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.notifyIn(), and notifyIn().

problem

DCOPProblemInterface<V, U> frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.problem

private

The problem.

Referenced by FactorGraphGen(), and FactorGraphGen().

queue

Queue frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.queue

private

This agent's queue.

Referenced by getStatsFromQueue(), and setQueue().

VAR_PREFIX

final String frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.VAR_PREFIX = "var_"

private

The prefix appended to variable node names to avoid name clashes with function node names.

Referenced by factorGraphToDOT().

---

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

• src/frodo2/algorithms/varOrdering/factorgraph/FactorGraphGen.java