The MGM algorithm. More...

Inheritance diagram for frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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
	MGM2 (Element parameters, DCOPProblemInterface< V, U > problem)
	Constructor for the stats reporter.
	MGM2 (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 ()
boolean	processOK (OK< V > msg, VariableInfo< V, U > varInfo)
	Method to process an OK message.
void	storeOffer (OFFER< V, U > msgOFFER, VariableInfo< V, U > varInfo)
	Stores an offer made.
void	processOFFER (VariableInfo< V, U > varInfo)
	checks whether all offers have been received, and acts accordingly
void	storeIMPROVE (IMPROVE< U > msg, VariableInfo< V, U > varInfo)
	Store an IMPROVE message received.
void	processIMPROVE (VariableInfo< V, U > varInfo)
	Method used to check whether all IMPROVE messages have been received.
boolean	processGO (VariableInfo< V, U > varInfo, boolean move)
	Method used to process a GO or NOGO message.
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	OFFER_MSG_TYPE = new MessageType ("MGM2", "offer")
	The type of an OFFER message.
static final MessageType	ACCEPT_MSG_TYPE = new MessageType ("MGM2", "accept")
	The type of a ACCEPT message.
static final MessageType	REJECT_MSG_TYPE = new MessageType ("MGM2", "reject")
	The type of a REJECT message.
static final MessageType	IMPROVE_MSG_TYPE = MGM.IMPROVE_MSG_TYPE
	Type used for the IMPROVE message.
static final MessageType	GO_MSG_TYPE = new MessageType ("MGM2", "go")
	Type used for the GO message.
static final MessageType	NO_GO_MSG_TYPE = new MessageType ("MGM2", "nogo")
	Type used for the NO GO message.
static final MessageType	CONV_STATS_MSG_TYPE = new MessageType ("MGM2", "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	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.
HashMap< String, VariableInfo< V, U > >	infos
	Contains, for each variable, an object containing all information needed by the algorithm.
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
int	cycles
	The maximal number of rounds to be performed.
boolean	started
	`true` when the START_AGENT message has been received, and `false` otherwise
DCOPProblemInterface< V, U >	problem
	The local problem definition.
int	variables_finished
	The number of variables that are finished.
double	q
	value between 0 and 1, used to determine whether a variable is offering or receiving
boolean	terminated
	`true` when the agent has terminated upon initialization, and `false` otherwise

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

◆ MGM2() [1/2]

frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.MGM2	(	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.

◆ MGM2() [2/2]

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

Constructor.

Parameters

problem	the local problem definition
parameters	parameters of the listener

References cycles, problem, and q.

Member Function Documentation

◆ createVariableInfo()

VariableInfo< V, U > frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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 the problem is a maximization problem, and `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.mgm2.MGM2< V extends Addable< V >, U extends Addable >.getAssignmentHistories ( )

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

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

◆ getCurrentSolution()

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

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

Todo: Use a generic ConvergenceReporter

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

◆ getMsgTypes()

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

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

Implements frodo2.communication.MessageListener< T >.

References ACCEPT_MSG_TYPE, GO_MSG_TYPE, IMPROVE_MSG_TYPE, NO_GO_MSG_TYPE, OFFER_MSG_TYPE, frodo2.algorithms.localSearch.mgm.MGM< V extends Addable< V >, U extends Addable >.OK_MSG_TYPE, REJECT_MSG_TYPE, START_MSG_TYPE, and frodo2.algorithms.AgentInterface< V extends Addable< V > >.STOP_AGENT.

◆ getStatsFromQueue()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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.mgm2.MGM2< 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.mgm2.MGM2< 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.

Referenced by processOK(), and storeOffer().

◆ notifyIn()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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(), init(), notifyIn(), OFFER_MSG_TYPE, and started.

Referenced by notifyIn(), processIMPROVE(), and processOFFER().

Here is the call graph for this function:

◆ processGO()

boolean frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.processGO	(	VariableInfo< V, U >	varInfo,
		boolean	move )

Method used to process a GO or NOGO message.

Author: Brammert Ottens, 6 apr. 2011

Parameters

varInfo	the variable that received the message
move	`true` when the message is GO, `false` when a NOGO

Returns: true when the message should be stored for later processing, and false otherwise

Here is the call graph for this function:

◆ processIMPROVE()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processIMPROVE ( VariableInfo< V, U > varInfo )

Method used to check whether all IMPROVE messages have been received.

Author: Brammert Ottens, 21 feb. 2011

Parameters

varInfo info on the variable that is responsible for the messages

Here is the call graph for this function:

◆ processOFFER()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.processOFFER ( VariableInfo< V, U > varInfo )

checks whether all offers have been received, and acts accordingly

Author: Brammert Ottens, 6 apr. 2011

Parameters

varInfo the variable that checks whether all offers have been received

Referenced by processOK().

Here is the call graph for this function:

◆ processOK()

boolean frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.processOK	(	OK< V >	msg,
		VariableInfo< V, U >	varInfo )

Method to process an OK message.

Author: Brammert Ottens, 21 feb. 2011

Parameters

msg	the message to be processed
varInfo	info on the variable that is responsible for the message

Returns: true when the message needs to be stored for later processing, and false otherwise

Referenced by processGO(), and processIMPROVE().

Here is the call graph for this function:

◆ reset()

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

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

Implements frodo2.algorithms.StatsReporter.

◆ sendOK()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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

Referenced by processGO(), and processIMPROVE().

◆ setQueue()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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.mgm2.MGM2< V extends Addable< V >, U extends Addable >.setSilent ( boolean silent )

See also: StatsReporterWithConvergence.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

◆ storeIMPROVE()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.storeIMPROVE	(	IMPROVE< U >	msg,
		VariableInfo< V, U >	varInfo )

Store an IMPROVE message received.

Author: Brammert Ottens, 6 apr. 2011

Parameters

msg	the message received
varInfo	the variable that receives the message

Here is the call graph for this function:

◆ storeOffer()

void frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable< U > >.storeOffer	(	OFFER< V, U >	msgOFFER,
		VariableInfo< V, U >	varInfo )

Stores an offer made.

Author: Brammert Ottens, 6 apr. 2011

Parameters

msgOFFER	the offer
varInfo	the variable that received the offer

Referenced by processOK().

Here is the call graph for this function:

Member Data Documentation

◆ ACCEPT_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.ACCEPT_MSG_TYPE = new MessageType ("MGM2", "accept")

static

The type of a ACCEPT message.

Referenced by frodo2.algorithms.localSearch.mgm.mgm2.ACCEPT< Val extends Addable< Val >, U extends Addable >.ACCEPT(), frodo2.algorithms.localSearch.mgm.mgm2.ACCEPT< Val extends Addable< Val >, U extends Addable >.ACCEPT(), and getMsgTypes().

◆ assignmentHistoriesMap

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

protected

For each variable its assignment history.

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

◆ CONV_STATS_MSG_TYPE

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

static

The type of the message containing the assignment history.

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

◆ convergence

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

protected

If true, the assignment history must be stored.

Referenced by init(), and sendOK().

◆ cycles

int frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.cycles

private

The maximal number of rounds to be performed.

Referenced by MGM2(), and sendOK().

◆ GO_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.GO_MSG_TYPE = new MessageType ("MGM2", "go")

static

Type used for the GO message.

Referenced by getMsgTypes(), and frodo2.algorithms.localSearch.mgm.mgm2.GO.GO().

◆ IMPROVE_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.IMPROVE_MSG_TYPE = MGM.IMPROVE_MSG_TYPE

static

Type used for the IMPROVE message.

Referenced by getMsgTypes(), and frodo2.algorithms.localSearch.mgm.mgm2.GO.GO().

◆ infos

HashMap<String, VariableInfo<V, U> > frodo2.algorithms.localSearch.mgm.mgm2.MGM2< 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.mgm2.MGM2< V extends Addable< V >, U extends Addable >.LOG = false

protected

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

Referenced by init(), log(), processOK(), and storeOffer().

◆ loggers

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

protected

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

Referenced by init(), and log().

◆ maximize

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

protected

true when solving a maximization problem, and false otherwise

Referenced by createVariableInfo(), init(), and storeIMPROVE().

◆ NO_GO_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.NO_GO_MSG_TYPE = new MessageType ("MGM2", "nogo")

static

Type used for the NO GO message.

Referenced by getMsgTypes(), frodo2.algorithms.localSearch.mgm.mgm2.NOGO.NOGO(), and frodo2.algorithms.localSearch.mgm.mgm2.NOGO.NOGO().

◆ OFFER_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.OFFER_MSG_TYPE = new MessageType ("MGM2", "offer")

static

The type of an OFFER message.

Referenced by getMsgTypes(), notifyIn(), frodo2.algorithms.localSearch.mgm.mgm2.OFFER< Val extends Addable< Val >, U extends Addable >.OFFER(), frodo2.algorithms.localSearch.mgm.mgm2.OFFER< Val extends Addable< Val >, U extends Addable >.OFFER(), and frodo2.algorithms.localSearch.mgm.mgm2.OFFERold< Val extends Addable< Val >, U extends Addable >.OFFERold().

◆ owners

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

protected

Maps variables to the agent that owns it.

Referenced by init(), processOFFER(), processOK(), sendOK(), and storeOffer().

◆ problem

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

private

The local problem definition.

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

◆ q

double frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.q

private

value between 0 and 1, used to determine whether a variable is offering or receiving

Referenced by MGM2(), and processOK().

◆ queue

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

protected

The queue to which this listener is registered.

Referenced by getStatsFromQueue(), init(), processIMPROVE(), processOFFER(), processOK(), sendOK(), setQueue(), and storeOffer().

◆ REJECT_MSG_TYPE

final MessageType frodo2.algorithms.localSearch.mgm.mgm2.MGM2< V extends Addable< V >, U extends Addable >.REJECT_MSG_TYPE = new MessageType ("MGM2", "reject")

static

The type of a REJECT message.

Referenced by getMsgTypes(), frodo2.algorithms.localSearch.mgm.mgm2.REJECT.REJECT(), and frodo2.algorithms.localSearch.mgm.mgm2.REJECT.REJECT().

◆ START_MSG_TYPE

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

private

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

Referenced by init(), and notifyIn().

◆ terminated

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

private

true when the agent has terminated upon initialization, and false otherwise

Referenced by init().

◆ variables_finished

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

private

The number of variables that are finished.

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

src/frodo2/algorithms/localSearch/mgm/mgm2/MGM2.java

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MGM2() [1/2]

◆ MGM2() [2/2]

Member Function Documentation

◆ createVariableInfo()

◆ getAssignmentHistories()

◆ getCurrentSolution()

◆ getMsgTypes()

◆ getStatsFromQueue()

◆ init()

◆ log()

◆ notifyIn()

◆ processGO()

◆ processIMPROVE()

◆ processOFFER()

◆ processOK()

◆ reset()

◆ sendOK()

◆ setQueue()

◆ setSilent()

◆ storeIMPROVE()

◆ storeOffer()

Member Data Documentation

◆ ACCEPT_MSG_TYPE

◆ assignmentHistoriesMap

◆ CONV_STATS_MSG_TYPE

◆ convergence

◆ cycles

◆ GO_MSG_TYPE

◆ IMPROVE_MSG_TYPE

◆ infos

◆ LOG

◆ loggers

◆ maximize

◆ NO_GO_MSG_TYPE

◆ OFFER_MSG_TYPE

◆ owners

◆ problem

◆ q

◆ queue

◆ REJECT_MSG_TYPE

◆ START_MSG_TYPE

◆ started

◆ terminated

◆ variables_finished