frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > > Class Template Reference

A variable node in a factor graph. More...

Inheritance diagram for frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >:

Public Member Functions
	VariableNode (String varName, String agent, V[] dom)
	Constructor.
String	toString ()
void	addFunction (FunctionNode< V, U > function)
	Adds a function in which this variable is involved.
String	getVarName ()
V[]	getDom ()
ArrayList< FunctionNode< V, U > >	getFunctions ()
String	getAgent ()

Protected Attributes
final String	varName
	The name of this variable.
final V[]	dom
	The domain of the variable.

Private Attributes
final String	agent
	The agent that controls this variable node.
final ArrayList< FunctionNode< V, U > >	functions = new ArrayList< FunctionNode<V, U> > ()
	The functions this variable is involved in.

Detailed Description

A variable node in a factor graph.

Author

Thomas Leaute

Parameters

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

Constructor & Destructor Documentation

VariableNode()

frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.VariableNode	(	String	varName,
		String	agent,
		V[]	dom )

Constructor.

Parameters

varName	the variable name
agent	the agent controlling this variable node
dom	the variable domain

References agent, dom, and varName.

Member Function Documentation

addFunction()

void frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.addFunction

(

FunctionNode< V, U >

function

)

Adds a function in which this variable is involved.

Parameters

function

the function node

Referenced by frodo2.algorithms.varOrdering.factorgraph.FactorGraphGen< V extends Addable< V >, U extends Addable< U > >.notifyIn(), and frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.VarInfo.VarInfo().

getAgent()

String frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.getAgent

(

)

Returns

the agent controlling this variable node

References agent.

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

getDom()

V[] frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.getDom

(

)

Returns

The domain of the variable

References dom.

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

getFunctions()

ArrayList< FunctionNode< V, U > > frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.getFunctions

(

)

Returns

The functions this variable is involved in

References functions.

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

getVarName()

String frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.getVarName

(

)

Returns

The name of this variable

References varName.

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

toString()

String frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.toString

(

)

See also

java.lang.Object#toString()

Member Data Documentation

agent

final String frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.agent

private

The agent that controls this variable node.

Referenced by getAgent(), VariableNode(), and frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.VarInfo.VarInfo().

dom

final V [] frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.dom

protected

The domain of the variable.

Referenced by getDom(), VariableNode(), and frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.VarInfo.VarInfo().

functions

final ArrayList< FunctionNode<V, U> > frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.functions = new ArrayList< FunctionNode<V, U> > ()

private

The functions this variable is involved in.

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

varName

final String frodo2.algorithms.varOrdering.factorgraph.VariableNode< V extends Addable< V >, U extends Addable< U > >.varName

protected

The name of this variable.

Referenced by getVarName(), VariableNode(), and frodo2.algorithms.maxsum.MaxSum< V extends Addable< V >, U extends Addable< U > >.VarInfo.VarInfo().

---

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

• src/frodo2/algorithms/varOrdering/factorgraph/VariableNode.java