frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > > Class Template Reference

This is a solver that reads in the problem, creates the agents, runs the problem and then collects the statistics . More...

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

Public Member Functions
	MGMsolver ()
	Constructor.
	MGMsolver (boolean useTCP)
	Constructor.
	MGMsolver (Class< V > domClass, Class< U > utilClass)
	Constructor.
	MGMsolver (Class< V > domClass, Class< U > utilClass, boolean useTCP)
	Constructor.
	MGMsolver (String agentDesc)
	Constructor.
	MGMsolver (String agentDesc, boolean useTCP)
	Constructor.
	MGMsolver (String agentDescFile, Class< V > domClass, Class< U > utilClass)
	Constructor.
	MGMsolver (String agentDescFile, Class< V > domClass, Class< U > utilClass, boolean useTCP)
	Constructor.
	MGMsolver (Document agentDesc)
	Constructor.
	MGMsolver (Document agentDesc, boolean useTCP)
	Constructor.
void	setConvergence (boolean convergence)
	Sets the convergence parameter to the desired value.
ArrayList< StatsReporter >	getSolGatherers ()
SolutionWithConvergence< V, U >	buildSolution ()
void	clear ()
Public Member Functions inherited from frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >
	AbstractDCOPsolver (String agentDesc, boolean measureTime, boolean useTCP, boolean measureMsgs, Class<? extends XCSPparser< V, U > > parserClass, Class< V > domClass, Class< U > valuationClass)
	Constructor.
S	solve (Document problem, int nbrElectionRounds, boolean measureMsgs, Long timeout, boolean cleanAfterwards)
S	solve (DCOPProblemInterface< V, U > problem, int nbrElectionRounds, boolean measureMsgs, Long timeout, boolean cleanAfterwards)
S	solve (Document problem)
S	solve (DCOPProblemInterface< V, U > problem)
S	solve (Document problem, Long timeout)
S	solve (DCOPProblemInterface< V, U > problem, Long timeout)
S	solve (Document problem, boolean cleanAfterwards)
S	solve (DCOPProblemInterface< V, U > problem, boolean cleanAfterwards)
S	solve (Document problem, int nbrElectionRounds)
S	solve (DCOPProblemInterface< V, U > problem, int nbrElectionRounds)
S	solve (Document problem, int nbrElectionRounds, boolean measureMsgs)
S	solve (DCOPProblemInterface< V, U > problem, int nbrElectionRounds, boolean measureMsgs)
S	solve (Document problem, int nbrElectionRounds, boolean measureMsgs, Long timeout)
S	solve (DCOPProblemInterface< V, U > problem, int nbrElectionRounds, boolean measureMsgs, Long timeout)
S	solve (Document problem, int nbrElectionRounds, Long timeout)
S	solve (DCOPProblemInterface< V, U > problem, int nbrElectionRounds, Long timeout)
S	solve (Document problem, boolean cleanAfterwards, Long timeout)
S	solve (DCOPProblemInterface< V, U > problem, boolean cleanAfterwards, Long timeout) throws OutOfMemoryError
Public Member Functions inherited from frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >
void	setProblem (P problem)
	Sets the problem.
void	setFactory (AgentFactory< V, U > factory)
	Sets the agent factory.
void	setDomClass (Class< V > domClass)
	Sets the class for variable values.
void	setUtilClass (Class< U > utilClass)
	Sets the class for utility values.
Document	getAgentDesc ()
abstract List<? extends StatsReporter >	getSolGatherers ()
abstract S	buildSolution ()
S	solve (Document problem)
	Solves the input problem.
String	plotStats (Solution< V, U > sol)
	Puts the statistics in a format that can easily be processed after the experiments.
String	plotDummyStats (boolean maximize)
	Used when the solver was not able to solve the problem.

Protected Member Functions
void	parseParams (String[] params)
String	getParamsHeader ()
String	getParamsToLine ()
Protected Member Functions inherited from frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >
String	getFileHeader (Document problemFile)
	Returns the header for the output CSV file.
