Struct rustfst::fst_properties::FstProperties

pub struct FstProperties(/* private fields */);

The property bits here assert facts about an FST. If individual bits are added, then the composite fst_properties below, the property functions and property names in fst_properties.cc, and TestProperties() in test-fst_properties.h should be updated. For each of these fst_properties below there is a pair of property bits, one positive and one negative. If the positive bit is set, the property is true. If the negative bit is set, the property is false. If neither is set, the property has unknown value. Both should never be simultaneously set. The individual positive and negative bit pairs should be adjacent with the positive bit at an odd and lower position.

Implementations

impl FstProperties

pub const ACCEPTOR: Self = _

ilabel == olabel for each transition.

pub const NOT_ACCEPTOR: Self = _

ilabel != olabel for some transition.

pub const I_DETERMINISTIC: Self = _

ilabels unique leaving each state.

pub const NOT_I_DETERMINISTIC: Self = _

ilabels not unique leaving some state.

pub const O_DETERMINISTIC: Self = _

olabels unique leaving each state.

pub const NOT_O_DETERMINISTIC: Self = _

olabels not unique leaving some state.

pub const EPSILONS: Self = _

FST has input/output epsilons.

pub const NO_EPSILONS: Self = _

FST has no input/output epsilons.

pub const I_EPSILONS: Self = _

FST has input epsilons.

pub const NO_I_EPSILONS: Self = _

FST has no input epsilons.

pub const O_EPSILONS: Self = _

FST has output epsilons.

pub const NO_O_EPSILONS: Self = _

FST has no output epsilons.

pub const I_LABEL_SORTED: Self = _

ilabels sorted wrt < for each state.

pub const NOT_I_LABEL_SORTED: Self = _

ilabels not sorted wrt < for some state.

pub const O_LABEL_SORTED: Self = _

olabels sorted wrt < for each state.

pub const NOT_O_LABEL_SORTED: Self = _

olabels not sorted wrt < for some state.

pub const WEIGHTED: Self = _

Non-trivial transition or final weights.

pub const UNWEIGHTED: Self = _

Only trivial transition and final weights.

pub const CYCLIC: Self = _

FST has cycles.

pub const ACYCLIC: Self = _

FST has no cycles.

pub const INITIAL_CYCLIC: Self = _

FST has cycles containing the initial state.

pub const INITIAL_ACYCLIC: Self = _

FST has no cycles containing the initial state.

pub const TOP_SORTED: Self = _

FST is topologically sorted.

pub const NOT_TOP_SORTED: Self = _

FST is not topologically sorted.

pub const ACCESSIBLE: Self = _

All states reachable from the initial state.

pub const NOT_ACCESSIBLE: Self = _

Not all states reachable from the initial state.

pub const COACCESSIBLE: Self = _

All states can reach a final state.

pub const NOT_COACCESSIBLE: Self = _

Not all states can reach a final state.

pub const STRING: Self = _

If NumStates() > 0, then state 0 is initial, state NumStates() - 1 is final, there is a transition from each non-final state i to state i + 1, and there are no other transitions.

pub const NOT_STRING: Self = _

Not a string FST.

pub const WEIGHTED_CYCLES: Self = _

FST has at least one weighted cycle.

pub const UNWEIGHTED_CYCLES: Self = _

Only unweighted cycles.

impl FstProperties

pub const fn empty() -> Self

Get a flags value with all bits unset.

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> u64

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: u64) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: u64) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: u64) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FstProperties

pub const fn iter(&self) -> Iter<FstProperties>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<FstProperties>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

impl FstProperties

pub fn knows(self, props: FstProperties) -> bool

Check that all the props passed as parameter are known.

Trait Implementations

impl Binary for FstProperties

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

Formats the value using the given formatter.

impl BitAnd for FstProperties

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = FstProperties

The resulting type after applying the & operator.

impl BitAndAssign for FstProperties

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for FstProperties

fn bitor(self, other: FstProperties) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = FstProperties

The resulting type after applying the | operator.

impl BitOrAssign for FstProperties

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for FstProperties

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = FstProperties

The resulting type after applying the ^ operator.

impl BitXorAssign for FstProperties

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for FstProperties

fn clone(&self) -> FstProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FstProperties

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

Formats the value using the given formatter.

impl Extend<FstProperties> for FstProperties

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for FstProperties

const FLAGS: &'static [Flag<FstProperties>] = _

The set of defined flags.

type Bits = u64

The underlying bits type.

fn bits(&self) -> u64

Get the underlying bits value.

fn from_bits_retain(bits: u64) -> FstProperties

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<FstProperties> for FstProperties

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for FstProperties

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoIterator for FstProperties

type Item = FstProperties

The type of the elements being iterated over.

type IntoIter = Iter<FstProperties>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for FstProperties

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

Formats the value using the given formatter.

impl Not for FstProperties

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = FstProperties

The resulting type after applying the ! operator.

impl Octal for FstProperties

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

Formats the value using the given formatter.

impl Ord for FstProperties

fn cmp(&self, other: &FstProperties) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for FstProperties

fn eq(&self, other: &FstProperties) -> 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 PartialOrd for FstProperties

fn partial_cmp(&self, other: &FstProperties) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PublicFlags for FstProperties

type Primitive = u64

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Shl<usize> for FstProperties

type Output = FstProperties

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl Shr<usize> for FstProperties

type Output = FstProperties

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl Sub for FstProperties

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = FstProperties

The resulting type after applying the - operator.

impl SubAssign for FstProperties

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for FstProperties

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

Formats the value using the given formatter.

impl Copy for FstProperties

impl Eq for FstProperties

impl StructuralPartialEq for FstProperties