StatesSet (GINsim 3.0.0b-SNAPSHOT API)

java.lang.Object
- org.ginsim.core.graph.hierarchicaltransitiongraph.StatesSet

```
public class StatesSet
extends Object
```
A wrapper of OMDDNode that adds the essentials methods to store states.

Each path terminating with a value > 0 indicates the state is present in the set.
The value is used to indicates several status.

Working with the size

The value of the size attribute, that is the number of state inside the set, could be inconsistent.
When adding a state (or a merge several Omdds), there is no efficient way to know if the state is added or if it was already present.
In this class, the size is always incremented when we try to add a new state. Therefore the value of the size could be inconsistent, more precisely be an overapproximation of the real value
To cope with this problem, there is several methods to work with the size :
- public int isSizeConsistent() indicates if the size is consistent
- public int updateSize() count the current size, by exploring the whole diagram
- public int getSize() gives the size or INCONSISTENT_SIZE is the size is not consistent
- public int getSizeOrOverApproximation() gives the size no matter its consistency
- public int getSizeOrUpdate()gives the size and eventually update it before if needed
Author:

Duncan Berenguier

Field Summary

Fields
Modifier and Type Field and Description

static int INCONSISTENT_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`INCONSISTENT_SIZE`

Constructor Summary

Constructors
Constructor and Description
`StatesSet(org.colomoto.mddlib.MDDManager ddmanager, byte[] childsCount)` Initialize a new set of states
`StatesSet(org.colomoto.mddlib.MDDManager ddmanager, int mdd, byte[] childsCount)` Initialize a new set of states

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addState(byte[] state, int newStatus)` Add state to the set with status If the state was already there, the old status remains. NB: use updateStatus to change the status.
`void`	`addState(String state, int newStatus)` Add state to the set with status If the state was already there, the old status remains. NB: use updateStatus to change the status.
`void`	`addStates(List<byte[]> states)` Add states to the set with status 1 If the states were already there, their old status remains. NB: use updateStatus to change the status.
`StatesSet`	`clone()`
`boolean`	`contains(byte[] state)` Test if the set contains state that is, if its status is not 0
`StringBuffer`	`firstStatesToString()` Return a String representation of a state in the set (the first in the pile or the first reach in the omdd)
`byte[]`	`getChildsCount()` Return An array indicating such that childsCount[i] indicates the maxValue of the i-th gene
`int`	`getSize()` Gives the count of states in the diagram or INCONSISTENT_SIZE if the size is in inconsistent state.
`int`	`getSizeOrOverApproximation()` Gives the count of states in the diagram or its overapproximation if the size is in inconsistent state.
`int`	`getSizeOrUpdate()` Gives the count of states in the diagram. If the size is in inconsistent state, then call `updateSize()` before.
`boolean`	`isSizeConsistent()` Indicates if the size is in a consistent state, that is if it really reflect the number of state in the set, or only an overapproximation.
`void`	`merge(StatesSet slaveNodeStateSet)` Merge this set with the stateSet of the slaveNode.
`void`	`parse(String parse)`
`int`	`stateFromArray(byte[] state)` Generate a new omdd corresponding to the state and with the status 1
`int`	`stateFromArray(byte[] state, int status)` Generate a new omdd corresponding to the state and with the status status
`int`	`stateFromString(String state)` Generate a new omdd corresponding to the state and with the status 1
`int`	`stateFromString(String str_state, int status)` Generate a new omdd corresponding to the state and with the status 1>
`List<byte[]>`	`statesToFullList()`
`void`	`statesToFullList(List<byte[]> v)` Fill a list with all the states in the omdd Each item of the returned list is a string representation using wildcard * (-1).
`List<byte[]>`	`statesToSchemaList()` Initialize and fill a list with all the states in the omdd Each item of the returned list is a string representation using wildcard * (-1).
`void`	`statesToSchemaList(List<byte[]> v)` Fill a list with all the states in the omdd Each item of the returned list is a string representation using wildcard * (-1).
`StringBuffer`	`statesToString(boolean addValue)` Return a String representation of the omdd
`int[]`	`updateSize()` Count the number of states in the Omdd and update the size accordingly
`boolean`	`updateStatus(byte[] state, int newStatus)` Change the status associated of state in the set to newStatus
`String`	`write()` Return a parenthesis based representation of the MDD

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

- Field Detail
  - INCONSISTENT_SIZE
```
public static final int INCONSISTENT_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StatesSet
```
public StatesSet(org.colomoto.mddlib.MDDManager ddmanager,
                 byte[] childsCount)
```
    Initialize a new set of states
  - StatesSet
```
public StatesSet(org.colomoto.mddlib.MDDManager ddmanager,
                 int mdd,
                 byte[] childsCount)
```
    Initialize a new set of states
- Method Detail
  - clone
```
public StatesSet clone()
```
    Overrides:
    
    clone in class Object
  - addState
```
public void addState(byte[] state,
                     int newStatus)
```
    Add state to the set with status
    If the state was already there, the old status remains.
    NB: use updateStatus to change the status.
    
    Parameters:
    
    state -
    
    newStatus -
  - addState
```
public void addState(String state,
                     int newStatus)
```
    Add state to the set with status
    If the state was already there, the old status remains.
    NB: use updateStatus to change the status.
    
    Parameters:
    
    state -
    
    newStatus -
  - addStates
