A MASproblem parser that is able to handle multiple types of agents. More...

Inheritance diagram for frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >:

[legend]

Public Member Functions
	MASparser (Element root)
	Constructor from a JDOM root Element.
	MASparser (Element root, boolean countNCCCs)
	Constructor from a JDOM root Element.
	MASparser (String agentName, String type, Element root, boolean countNCCCs, HashSet< String > spacesToIgnoreNcccs)
	Constructor from a JDOM root Element.
	MASparser (String agentName, String type, Element root, boolean countNCCCs)
	Constructor from a JDOM root Element.
	MASparser (Document doc)
	Constructor from a JDOM Document.
	MASparser (Document doc, Element params)
	Constructor.
String	getType ()
String	getAgent ()
Set< String >	getAgents ()
U	getZeroUtility ()
U	getPlusInfUtility ()
U	getMinInfUtility ()
Element	getLocalProblem ()
MASparser< V, U >	getSubProblem (String agent)
boolean	multipleTypes ()
void	reset (ProblemInterface< V, U > newProblem)
void	setDomClass (Class< V > domClass)
Class< V >	getDomClass ()
void	setUtilClass (Class< U > utilClass)
Class< U >	getUtilClass ()
U	utilInstance ()
void	incrNCCCs (long incr)
void	setNCCCs (long ncccs)
long	getNCCCs ()
String	toString ()
MASparser< V, U >	parse ()
Public Member Functions inherited from frodo2.solutionSpaces.ProblemInterface< V, U >
void	reset (ProblemInterface< V, U > newProblem)
	Resets this problem to be the same as the input one.
void	setDomClass (Class< V > domClass)
	Sets the class to be used for variable values.
Class< V >	getDomClass ()
void	setUtilClass (Class< U > utilClass)
	Sets the class to be used for utility values.
Class< U >	getUtilClass ()
U	getZeroUtility ()
U	getPlusInfUtility ()
U	getMinInfUtility ()
String	getAgent ()
Set< String >	getAgents ()
ProblemInterface< V, U >	getSubProblem (String agent)
	Builds the subproblem description for a given agent by extracting it from the overall problem description.
boolean	multipleTypes ()
void	incrNCCCs (long incr)
	Increments the number of constraint checks.
long	getNCCCs ()
void	setNCCCs (long ncccs)
	Sets the NCCC count.
Public Member Functions inherited from frodo2.algorithms.ParserInterface< V, U >
ProblemInterface< V, U >	parse ()

Static Public Member Functions
static Document	parse (File file) throws JDOMException, IOException
	Creates a JDOM Document out of the input XML file.
static Document	parse (String path) throws JDOMException, IOException
	Creates a JDOM Document out of the input XML file path in XCSP format.
static Document	parse (InputStream stream) throws JDOMException, IOException
	Creates a JDOM Document out of the input XML stream in XCSP format.

Protected Attributes
Element	root
	the JDOM root element
String	type
	the type of the agent owning this problem
Class< V >	domClass = (Class<V>) AddableInteger.class
	The class to be used for variable values.
Class< U >	utilClass = (Class<U>) AddableInteger.class
	The class to be used for utility values.
final boolean	countNCCCs
	Whether to count constraint checks.
HashSet< String >	spacesToIgnoreNcccs
	a set of spaces for which ncccs should be ignored

Private Attributes
String	agentName
	the name of the agent owning the problem, if applicable
long	ncccCount
	The NCCC count.

Static Private Attributes
static final long	serialVersionUID = 5407324017599034300L
	Used for serialization.

Detailed Description

A MASproblem parser that is able to handle multiple types of agents.

Author: Brammert Ottens, 8 jun 2010

Parameters

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

Constructor & Destructor Documentation

◆ MASparser() [1/6]

frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.MASparser ( Element root )

Constructor from a JDOM root Element.

Parameters

root	the JDOM root Element

References root.

Referenced by getSubProblem(), and parse().

◆ MASparser() [2/6]

frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable< U > >.MASparser	(	Element	root,
		boolean	countNCCCs )

Constructor from a JDOM root Element.

Parameters

root	the JDOM root Element
countNCCCs	`true` when NCCCs should be counted

References countNCCCs, and root.

◆ MASparser() [3/6]

frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable< U > >.MASparser	(	String	agentName,
		String	type,
		Element	root,
		boolean	countNCCCs,
		HashSet< String >	spacesToIgnoreNcccs )

Constructor from a JDOM root Element.

Parameters

