MDDManagerProxy (MDD manipulation toolkit 0.4.1 API)

java.lang.Object
- org.colomoto.mddlib.internal.MDDManagerProxy

All Implemented Interfaces:

MDDManager
```
public class MDDManagerProxy
extends Object
implements MDDManager
```
MDDManager adding a custom order on top of an existing MDDStore. It acts mostly as proxy to the actual store but provides a uniform API. It should be created through the getProxy method. For convenience, MDDManager offers a wrapper method: getManager().

Author:

Aurelien Naldi

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean[]`	`collectDecisionVariables(int node)` Collect variables on which a MDD depends.
`String`	`dumpMDD(int node)` Write a raw text representation of the MDD
`MDDVariable`	`ensureVariable(Object key, byte nbval)` get a variable, create it if needed.
`void`	`free(int pos)` Free a node.
`MDDVariable[]`	`getAllVariables()` Get all MDDVariables in this manager.
`int`	`getChild(int node, int value)` Get a specific child for a node.
`int[]`	`getChildren(int node)` Get all the children of a given node.
`int`	`getLeafCount()` Get the number of leaves
`MDDManager`	`getManager(List<?> order)` Get a new manager for this MDD Store, using a custom variable order.
`VariableEffect[]`	`getMultivaluedVariableEffect(MDDVariable var, int node)` Determine the effect of a given variable on a MDD.
`int`	`getNodeCount()`
`MDDVariable`	`getNodeVariable(int n)` Get the variable associated to a given node.
`static MDDManager`	`getProxy(MDDStore store, List<?> customOrder)`
`NodeRelation`	`getRelation(int first, int other)` Determine the relation between two nodes.
`int`	`getSign(int node, MDDVariable pivot)` Infer the effect of a variable in a given MDD.
`VariableEffect`	`getVariableEffect(MDDVariable var, int node)` Determine the effect of a given variable on a MDD.
`MDDVariable`	`getVariableForKey(Object key)` Get the MDDVariable associated to a given key.
`int`	`getVariableIndex(MDDVariable var)` Get the position of a given variable in this manager's list of variables.
`byte`	`groupReach(int node, byte[] values)` Get the value reached by a group of paths.
`boolean`	`isleaf(int node)`
`boolean`	`isView(MDDManager ddm)`
`int`	`mnot(int node, int v)` Multi-valued not: flip leaves 0 and v.
`int`	`nodeFromState(byte[] state, int value)` Create a MDD representing a state.
`int`	`nodeFromStates(Collection<byte[]> states, int value)` Create a MDD representing a group of states.
`int`	`not(int node)` Logical not, performed by flipping leaves 0 and 1.
`int`	`parseDump(String s)` Create a MDD from a dumped structure
`byte`	`reach(int node, byte[] values)` Find the leaf reached for a given variable assignment
`int`	`use(int node)` Mark a node as used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getProxy
```
public static MDDManager getProxy(MDDStore store,
                                  List<?> customOrder)
```
  - reach
```
public byte reach(int node,
                  byte[] values)
```
    Description copied from interface: MDDManager
    
    Find the leaf reached for a given variable assignment
    
    Specified by:
    
    reach in interface MDDManager
    
    Returns:
    
    the leaf reached for this assignment
  - groupReach
```
public byte groupReach(int node,
                       byte[] values)
```
    Description copied from interface: MDDManager
    
    Get the value reached by a group of paths.
    
    Specified by:
    
    groupReach in interface MDDManager
    
    Returns:
    
    the leaf reached for this assignment
  - getVariableForKey
```
public MDDVariable getVariableForKey(Object key)
```
    Description copied from interface: MDDManager
    
    Get the MDDVariable associated to a given key.
    
    Specified by:
    
    getVariableForKey in interface MDDManager
    
    Returns:
    
    the associated MDDVariable
  - nodeFromState
```
public int nodeFromState(byte[] state,
                         int value)