```
public void addStates(List<byte[]> states)
```
    Add states to the set with status 1
    If the states were already there, their old status remains.
    NB: use updateStatus to change the status.
    
    Parameters:
    
    states, - a List<byte[]> of states to add
  - merge
```
public void merge(StatesSet slaveNodeStateSet)
```
    Merge this set with the stateSet of the slaveNode.
    
    Parameters:
    
    slaveNodeStateSet -
  - updateSize
```
public int[] updateSize()
```
    Count the number of states in the Omdd and update the size accordingly
    
    Returns:
    
    an array indiced by the status and counting the number of state per status
  - isSizeConsistent
```
public boolean isSizeConsistent()
```
    Indicates if the size is in a consistent state, that is if it really reflect the number of state in the set, or only an overapproximation.
    
    Returns:
    
    true if size is equal to the exact count of state in the set.
  - getSize
```
public int getSize()
```
    Gives the count of states in the diagram or INCONSISTENT_SIZE if the size is in inconsistent state.
    
    Returns:
    
    the count of states in the set or INCONSISTENT_SIZE
  - getSizeOrOverApproximation
```
public int getSizeOrOverApproximation()
```
    Gives the count of states in the diagram or its overapproximation if the size is in inconsistent state.
    
    Returns:
    
    the count of states in the set
  - getSizeOrUpdate
```
public int getSizeOrUpdate()
```
    Gives the count of states in the diagram.
    If the size is in inconsistent state, then call updateSize() before.
    
    Note that by calling this function, you will not be able to retrieve the count of state per status.
    
    Returns:
    
    the count of states in the set
  - contains
```
public boolean contains(byte[] state)
```
    Test if the set contains state that is, if its status is not 0
    
    Parameters:
    
    state -
    
    Returns:
    
    true if the set contains state
  - updateStatus
```
public boolean updateStatus(byte[] state,
                            int newStatus)
```
    Change the status associated of state in the set to newStatus
    Parameters:
    
    state -
    
    newStatus -
    
    Returns:
    true if the status is changed or was already equal to newStatus.
    
    false if the state wasn't in the set.
  - stateFromArray
```
public int stateFromArray(byte[] state)
```
    Generate a new omdd corresponding to the state and with the status 1
    
    Parameters:
    
    state - the state to generate
    
    Returns:
    
    the omdd
  - stateFromArray
```
public int stateFromArray(byte[] state,
                          int status)
```
    Generate a new omdd corresponding to the state and with the status status
    
    Parameters:
    
    state - the state to generate
    
    status - the value to append at the leaf.
    
    Returns:
    
    the omdd
  - stateFromString
```
public int stateFromString(String state)
```
    Generate a new omdd corresponding to the state and with the status 1
    
    Parameters:
    
    state - the state to generate
    
    Returns:
    
    the omdd
  - stateFromString
```
public int stateFromString(String str_state,
                           int status)
```
    Generate a new omdd corresponding to the state and with the status 1>
    
    Parameters:
    
    str_state - the state to generate
    
    Returns:
    
    the omdd
  - getChildsCount
```
public byte[] getChildsCount()
```
    Return An array indicating such that childsCount[i] indicates the maxValue of the i-th gene
    
    Use :
```
        int countChilds = childsCount[level];
        for (int i = 0; i < countChilds; i++) {
                ....omdd.next[i]....
 
```
    Returns:
    
    the ChildsCount array
  - statesToSchemaList
```
public List<byte[]> statesToSchemaList()
```
    Initialize and fill a list with all the states in the omdd Each item of the returned list is a string representation using wildcard * (-1). Note the order in the list is relative to the omdd structure.
    
    Returns:
    
    a list made of all the states as schemata (using *)
  - statesToSchemaList
```
public void statesToSchemaList(List<byte[]> v)
```
    Fill a list with all the states in the omdd Each item of the returned list is a string representation using wildcard * (-1). Note the order in the list is relative to the omdd structure.
  - statesToFullList
```
public List<byte[]> statesToFullList()
```
  - statesToFullList
```
public void statesToFullList(List<byte[]> v)
```
    Fill a list with all the states in the omdd Each item of the returned list is a string representation using wildcard * (-1). Note the order in the list is relative to the omdd structure.
  - write
```
public String write()
```
    Return a parenthesis based representation of the MDD
  - statesToString
```
public StringBuffer statesToString(boolean addValue)
```
    Return a String representation of the omdd
  - firstStatesToString
```
public StringBuffer firstStatesToString()
```
    Return a String representation of a state in the set (the first in the pile or the first reach in the omdd)
  - parse
```
public void parse(String parse)
           throws SAXException
```
    Throws:
    
    SAXException

Class StatesSet

Working with the size

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

INCONSISTENT_SIZE

Constructor Detail

StatesSet

StatesSet

Method Detail

clone

addState

addState

addStates

merge

updateSize

isSizeConsistent

getSize

getSizeOrOverApproximation

getSizeOrUpdate

contains

updateStatus

stateFromArray

stateFromArray

stateFromString

stateFromString

getChildsCount

statesToSchemaList

statesToSchemaList

statesToFullList

statesToFullList

write

statesToString

firstStatesToString

parse