org.colomoto.mddlib

Class MDDVariable

java.lang.Object

org.colomoto.mddlib.MDDVariable

public class MDDVariable
extends Object

Definition of a multi-valued variable used in a MDDManager. This class is also used to retrieve (or create) nodes associated to the variable.

A variable has a name, an optional associated object and set of possible values. For the sake of simplicity, only the number of possible values is defined, the MDD manager will use the integer range [0..nbval[.

A Boolean variable uses 2 values and will be mapped to the [0,1] interval.
A ternary variable uses 3 values and will be mapped to the [0,2] interval.

If your variable can take another set of values, it is your responsibility to map them to the [0..nbval[ interval.

Author:

Aurelien Naldi

Field Summary

Fields

Modifier and Type	Field and Description
Object	key Key used to create the variable.
byte	nbval Number of possible values for this variable.
int	order Rank of this variable in the MDDmanager.

Constructor Summary

Constructors

Constructor and Description
MDDVariable(MDDStore store, int order, Object key, byte nbval)

Method Summary

Modifier and Type	Method and Description
boolean	after(MDDVariable other) Test if this variable comes after another variable.
boolean	equals(Object other)
int	getNode(int[] children) Get a multi-valued node.
int	getNode(int f, int t) get a boolean node.
int	getNodeForValue(int v, int value)
int	getNodeFree(int[] children) Get a node and release the provided children.
int	getNodeFree(int f, int t) Get a Boolean node and release the provided children.
int	getSimpleNode(int vfalse, int vtrue, int start, int end) Get a node for the specified variable with two different children: a "true" child in the specified range and a "false" one outside.
int	hashCode()
static MDDVariable	selectFirstVariable(MDDVariable v1, MDDVariable v2) Get the variable with the best priority.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

key

public final Object key

Key used to create the variable. It is used to show the variable name.

nbval

public final byte nbval

Number of possible values for this variable. it must be at least 2.

order

public final int order

Rank of this variable in the MDDmanager. Ranks should be unique and provided by the MDD store.

Constructor Detail

MDDVariable

public MDDVariable(MDDStore store,
                   int order,
                   Object key,
                   byte nbval)

Method Detail

getNodeForValue

public int getNodeForValue(int v,
                           int value)

getNode

public int getNode(int f,
                   int t)

get a boolean node. It will be created if needed The resulting ID should be freed when it stopped being used.

Parameters:

f - left child (false)

t - right child (true)

Returns:

the ID of the node

getNode

public int getNode(int[] children)

Get a multi-valued node. It will be created if needed. The resulting ID should be freed when it stopped being used.

Parameters:

children -

Returns:

the ID of the node

getNodeFree

public int getNodeFree(int f,
                       int t)

Get a Boolean node and release the provided children.

Parameters:

f -

t -

Returns:

the ID of the node

See Also:

getNode(int, int)

getNodeFree

public int getNodeFree(int[] children)

Get a node and release the provided children.

Parameters:

children -

Returns:

the ID of the node

See Also:

getNode(int[])

getSimpleNode

public int getSimpleNode(int vfalse,
                         int vtrue,
                         int start,
                         int end)

Get a node for the specified variable with two different children: a "true" child in the specified range and a "false" one outside.

Parameters:

vfalse - the "false" child

vtrue - the "true" child

start - the start of the "true" range

end - the end of the "true" range

Returns:

a MDD ID.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Overrides:

equals in class Object

after

public boolean after(MDDVariable other)

Test if this variable comes after another variable.

Parameters:

other -

Returns:

true if this variable has a lower priority than the other

selectFirstVariable

public static MDDVariable selectFirstVariable(MDDVariable v1,
                                              MDDVariable v2)

Get the variable with the best priority.

Parameters:

v1 -

v2 -

Returns:

the variable with the best priority

toString

public String toString()

Overrides:

toString in class Object