State (Syntax Compiler-Compiler 4.2.0 API)

java.lang.Object
- me.jaimegarza.syntax.model.parser.State

```
public class State
extends Object
```
~pojo class

A grammar G is defined as a set {N, T, Σ ∈ N, R}
- n_i ∈ N is the set of NonTerminal symbols
- t_i ∈ T is the set of Terminal symbols
- Σ ∈ N, is the "distinguished symbol", or the root of the grammar
- R is the set of Rules of the form
```
    α → β
```
  where:
  α ∈ N
  β is a repetition of zero or many symbols s_i; ∈ N ∪ T
A parser P is defined as a set {I, A, Γ, E}
```
   P = (N ∪ T) × I
```
- i_i ∈ I is the mapping set of states that identify the FSA of the parser.
  
  A state i_i contains a set A^' ⊆ A and a set Γ^' ⊆ Γ for its particular set of actions and gotos. It also contains e_i or ∅ as the error that this state reports on an error.
- a_i ∈ A is the subset ⊆ T × I of all a Actions or state transitions.
  An action a_i is a pair (t ∈ T, i ∈ I) that maps a state to another via terminal t on a Shift action.
  
  s_j = A(t, s_i)
- γ_i ∈ Γ is the subset ⊆ N × I of GoTos.
  A GoTo γ_i is a pair (n ∈ N, i ∈ I) that maps a state to another state via non-terminal n on the final state of a Reduce action.
  
  s_j = Γ(n, s_i)
- e_i ∈ E is the set of errors that can be emitted by the grammar
Additionally, the closure of a dot -- where χ ∈ N ∪ T and β ∈ (N ∪ T)* -- is defined as

closure(n_i → α . χβ) =
1. ∅ if χ ∈ T or ¬∃χβ; or
2. {χ → . δ; ∀ χ ∈ N} | χ → δ ∈ R
For generation purposes i_i is augmented with
from ∈ I
symbol ∈ N ∪ T
default ∈ A
review ∈ {true, false}
dot_i is a pair (r_i ∈ R, pos ∈ Int ≤ |r_i|), where |r_i| is the number of items in a rule r_i
Author:

jaimegarza@gmail.com

Constructor Summary

Constructors
Constructor and Description

State(int id, int from, Symbol symbol)
Construct a state

Constructors
Constructor and Description
`State(int id, int from, Symbol symbol)` Construct a state

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAllClosureDots(List<Dot> dots)` Merge all dots into this objects closure dots.
`void`	`addAllKernelDots(List<Dot> dots)` Merge all dots into this objects kernel dots.
`void`	`addClosureDot(Dot dot)` Add a dot to the closure dot set
`void`	`addKernelDot(Dot dot)` Add a dot to the kernel dot set
`boolean`	`equals(Object obj)`
`List<Action>`	`getActions()`
`int`	`getActionSize()`
`List<Dot>`	`getAllDots()`
`List<Dot>`	`getClosureDots()`
`int`	`getDefaultValue()`
`Dot`	`getDot(int i)`
`int`	`getFrom()`
`int`	`getId()`
`List<Dot>`	`getKernelDots()`
`int`	`getMessage()`
`int`	`getPosition()`
`int[]`	`getRow()`
`Symbol`	`getSymbol()`
`int`	`getSymbolId()` Convenience method to get the id of the originating symbol
`boolean`	`isReview()`
`void`	`setActions(List<Action> actions)`
`void`	`setDefaultValue(int defaultValue)`
`void`	`setFrom(int from)`
`void`	`setId(int id)`
`void`	`setMessage(int message)`
`void`	`setPosition(int position)`
`void`	`setReview(boolean review)`
`void`	`setRow(int[] row)`
`void`	`setSymbol(Symbol symbol)`
`String`	`toString()` Returns a representation of the state (all its rules and dots) with additional information of what is this state's origin (what state this is coming from, and with what symbol)

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

- Constructor Detail
  - State
```
public State(int id,
             int from,
             Symbol symbol)
