A DFS Generation module that integrates a root election mechanism. More...

Inheritance diagram for frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >:

[legend]

Classes
class	SinkQueue
	A Queue that discards all messages sent. More...
class	FakeQueue
	There is one such FakeQueue for each candidate root. More...

Public Member Functions
	DFSgenerationParallel (DCOPProblemInterface<?, ?> problem, Element params) throws IllegalArgumentException, InstantiationException, IllegalAccessException, InvocationTargetException, NoSuchMethodException, ClassNotFoundException
	Constructor.
	DFSgenerationParallel (Element params, DCOPProblemInterface<?, ?> problem)
	Constructor in stats gatherer mode.
void	reset ()
void	setSilent (boolean silent)
void	setQueue (Queue queue)
void	getStatsFromQueue (Queue queue)
Collection< MessageType >	getMsgTypes ()
void	notifyIn (Message msg)
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	PARALLEL_DFS_MSG_TYPE = new MessageType ("VarOrdering", "DFSgenerationParallel", "ParallelDFSwrapper")
	The type of the messages containing DFS messages for a particular candidate root.

Static Package Attributes
static final MessageType	RELEASE_OUTPUT_MSG_TYPE = new MessageType ("VarOrdering", "DFSgenerationParallel", "ReleaseDFSoutput")
	The type of the messages telling variables to release their DFS output messages.

Private Member Functions
void	init (String notRoot)
	Initializes the module.
FakeQueue	newFakeQueue (S root)
	Creates a FakeQueue associated with the input candidate root.

Private Attributes
DCOPProblemInterface<?, ?>	problem
	The problem.
boolean	silent = false
	Whether the stats gatherer should display stats.
boolean	started = false
	Whether the module has already been started.
Queue	queue
	The queue used to exchange messages.
ScoringHeuristic< S >	rootElectionHeuristic
	The heuristic used to choose the root.
Element	dfsGenerationParams
	The parameters of the underlying DFS generation module.
Constructor< ? extends DFSgeneration<?, ?> >	dfsGenerationConstructor
	Constructor for the underlying DFS generation module.
Map< String, S >	rootElectionScores
	For each of my variables, its root election score.
HashMap< S, FakeQueue >	queues = new HashMap<S, FakeQueue> ()
	For each candidate root (identified by its root election score), the corresponding FakeQueue.
Map< String, String >	owners
	For each known variable, its owner agent.
DFSgeneration<?, ?>	statsGatherer
	The module used for displaying the DFS in stats gatherer mode.
IncomingMsgPolicyInterface< MessageType >	dfsHeuristic
	The DFS heuristic module (if the heuristic needs to exchange messages).
ArrayList< Message >	heuristicMsgs = new ArrayList<Message> ()
	The DFS heuristic messages received.
Element	myParams
	This module's parameters.

Detailed Description

A DFS Generation module that integrates a root election mechanism.

Each variable starts its own DFS Generation algorithm, with itself as the root, in which messages are labeled with the VariableElection score of the root. One particular DFS Generation instance is interrupted as soon as a variable receives a message labeled with a root score that is lower than its own Variable Election score. When a particular DFS Generation instance successfully terminates (there can be only one), it passes messages down the DFS to notify all variables.

Author: Thomas Leaute

Parameters

<S>	the type used for the root election scores

Note: T must properly override equals(Object) and hashCode().

Todo: The DFS heuristic modules are added to each FakeQueue, which results in exchanging duplicate heuristic messages

Constructor & Destructor Documentation

◆ DFSgenerationParallel() [1/2]

frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.DFSgenerationParallel	(	DCOPProblemInterface<?, ?>	problem,
		Element	params ) throws IllegalArgumentException, InstantiationException, IllegalAccessException, InvocationTargetException, NoSuchMethodException, ClassNotFoundException

Constructor.

Parameters

problem	the agent's subproblem
params	the parameters of the module

Exceptions

NoSuchMethodException	if the root election heuristic or the underlying DFS generation module doesn't have a constructor that takes in (ProblemInterface, Element)
InvocationTargetException	if the root election heuristic constructor throws an exception
IllegalAccessException	if the root election heuristic constructor is not accessible
InstantiationException	if the root election heuristic is abstract
IllegalArgumentException	should never happen
ClassNotFoundException	if the class for the the root election heuristic or for the underlying DFS generation module is not found

References DFSgenerationParallel(), frodo2.communication.MessageType.fromXML(), problem, and frodo2.algorithms.SingleQueueAgent< Val extends Addable< Val > >.setMsgType().

Referenced by DFSgenerationParallel().

Here is the call graph for this function:

◆ DFSgenerationParallel() [2/2]

frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.DFSgenerationParallel	(	Element	params,
		DCOPProblemInterface<?, ?>	problem )

Constructor in stats gatherer mode.

Parameters

params	the parameters of the module
problem	the overall problem

References problem.

Member Function Documentation

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.getMsgTypes ( )

See also: StatsReporter.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

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

◆ getStatsFromQueue()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.getStatsFromQueue ( Queue queue )

See also: StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.getStatsFromQueue(), queue, and frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.setSilent().

Here is the call graph for this function:

◆ init()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.init ( String notRoot )

private

Initializes the module.

Parameters

