The MGM algorithm. More...

Inheritance diagram for frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >:

[legend]

Classes
enum	StateValue
	The state of the current variable: More...
class	VariableInfo
	Convenience class that contains all necessary information on a single variable. More...

Public Member Functions
	MGM (Element parameters, DCOPProblemInterface< V, U > problem)
	Constructor for the stats reporter.
	MGM (DCOPProblemInterface< V, U > problem, Element parameters)
	Constructor.
void	getStatsFromQueue (Queue queue)
void	setSilent (boolean silent)
void	reset ()
void	notifyIn (Message msg)
void	setQueue (Queue queue)
Collection< MessageType >	getMsgTypes ()
HashMap< String, ArrayList< frodo2.algorithms.StatsReporterWithConvergence.CurrentAssignment< V > > >	getAssignmentHistories ()
Map< String, V >	getCurrentSolution ()
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 START message.
static final MessageType	OK_MSG_TYPE = new MessageType ("MGM", "ok")
	Type used for the OK message.
static final MessageType	IMPROVE_MSG_TYPE = new MessageType ("MGM", "improve")
	Type used for the IMPROVE message.
static final MessageType	CONV_STATS_MSG_TYPE = new MessageType ("MGM", "ConvStats")
	The type of the message containing the assignment history.

Protected Member Functions
void	init ()
	Called when the first message is received, initializes all the fields and variables that are needed.
void	sendOK (VariableInfo< V, U > varInfo)
	Sending an OK message to all neighbors.
void	sendIMPROVE (VariableInfo< V, U > varInfo)
	Send an improve message to all neighbors.
void	log (String variableID, String message)
	Log function used to print the variables state during debugging.
VariableInfo< V, U >	createVariableInfo (String variableID, DCOPProblemInterface< V, U > problem, List<? extends UtilitySolutionSpace< V, U > > spaces, boolean maximize)
	method used to create a VariableInfo object

Protected Attributes
Queue	queue
	The queue to which this listener is registered.
final boolean	LOG = false
	When `true`, every variable writes log information to a log file.
HashMap< String, BufferedWriter >	loggers
	A list of buffered writers used to log information during debugging.
final boolean	maximize
	`true` when solving a maximization problem, and false otherwise
Map< String, String >	owners
	Maps variables to the agent that owns it.
int	max_distance = 100
	The maximal number of rounds to be performed.
boolean	started
	`true` when the START_AGENT message has been received, and `false` otherwise
HashMap< String, VariableInfo< V, U > >	infos
	Contains, for each variable, an object containing all information needed by the algorithm.
DCOPProblemInterface< V, U >	problem
	The local problem definition.
int	variables_finished
	The number of variables that are finished.
final boolean	convergence
	If `true`, the assignment history must be stored.
HashMap< String, ArrayList< CurrentAssignment< V > > >	assignmentHistoriesMap
	For each variable its assignment history.

Private Attributes
boolean	terminated
	`true` when this agent has sent the agent finished message

Detailed Description

The MGM algorithm.

Author: Brammert Ottens, 21 feb. 2011

Parameters

<V>	type used for domain values
<U>	type used for utility values

Constructor & Destructor Documentation

◆ MGM() [1/2]

frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.MGM	(	Element	parameters,
		DCOPProblemInterface< V, U >	problem )

Constructor for the stats reporter.

Parameters

parameters	parameters of the stats reporter
problem	the problem that is being solved

References assignmentHistoriesMap, and problem.

◆ MGM() [2/2]

frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.MGM	(	DCOPProblemInterface< V, U >	problem,
		Element	parameters )

Constructor.

Parameters

problem	the local problem definition
parameters	parameters of the listener

References problem.

Member Function Documentation

◆ createVariableInfo()

VariableInfo< V, U > frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.createVariableInfo	(	String	variableID,
		DCOPProblemInterface< V, U >	problem,
		List<? extends UtilitySolutionSpace< V, U > >	spaces,
		boolean	maximize )

protected

method used to create a VariableInfo object

Author: Brammert Ottens, 16 feb. 2011

Parameters

variableID	the ID of the variable
problem	the local problem definition
spaces	list of spaces owned by the agent
maximize	`true` when dealing with a maximization problem, `false` otherwise

Returns: a VariablInfo object for variableID

References maximize, and problem.

Referenced by init().

◆ getAssignmentHistories()

HashMap< String, ArrayList< frodo2.algorithms.StatsReporterWithConvergence.CurrentAssignment< V > > > frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.getAssignmentHistories ( )

See also: frodo2.algorithms.StatsReporterWithConvergence.getAssignmentHistories()

Implements frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.

References assignmentHistoriesMap.

◆ getCurrentSolution()

Map< String, V > frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.getCurrentSolution ( )

See also: frodo2.algorithms.StatsReporterWithConvergence.getCurrentSolution()

Todo: Replace with a generic ConvergenceReporter

Implements frodo2.algorithms.StatsReporterWithConvergence< Val extends Addable< Val > >.

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.getMsgTypes ( )

See also: frodo2.communication.MessageListener.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

References IMPROVE_MSG_TYPE, OK_MSG_TYPE, START_MSG_TYPE, and frodo2.algorithms.AgentInterface< V extends Addable< V > >.STOP_AGENT.

◆ getStatsFromQueue()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.getStatsFromQueue ( Queue queue )

See also: frodo2.algorithms.StatsReporter.getStatsFromQueue(frodo2.communication.Queue)

Implements frodo2.algorithms.StatsReporter.

References queue.

◆ init()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.init ( )

protected

Called when the first message is received, initializes all the fields and variables that are needed.

Author: Brammert Ottens, 21 feb. 2011

Referenced by notifyIn().

Here is the call graph for this function:

