StateSet (GINsim 3.0.0b-SNAPSHOT API)

java.lang.Object
- org.ginsim.service.tool.avatar.domain.AbstractStateSet
- - org.ginsim.service.tool.avatar.domain.StateSet

```
public class StateSet
extends AbstractStateSet
```
Default representation of a state-set recurring to a hash-map of states
States are efficiently stored and accessed using minimal keys

Version:

1.0

Author:

Rui Henriques

Constructor Summary

Constructors
Constructor and Description
`StateSet()` Creates an empty state-set
`StateSet(List<byte[]> successors)` Creates a state-set with the given list of states
`StateSet(List<byte[]> successors, double p)` Creates a state-set with the given list of states and their probability of occurrence
`StateSet(State s)` Creates a state-set with the given state
`StateSet(StateSet _states)` Clones a given state-set

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(State s)` Adds a state to the given state-set
`void`	`addAll(StateSet set)` Adds a set of states to the state-set
`void`	`addCumulative(State s)` Adds a state to the state-set (whenever the given state is already present within the state-set, the probability of the state to be inserted is added to the original state in the state-set)
`boolean`	`contains(State state)` Checks whether a given state is contained in the state-set
`boolean`	`contains(String key)` Checks whether a given state (based on its key) is in the state-set
`StateSet`	`getExitStateSet()` Returns the states accessible from the state-set
`State`	`getFirstState()` Accesses the first state in the state-set (useful to iterate and remove)
`Collection<String>`	`getKeys()` Returns a collection with the keys of the states in the state-set
`double`	`getProbability(State s)` Returns the probability of a given state in the state-set
`State`	`getProbableExitState(State s)` Randomly accesses a probable exit state from a given state in the state-set
`State`	`getProbableRandomState()` Selects a state by adequately considering the probabilities of the states in the state-set
`State`	`getState(String sKey)` Returns a state given its key
`Collection<State>`	`getStates()` Returns a collection with the states in the state-set
`State`	`getUniformRandomState()` Selects a state assuming an uniform distribution of the probabilities of the states in the state-set
`boolean`	`hasExits()`
`boolean`	`hasOverlapping(StateSet set)` Checks whether two state-sets share states
`boolean`	`hasPaths()`
`boolean`	`isEmpty()` Checks whether the state-set has states
`void`	`remove(State s)` Removes a given state from the state-set
`void`	`setExitStates(StateSet exit)` Stores the set of reachable states from the current state-set
`void`	`setProbPaths(FinalPaths exit)` Stores the set of outgoing transitions from the current state-set
`int`	`size()` Returns the number of states in the state-set
`String`	`toLongString()` Detailed description of the states in the state-set as a String object
`String`	`toString()`
`double`	`totalProbability()` Sums the probability of all of the internal states

Methods inherited from class org.ginsim.service.tool.avatar.domain.AbstractStateSet
getKey, setKey

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

- Constructor Detail
  - StateSet
```
public StateSet()
```
    Creates an empty state-set
  - StateSet
```
public StateSet(State s)
```
    Creates a state-set with the given state
    
    Parameters:
    
    s - state to be enclosed within the state-set
  - StateSet
```
public StateSet(List<byte[]> successors)
```
    Creates a state-set with the given list of states
    
    Parameters:
    
    successors - states to be included in the new state-set
  - StateSet
```
public StateSet(List<byte[]> successors,
                double p)
