A message containing a linear order on all variables belonging to a given connected component of the constraint graph. More...

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

[legend]

Public Member Functions
	OrderMsg ()
	Empty constructor used for externalization.
	OrderMsg (MessageType type, Comparable<?> componentID, List< String > order, List< String > agents)
	Constructor.
	OrderMsg (MessageType type, List< List< String > > order, List< String > agents, Comparable<?> componentID)
	Constructor.
	OrderMsg (MessageType type, List< List< String > > order, List< String > agents, Comparable<?> componentID, List< UtilitySolutionSpace< V, U > > spaces)
	Constructor.
	OrderMsg (MessageType type, List< List< String > > order, List< String > ids, List< String > agents, Comparable<?> componentID, List< UtilitySolutionSpace< V, U > > spaces)
	Constructor.
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
Comparable<?>	getComponentID ()
List< List< String > >	getOrder ()
List< String >	getFlatOrder ()
List< String >	getIDs ()
List< String >	getAgents ()
List< UtilitySolutionSpace< V, U > >	getSpaces ()
String	toString ()
Public Member Functions inherited from frodo2.communication.Message
	Message (MessageType type)
	Constructor.
	Message ()
	Empty constructor.
MessageType	getType ()
void	fakeSerialize ()
	Pretends to serialize the message.

Static Public Attributes
static final MessageType	ORDER_MSG_TYPE = new MessageType ("VarOrdering", "OrderMsg", "VarOrder")
	The types of the messages containing the chosen linear order of variables.
static final MessageType	STATS_MSG_TYPE = new MessageType ("VarOrdering", "OrderMsg", "VarOrderStats")
	The types of the messages containing the chosen linear order of variables sent to the stats gatherer.

Private Attributes
Comparable<?>	componentID
	The ID of the connected component in the constraint graph.
List< List< String > >	order
	The order of the variables, grouped into clusters.
List< String >	ids
	The ID of each cluster.
List< String >	agents
	The agent corresponding to each cluster in the order.
List< UtilitySolutionSpace< V, U > >	spaces
	The (joint) constraint that each cluster is responsible for enforcing.

Additional Inherited Members
Protected Attributes inherited from frodo2.communication.Message
MessageType	type
	The type of this message.

Detailed Description

A message containing a linear order on all variables belonging to a given connected component of the constraint graph.

Parameters

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

Constructor & Destructor Documentation

◆ OrderMsg() [1/5]

frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.OrderMsg ( )

Empty constructor used for externalization.

◆ OrderMsg() [2/5]

frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable< U > >.OrderMsg	(	MessageType	type,
		Comparable<?>	componentID,
		List< String >	order,
		List< String >	agents )

Constructor.

Parameters

type	the type of the message
componentID	The ID of the connected component in the constraint graph
order	The variable order
agents	The agent corresponding to each variable in the order

References agents, componentID, order, and frodo2.communication.Message.type.

◆ OrderMsg() [3/5]

frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable< U > >.OrderMsg	(	MessageType	type,
		List< List< String > >	order,
		List< String >	agents,
		Comparable<?>	componentID )

Constructor.

Parameters

type	the type of the message
componentID	The ID of the connected component in the constraint graph
order	The cluster order
agents	The agent corresponding to each variable in the order

References agents, componentID, order, and frodo2.communication.Message.type.

◆ OrderMsg() [4/5]

frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable< U > >.OrderMsg	(	MessageType	type,
		List< List< String > >	order,
		List< String >	agents,
		Comparable<?>	componentID,
		List< UtilitySolutionSpace< V, U > >	spaces )

Constructor.

Parameters

type	the type of the message
componentID	The ID of the connected component in the constraint graph
order	The cluster order
agents	The agent corresponding to each variable in the order
spaces	The space each cluster is responsible for enforcing

References agents, componentID, order, spaces, and frodo2.communication.Message.type.

◆ OrderMsg() [5/5]

frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable< U > >.OrderMsg	(	MessageType	type,
		List< List< String > >	order,
		List< String >	ids,
		List< String >	agents,
		Comparable<?>	componentID,
		List< UtilitySolutionSpace< V, U > >	spaces )

Constructor.

Parameters

type	the type of the message
componentID	The ID of the connected component in the constraint graph
order	The cluster order
ids	Each cluster's ID
agents	The agent corresponding to each variable in the order
spaces	The space each cluster is responsible for enforcing

References agents, componentID, ids, order, spaces, and frodo2.communication.Message.type.

Member Function Documentation

