Creates a linear ordering among variables. More...

Inheritance diagram for frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >:

[legend]

Classes
class	MaxWidthMinDom
	A linear ordering heuristic that chooses first variables with highest numbers of links with previous variables, breaking ties by minimizing domain size. More...

Public Member Functions
	CentralLinearOrdering (Element parameters, DCOPProblemInterface< V, U > problem)
	The constructor called in "statistics gatherer" mode.
	CentralLinearOrdering (DCOPProblemInterface< V, U > problem, Element parameters)
	Constructor.
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	REPORT_MSG_TYPE = new MessageType ("VarOrdering", "CentralLinearOrdering", "VarOrderReport")
	The type of messages sent by agents to the dictator with information on their variables.

Protected Member Functions
void	init ()
	Parses the problem.
abstract void	reportVars ()
	Sends all necessary information about variables to the dictator.
abstract String[]	chooseOrder ()

Protected Attributes
Queue	queue
	This module's queue.
DCOPProblemInterface< V, U >	problem
	The problem.
boolean	started = false
	Whether the module has already started the algorithm.
String	dictator
	The name of the agent that chooses the variable order.
Map< String, String >	owners
	Who owns each agent.
String	myID
	This agent's ID.

Private Member Functions
void	printOrder (List< String > order)
	Prints the input linear order in DOT format.

Private Attributes
boolean	silent = false
	Whether the stats gatherer should display the resulting linear order.
Set< String >	allAgents
	The sets of all agents in the problem.
int	countdown = 0
	The number of reports we are still waiting for from other agents.

Static Private Attributes
static final MessageType	TEMP_OUTPUT_MSG_TYPE = new MessageType ("VarOrdering", "CentralLinearOrdering", "VarOrderNoSpace")
	The type of the message notifying the agent of the chosen ordering, excluding the spaces.

Detailed Description

Creates a linear ordering among variables.

All agents report their variables (along with possible heuristic-related information) to the first agent in lexicographic order, and this agent then centrally chooses a linear order on all variables, and broadcasts the result to all agents.

Parameters

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

Warning: Requires that each agent know the identity of all other agents in the problem.

Author: Thomas Leaute

Constructor & Destructor Documentation

◆ CentralLinearOrdering() [1/2]

frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable< U > >.CentralLinearOrdering	(	Element	parameters,
		DCOPProblemInterface< V, 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.

◆ CentralLinearOrdering() [2/2]

frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable< U > >.CentralLinearOrdering	(	DCOPProblemInterface< V, U >	problem,
		Element	parameters )

Constructor.

Parameters

problem	this agent's problem
parameters	the parameters for CentralLinearOrdering

References problem.

Member Function Documentation

◆ chooseOrder()

abstract String[] frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.chooseOrder ( )

abstractprotected

Returns: the chosen order on variables

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.getMsgTypes ( )

See also: StatsReporter.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

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

◆ getStatsFromQueue()

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

See also: StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References queue, and frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.STATS_MSG_TYPE.

◆ init()

void frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.init ( )

protected

Parses the problem.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, allAgents, frodo2.solutionSpaces.ProblemInterface< V extends Addable< V >, U extends Addable >.getAgent(), frodo2.solutionSpaces.ProblemInterface< V extends Addable< V >, U extends Addable >.getAgents(), frodo2.solutionSpaces.DCOPProblemInterface< V extends Addable< V >, U extends Addable >.getMyVars(), myID, reportVars(), and frodo2.communication.Queue.sendMessageToSelf().

Referenced by notifyIn().

Here is the call graph for this function:

◆ notifyIn()

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

See also: StatsReporter.notifyIn(Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.algorithms.AgentInterface< V extends Addable< V > >.AGENT_FINISHED, frodo2.communication.MessageType.equals(), init(), notifyIn(), REPORT_MSG_TYPE, and frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.STATS_MSG_TYPE.

Referenced by notifyIn().

Here is the call graph for this function:

◆ printOrder()

void frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.printOrder ( List< String > order )

private

Prints the input linear order in DOT format.

Parameters

order the variable order

References problem.

◆ reportVars()

abstract void frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.reportVars ( )

abstractprotected

Sends all necessary information about variables to the dictator.

Referenced by init().

◆ reset()

void frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

◆ setQueue()

void frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< 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.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.setSilent ( boolean silent )

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

References silent.

Member Data Documentation

◆ allAgents

Set<String> frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.allAgents

private

The sets of all agents in the problem.

Referenced by init().

◆ countdown

int frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.countdown = 0

private

The number of reports we are still waiting for from other agents.

◆ dictator

String frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.dictator

protected

The name of the agent that chooses the variable order.

◆ myID

String frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.myID

protected

This agent's ID.

Referenced by init().

◆ owners

Map<String, String> frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.owners

protected

Who owns each agent.

◆ problem

DCOPProblemInterface<V, U> frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.problem

protected

The problem.

Referenced by CentralLinearOrdering(), CentralLinearOrdering(), and printOrder().

◆ queue

Queue frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.queue

protected

This module's queue.

Referenced by getStatsFromQueue(), and setQueue().

◆ REPORT_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.REPORT_MSG_TYPE = new MessageType ("VarOrdering", "CentralLinearOrdering", "VarOrderReport")

static

The type of messages sent by agents to the dictator with information on their variables.

Referenced by getMsgTypes(), and notifyIn().

◆ silent

boolean frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.silent = false

private

Whether the stats gatherer should display the resulting linear order.

Referenced by setSilent().

◆ START_MSG_TYPE

MessageType frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, 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.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.started = false

protected

Whether the module has already started the algorithm.

◆ TEMP_OUTPUT_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.TEMP_OUTPUT_MSG_TYPE = new MessageType ("VarOrdering", "CentralLinearOrdering", "VarOrderNoSpace")

staticprivate

The type of the message notifying the agent of the chosen ordering, excluding the spaces.

Referenced by getMsgTypes().

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

src/frodo2/algorithms/varOrdering/linear/CentralLinearOrdering.java

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CentralLinearOrdering() [1/2]

◆ CentralLinearOrdering() [2/2]

Member Function Documentation

◆ chooseOrder()

◆ getMsgTypes()

◆ getStatsFromQueue()

◆ init()

◆ notifyIn()

◆ printOrder()

◆ reportVars()

◆ reset()

◆ setQueue()

◆ setSilent()

Member Data Documentation

◆ allAgents

◆ countdown

◆ dictator

◆ myID

◆ owners

◆ problem

◆ queue

◆ REPORT_MSG_TYPE

◆ silent

◆ START_MSG_TYPE

◆ started

◆ TEMP_OUTPUT_MSG_TYPE