```
    Construct a state
    
    Parameters:
    
    id - the id of the state
    
    from - the state that originated the new state
    
    symbol - the symbol that was followed to reach this state
- Method Detail
  - getSymbolId
```
public int getSymbolId()
```
    Convenience method to get the id of the originating symbol
    
    Returns:
    
    the id of the symbol
  - getKernelDots
```
public List<Dot> getKernelDots()
```
    Returns:
    
    only the kernel dots
  - getClosureDots
```
public List<Dot> getClosureDots()
```
    Returns:
    
    only the kernel dots
  - getAllDots
```
public List<Dot> getAllDots()
```
    Returns:
    
    only the kernel dots
  - getDot
```
public Dot getDot(int i)
```
    Parameters:
    
    i - the index
    
    Returns:
    
    a dot in with the given index
  - addKernelDot
```
public void addKernelDot(Dot dot)
```
    Add a dot to the kernel dot set
    
    Parameters:
    
    dot - the dot to be added
  - addClosureDot
```
public void addClosureDot(Dot dot)
```
    Add a dot to the closure dot set
    
    Parameters:
    
    dot - the dot to be added
  - addAllKernelDots
```
public void addAllKernelDots(List<Dot> dots)
```
    Merge all dots into this objects kernel dots.
    
    Parameters:
    
    dots - is the list of dots to merge from
  - addAllClosureDots
```
public void addAllClosureDots(List<Dot> dots)
```
    Merge all dots into this objects closure dots.
    
    Parameters:
    
    dots - is the list of dots to merge from
  - getId
```
public int getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(int id)
```
    Parameters:
    
    id - the id to set
  - isReview
```
public boolean isReview()
```
    Returns:
    
    the review
  - setReview
```
public void setReview(boolean review)
```
    Parameters:
    
    review - the review to set
  - getFrom
```
public int getFrom()
```
    Returns:
    
    the from
  - setFrom
```
public void setFrom(int from)
```
    Parameters:
    
    from - the from to set
  - getSymbol
```
public Symbol getSymbol()
```
    Returns:
    
    the symbol
  - setSymbol
```
public void setSymbol(Symbol symbol)
```
    Parameters:
    
    symbol - the symbol to set
  - getDefaultValue
```
public int getDefaultValue()
```
    Returns:
    
    the defaultValue
  - setDefaultValue
```
public void setDefaultValue(int defaultValue)
```
    Parameters:
    
    defaultValue - the defaultValue to set
  - getActions
```
public List<Action> getActions()
```
    Returns:
    
    the actions
  - setActions
```
public void setActions(List<Action> actions)
```
    Parameters:
    
    actions - the actions to set
  - getPosition
```
public int getPosition()
```
    Returns:
    
    the position
  - setPosition
```
public void setPosition(int position)
```
    Parameters:
    
    position - the position to set
  - getActionSize
```
public int getActionSize()
```
    Returns:
    
    the actionSize
  - getMessage
```
public int getMessage()
```
    Returns:
    
    the message
  - setMessage
```
public void setMessage(int message)
```
    Parameters:
    
    message - the message to set
  - getRow
```
public int[] getRow()
```
    Returns:
    
    the row
  - setRow
```
public void setRow(int[] row)
```
    Parameters:
    
    row - the row to set. The array is copied into a new array since the original array's content may change.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
    
    See Also:
    
    Object.equals(java.lang.Object)
  - toString
```
public String toString()
```
    Returns a representation of the state (all its rules and dots) with additional information of what is this state's origin (what state this is coming from, and with what symbol)
    
    Overrides:
    
    toString in class Object
    
    See Also:
    
    Object.toString()

Class State

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

State

Method Detail

getSymbolId

getKernelDots

getClosureDots

getAllDots

getDot

addKernelDot

addClosureDot

addAllKernelDots

addAllClosureDots

getId

setId

isReview

setReview

getFrom

setFrom

getSymbol

setSymbol

getDefaultValue

setDefaultValue

getActions

setActions

getPosition

setPosition

getActionSize

getMessage

setMessage

getRow

setRow

equals

toString