Struct rustfst::fst_impls::ConstFst

pub struct ConstFst<W> { /* private fields */ }

Immutable FST whose states and trs each implemented by single arrays,

Trait Implementations

impl<W: Clone> Clone for ConstFst<W>

fn clone(&self) -> ConstFst<W>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<W: Semiring> CoreFst<W> for ConstFst<W>

type TRS = TrsConst<W>

Weight use in the wFST. This type must implement the Semiring trait.

fn start(&self) -> Option<StateId>

Returns the ID of the start state of the wFST if it exists else none.

fn final_weight(&self, state_id: StateId) -> Result<Option<W>>

Retrieves the final weight of a state (if the state is a final one).

unsafe fn final_weight_unchecked(&self, state_id: StateId) -> Option<W>

Retrieves the final weight of a state (if the state is a final one).

fn num_trs(&self, s: StateId) -> Result<usize>

Number of trs leaving a specific state in the wFST.

unsafe fn num_trs_unchecked(&self, s: StateId) -> usize

Number of trs leaving a specific state in the wFST.

fn get_trs(&self, state_id: StateId) -> Result<Self::TRS>

Get an iterator on the transitions leaving state state.

unsafe fn get_trs_unchecked(&self, state_id: StateId) -> Self::TRS

Get an iterator on the transitions leaving state state.

fn properties(&self) -> FstProperties

Retrieve the FstProperties stored in the Fst. As a result, all the properties returned are verified by the Fst but some other properties might be true as well despite the flag not being set.

fn num_input_epsilons(&self, state: StateId) -> Result<usize>

Returns the number of trs with epsilon input labels leaving a state.

fn num_output_epsilons(&self, state: StateId) -> Result<usize>

Returns the number of trs with epsilon output labels leaving a state.

fn is_final(&self, state_id: StateId) -> Result<bool>

Returns whether or not the state with identifier passed as parameters is a final state.

unsafe fn is_final_unchecked(&self, state: StateId) -> bool

Returns whether or not the state with identifier passed as parameters is a final state.

fn is_start(&self, state_id: StateId) -> bool

Check whether a state is the start state or not.

fn properties_with_mask(&self, mask: FstProperties) -> FstProperties

Apply a mask to the FstProperties returned.

fn properties_check(&self, props_known: FstProperties) -> Result<FstProperties>

Retrieve the FstProperties in the Fst and check that all the properties in props_known are known (not the same as true). If not an error is returned.

impl<W: Debug> Debug for ConstFst<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W: 'static + SerializableSemiring> Display for ConstFst<W>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<W: 'static + Semiring> ExpandedFst<W> for ConstFst<W>

fn num_states(&self) -> usize

Returns the number of states that contains the FST. They are all counted even if some states are not on a successful path (doesn’t perform triming).

fn states_range(&self) -> Range<StateId>

fn approx_equal<F2: ExpandedFst<W>>(&self, fst2: &F2, delta: f32) -> bool

impl<W: Semiring> From<VectorFst<W>> for ConstFst<W>

fn from(ifst: VectorFst<W>) -> Self

Converts to this type from the input type.

impl<W: Semiring> Fst<W> for ConstFst<W>

fn input_symbols(&self) -> Option<&Arc<SymbolTable>>

Retrieves the input SymbolTable associated to the Fst. If no SymbolTable has been previously attached then None is returned.

fn output_symbols(&self) -> Option<&Arc<SymbolTable>>

Retrieves the output SymbolTable associated to the Fst. If no SymbolTable has been previously attached then None is returned.

fn set_input_symbols(&mut self, symt: Arc<SymbolTable>)

Attaches an output SymbolTable to the Fst. The SymbolTable is not duplicated with the use of Arc.

fn set_output_symbols(&mut self, symt: Arc<SymbolTable>)

Attaches an output SymbolTable to the Fst. The SymbolTable is not duplicated with the use of Arc.

fn take_input_symbols(&mut self) -> Option<Arc<SymbolTable>>

Removes the input symbol table from the Fst and retrieves it.

fn take_output_symbols(&mut self) -> Option<Arc<SymbolTable>>

Removes the output symbol table from the Fst and retrieves it.

fn final_states_iter(&self) -> FinalStatesIterator<'_, W, Self>

where Self: Sized,

Returns an Iterator on the final states along with their weight.

fn paths_iter(&self) -> PathsIterator<'_, W, Self>

where Self: Sized,

Returns an Iterator on the paths accepted by the Fst.

fn string_paths_iter(&self) -> Result<StringPathsIterator<'_, W, Self>>

where Self: Sized,

Returns an Iterator on the paths accepted by the Fst. Plus, handles the SymbolTable allowing to retrieve the strings instead of only the sequence of labels.

impl<W> FstIntoIterator<W> for ConstFst<W>

where W: 'static + Semiring,

type TrsIter = IntoIter<Tr<W>>

type FstIter = Box<dyn Iterator<Item = FstIterData<W, <ConstFst<W> as FstIntoIterator<W>>::TrsIter>>>

fn fst_into_iter(self) -> Self::FstIter

impl<'a, W: Semiring + 'static> FstIterator<'a, W> for ConstFst<W>

type FstIter = Map<Enumerate<Zip<Iter<'a, ConstState<W>>, RepeatN<&'a Arc<Vec<Tr<W>>>>>>, Box<dyn FnMut((usize, (&'a ConstState<W>, &'a Arc<Vec<Tr<W>>>))) -> FstIterData<W, <ConstFst<W> as CoreFst<W>>::TRS>>>

fn fst_iter(&'a self) -> Self::FstIter

impl<W: Semiring> PartialEq for ConstFst<W>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<W: SerializableSemiring> SerializableFst<W> for ConstFst<W>

fn fst_type() -> String

String identifying the type of the FST. Will be used when serialiing and deserializing an FST in binary format.

fn load(data: &[u8]) -> Result<Self>

Loads an FST from the binary format data in a Read.

fn store<O: Write>(&self, output: O) -> Result<()>

Store the FST in binary format to a Write.

fn from_parsed_fst_text(parsed_fst_text: ParsedTextFst<W>) -> Result<Self>

Turns a generic wFST format into the one of the wFST.

fn read<P: AsRef<Path>>(path_bin_fst: P) -> Result<Self>

Loads an FST from a file in binary format.

fn write<P: AsRef<Path>>(&self, path_bin_fst: P) -> Result<()>

Writes the FST to a file in binary format.

fn from_text_string(fst_string: &str) -> Result<Self>

Deserializes a wFST in text from a path and returns a loaded wFST.

fn read_text<P: AsRef<Path>>(path_text_fst: P) -> Result<Self>

Deserializes a wFST in text from a path and returns a loaded wFST.

fn write_text<P: AsRef<Path>>(&self, path_output: P) -> Result<()>

Serializes the FST as a text file in a format compatible with OpenFST.

fn text(&self) -> Result<String>

Writes the text representation of the FST into a String.

fn draw<P: AsRef<Path>>( &self, path_output: P, config: &DrawingConfig ) -> Result<()>

Serializes the FST as a DOT file compatible with GraphViz binaries.

impl<'a, W> StateIterator<'a> for ConstFst<W>

type Iter = Range<u32>

Iterator used to iterate over the state_id of the states of an FST.

fn states_iter(&'a self) -> Self::Iter

Creates an iterator over the state_id of the states of an FST.