```
    Creates a state-set with the given list of states and their probability of occurrence
    
    Parameters:
    
    successors - states to be included in the new state-set
    
    p - probability associated with each of the given set of states (between 0 and 1)
  - StateSet
```
public StateSet(StateSet _states)
```
    Clones a given state-set
    
    Parameters:
    
    _states - the states to be included in the cloned state-set
- Method Detail
  - getState
```
public State getState(String sKey)
```
    Returns a state given its key
    
    Parameters:
    
    sKey - the key of the desirable state
    
    Returns:
    
    the state associated with a given key (null if there is no state in the state-set with the given key)
  - add
```
public void add(State s)
```
    Adds a state to the given state-set
    
    Parameters:
    
    s - the state to be added
  - addCumulative
```
public void addCumulative(State s)
```
    Adds a state to the state-set (whenever the given state is already present within the state-set, the probability of the state to be inserted is added to the original state in the state-set)
    
    Parameters:
    
    s - the state to be added
  - addAll
```
public void addAll(StateSet set)
```
    Adds a set of states to the state-set
    
    Parameters:
    
    set - the set of states to be added
  - hasOverlapping
```
public boolean hasOverlapping(StateSet set)
```
    Checks whether two state-sets share states
    
    Parameters:
    
    set - the state-set to be compared
    
    Returns:
    
    true if the two states share one or more states
  - isEmpty
```
public boolean isEmpty()
```
    Checks whether the state-set has states
    
    Returns:
    
    true if the state-set has one or more states
  - contains
```
public boolean contains(State state)
```
    Description copied from class: AbstractStateSet
    
    Checks whether a given state is contained in the state-set
    
    Specified by:
    
    contains in class AbstractStateSet
    
    Parameters:
    
    state - state to be checked
    
    Returns:
    
    true if the given state is contained in the state-set
  - contains
```
public boolean contains(String key)
```
    Checks whether a given state (based on its key) is in the state-set
    
    Parameters:
    
    key - identifier of the state to be checked
    
    Returns:
    
    true if the given state (based on its key) is in the state-set
  - size
```
public int size()
```
    Returns the number of states in the state-set
    
    Specified by:
    
    size in class AbstractStateSet
    
    Returns:
    
    number of states in the state-set
  - getStates
```
public Collection<State> getStates()
```
    Returns a collection with the states in the state-set
    
    Returns:
    
    states in the state-set
  - getKeys
```
public Collection<String> getKeys()
```
    Returns a collection with the keys of the states in the state-set
    
    Specified by:
    
    getKeys in class AbstractStateSet
    
    Returns:
    
    keys of the states in the state-set
  - getFirstState
```
public State getFirstState()
```
    Accesses the first state in the state-set (useful to iterate and remove)
    
    Returns:
    
    the first state in the state-set
  - getUniformRandomState
```
public State getUniformRandomState()
```
    Selects a state assuming an uniform distribution of the probabilities of the states in the state-set
    
    Returns:
    
    a randomly selected state
  - getProbableRandomState
```
public State getProbableRandomState()
```
    Selects a state by adequately considering the probabilities of the states in the state-set
    
    Returns:
    
    a probable state randomly selected according to the probabilities of the states in the state-set
  - getProbability
```
public double getProbability(State s)
```
    Returns the probability of a given state in the state-set
    
    Parameters:
    
    s - the state whose probability is to be checked
    
    Returns:
    
    the probability of the given state in the state-set
  - totalProbability
```
public double totalProbability()
```
    Sums the probability of all of the internal states
    
    Returns:
  - remove
```
public void remove(State s)
```
    Removes a given state from the state-set
    
    Parameters:
    
    v - the state to be removed from the state-set
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toLongString
```
public String toLongString()
```
    Detailed description of the states in the state-set as a String object
    
    Returns:
    
    detailed description of the states in the state-set
  - setProbPaths
```
public void setProbPaths(FinalPaths exit)
```
    Stores the set of outgoing transitions from the current state-set
    
    Parameters:
    
    exit - the set of outgoing transitions from the current state-set
  - hasExits
```
public boolean hasExits()
```
  - hasPaths
```
public boolean hasPaths()
```
  - getExitStateSet
```
public StateSet getExitStateSet()
```
    Returns the states accessible from the state-set
    
    Returns:
    
    states accessible from the state-set
    
    See Also:
    
    setExitStates
  - setExitStates
```
public void setExitStates(StateSet exit)
```
    Stores the set of reachable states from the current state-set
    
    Parameters:
    
    exit - the set of states accessible from the current state-set
  - getProbableExitState
```
public State getProbableExitState(State s)
```
    Randomly accesses a probable exit state from a given state in the state-set
    
    Parameters:
    
    s - state in the state-set
    
    Returns:
    
    a probable exit state selected according to its reachability

Class StateSet

Constructor Summary

Method Summary

Methods inherited from class org.ginsim.service.tool.avatar.domain.AbstractStateSet

Methods inherited from class java.lang.Object

Constructor Detail

StateSet

StateSet

StateSet

StateSet

StateSet

Method Detail

getState

add

addCumulative

addAll

hasOverlapping

isEmpty

contains

contains

size

getStates

getKeys

getFirstState

getUniformRandomState

getProbableRandomState

getProbability

totalProbability

remove

toString

toLongString

setProbPaths

hasExits

hasPaths

getExitStateSet

setExitStates

getProbableExitState