◆ getAgents()

List< String > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.getAgents ( )

Returns: The agent corresponding to each variable in the order

Referenced by frodo2.algorithms.varOrdering.linear.tests.CentralLinearOrderingTest.notifyIn().

◆ getComponentID()

Comparable<?> frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.getComponentID ( )

Returns: The ID of the connected component in the constraint graph

◆ getFlatOrder()

List< String > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.getFlatOrder ( )

Returns: The variable order in a flattened list

References order.

Referenced by frodo2.algorithms.varOrdering.linear.tests.CentralLinearOrderingTest.notifyIn().

◆ getIDs()

List< String > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.getIDs ( )

Returns: each cluster's ID

◆ getOrder()

List< List< String > > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.getOrder ( )

Returns: The variable order

Referenced by frodo2.algorithms.varOrdering.linear.tests.CentralLinearOrderingTest.notifyIn().

◆ getSpaces()

List< UtilitySolutionSpace< V, U > > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.getSpaces ( )

Returns: the (joint) constraint that each cluster is responsible for enforcing

References spaces.

◆ readExternal()

void frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.readExternal ( ObjectInput in ) throws IOException, ClassNotFoundException

See also: java.io.Externalizable#readExternal(java.io.ObjectInput)

Reimplemented from frodo2.communication.Message.

◆ toString()

String frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.toString ( )

See also: Message.toString()

Reimplemented from frodo2.communication.Message.

◆ writeExternal()

void frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.writeExternal ( ObjectOutput out ) throws IOException

See also: java.io.Externalizable#writeExternal(java.io.ObjectOutput)

Warning: The spaces are NOT serialized.

Reimplemented from frodo2.communication.Message.

References agents.

Member Data Documentation

◆ agents

List<String> frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.agents

private

The agent corresponding to each cluster in the order.

Referenced by OrderMsg(), OrderMsg(), OrderMsg(), OrderMsg(), and writeExternal().

◆ componentID

Comparable<?> frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.componentID

private

The ID of the connected component in the constraint graph.

Referenced by OrderMsg(), OrderMsg(), OrderMsg(), and OrderMsg().

◆ ids

List<String> frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.ids

private

The ID of each cluster.

Referenced by OrderMsg().

◆ order

List<List<String> > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.order

private

The order of the variables, grouped into clusters.

Referenced by getFlatOrder(), OrderMsg(), OrderMsg(), OrderMsg(), and OrderMsg().

◆ ORDER_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.ORDER_MSG_TYPE = new MessageType ("VarOrdering", "OrderMsg", "VarOrder")

static

The types of the messages containing the chosen linear order of variables.

Referenced by frodo2.algorithms.varOrdering.linear.tests.CentralLinearOrderingTest.getMsgTypes().

◆ spaces

List< UtilitySolutionSpace<V, U> > frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.spaces

private

The (joint) constraint that each cluster is responsible for enforcing.

Referenced by getSpaces(), OrderMsg(), and OrderMsg().

◆ STATS_MSG_TYPE

final MessageType frodo2.algorithms.varOrdering.linear.OrderMsg< V extends Addable< V >, U extends Addable >.STATS_MSG_TYPE = new MessageType ("VarOrdering", "OrderMsg", "VarOrderStats")

static

The types of the messages containing the chosen linear order of variables sent to the stats gatherer.

Referenced by frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.getStatsFromQueue(), frodo2.algorithms.varOrdering.linear.LinearOrdering< V extends Addable< V >, U extends Addable >.getStatsFromQueue(), frodo2.algorithms.varOrdering.linear.CentralLinearOrdering< V extends Addable< V >, U extends Addable >.notifyIn(), frodo2.algorithms.varOrdering.linear.LinearOrdering< V extends Addable< V >, U extends Addable >.notifyIn(), and frodo2.algorithms.varOrdering.linear.tests.CentralLinearOrderingTest.test().

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

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

Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OrderMsg() [1/5]

◆ OrderMsg() [2/5]

◆ OrderMsg() [3/5]

◆ OrderMsg() [4/5]

◆ OrderMsg() [5/5]

Member Function Documentation

◆ getAgents()

◆ getComponentID()

◆ getFlatOrder()

◆ getIDs()

◆ getOrder()

◆ getSpaces()

◆ readExternal()

◆ toString()

◆ writeExternal()

Member Data Documentation

◆ agents

◆ componentID

◆ ids

◆ order

◆ ORDER_MSG_TYPE

◆ spaces

◆ STATS_MSG_TYPE