Struct rustfst::semirings::SemiringProperties

pub struct SemiringProperties { /* fields omitted */ }

Properties verified by the Semiring.

Implementations

impl SemiringProperties

pub const LEFT_SEMIRING: SemiringProperties

For all a, b, c: Times(c, Plus(a, b)) = Plus(Times(c, a), Times(c, b)).

pub const RIGHT_SEMIRING: SemiringProperties

For all a, b, c: Times(Plus(a, b), c) = Plus(Times(a, c), Times(b, c)).

pub const COMMUTATIVE: SemiringProperties

For all a, b: Times(a, b) = Times(b, a).

pub const IDEMPOTENT: SemiringProperties

For all a: Plus(a, a) = a.

pub const PATH: SemiringProperties

For all a, b: Plus(a, b) = a or Plus(a, b) = b.

pub const SEMIRING: SemiringProperties

pub const fn empty() -> SemiringProperties

Returns an empty set of flags

pub const fn all() -> SemiringProperties

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<SemiringProperties>

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

pub const fn from_bits_truncate(bits: u32) -> SemiringProperties

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

pub const unsafe fn from_bits_unchecked(bits: u32) -> SemiringProperties

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: SemiringProperties) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for SemiringProperties

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

Formats the value using the given formatter.

impl BitAnd<SemiringProperties> for SemiringProperties

type Output = SemiringProperties

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<SemiringProperties> for SemiringProperties

fn bitand_assign(&mut self, other: SemiringProperties)

Disables all flags disabled in the set.

impl BitOr<SemiringProperties> for SemiringProperties

type Output = SemiringProperties

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<SemiringProperties> for SemiringProperties

fn bitor_assign(&mut self, other: SemiringProperties)

Adds the set of flags.

impl BitXor<SemiringProperties> for SemiringProperties

type Output = SemiringProperties

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<SemiringProperties> for SemiringProperties

fn bitxor_assign(&mut self, other: SemiringProperties)

Toggles the set of flags.

impl Clone for SemiringProperties

fn clone(&self) -> SemiringProperties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for SemiringProperties

impl Debug for SemiringProperties

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

Formats the value using the given formatter.

impl Eq for SemiringProperties

impl Extend<SemiringProperties> for SemiringProperties

fn extend<T: IntoIterator<Item = SemiringProperties>>(&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<SemiringProperties> for SemiringProperties

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

Creates a value from an iterator.

impl Hash for SemiringProperties

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 SemiringProperties

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

Formats the value using the given formatter.

impl Not for SemiringProperties

type Output = SemiringProperties

The resulting type after applying the ! operator.

fn not(self) -> SemiringProperties

Returns the complement of this set of flags.

impl Octal for SemiringProperties

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

Formats the value using the given formatter.

impl Ord for SemiringProperties

fn cmp(&self, other: &SemiringProperties) -> 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<SemiringProperties> for SemiringProperties

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

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

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

This method tests for !=.

impl PartialOrd<SemiringProperties> for SemiringProperties

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for SemiringProperties

impl StructuralPartialEq for SemiringProperties

impl Sub<SemiringProperties> for SemiringProperties

type Output = SemiringProperties

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<SemiringProperties> for SemiringProperties

fn sub_assign(&mut self, other: SemiringProperties)

Disables all flags enabled in the set.

impl UpperHex for SemiringProperties

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

Formats the value using the given formatter.