frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > > Class Template Reference

A message sent by a function node. More...

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

Public Member Functions
	FunctionMsg ()
	Empty constructor used for externalization.
	FunctionMsg (String functionNode, UtilitySolutionSpace< V, U > marginalUtil)
	Constructor.
void	fakeSerialize ()
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
String	getFunctionNode ()
UtilitySolutionSpace< V, U >	getMarginalUtil ()
Public Member Functions inherited from frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >
	MessageWith2Payloads (MessageType type, T1 payload1, T2 payload2)
	Constructor.
	MessageWith2Payloads ()
	Empty constructor.
MessageWith2Payloads< T1, T2 >	clone ()
T1	getPayload1 ()
void	setPayload1 (T1 payload1)
T2	getPayload2 ()
void	setPayload2 (T2 payload2)
String	toString ()
Public Member Functions inherited from frodo2.communication.Message
	Message (MessageType type)
	Constructor.
	Message ()
	Empty constructor.
MessageType	getType ()

Static Public Attributes
static final MessageType	FUNCTION_MSG_TYPE = new MessageType ("Max-Sum", "FunctionToVar")
	The type of this message.

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

Detailed Description

A message sent by a function node.

Author

Thomas Leaute, remotely based on a preliminary contribution by Sokratis Vavilis and George Vouros (AI-Lab of the University of the Aegean)

Parameters

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

Constructor & Destructor Documentation

FunctionMsg() [1/2]

frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.FunctionMsg

(

)

Empty constructor used for externalization.

References FUNCTION_MSG_TYPE.

FunctionMsg() [2/2]

frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.FunctionMsg	(	String	functionNode,
		UtilitySolutionSpace< V, U >	marginalUtil )

Constructor.

Parameters

functionNode	the sender of this message
marginalUtil	the marginal utility as a function of the destination variable

References FUNCTION_MSG_TYPE.

Member Function Documentation

fakeSerialize()

void frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.fakeSerialize

(

)

See also

MessageWithPayload.fakeSerialize()

Reimplemented from frodo2.communication.Message.

References getMarginalUtil().

Here is the call graph for this function:

getFunctionNode()

String frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.getFunctionNode

(

)

Returns

the name of the sender function node

References frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.getPayload1().

Referenced by frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.notifyIn().

Here is the call graph for this function:

getMarginalUtil()

UtilitySolutionSpace< V, U > frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.getMarginalUtil

(

)

Returns

the marginal utility as a function of the destination variable

References frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.getPayload2().

Referenced by fakeSerialize(), and frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.notifyIn().

Here is the call graph for this function:

readExternal()

void frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.readExternal

(

ObjectInput

in

)

throws IOException, ClassNotFoundException

See also

java.io.Externalizable#readExternal(java.io.ObjectInput)

Reimplemented from frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.

References readExternal().

Referenced by readExternal().

Here is the call graph for this function:

writeExternal()

void frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.writeExternal

(

ObjectOutput

out

)

throws IOException

See also

java.io.Externalizable#writeExternal(java.io.ObjectOutput)

Reimplemented from frodo2.communication.MessageWith2Payloads< T1 extends Serializable, T2 extends Serializable >.

Member Data Documentation

FUNCTION_MSG_TYPE

final MessageType frodo2.algorithms.maxsum.FunctionMsg< V extends Addable< V >, U extends Addable< U > >.FUNCTION_MSG_TYPE = new MessageType ("Max-Sum", "FunctionToVar")

static

The type of this message.

Referenced by FunctionMsg(), and FunctionMsg().

---

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

• src/frodo2/algorithms/maxsum/FunctionMsg.java