agentName	the name of the agent owning the input subproblem
type	the type of the agent
root	the JDOM root Element
countNCCCs	`true` when NCCCs should be counted
spacesToIgnoreNcccs	the list of spaces who's NCCCs should not be counted

References agentName, countNCCCs, root, spacesToIgnoreNcccs, and type.

◆ MASparser() [4/6]

frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable< U > >.MASparser	(	String	agentName,
		String	type,
		Element	root,
		boolean	countNCCCs )

Constructor from a JDOM root Element.

Parameters

agentName	the name of the agent owning the input subproblem
type	the type of the agent
root	the JDOM root Element
countNCCCs	`true` when NCCCs should be counted

References agentName, countNCCCs, root, and type.

◆ MASparser() [5/6]

frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.MASparser ( Document doc )

Constructor from a JDOM Document.

Parameters

doc	the JDOM Document

◆ MASparser() [6/6]

frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable< U > >.MASparser	(	Document	doc,
		Element	params )

Constructor.

Parameters

doc	the JDOM Document
params	the parameters of the parser

References setUtilClass(), and spacesToIgnoreNcccs.

Here is the call graph for this function:

Member Function Documentation

◆ getAgent()

String frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getAgent ( )

See also: frodo2.solutionSpaces.ProblemInterface.getAgent()

References agentName.

Referenced by frodo2.algorithms.test.MASparserTest.testGetSubProblemString().

◆ getAgents()

Set< String > frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getAgents ( )

See also: frodo2.solutionSpaces.ProblemInterface.getAgents()

References root.

◆ getDomClass()

Class< V > frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getDomClass ( )

See also: ProblemInterface.getDomClass()

References domClass.

◆ getLocalProblem()

Element frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getLocalProblem ( )

Author: Brammert Ottens, 10 jun 2010

Returns: the local problem of the agent

Warning: should only be called by agents!

Implements frodo2.solutionSpaces.MASProblemInterface< V extends Addable< V >, U extends Addable >.

References root.

◆ getMinInfUtility()

U frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getMinInfUtility ( )

See also: frodo2.solutionSpaces.ProblemInterface.getMinInfUtility()

References utilClass.

◆ getNCCCs()

long frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getNCCCs ( )

See also: ProblemInterface.getNCCCs()

References ncccCount.

◆ getPlusInfUtility()

U frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getPlusInfUtility ( )

See also: frodo2.solutionSpaces.ProblemInterface.getPlusInfUtility()

References utilClass.

◆ getSubProblem()

MASparser< V, U > frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getSubProblem ( String agent )

See also: frodo2.solutionSpaces.ProblemInterface.getSubProblem(java.lang.String)

References countNCCCs, MASparser(), root, and spacesToIgnoreNcccs.

Referenced by frodo2.algorithms.test.MASparserTest.testGetSubProblemString().

Here is the call graph for this function:

◆ getType()

String frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getType ( )

See also: frodo2.solutionSpaces.MASProblemInterface.getType()

Implements frodo2.solutionSpaces.MASProblemInterface< V extends Addable< V >, U extends Addable >.

References type.

Referenced by frodo2.algorithms.test.MASparserTest.testGetSubProblemString().

◆ getUtilClass()

Class frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getUtilClass ( )

See also: ProblemInterface.getUtilClass()

References utilClass.

◆ getZeroUtility()

U frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.getZeroUtility ( )

See also: frodo2.solutionSpaces.ProblemInterface.getZeroUtility()

References utilClass.

◆ incrNCCCs()

void frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.incrNCCCs ( long incr )

See also: ProblemInterface.incrNCCCs(long)

References countNCCCs.

◆ multipleTypes()

boolean frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.multipleTypes ( )

See also: frodo2.solutionSpaces.ProblemInterface.multipleTypes()

◆ parse() [1/4]

MASparser< V, U > frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.parse ( )

See also: ParserInterface.parse()

References MASparser().

Here is the call graph for this function:

◆ parse() [2/4]

Document frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.parse ( File file ) throws JDOMException, IOException

static

Creates a JDOM Document out of the input XML file.

Parameters

file	the XML file

Returns: a JDOM Document resulting from the parsing of the input file

Exceptions

JDOMException	if a parsing error occurs while reading the file
IOException	if an I/O error occurs while accessing the file

Author: Thomas Leaute

Referenced by parse(), and frodo2.algorithms.test.MASparserTest.testParseString().

◆ parse() [3/4]

Document frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.parse ( InputStream stream ) throws JDOMException, IOException

static

Creates a JDOM Document out of the input XML stream in XCSP format.

Parameters

stream the XML stream

Returns: a JDOM Document resulting from the parsing of the input file

