Struct rustfst::fst_properties::FstProperties

pub struct FstProperties { /* fields omitted */ }

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: FstProperties

ilabel == olabel for each transition.

pub const NOT_ACCEPTOR: FstProperties

ilabel != olabel for some transition.

pub const I_DETERMINISTIC: FstProperties

ilabels unique leaving each state.

pub const NOT_I_DETERMINISTIC: FstProperties

ilabels not unique leaving some state.

pub const O_DETERMINISTIC: FstProperties

olabels unique leaving each state.

pub const NOT_O_DETERMINISTIC: FstProperties

olabels not unique leaving some state.

pub const EPSILONS: FstProperties

FST has input/output epsilons.

pub const NO_EPSILONS: FstProperties

FST has no input/output epsilons.

pub const I_EPSILONS: FstProperties

FST has input epsilons.

pub const NO_I_EPSILONS: FstProperties

FST has no input epsilons.

pub const O_EPSILONS: FstProperties

FST has output epsilons.

pub const NO_O_EPSILONS: FstProperties

FST has no output epsilons.

pub const I_LABEL_SORTED: FstProperties

ilabels sorted wrt < for each state.

pub const NOT_I_LABEL_SORTED: FstProperties

ilabels not sorted wrt < for some state.

pub const O_LABEL_SORTED: FstProperties

olabels sorted wrt < for each state.

pub const NOT_O_LABEL_SORTED: FstProperties

olabels not sorted wrt < for some state.

pub const WEIGHTED: FstProperties

Non-trivial transition or final weights.

pub const UNWEIGHTED: FstProperties

Only trivial transition and final weights.

pub const CYCLIC: FstProperties

FST has cycles.

pub const ACYCLIC: FstProperties

FST has no cycles.

pub const INITIAL_CYCLIC: FstProperties

FST has cycles containing the initial state.

pub const INITIAL_ACYCLIC: FstProperties

FST has no cycles containing the initial state.

pub const TOP_SORTED: FstProperties

FST is topologically sorted.

pub const NOT_TOP_SORTED: FstProperties

FST is not topologically sorted.

pub const ACCESSIBLE: FstProperties

All states reachable from the initial state.

pub const NOT_ACCESSIBLE: FstProperties

Not all states reachable from the initial state.

pub const COACCESSIBLE: FstProperties

All states can reach a final state.

pub const NOT_COACCESSIBLE: FstProperties

Not all states can reach a final state.

pub const STRING: FstProperties

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: FstProperties

Not a string FST.

pub const WEIGHTED_CYCLES: FstProperties

FST has at least one weighted cycle.

pub const UNWEIGHTED_CYCLES: FstProperties

Only unweighted cycles.

pub const fn empty() -> FstProperties

Returns an empty set of flags

pub const fn all() -> FstProperties

Returns the set containing all flags.

pub const fn bits(&self) -> u64

Returns the raw value of the flags currently stored.

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

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

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

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u64) -> FstProperties

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

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

Returns true if there are flags common to both self and other.

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

Returns true all of the flags in other are contained within self.

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

Inserts or removes the specified flags depending on the passed value.

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<FstProperties> for FstProperties

type Output = FstProperties

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<FstProperties> for FstProperties

fn bitand_assign(&mut self, other: FstProperties)

Disables all flags disabled in the set.

impl BitOr<FstProperties> for FstProperties

type Output = FstProperties

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<FstProperties> for FstProperties

fn bitor_assign(&mut self, other: FstProperties)

Adds the set of flags.

impl BitXor<FstProperties> for FstProperties

type Output = FstProperties

The resulting type after applying the ^ operator.

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

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<FstProperties> for FstProperties

fn bitxor_assign(&mut self, other: FstProperties)

Toggles the set of flags.

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 Copy for FstProperties

impl Debug for FstProperties

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

Formats the value using the given formatter.

impl Eq for FstProperties

impl Extend<FstProperties> for FstProperties

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

Extends a collection with the contents of an iterator.

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 FromIterator<FstProperties> for FstProperties

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

Creates a value from an iterator.

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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for FstProperties

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

Formats the value using the given formatter.

impl Not for FstProperties

type Output = FstProperties

The resulting type after applying the ! operator.

fn not(self) -> FstProperties

Returns the complement of this set of flags.

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<FstProperties> 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: &FstProperties) -> bool

This method tests for !=.

impl PartialOrd<FstProperties> 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: &FstProperties) -> bool

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

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

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

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

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

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

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

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 StructuralEq for FstProperties

impl StructuralPartialEq for FstProperties

impl Sub<FstProperties> for FstProperties

type Output = FstProperties

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<FstProperties> for FstProperties

fn sub_assign(&mut self, other: FstProperties)

Disables all flags enabled in the set.

impl UpperHex for FstProperties

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

Formats the value using the given formatter.