The listener that checks the messages sent by the UTILpropagation and VALUEpropagation listeners. More...

Inheritance diagram for frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener:

[legend]

Public Member Functions
	Listener (boolean useTCP, boolean useXML, Class< ? extends IncomingMsgPolicyInterface< MessageType > > UTILpropClass, Class< ? extends IncomingMsgPolicyInterface< MessageType > > VALUEpropClass, boolean withAnonymVars) throws IOException, NoSuchMethodException, IllegalArgumentException, InstantiationException, IllegalAccessException, InvocationTargetException
	Constructor that tests the UTIL and VALUE propagation protocols on a random DFS.
Collection< MessageType >	getMsgTypes ()
	Listens to the outputs of the UTIL and VALUE propagation protocols.
void	notifyIn (Message msg)
void	setQueue (Queue queue)
	Does nothing.
void	getStatsFromQueue (Queue queue)
void	setSilent (boolean silent)
void	reset ()
Public Member Functions inherited from frodo2.communication.IncomingMsgPolicyInterface< T >
default void	notifyIn (Message msg, Object toAgent)
	Notifies the listener of an incoming message.

Protected Member Functions
void	checkOutput ()
	Checks that the output of the module is correct.
Hypercube< AddableInteger, U >	simulateUTILslice (String var)
	Simulates UTIL propagation on the subtree rooted at the input variable, doing slices instead of projections.

Protected Attributes
Map< String, UtilitySolutionSpace< AddableInteger, U > >	hypercubes
	For each variable, the constraint it is responsible for enforcing.
XCSPparser< AddableInteger, U >	parser
	The parser for the problem.

Private Member Functions
void	waitForOutputs ()
	Waits for the outputs of the module and checks their validity.

Private Attributes
U	optTotalUtil
	Optimal, total utility across all connected components.
Object	optTotalUtil_lock = new Object ()
	Used to synchronize access to optTotalUtil, which can be `null`.
Map< String, QueueOutputPipeInterface >	pipes
	The pipes of the queue network, indexed by agent name.
Queue	myQueue
	The Listener's own queue.
List< ? extends UtilitySolutionSpace< AddableInteger, U > >	spaces
	The constraints in the problem.
SolutionCollector< AddableInteger, U >	solCollector
	The statistics gatherer.

Detailed Description

The listener that checks the messages sent by the UTILpropagation and VALUEpropagation listeners.

Constructor & Destructor Documentation

◆ Listener()

frodo2.algorithms.dpop.test.VALUEpropagationTest< U extends Addable< U > >.Listener.Listener	(	boolean	useTCP,
		boolean	useXML,
		Class< ? extends IncomingMsgPolicyInterface< MessageType > >	UTILpropClass,
		Class< ? extends IncomingMsgPolicyInterface< MessageType > >	VALUEpropClass,
		boolean	withAnonymVars ) throws IOException, NoSuchMethodException, IllegalArgumentException, InstantiationException, IllegalAccessException, InvocationTargetException

Constructor that tests the UTIL and VALUE propagation protocols on a random DFS.

Parameters

useTCP	`true` whether TCP pipes should be used instead of QueueIOPipes
useXML	whether we should use the constructor that takes in XML elements, or the manual constructor
UTILpropClass	the class of the UTIL propagation module under test
VALUEpropClass	the class of the VALUE propagation module under test
withAnonymVars	if `true`, variables without owners are taken into account

Exceptions

IOException	if the method fails to create pipes
NoSuchMethodException	if the VALUEpropagation class does not have a public constructor that takes in a ProblemInterface and a JDOM Element
InvocationTargetException	if the VALUEpropagation constructor throws an exception
IllegalAccessException	if the VALUEpropagation class does not have a public constructor that takes in a ProblemInterface and a JDOM Element
InstantiationException	would be thrown if VALUEpropagation were abstract
IllegalArgumentException	if the VALUEpropagation constructor does not take the proper arguments

Here is the call graph for this function:

Member Function Documentation

◆ checkOutput()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.checkOutput ( )

protected

Checks that the output of the module is correct.