notRoot a variable we already know is not a root

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getMyVars(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getNbrIntVars(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getNeighborhoods(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getOwner(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getOwners(), frodo2.algorithms.heuristics.ScoringHeuristic< S extends Comparable< S > &Serializable >.getScores(), newFakeQueue(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners(), and frodo2.communication.Queue.sendMessageToSelf().

Referenced by notifyIn().

Here is the call graph for this function:

◆ newFakeQueue()

FakeQueue frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.newFakeQueue ( S root )

private

Creates a FakeQueue associated with the input candidate root.

Parameters

root	the candidate root

Returns: a new FakeQueue

References frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.addIncomingMessagePolicyForReal(), and frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners().

Referenced by init(), and notifyIn().

Here is the call graph for this function:

◆ notifyIn()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.notifyIn ( Message msg )

See also: StatsReporter.notifyIn(Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.CHILD_MSG_TYPE, frodo2.communication.MessageType.equals(), init(), frodo2.communication.MessageType.isParent(), newFakeQueue(), notifyIn(), and frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners().

Referenced by notifyIn().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

References frodo2.algorithms.varOrdering.dfs.DFSgeneration< V extends Addable< V >, U extends Addable >.reset().

Here is the call graph for this function:

◆ setQueue()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.setQueue ( Queue queue )

See also: StatsReporter.setQueue(Queue)

Implements frodo2.communication.MessageListener< T >.

References queue, and frodo2.communication.MessageListener< T >.setQueue().

Here is the call graph for this function:

◆ setSilent()

void frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.setSilent ( boolean silent )

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

References silent.

Member Data Documentation

◆ dfsGenerationConstructor

Constructor< ? extends DFSgeneration<?, ?> > frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.dfsGenerationConstructor

private

Constructor for the underlying DFS generation module.

◆ dfsGenerationParams

Element frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.dfsGenerationParams

private

The parameters of the underlying DFS generation module.

◆ dfsHeuristic

IncomingMsgPolicyInterface<MessageType> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.dfsHeuristic

private

The DFS heuristic module (if the heuristic needs to exchange messages).

◆ heuristicMsgs

ArrayList<Message> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.heuristicMsgs = new ArrayList<Message> ()

private

The DFS heuristic messages received.

◆ myParams

Element frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.myParams

private

This module's parameters.

◆ owners

Map<String, String> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.owners

private

For each known variable, its owner agent.

Referenced by frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.releaseOutput().

◆ PARALLEL_DFS_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.PARALLEL_DFS_MSG_TYPE = new MessageType ("VarOrdering", "DFSgenerationParallel", "ParallelDFSwrapper")

static

The type of the messages containing DFS messages for a particular candidate root.

Referenced by getMsgTypes(), frodo2.algorithms.varOrdering.dfs.ParallelDFSmsg< S extends Comparable< S > &Serializable >.ParallelDFSmsg(), and frodo2.algorithms.varOrdering.dfs.ParallelDFSmsg< S extends Comparable< S > &Serializable >.ParallelDFSmsg().

◆ problem

DCOPProblemInterface<?, ?> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.problem

private

The problem.

Referenced by DFSgenerationParallel(), and DFSgenerationParallel().

◆ queue

Queue frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.queue

private

The queue used to exchange messages.

Referenced by getStatsFromQueue(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.releaseOutput(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.sendMessage(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.sendMessage(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.sendMessageToMulti(), frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.sendMessageToSelf(), and setQueue().

◆ queues

HashMap<S, FakeQueue> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.queues = new HashMap<S, FakeQueue> ()

private

For each candidate root (identified by its root election score), the corresponding FakeQueue.

◆ RELEASE_OUTPUT_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.RELEASE_OUTPUT_MSG_TYPE = new MessageType ("VarOrdering", "DFSgenerationParallel", "ReleaseDFSoutput")

staticpackage

The type of the messages telling variables to release their DFS output messages.

Referenced by frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners(), frodo2.algorithms.varOrdering.dfs.ReleaseDFSmsg.ReleaseDFSmsg(), and frodo2.algorithms.varOrdering.dfs.ReleaseDFSmsg.ReleaseDFSmsg().

◆ rootElectionHeuristic

ScoringHeuristic<S> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.rootElectionHeuristic

private

The heuristic used to choose the root.

◆ rootElectionScores

Map<String, S> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.rootElectionScores

private

For each of my variables, its root election score.

Referenced by frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.FakeQueue.notifyInListeners().

◆ silent

boolean frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.silent = false

private

Whether the stats gatherer should display stats.

Referenced by setSilent().

◆ START_MSG_TYPE

MessageType frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.START_MSG_TYPE = AgentInterface.START_AGENT

static

The type of the message telling the module to start.

Referenced by getMsgTypes().

◆ started

boolean frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.started = false

private

Whether the module has already been started.

◆ statsGatherer

DFSgeneration<?, ?> frodo2.algorithms.varOrdering.dfs.DFSgenerationParallel< S extends Comparable< S > &Serializable >.statsGatherer

private

The module used for displaying the DFS in stats gatherer mode.

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

src/frodo2/algorithms/varOrdering/dfs/DFSgenerationParallel.java

Classes

Public Member Functions

Static Public Attributes

Static Package Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DFSgenerationParallel() [1/2]

◆ DFSgenerationParallel() [2/2]

Member Function Documentation

◆ getMsgTypes()

◆ getStatsFromQueue()

◆ init()

◆ newFakeQueue()

◆ notifyIn()

◆ reset()

◆ setQueue()

◆ setSilent()

Member Data Documentation

◆ dfsGenerationConstructor

◆ dfsGenerationParams

◆ dfsHeuristic

◆ heuristicMsgs

◆ myParams

◆ owners

◆ PARALLEL_DFS_MSG_TYPE

◆ problem

◆ queue

◆ queues

◆ RELEASE_OUTPUT_MSG_TYPE

◆ rootElectionHeuristic

◆ rootElectionScores

◆ silent

◆ START_MSG_TYPE

◆ started

◆ statsGatherer