1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
use std::cmp::Ordering; use anyhow::Result; use crate::algorithms::closure::ClosureType; use crate::algorithms::TrMapper; use crate::fst_properties::FstProperties; use crate::fst_traits::ExpandedFst; use crate::semirings::Semiring; use crate::tr::Tr; use crate::trs_iter_mut::TrsIterMut; use crate::{Label, StateId}; /// Trait defining the methods to modify a wFST. pub trait MutableFst<W: Semiring>: ExpandedFst<W> { /// Creates an empty wFST. fn new() -> Self; /// 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. /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{BooleanWeight, Semiring}; /// # use rustfst::Tr; /// 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)); /// ``` fn set_start(&mut self, state_id: StateId) -> Result<()>; unsafe fn set_start_unchecked(&mut self, state_id: StateId); /// 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. /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{BooleanWeight, Semiring}; /// # use rustfst::Tr; /// 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())); /// ``` 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); /// Adds a new state to the current FST. The identifier of the new state is returned /// /// # Example /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{BooleanWeight, Semiring}; /// 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_state(&mut self) -> StateId; fn add_states(&mut self, n: usize); fn tr_iter_mut(&mut self, state_id: StateId) -> Result<TrsIterMut<W>>; unsafe fn tr_iter_unchecked_mut(&mut self, state_id: StateId) -> TrsIterMut<W>; /// 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 /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst, StateIterator}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{BooleanWeight, Semiring}; /// 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_state(&mut self, state_id: StateId) -> Result<()>; // TODO: Need to define a correct behaviour is the same state is present multiple times in the iterator /// 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 /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst, StateIterator}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{BooleanWeight, Semiring}; /// 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_states<T: IntoIterator<Item = StateId>>(&mut self, states: T) -> Result<()>; /// 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 /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst, StateIterator}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{BooleanWeight, Semiring}; /// 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); /// /// ``` fn del_all_states(&mut self); unsafe fn del_trs_id_sorted_unchecked(&mut self, state: StateId, to_del: &Vec<usize>); /// 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 /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{ProbabilityWeight, Semiring}; /// # use rustfst::Tr; /// # use anyhow::Result; /// # fn main() -> Result<()> { /// 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); /// # Ok(()) /// # } /// ``` fn add_tr(&mut self, source: StateId, tr: Tr<W>) -> Result<()>; unsafe fn add_tr_unchecked(&mut self, source: StateId, tr: Tr<W>); /// 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 /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{Semiring, ProbabilityWeight}; /// # use rustfst::Tr; /// # use anyhow::Result; /// # fn main() -> Result<()> { /// 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); /// # Ok(()) /// # } /// ``` fn emplace_tr<S: Into<W>>( &mut self, source: StateId, ilabel: Label, olabel: Label, weight: S, nextstate: StateId, ) -> Result<()> { self.add_tr(source, Tr::new(ilabel, olabel, weight, nextstate)) } unsafe fn emplace_tr_unchecked<S: Into<W>>( &mut self, source: StateId, ilabel: Label, olabel: Label, weight: S, nextstate: StateId, ) { self.add_tr_unchecked(source, Tr::new(ilabel, olabel, weight, nextstate)) } unsafe fn set_trs_unchecked(&mut self, source: StateId, trs: Vec<Tr<W>>); /// Remove the final weight of a specific state. fn delete_final_weight(&mut self, source: StateId) -> Result<()>; unsafe fn delete_final_weight_unchecked(&mut self, source: StateId); /// Deletes all the trs leaving a state. fn delete_trs(&mut self, source: StateId) -> Result<()>; /// Remove all trs leaving a state and return them. fn pop_trs(&mut self, source: StateId) -> Result<Vec<Tr<W>>>; unsafe fn pop_trs_unchecked(&mut self, source: StateId) -> Vec<Tr<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 /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{Semiring, ProbabilityWeight}; /// # use rustfst::Tr; /// # use anyhow::Result; /// # fn main() -> Result<()> { /// 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); /// # Ok(()) /// # } /// ``` 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. /// This version leads to `undefined behaviour` if the state doesn't exist. /// /// # Example /// /// ``` /// # use rustfst::fst_traits::{CoreFst, MutableFst, ExpandedFst}; /// # use rustfst::fst_impls::VectorFst; /// # use rustfst::semirings::{Semiring, ProbabilityWeight}; /// # use rustfst::Tr; /// # use anyhow::Result; /// # fn main() -> Result<()> { /// 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); /// # Ok(()) /// # } /// ``` unsafe fn take_final_weight_unchecked(&mut self, state_id: 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); /// 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. fn closure(&mut self, closure_type: ClosureType) { crate::algorithms::closure::closure(self, closure_type) } /// Maps a transition using a `TrMapper` object. fn tr_map<M: TrMapper<W>>(&mut self, mapper: &mut M) -> Result<()> { crate::algorithms::tr_map(self, mapper) } /// Set the internal properties of the Fst. All the set properties must be verified by the Fst! fn set_properties(&mut self, props: FstProperties); /// Set only a subset of the internal properties of the Fst. fn set_properties_with_mask(&mut self, props: FstProperties, mask: FstProperties); /// Compute the properties verified by the Fst (with a mask) and update /// the internal property bits. fn compute_and_update_properties(&mut self, mask: FstProperties) -> Result<FstProperties> { let mut knownprops = FstProperties::empty(); let testprops = crate::fst_properties::compute_fst_properties(self, mask, &mut knownprops, true)?; self.set_properties_with_mask(testprops, knownprops); Ok(testprops & mask) } /// Compute all the properties verified by the Fst and update the internal property bits. fn compute_and_update_properties_all(&mut self) -> Result<FstProperties> { self.compute_and_update_properties(FstProperties::all_properties()) } }