String	getProbStats (Document problemFile, String probFilename)
	Parses the statistics about the problem instance.
String	getTimeoutLine (String algoName, Document problemFile, String probFilename)
	Returns a timeout line for the output CSV file.
	AbstractDCOPsolver ()
	Dummy constructor.
	AbstractDCOPsolver (String agentDescFile)
	Constructor from an agent configuration file.
	AbstractDCOPsolver (String agentDescFile, boolean useTCP)
	Constructor from an agent configuration file.
	AbstractDCOPsolver (String agentDescFile, boolean useTCP, int shift)
	Constructor from an agent configuration file.
	AbstractDCOPsolver (Document agentDesc)
	Constructor.
	AbstractDCOPsolver (Document agentDesc, boolean useTCP)
	Constructor.
	AbstractDCOPsolver (Document agentDesc, Class< ? extends XCSPparser< V, U > > parserClass)
	Constructor.
	AbstractDCOPsolver (Document agentDesc, Class< ? extends XCSPparser< V, U > > parserClass, boolean useTCP)
	Constructor.
void	setNbrElectionRounds (int nbrElectionRounds)
	Sets the number of rounds of VariableElection.
void	setProblemRescalerShift (int shift)
	Sets the shift parameter of the ProblemRescaler module (if used).
void	overrideMsgTypes ()
	Overrides message types if necessary.
Protected Member Functions inherited from frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >
	AbstractSolver ()
	Dummy constructor.
void	clear ()
	Clears the parser.

Private Member Functions
Element	getElement (Element modules)
	Looks up the Element for the DSA module in the agent configuration file.

Private Attributes
MGM< V, U >	mgmModule
	The MGM module.
SolutionCollector< V, U >	solCollector
	The solution collector.

Additional Inherited Members
Static Public Member Functions inherited from frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >
static void	main (String[] args) throws Exception
	Solves a problem and writes statistics to a file.
Protected Attributes inherited from frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >
Document	agentDesc
	Description of the agent to be used.
AgentFactory< V, U >	factory
	The agent factory.
Class< ? extends XCSPparser< V, U > >	parserClass
	The class of the parser to be used.
List<? extends StatsReporter >	solGatherers
	The list of modules that record statistics about problem solving.
P	problem
	The problem.
final boolean	useTCP
	Whether to use TCP pipes or shared memory pipes.

Detailed Description

This is a solver that reads in the problem, creates the agents, runs the problem and then collects the statistics .

Author

Brammert Ottens, Thomas Leaute

Parameters

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

Constructor & Destructor Documentation