```
    Description copied from interface: MDDManager
    
    Create a MDD representing a state.
    
    Specified by:
    
    nodeFromState in interface MDDManager
    
    Returns:
  - nodeFromStates
```
public int nodeFromStates(Collection<byte[]> states,
                          int value)
```
    Description copied from interface: MDDManager
    
    Create a MDD representing a group of states.
    
    Specified by:
    
    nodeFromStates in interface MDDManager
    
    Returns:
  - getVariableIndex
```
public int getVariableIndex(MDDVariable var)
```
    Description copied from interface: MDDManager
    
    Get the position of a given variable in this manager's list of variables.
    
    Specified by:
    
    getVariableIndex in interface MDDManager
    
    Returns:
    
    the position in getAllVariables().
  - getAllVariables
```
public MDDVariable[] getAllVariables()
```
    Description copied from interface: MDDManager
    
    Get all MDDVariables in this manager.
    
    Specified by:
    
    getAllVariables in interface MDDManager
    
    Returns:
    
    the ordered list of available MDDVariables.
  - ensureVariable
```
public MDDVariable ensureVariable(Object key,
                                  byte nbval)
```
    Description copied from interface: MDDManager
    
    get a variable, create it if needed.
    
    Specified by:
    
    ensureVariable in interface MDDManager
    
    Returns:
  - getManager
```
public MDDManager getManager(List<?> order)
```
    Description copied from interface: MDDManager
    
    Get a new manager for this MDD Store, using a custom variable order. The new manager will use the same MDDStore as backend: it is just a different view of the same MDD dataset.
    
    Specified by:
    
    getManager in interface MDDManager
    
    Parameters:
    
    order - requested variable order.
    
    Returns:
    
    a new manager (this if the order is the same)
  - getNodeVariable
```
public MDDVariable getNodeVariable(int n)
```
    Description copied from interface: MDDManager
    
    Get the variable associated to a given node.
    
    Specified by:
    
    getNodeVariable in interface MDDManager
    
    Parameters:
    
    n - the node ID
    
    Returns:
    
    the variable of null if the node is a leaf.
  - free
```
public void free(int pos)
```
    Description copied from interface: MDDManager
    
    Free a node. If it is not used at all anymore, it will be removed from the data structure.
    This should be used for each node id that was obtained through one of the get_?node() method, or for the one explicitly marked as used.
    Note that the space will be made available for new nodes, but it will NOT be returned to the garbage collector.
    
    Specified by:
    
    free in interface MDDManager
    
    See Also:
    
    use(int), get_bnode(int, int, int), get_mnode(int, int[])
  - use
```
public int use(int node)
```
    Description copied from interface: MDDManager
    
    Mark a node as used. This is done automatically when creating or reusing a node. In most cases, manually calling this should not be necessary. If you do call it, remember to call free(int) when you release it.
    
    Specified by:
    
    use in interface MDDManager
    
    Returns:
    
    the ID of the node (yes, the same as the parameter, just as convenience)
  - isleaf
```
public boolean isleaf(int node)
```
    Specified by:
    
    isleaf in interface MDDManager
    
    Parameters:
    
    node - the ID of the tested node.
    
    Returns:
    
    true if id denotes a leaf in this manager
  - getChild
```
public int getChild(int node,
                    int value)
```
    Description copied from interface: MDDManager
    
    Get a specific child for a node. Note: the child is not counted as used, do not free it (or call manager.use() before)
    
    Specified by:
    
    getChild in interface MDDManager
    
    Parameters:
    
    node - id of a node
    
    value - assignment value
    
    Returns:
    
    the id of the child node reached when assigning this value to the variable of the provided node.
  - getChildren
```
public int[] getChildren(int node)
```
    Description copied from interface: MDDManager
    
    Get all the children of a given node. Node: this will create a new array to hold the children. Children are not counted as used, do not free them (or call manager.use() before)
    
    Specified by:
    
    getChildren in interface MDDManager
    
    Returns:
    
    an array holding all the children, or null if it is a leaf.
  - not
```
public int not(int node)
```
    Description copied from interface: MDDManager
    
    Logical not, performed by flipping leaves 0 and 1.
    
    Specified by:
    
    not in interface MDDManager
    
    Returns:
    
    the ID of the flipped MDD root
  - mnot
```
public int mnot(int node,
                int v)