References frodo2.algorithms.dpop.test.VALUEpropagationTest >.dfs, frodo2.solutionSpaces.hypercube.Hypercube< V extends Addable< V >, U extends Addable >.getUtility(), frodo2.algorithms.dpop.test.VALUEpropagationTest >.graph, optTotalUtil, and simulateUTILslice().

Referenced by waitForOutputs().

Here is the call graph for this function:

◆ getMsgTypes()

Collection< MessageType > frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.getMsgTypes ( )

Listens to the outputs of the UTIL and VALUE propagation protocols.

See also: IncomingMsgPolicyInterface.getMsgTypes()

Implements frodo2.communication.MessageListener< T >.

References frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.ASSIGNMENTS_MSG_TYPE, and frodo2.algorithms.dpop.UTILpropagation< Val extends Addable< Val >, U extends Addable >.OPT_UTIL_MSG_TYPE.

◆ getStatsFromQueue()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.getStatsFromQueue ( Queue queue )

See also: StatsReporter.getStatsFromQueue(Queue)

Implements frodo2.algorithms.StatsReporter.

References frodo2.communication.Queue.addIncomingMessagePolicy(), and frodo2.algorithms.SolutionCollector< V extends Addable< V >, U extends Addable >.ASSIGNMENTS_MSG_TYPE.

Referenced by Listener().

Here is the call graph for this function:

◆ notifyIn()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.notifyIn ( Message msg )

See also: StatsReporter.notifyIn(Message)

Implements frodo2.communication.IncomingMsgPolicyInterface< T >.

References frodo2.communication.MessageType.equals(), notifyIn(), and frodo2.algorithms.dpop.UTILpropagation< Val extends Addable< Val >, U extends Addable >.OPT_UTIL_MSG_TYPE.

Referenced by notifyIn().

Here is the call graph for this function:

◆ reset()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.reset ( )

See also: StatsReporter.reset()

Implements frodo2.algorithms.StatsReporter.

◆ setQueue()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.setQueue ( Queue queue )

Does nothing.

See also: IncomingMsgPolicyInterface.setQueue(Queue)

Implements frodo2.communication.MessageListener< T >.

◆ setSilent()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.setSilent ( boolean silent )

See also: StatsReporter.setSilent(boolean)

Implements frodo2.algorithms.StatsReporter.

◆ simulateUTILslice()

Hypercube< AddableInteger, U > frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.simulateUTILslice ( String var )

protected

Simulates UTIL propagation on the subtree rooted at the input variable, doing slices instead of projections.

Parameters

var	root variable

Returns: the UTIL message that the input variable sends to its parent (if any)

References frodo2.algorithms.dpop.test.VALUEpropagationTest >.dfs, hypercubes, frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable >.join(), frodo2.algorithms.dpop.test.VALUEpropagationTest >.optAssignments, parser, simulateUTILslice(), and frodo2.solutionSpaces.UtilitySolutionSpace< V extends Addable< V >, U extends Addable >.slice().

Referenced by checkOutput(), and simulateUTILslice().

Here is the call graph for this function:

◆ waitForOutputs()

void frodo2.algorithms.dpop.test.VALUEpropagationTest >.Listener.waitForOutputs ( )

private

Waits for the outputs of the module and checks their validity.

Bug: Sometimes, the pipes are closed while the VALUEpropagation listeners are still sending messages; this throws a SocketException, but the unit tests still pass and are still valid.

References checkOutput(), frodo2.algorithms.dpop.test.VALUEpropagationTest >.dfs, frodo2.algorithms.dpop.test.VALUEpropagationTest >.finished, frodo2.algorithms.dpop.test.VALUEpropagationTest >.finished_lock, frodo2.algorithms.dpop.test.VALUEpropagationTest >.graph, hypercubes, myQueue, frodo2.algorithms.dpop.test.VALUEpropagationTest >.nbrMsgsRemaining, pipes, frodo2.algorithms.dpop.test.VALUEpropagationTest >.queues, spaces, and frodo2.algorithms.dpop.test.UTILpropagationTest >.startUTIL().