Exceptions

JDOMException	if a parsing error occurs while reading the file
IOException	if an I/O error occurs while accessing the file

Author: Thomas Leaute

◆ parse() [4/4]

Document frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.parse ( String path ) throws JDOMException, IOException

static

Creates a JDOM Document out of the input XML file path in XCSP format.

Parameters

path	the XML file path

Returns: a JDOM Document resulting from the parsing of the input file

Exceptions

JDOMException	if a parsing error occurs while reading the file
IOException	if an I/O error occurs while accessing the file

References parse().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.reset ( ProblemInterface< V, U > newProblem )

See also: frodo2.solutionSpaces.ProblemInterface.reset(frodo2.solutionSpaces.ProblemInterface)

◆ setDomClass()

void frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.setDomClass ( Class< V > domClass )

See also: ProblemInterface.setDomClass(java.lang.Class)

References domClass.

◆ setNCCCs()

void frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.setNCCCs ( long ncccs )

See also: ProblemInterface.setNCCCs(long)

References countNCCCs.

◆ setUtilClass()

void frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.setUtilClass ( Class utilClass )

See also: frodo2.solutionSpaces.ProblemInterface.setUtilClass(java.lang.Class)

References utilClass.

Referenced by MASparser().

◆ toString()

String frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.toString ( )

See also: java.lang.Object#toString()

References agentName, frodo2.algorithms.XCSPparser< V extends Addable< V >, U extends Addable >.toString(), and type.

Here is the call graph for this function:

◆ utilInstance()

U frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.utilInstance ( )

See also: MASProblemInterface.utilInstance()

Implements frodo2.solutionSpaces.MASProblemInterface< V extends Addable< V >, U extends Addable >.

References utilClass.

Member Data Documentation

◆ agentName

String frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.agentName

private

the name of the agent owning the problem, if applicable

Referenced by getAgent(), MASparser(), MASparser(), and toString().

◆ countNCCCs

final boolean frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.countNCCCs

protected

Whether to count constraint checks.

Referenced by getSubProblem(), incrNCCCs(), MASparser(), MASparser(), MASparser(), and setNCCCs().

◆ domClass

Class<V> frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.domClass = (Class<V>) AddableInteger.class

protected

The class to be used for variable values.

Referenced by getDomClass(), and setDomClass().

◆ ncccCount

long frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.ncccCount

private

The NCCC count.

Referenced by getNCCCs().

◆ root

Element frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.root

protected

the JDOM root element

Referenced by getAgents(), getLocalProblem(), getSubProblem(), MASparser(), MASparser(), MASparser(), and MASparser().

◆ serialVersionUID

final long frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.serialVersionUID = 5407324017599034300L

staticprivate

Used for serialization.

◆ spacesToIgnoreNcccs

HashSet<String> frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.spacesToIgnoreNcccs

protected

a set of spaces for which ncccs should be ignored

Referenced by getSubProblem(), MASparser(), and MASparser().

◆ type

String frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.type

protected

the type of the agent owning this problem

Referenced by getType(), MASparser(), MASparser(), and toString().

◆ utilClass

Class frodo2.algorithms.MASparser< V extends Addable< V >, U extends Addable >.utilClass = (Class) AddableInteger.class

protected

The class to be used for utility values.

Referenced by getMinInfUtility(), getPlusInfUtility(), getUtilClass(), getZeroUtility(), setUtilClass(), and utilInstance().

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

src/frodo2/algorithms/MASparser.java

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ MASparser() [1/6]

◆ MASparser() [2/6]

◆ MASparser() [3/6]

◆ MASparser() [4/6]

◆ MASparser() [5/6]

◆ MASparser() [6/6]

Member Function Documentation

◆ getAgent()

◆ getAgents()

◆ getDomClass()

◆ getLocalProblem()

◆ getMinInfUtility()

◆ getNCCCs()

◆ getPlusInfUtility()

◆ getSubProblem()

◆ getType()

◆ getUtilClass()

◆ getZeroUtility()

◆ incrNCCCs()

◆ multipleTypes()

◆ parse() [1/4]

◆ parse() [2/4]

◆ parse() [3/4]

◆ parse() [4/4]

◆ reset()

◆ setDomClass()

◆ setNCCCs()

◆ setUtilClass()

◆ toString()

◆ utilInstance()

Member Data Documentation

◆ agentName

◆ countNCCCs

◆ domClass

◆ ncccCount

◆ root

◆ serialVersionUID

◆ spacesToIgnoreNcccs

◆ type

◆ utilClass