```
    Description copied from interface: MDDManager
    
    Multi-valued not: flip leaves 0 and v.
    
    Specified by:
    
    mnot in interface MDDManager
    
    v - the positive value
    
    Returns:
  - getRelation
```
public NodeRelation getRelation(int first,
                                int other)
```
    Description copied from interface: MDDManager
    
    Determine the relation between two nodes. Mainly used by operators to select the appropriate code path.
    
    Specified by:
    
    getRelation in interface MDDManager
    
    Returns:
    
    an NodeRelation value denoting which node is a leaf or has the highest ranked variable
  - getNodeCount
```
public int getNodeCount()
```
    Specified by:
    
    getNodeCount in interface MDDManager
    
    Returns:
    
    the number of non-leaf nodes stored in the manager.
  - getLeafCount
```
public int getLeafCount()
```
    Description copied from interface: MDDManager
    
    Get the number of leaves
    
    Specified by:
    
    getLeafCount in interface MDDManager
    
    Returns:
    
    the number of possible leaves (i.e. max leaf index)
  - getSign
```
public int getSign(int node,
                   MDDVariable pivot)
```
    Description copied from interface: MDDManager
    
    Infer the effect of a variable in a given MDD.
    
    Specified by:
    
    getSign in interface MDDManager
    
    Parameters:
    
    node - the MDD
    
    pivot - the variable of interest
    
    Returns:
    
    0 for no effect, 1 for positive effect, -1 for negative effect or 2 for dual effect
  - collectDecisionVariables
```
public boolean[] collectDecisionVariables(int node)
```
    Description copied from interface: MDDManager
    
    Collect variables on which a MDD depends.
    
    Specified by:
    
    collectDecisionVariables in interface MDDManager
    
    Returns:
    
    a boolean array indicating for each variable if it affects the given MDD.
  - getVariableEffect
```
public VariableEffect getVariableEffect(MDDVariable var,
                                        int node)
```
    Description copied from interface: MDDManager
    
    Determine the effect of a given variable on a MDD. To find variables of interest, use collectDecisionVariables(node).
    
    Specified by:
    
    getVariableEffect in interface MDDManager
    
    Returns:
    
    the effect of this variable.
  - getMultivaluedVariableEffect
```
public VariableEffect[] getMultivaluedVariableEffect(MDDVariable var,
                                                     int node)
```
    Description copied from interface: MDDManager
    
    Determine the effect of a given variable on a MDD. To find variables of interest, use collectDecisionVariables(node).
    
    Specified by:
    
    getMultivaluedVariableEffect in interface MDDManager
    
    Returns:
    
    the effects of each level switch for this variable
  - isView
```
public boolean isView(MDDManager ddm)
```
    Specified by:
    
    isView in interface MDDManager
  - dumpMDD
```
public String dumpMDD(int node)
```
    Description copied from interface: MDDManager
    
    Write a raw text representation of the MDD
    
    Specified by:
    
    dumpMDD in interface MDDManager
    
    Returns:
    
    a string representing the MDD structure
  - parseDump
```
public int parseDump(String s)
              throws ParseException
```
    Description copied from interface: MDDManager
    
    Create a MDD from a dumped structure
    
    Specified by:
    
    parseDump in interface MDDManager
    
    Parameters:
    
    s - the string representing the MDD structure
    
    Returns:
    
    the corresponding MDD
    
    Throws:
    
    ParseException

Class MDDManagerProxy

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getProxy

reach

groupReach

getVariableForKey

nodeFromState

nodeFromStates

getVariableIndex

getAllVariables

ensureVariable

getManager

getNodeVariable

free

use

isleaf

getChild

getChildren

not

mnot

getRelation

getNodeCount

getLeafCount

getSign

collectDecisionVariables

getVariableEffect

getMultivaluedVariableEffect

isView

dumpMDD

parseDump