MGMsolver() [1/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver

(

)

Constructor.

MGMsolver() [2/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver

(

boolean

useTCP

)

Constructor.

Parameters

useTCP

Whether to use TCP pipes or shared memory pipes

Warning

Using TCP pipes automatically disables simulated time.

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.useTCP.

MGMsolver() [3/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver	(	Class< V >	domClass,
		Class< U >	utilClass )

Constructor.

Parameters

domClass	the class to use for variable values
utilClass	the class to use for utilities

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setDomClass(), and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setUtilClass().

Here is the call graph for this function:

MGMsolver() [4/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver	(	Class< V >	domClass,
		Class< U >	utilClass,
		boolean	useTCP )

Constructor.

Parameters

domClass	the class to use for variable values
utilClass	the class to use for utilities
useTCP	Whether to use TCP pipes or shared memory pipes

Warning

Using TCP pipes automatically disables simulated time.

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setDomClass(), frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setUtilClass(), and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.useTCP.

Here is the call graph for this function:

MGMsolver() [5/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver

(

String

agentDesc

)

Constructor.

Parameters

agentDesc

path to the agent description file

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.agentDesc.

MGMsolver() [6/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver	(	String	agentDesc,
		boolean	useTCP )

Constructor.

Parameters

agentDesc	path to the agent description file
useTCP	Whether to use TCP pipes or shared memory pipes

Warning

Using TCP pipes automatically disables simulated time.

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.agentDesc, and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.useTCP.

MGMsolver() [7/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver	(	String	agentDescFile,
		Class< V >	domClass,
		Class< U >	utilClass )

Constructor.

Parameters

agentDescFile	description of the agent to be used
domClass	the class to be used for variable values
utilClass	the class to be used for utility values

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setDomClass(), and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setUtilClass().

Here is the call graph for this function:

MGMsolver() [8/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver	(	String	agentDescFile,
		Class< V >	domClass,
		Class< U >	utilClass,
		boolean	useTCP )

Constructor.

Parameters

agentDescFile	description of the agent to be used
domClass	the class to be used for variable values
utilClass	the class to be used for utility values
useTCP	Whether to use TCP pipes or shared memory pipes

Warning

Using TCP pipes automatically disables simulated time.

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setDomClass(), frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.setUtilClass(), and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.useTCP.

Here is the call graph for this function:

MGMsolver() [9/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver

(

Document

agentDesc

)

Constructor.

Parameters

agentDesc

description of the agent to be used

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.agentDesc.

MGMsolver() [10/10]

frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.MGMsolver	(	Document	agentDesc,
		boolean	useTCP )

Constructor.

Parameters

agentDesc	description of the agent to be used
useTCP	Whether to use TCP pipes or shared memory pipes

Warning

Using TCP pipes automatically disables simulated time.

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.agentDesc, and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.useTCP.

Member Function Documentation

buildSolution()

SolutionWithConvergence< V, U > frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.buildSolution

(

)

See also

AbstractDCOPsolver.buildSolution()

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.factory, and mgmModule.

clear()

void frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.clear

(

)

See also

AbstractDCOPsolver.clear()

getElement()

Element frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.getElement ( Element modules )

private

Looks up the Element for the DSA module in the agent configuration file.

Parameters

modules

a list of modules

Returns

the DSA module element, or null if not found

Referenced by getParamsToLine(), and parseParams().

getParamsHeader()

String frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.getParamsHeader ( )

protected

See also

AbstractDCOPsolver.getParamsHeader()

Reimplemented from frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >.

getParamsToLine()

String frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.getParamsToLine ( )

protected

See also

AbstractDCOPsolver.getParamsToLine()

Reimplemented from frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >.

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.agentDesc, and getElement().

Here is the call graph for this function:

getSolGatherers()

ArrayList< StatsReporter > frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.getSolGatherers

(

)

See also

AbstractDCOPsolver.getSolGatherers()

References mgmModule, frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.problem, frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable< U > >.setSilent(), and frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.solGatherers.

Here is the call graph for this function:

parseParams()

void frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.parseParams ( String[] params )

protected

See also

AbstractDCOPsolver.parseParams(java.lang.String[])

Parameters

params

{variant, conflictCost, p, sync, maxRounds}

Reimplemented from frodo2.algorithms.AbstractDCOPsolver< V extends Addable< V >, U extends Addable< U >, S extends Solution< V, U >.

References getElement().

Here is the call graph for this function:

setConvergence()

void frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.setConvergence

(

boolean

convergence

)

Sets the convergence parameter to the desired value.

Parameters

convergence

true when convergence must be measured, and false otherwise

References frodo2.algorithms.AbstractSolver< DCOPProblemInterface< V, U >, V, U, S >.agentDesc.

Member Data Documentation

mgmModule

MGM<V, U> frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.mgmModule

private

The MGM module.

Referenced by buildSolution(), and getSolGatherers().

solCollector

SolutionCollector<V, U> frodo2.algorithms.localSearch.mgm.MGMsolver< V extends Addable< V >, U extends Addable< U > >.solCollector

private

The solution collector.

---

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

• src/frodo2/algorithms/localSearch/mgm/MGMsolver.java