Skip to main content

SymbolBijection

Struct SymbolBijection 

Source
pub struct SymbolBijection<A: SerialAlphabet> { /* private fields */ }
Expand description

A caller-defined, validated bijection between two finite alphabets.

Implementations§

Source§

impl<A: SerialAlphabet> SymbolBijection<A>

Source

pub fn try_new<I>( source: A, target: A, pairs: I, ) -> Result<Self, SymbolBijectionError>
where I: IntoIterator<Item = (A::Symbol, A::Symbol)>,

Validates a complete symbol-pair bijection from source to target.

Source

pub fn cyclic(alphabet: A, steps: usize) -> Result<Self, SymbolBijectionError>

Constructs a cyclic relabeling over one alphabet’s canonical order.

Source

pub fn source(&self) -> &A

Returns the source alphabet.

Source

pub fn target(&self) -> &A

Returns the target alphabet.

Source

pub fn source_to_target(&self) -> &[usize]

Returns the validated source-position to target-position bijection.

Source

pub fn map_symbol( &self, symbol: &A::Symbol, ) -> Result<A::Symbol, SymbolBijectionError>

Maps one source symbol to its target symbol.

Source

pub fn is_identity(&self) -> bool

Returns whether symbols and alphabet identity are unchanged.

Source

pub fn inverse(&self) -> Result<Self, SymbolBijectionError>

Returns the exact inverse bijection.

Source

pub fn compose(&self, next: &Self) -> Result<Self, SeriesTransformError>

Composes self followed by next.

Source

pub fn canonical_form(&self) -> String

Returns the deterministic identity-and-ordinal representation.

Trait Implementations§

Source§

impl<A: Clone + SerialAlphabet> Clone for SymbolBijection<A>

Source§

fn clone(&self) -> SymbolBijection<A>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<A: Debug + SerialAlphabet> Debug for SymbolBijection<A>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<A: Eq + SerialAlphabet> Eq for SymbolBijection<A>

Source§

impl<A: PartialEq + SerialAlphabet> PartialEq for SymbolBijection<A>

Source§

fn eq(&self, other: &SymbolBijection<A>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<A: PartialEq + SerialAlphabet> StructuralPartialEq for SymbolBijection<A>

Auto Trait Implementations§

§

impl<A> Freeze for SymbolBijection<A>
where A: Freeze,

§

impl<A> RefUnwindSafe for SymbolBijection<A>
where A: RefUnwindSafe,

§

impl<A> Send for SymbolBijection<A>
where A: Send,

§

impl<A> Sync for SymbolBijection<A>
where A: Sync,

§

impl<A> Unpin for SymbolBijection<A>
where A: Unpin,

§

impl<A> UnsafeUnpin for SymbolBijection<A>
where A: UnsafeUnpin,

§

impl<A> UnwindSafe for SymbolBijection<A>
where A: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.