Trait rustfst::fst_traits::MutableFst [−][src]
pub trait MutableFst<W: Semiring>: ExpandedFst<W> {}Show methods
fn new() -> Self; fn set_start(&mut self, state_id: StateId) -> Result<()>; unsafe fn set_start_unchecked(&mut self, state: StateId); fn set_final<S: Into<W>>(
&mut self,
state_id: StateId,
final_weight: S
) -> Result<()>; unsafe fn set_final_unchecked<S: Into<W>>(
&mut self,
state_id: StateId,
final_weight: S
); fn add_state(&mut self) -> StateId; fn add_states(&mut self, n: usize); fn tr_iter_mut(&mut self, state: StateId) -> Result<TrsIterMut<'_, W>>; unsafe fn tr_iter_unchecked_mut(
&mut self,
state_id: StateId
) -> TrsIterMut<'_, W>; fn del_state(&mut self, state_id: StateId) -> Result<()>; fn del_states<T: IntoIterator<Item = StateId>>(
&mut self,
states: T
) -> Result<()>; fn del_all_states(&mut self); unsafe fn del_trs_id_sorted_unchecked(
&mut self,
state: StateId,
to_del: &[usize]
); fn add_tr(&mut self, source: StateId, tr: Tr<W>) -> Result<()>; unsafe fn add_tr_unchecked(&mut self, state: StateId, tr: Tr<W>); unsafe fn set_trs_unchecked(&mut self, source: StateId, trs: Vec<Tr<W>>); fn delete_final_weight(&mut self, source: StateId) -> Result<()>; unsafe fn delete_final_weight_unchecked(&mut self, source: StateId); fn delete_trs(&mut self, source: StateId) -> Result<()>; fn pop_trs(&mut self, source: StateId) -> Result<Vec<Tr<W>>>; unsafe fn pop_trs_unchecked(&mut self, source: StateId) -> Vec<Tr<W>>; fn take_final_weight(&mut self, state_id: StateId) -> Result<Option<W>>; unsafe fn take_final_weight_unchecked(
&mut self,
state: StateId
) -> Option<W>; fn sort_trs_unchecked<F: Fn(&Tr<W>, &Tr<W>) -> Ordering>(
&mut self,
state: StateId,
f: F
); unsafe fn unique_trs_unchecked(&mut self, state: StateId); unsafe fn sum_trs_unchecked(&mut self, state: StateId); fn set_properties(&mut self, props: FstProperties); fn set_properties_with_mask(
&mut self,
props: FstProperties,
mask: FstProperties
); fn emplace_tr<S: Into<W>>(
&mut self,
source: StateId,
ilabel: Label,
olabel: Label,
weight: S,
nextstate: StateId
) -> Result<()> { ... } unsafe fn emplace_tr_unchecked<S: Into<W>>(
&mut self,
state: StateId,
ilabel: Label,
olabel: Label,
weight: S,
nextstate: StateId
) { ... } fn closure(&mut self, closure_type: ClosureType) { ... } fn tr_map<M: TrMapper<W>>(&mut self, mapper: &mut M) -> Result<()> { ... } fn compute_and_update_properties(
&mut self,
mask: FstProperties
) -> Result<FstProperties> { ... } fn compute_and_update_properties_all(&mut self) -> Result<FstProperties> { ... }
Expand description
Trait defining the methods to modify a wFST.
Required methods
The state with identifier state_id
is now the start state.
Note that only one start state is allowed in this implementation. Calling this function twice
will mean losing the first start state.
If the state_id
doesn’t exist an error is raised.
let mut fst = VectorFst::<BooleanWeight>::new(); let s1 = fst.add_state(); let s2 = fst.add_state(); assert_eq!(fst.start(), None); fst.set_start(s1); assert_eq!(fst.start(), Some(s1)); fst.set_start(s2); assert_eq!(fst.start(), Some(s2));
unsafe fn set_start_unchecked(&mut self, state: StateId)
unsafe fn set_start_unchecked(&mut self, state: StateId)
The state with identifier state_id
is now the start state.
Safety
Unsafe behaviour if state
is not present in Fst.
The state with identifier state_id
is now a final state with a weight final_weight
.
If the state_id
doesn’t exist an error is raised.
let mut fst = VectorFst::<BooleanWeight>::new(); let s1 = fst.add_state(); let s2 = fst.add_state(); assert_eq!(fst.final_weight(s1).unwrap(), None); assert_eq!(fst.final_weight(s2).unwrap(), None); fst.set_final(s1, BooleanWeight::one()); assert_eq!(fst.final_weight(s1).unwrap(), Some(BooleanWeight::one())); assert_eq!(fst.final_weight(s2).unwrap(), None); fst.set_final(s2, BooleanWeight::one()); assert_eq!(fst.final_weight(s1).unwrap(), Some(BooleanWeight::one())); assert_eq!(fst.final_weight(s2).unwrap(), Some(BooleanWeight::one()));
unsafe fn set_final_unchecked<S: Into<W>>(
&mut self,
state_id: StateId,
final_weight: S
)
unsafe fn set_final_unchecked<S: Into<W>>(
&mut self,
state_id: StateId,
final_weight: S
)
Set the final weight of the state with state if state_id
.
Safety
Unsafe behaviour if state
is not present in Fst.
Adds a new state to the current FST. The identifier of the new state is returned
Example
let mut fst = VectorFst::<BooleanWeight>::new(); assert_eq!(fst.num_states(), 0); fst.add_state(); assert_eq!(fst.num_states(), 1); fst.add_state(); assert_eq!(fst.num_states(), 2);
fn add_states(&mut self, n: usize)
fn add_states(&mut self, n: usize)
Add n
states to the Fst.
fn tr_iter_mut(&mut self, state: StateId) -> Result<TrsIterMut<'_, W>>
fn tr_iter_mut(&mut self, state: StateId) -> Result<TrsIterMut<'_, W>>
Return a mutable iterator on the Tr
s of the state state
.
unsafe fn tr_iter_unchecked_mut(
&mut self,
state_id: StateId
) -> TrsIterMut<'_, W>
unsafe fn tr_iter_unchecked_mut(
&mut self,
state_id: StateId
) -> TrsIterMut<'_, W>
Return a mutable iterator on the Tr
s of the state state
.
Safety
Unsafe behaviour if state
is not present in Fst.
Removes a state from an FST. It also removes all the trs starting from another state and
reaching this state. An error is raised if the state state_id
doesn’t exist.
Example
let mut fst = VectorFst::<BooleanWeight>::new(); assert_eq!(fst.states_iter().count(), 0); let s1 = fst.add_state(); assert_eq!(fst.states_iter().count(), 1); fst.del_state(s1); assert_eq!(fst.states_iter().count(), 0);
fn del_states<T: IntoIterator<Item = StateId>>(
&mut self,
states: T
) -> Result<()>
fn del_states<T: IntoIterator<Item = StateId>>(
&mut self,
states: T
) -> Result<()>
Removes multiple states from an FST. If one of the states doesn’t exist, an error is raised.
Warning
This method modifies the id of the states that are left in the FST. Id that were used before calling this function should no longer be used.
Example
let mut fst = VectorFst::<BooleanWeight>::new(); assert_eq!(fst.states_iter().count(), 0); let s1 = fst.add_state(); let s2 = fst.add_state(); assert_eq!(fst.states_iter().count(), 2); let states_to_remove = vec![s1, s2]; fst.del_states(states_to_remove.into_iter()); assert_eq!(fst.states_iter().count(), 0);
fn del_all_states(&mut self)
fn del_all_states(&mut self)
Remove all the states in the FST. As a result, all the trs are also removed, as well as the start state and all the fina states.
Example
let mut fst = VectorFst::<BooleanWeight>::new(); assert_eq!(fst.states_iter().count(), 0); let s1 = fst.add_state(); let s2 = fst.add_state(); assert_eq!(fst.states_iter().count(), 2); fst.del_all_states(); assert_eq!(fst.states_iter().count(), 0);
Remove transitions from the fst at state state
. Transitions are specified with
their index. The to_del
vector MUST be sorted.
Safety
Unsafe behaviour if state
is not present in Fst.
Adds a transition to the FST. The transition will start in the state source
.
Errors
An error is raised if the state source
doesn’t exist.
Example
let mut fst = VectorFst::<ProbabilityWeight>::new(); let s1 = fst.add_state(); let s2 = fst.add_state(); assert_eq!(fst.num_trs(s1)?, 0); fst.add_tr(s1, Tr::new(3, 5, 1.2, s2)); assert_eq!(fst.num_trs(s1)?, 1);
unsafe fn add_tr_unchecked(&mut self, state: StateId, tr: Tr<W>)
unsafe fn add_tr_unchecked(&mut self, state: StateId, tr: Tr<W>)
Adds a transition to the FST. The transition will start in the state state
.
Safety
Unsafe behaviour if state
is not present in Fst.
unsafe fn set_trs_unchecked(&mut self, source: StateId, trs: Vec<Tr<W>>)
unsafe fn set_trs_unchecked(&mut self, source: StateId, trs: Vec<Tr<W>>)
Set all the Tr
s leaving the state state
to the parameters trs
erasing
the Tr
s previously stored.
Be careful as this function doesn’t update the FstProperties
.
Safety
Unsafe behaviour if state
is not present in Fst.
fn delete_final_weight(&mut self, source: StateId) -> Result<()>
fn delete_final_weight(&mut self, source: StateId) -> Result<()>
Remove the final weight of a specific state.
unsafe fn delete_final_weight_unchecked(&mut self, source: StateId)
unsafe fn delete_final_weight_unchecked(&mut self, source: StateId)
fn delete_trs(&mut self, source: StateId) -> Result<()>
fn delete_trs(&mut self, source: StateId) -> Result<()>
Deletes all the trs leaving a state.
Remove all trs leaving a state and return them.
unsafe fn pop_trs_unchecked(&mut self, source: StateId) -> Vec<Tr<W>>
unsafe fn pop_trs_unchecked(&mut self, source: StateId) -> Vec<Tr<W>>
Remove all the Tr
leaving the state state
and return them.
Safety
Unsafe behaviour if state
is not present in Fst.
fn take_final_weight(&mut self, state_id: StateId) -> Result<Option<W>>
fn take_final_weight(&mut self, state_id: StateId) -> Result<Option<W>>
Takes the final weight out of the fst, leaving a None in its place.
Errors
An error is raised if the state with id state_id
doesn’t exist.
Example
let mut fst = VectorFst::<ProbabilityWeight>::new(); let s1 = fst.add_state(); fst.set_final(s1, 1.2)?; assert_eq!(fst.final_weight(s1)?, Some(ProbabilityWeight::new(1.2))); let weight = fst.take_final_weight(s1)?; assert_eq!(weight, Some(ProbabilityWeight::new(1.2))); assert_eq!(fst.final_weight(s1)?, None);
unsafe fn take_final_weight_unchecked(&mut self, state: StateId) -> Option<W>
unsafe fn take_final_weight_unchecked(&mut self, state: StateId) -> Option<W>
Takes the final weight out of the fst, leaving a None in its place.
This version leads to undefined behaviour
if the state doesn’t exist.
Example
let mut fst = VectorFst::<ProbabilityWeight>::new(); let s1 = fst.add_state(); fst.set_final(s1, 1.2)?; assert_eq!(fst.final_weight(s1)?, Some(ProbabilityWeight::new(1.2))); let weight = unsafe {fst.take_final_weight_unchecked(s1)}; assert_eq!(weight, Some(ProbabilityWeight::new(1.2))); assert_eq!(fst.final_weight(s1)?, None);
Safety
Unsafe behaviour if state
is not present in Fst.
unsafe fn unique_trs_unchecked(&mut self, state: StateId)
unsafe fn unique_trs_unchecked(&mut self, state: StateId)
Remove duplicate Trs leaving the state state
with the same ilabel
, olabel
, weight
and nextstate
.
Be careful as this function doesn’t update the FstProperties!
Safety
Unsafe behaviour if state
not present in Fst.
unsafe fn sum_trs_unchecked(&mut self, state: StateId)
unsafe fn sum_trs_unchecked(&mut self, state: StateId)
Merge the Trs leaving the state state
with the same ilabel
, olabel
and nextstate
and sum their weights.
Be careful as this function doesn’t update the FstProperties!
Safety
Unsafe behaviour if state
not present in Fst.
fn set_properties(&mut self, props: FstProperties)
fn set_properties(&mut self, props: FstProperties)
Set the internal properties of the Fst. All the set properties must be verified by the Fst!
fn set_properties_with_mask(
&mut self,
props: FstProperties,
mask: FstProperties
)
fn set_properties_with_mask(
&mut self,
props: FstProperties,
mask: FstProperties
)
Set only a subset of the internal properties of the Fst.
Provided methods
Adds a transition to the FST. The transition will start in the state source
.
Errors
An error is raised if the state source
doesn’t exist.
Example
let mut fst = VectorFst::<ProbabilityWeight>::new(); let s1 = fst.add_state(); let s2 = fst.add_state(); assert_eq!(fst.num_trs(s1)?, 0); fst.emplace_tr(s1, 3, 5, 1.2, s2); assert_eq!(fst.num_trs(s1)?, 1);
Adds a transition to the FST. The transition will start in the state state
.
Safety
Unsafe behaviour if state
is not present in Fst.
fn closure(&mut self, closure_type: ClosureType)
fn closure(&mut self, closure_type: ClosureType)
This operation computes the concatenative closure.
If A transduces string x
to y
with weight a
,
then the closure transduces x
to y
with weight a
,
xx
to yy
with weight a ⊗ a
, xxx
to yyy
with weight a ⊗ a ⊗ a
, etc.
If closure_star then the empty string is transduced to itself with weight 1
as well.
Maps a transition using a TrMapper
object.
fn compute_and_update_properties(
&mut self,
mask: FstProperties
) -> Result<FstProperties>
fn compute_and_update_properties(
&mut self,
mask: FstProperties
) -> Result<FstProperties>
Compute the properties verified by the Fst (with a mask) and update the internal property bits.
fn compute_and_update_properties_all(&mut self) -> Result<FstProperties>
fn compute_and_update_properties_all(&mut self) -> Result<FstProperties>
Compute all the properties verified by the Fst and update the internal property bits.