◆ log()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable< U > >.log	(	String	variableID,
		String	message )

protected

Log function used to print the variables state during debugging.

Parameters

variableID	The ID of the variable that is logging
message	The message that must be logged

References LOG, and loggers.

◆ notifyIn()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.notifyIn ( Message msg )

See also: frodo2.communication.IncomingMsgPolicyInterface.notifyIn(frodo2.communication.Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References CONV_STATS_MSG_TYPE, frodo2.communication.MessageType.equals(), IMPROVE_MSG_TYPE, init(), notifyIn(), and started.

Referenced by notifyIn().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.reset ( )

See also: frodo2.algorithms.StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

References assignmentHistoriesMap.

◆ sendIMPROVE()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.sendIMPROVE ( VariableInfo< V, U > varInfo )

protected

Send an improve message to all neighbors.

Author: Brammert Ottens, 21 feb. 2011

Parameters

varInfo the variable that is sending the messages

Here is the call graph for this function:

◆ sendOK()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.sendOK ( VariableInfo< V, U > varInfo )

protected

Sending an OK message to all neighbors.

Author: Brammert Ottens, 21 feb. 2011

Parameters

varInfo the variable that is sending the messages

◆ setQueue()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.setQueue ( Queue queue )

See also: frodo2.communication.MessageListener.setQueue(frodo2.communication.Queue)

Implements frodo2.communication.MessageListener< T >.

References queue.

◆ setSilent()

void frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.setSilent ( boolean silent )

See also: StatsReporterWithConvergence.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

Member Data Documentation

◆ assignmentHistoriesMap

HashMap<String, ArrayList<CurrentAssignment<V> > > frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.assignmentHistoriesMap

protected

For each variable its assignment history.

Referenced by getAssignmentHistories(), init(), MGM(), reset(), and sendOK().

◆ CONV_STATS_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.CONV_STATS_MSG_TYPE = new MessageType ("MGM", "ConvStats")

static

The type of the message containing the assignment history.

Referenced by init(), and notifyIn().

◆ convergence

final boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.convergence

protected

If true, the assignment history must be stored.

Referenced by init(), and sendOK().

◆ IMPROVE_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.IMPROVE_MSG_TYPE = new MessageType ("MGM", "improve")

static

Type used for the IMPROVE message.

Referenced by getMsgTypes(), frodo2.algorithms.localSearch.mgm.IMPROVE >.IMPROVE(), frodo2.algorithms.localSearch.mgm.IMPROVE >.IMPROVE(), frodo2.algorithms.localSearch.mgm.mgm2.IMPROVE >.IMPROVE(), frodo2.algorithms.localSearch.mgm.mgm2.IMPROVE >.IMPROVE(), and notifyIn().

◆ infos

HashMap<String, VariableInfo<V, U> > frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.infos

protected

Contains, for each variable, an object containing all information needed by the algorithm.

Referenced by init(), and sendOK().

◆ LOG

final boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.LOG = false

protected

When true, every variable writes log information to a log file.

Referenced by log().

◆ loggers

HashMap<String, BufferedWriter> frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.loggers

protected

A list of buffered writers used to log information during debugging.

Referenced by log().

◆ max_distance

int frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.max_distance = 100

protected

The maximal number of rounds to be performed.

Referenced by sendOK().

◆ maximize

final boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.maximize

protected

true when solving a maximization problem, and false otherwise

Referenced by createVariableInfo(), and init().

◆ OK_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.OK_MSG_TYPE = new MessageType ("MGM", "ok")

static

Type used for the OK message.

Referenced by getMsgTypes(), frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.getMsgTypes(), frodo2.algorithms.localSearch.mgm.OK< V extends Addable< V > >.OK(), and frodo2.algorithms.localSearch.mgm.OK< V extends Addable< V > >.OK().

◆ owners

Map<String, String> frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.owners

protected

Maps variables to the agent that owns it.

Referenced by init(), sendIMPROVE(), and sendOK().

◆ problem

DCOPProblemInterface<V, U> frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.problem

protected

The local problem definition.

Referenced by createVariableInfo(), init(), MGM(), MGM(), and frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.VariableInfo< V extends Addable< V >, U extends Addable >.VariableInfo().

◆ queue

Queue frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.queue

protected

The queue to which this listener is registered.

Referenced by getStatsFromQueue(), init(), sendIMPROVE(), sendOK(), and setQueue().

◆ START_MSG_TYPE

MessageType frodo2.algorithms.localSearch.mgm.MGM< 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.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.started

protected

true when the START_AGENT message has been received, and false otherwise

Referenced by init(), and notifyIn().

◆ terminated

boolean frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.terminated

private

true when this agent has sent the agent finished message

Referenced by init().

◆ variables_finished

int frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.variables_finished

protected

The number of variables that are finished.

Referenced by init(), and sendOK().

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

src/frodo2/algorithms/localSearch/mgm/MGM.java

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MGM() [1/2]

◆ MGM() [2/2]

Member Function Documentation

◆ createVariableInfo()

◆ getAssignmentHistories()

◆ getCurrentSolution()

◆ getMsgTypes()

◆ getStatsFromQueue()

◆ init()

◆ log()

◆ notifyIn()

◆ reset()

◆ sendIMPROVE()

◆ sendOK()

◆ setQueue()

◆ setSilent()

Member Data Documentation

◆ assignmentHistoriesMap

◆ CONV_STATS_MSG_TYPE

◆ convergence

◆ IMPROVE_MSG_TYPE

◆ infos

◆ LOG

◆ loggers

◆ max_distance

◆ maximize

◆ OK_MSG_TYPE

◆ owners

◆ problem

◆ queue

◆ START_MSG_TYPE

◆ started

◆ terminated

◆ variables_finished