frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > > Class Template Reference

The message used to send a VALUE message to a variable's pseudochildren in ADOPT. More...

Inheritance diagram for frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >:

Public Member Functions
	COSTmsg ()
	Empty constructor.
	COSTmsg (String sender, String receiver, HashMap< String, Val > context, U lb, U ub)
	Constructor.
String	toString ()
void	writeExternal (ObjectOutput out) throws IOException
void	readExternal (ObjectInput in) throws IOException, ClassNotFoundException
boolean	equals (Object msg)
String	getSender ()
	Getter function.
String	getReceiver ()
	Getter function.
HashMap< String, Val >	getContext ()
	Getter function.
U	getLB ()
	Getter function.
U	getUB ()
	Getter function.
Public Member Functions inherited from frodo2.communication.Message
	Message (MessageType type)
	Constructor.
	Message ()
	Empty constructor.
MessageType	getType ()
void	fakeSerialize ()
	Pretends to serialize the message.

Package Attributes
String	receiver
	The receiving variable.

Private Attributes
String	sender
	The sending variable.
HashMap< String, Val >	context
	The context in which this message was created.
U	lb
	The upper bound.
U	ub
	The lower bound.

Static Private Attributes
static final long	serialVersionUID = 2153239219905600645L
	Use for serialization.

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

Detailed Description

The message used to send a VALUE message to a variable's pseudochildren in ADOPT.

Parameters

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

Constructor & Destructor Documentation

COSTmsg() [1/2]

frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.COSTmsg

(

)

Empty constructor.

References frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.COST_MSG_TYPE.

Referenced by equals().

COSTmsg() [2/2]

frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.COSTmsg	(	String	sender,
		String	receiver,
		HashMap< String, Val >	context,
		U	lb,
		U	ub )

Constructor.

Parameters

sender	the sender variable
receiver	the recipient variable
context	the context
lb	the lower bound
ub	the upper bound

References context, frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.COST_MSG_TYPE, lb, receiver, sender, and ub.

Member Function Documentation

equals()

boolean frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.equals

(

Object

msg

)

See also

java.lang.Object#equals(java.lang.Object)

References context, COSTmsg(), equals(), frodo2.communication.Message.getType(), lb, frodo2.communication.Message.Message(), receiver, sender, and ub.

Referenced by equals().

Here is the call graph for this function:

getContext()

HashMap< String, Val > frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.getContext

(

)

Getter function.

Returns

the value

References context.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleCOSTmessage().

getLB()

U frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.getLB

(

)

Getter function.

Returns

the lower bound reported by the sender

References lb.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleCOSTmessage().

getReceiver()

String frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.getReceiver

(

)

Getter function.

Returns

the variable that is to receive this message

References receiver.

getSender()

String frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.getSender

(

)

Getter function.

Returns

the variable that sent this message

References sender.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleCOSTmessage().

getUB()

U frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.getUB

(

)

Getter function.

Returns

the upper bound reported by the sender

References ub.

Referenced by frodo2.algorithms.adopt.ADOPT< Val extends Addable< Val >, U extends Addable< U > >.Original< Val extends Addable< Val >, U extends Addable< U > >.handleCOSTmessage().

readExternal()

void frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.readExternal

(

ObjectInput

in

)

throws IOException, ClassNotFoundException

See also

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

Reimplemented from frodo2.communication.Message.

References readExternal().

Referenced by readExternal().

Here is the call graph for this function:

toString()

String frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.toString

(

)

See also

Message.toString()

Reimplemented from frodo2.communication.Message.

writeExternal()

void frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.writeExternal

(

ObjectOutput

out

)

throws IOException

See also

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

Reimplemented from frodo2.communication.Message.

Member Data Documentation

context

HashMap<String, Val> frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.context

private

The context in which this message was created.

Referenced by COSTmsg(), equals(), and getContext().

lb

U frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.lb

private

The upper bound.

Referenced by COSTmsg(), equals(), and getLB().

receiver

String frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.receiver

package

The receiving variable.

Referenced by COSTmsg(), equals(), and getReceiver().

sender

String frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.sender

private

The sending variable.

Referenced by COSTmsg(), equals(), and getSender().

serialVersionUID

final long frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.serialVersionUID = 2153239219905600645L

staticprivate

Use for serialization.

ub

U frodo2.algorithms.adopt.COSTmsg< Val extends Addable< Val >, U extends Addable< U > >.ub

private

The lower bound.

Referenced by COSTmsg(), equals(), and getUB().

---

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

• src/frodo2/algorithms/adopt/COSTmsg.java