edu.cmu.sphinx.fst

Class Fst

java.lang.Object

edu.cmu.sphinx.fst.Fst

Direct Known Subclasses:

ImmutableFst

public class Fst
extends java.lang.Object

A mutable finite state transducer implementation. Holds an ArrayList of State objects allowing additions/deletions.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String[]	isyms
protected java.lang.String[]	osyms
protected Semiring	semiring
protected State	start

Constructor Summary

Constructors

Constructor and Description
Fst() Default Constructor
Fst(int numStates) Constructor specifying the initial capacity of the states ArrayList (this is an optimization used in various operations)
Fst(Semiring s) Constructor specifying the fst's semiring

Method Summary

Modifier and Type	Method and Description
void	addState(State state) Adds a state to the fst
void	deleteState(State state) Deletes a state
void	deleteStates(java.util.HashSet<State> toDelete)
boolean	equals(java.lang.Object obj)
java.lang.String[]	getIsyms() Get the input symbols' array
int	getNumStates() Get the number of states in the fst
java.lang.String[]	getOsyms() Get the output symbols' array
Semiring	getSemiring() Get the semiring
State	getStart() Get the initial states
State	getState(int index)
int	hashCode()
static Fst	loadModel(java.lang.String filename) Deserializes an Fst from disk
protected static java.lang.String[]	readStringMap(java.io.ObjectInputStream in) Deserializes a symbol map from an ObjectInputStream
void	remapStateIds() Remaps the states' ids.
void	saveModel(java.lang.String filename) Saves binary model to disk
void	setIsyms(java.lang.String[] isyms) Set the input symbols
void	setOsyms(java.lang.String[] osyms) Set the output symbols
void	setSemiring(Semiring semiring) Set the Semiring
void	setStart(State start) Set the initial state
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

start

protected State start

isyms

protected java.lang.String[] isyms

osyms

protected java.lang.String[] osyms

semiring

protected Semiring semiring

Constructor Detail

Fst

public Fst()

Default Constructor

Fst

public Fst(int numStates)

Constructor specifying the initial capacity of the states ArrayList (this is an optimization used in various operations)

Parameters:

numStates - the initial capacity

Fst

public Fst(Semiring s)

Constructor specifying the fst's semiring

Parameters:

s - the fst's semiring

Method Detail

getStart

public State getStart()

Get the initial states

Returns:

the initial state

getSemiring

public Semiring getSemiring()

Get the semiring

Returns:

used semiring

setSemiring

public void setSemiring(Semiring semiring)

Set the Semiring

Parameters:

semiring - the semiring to set

setStart

public void setStart(State start)

Set the initial state

Parameters:

start - the initial state

getNumStates

public int getNumStates()

Get the number of states in the fst

Returns:

number of states

getState

public State getState(int index)

addState

public void addState(State state)

Adds a state to the fst

Parameters:

state - the state to be added

getIsyms

public java.lang.String[] getIsyms()

Get the input symbols' array

Returns:

array of input symbols

setIsyms

public void setIsyms(java.lang.String[] isyms)

Set the input symbols

Parameters:

isyms - the isyms to set

getOsyms

public java.lang.String[] getOsyms()

Get the output symbols' array

Returns:

array fo output symbols

setOsyms

public void setOsyms(java.lang.String[] osyms)

Set the output symbols

Parameters:

osyms - the osyms to set

saveModel

public void saveModel(java.lang.String filename)
               throws java.io.IOException

Saves binary model to disk

Parameters:

filename - the binary model filename

Throws:

java.io.IOException - if IO went wrong

readStringMap

protected static java.lang.String[] readStringMap(java.io.ObjectInputStream in)
                                           throws java.io.IOException,
                                                  java.lang.ClassNotFoundException

Deserializes a symbol map from an ObjectInputStream

Parameters:

in - the ObjectInputStream. It should be already be initialized by the caller.

Returns:

the deserialized symbol map

Throws:

java.io.IOException - if IO went wrong

java.lang.ClassNotFoundException - if serialization went wrong

loadModel

public static Fst loadModel(java.lang.String filename)
                     throws java.io.IOException,
                            java.lang.ClassNotFoundException

Deserializes an Fst from disk

Parameters:

filename - the binary model filename

Returns:

deserialized FST

Throws:

java.io.IOException - io IO went wrong

java.lang.ClassNotFoundException - if serialization went wrong

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

deleteState

public void deleteState(State state)

Deletes a state

Parameters:

state - the state to delete

remapStateIds

public void remapStateIds()

Remaps the states' ids. States' ids are renumbered starting from 0 up to @see getNumStates()

deleteStates

public void deleteStates(java.util.HashSet<State> toDelete)