Struct SeriesTransform 

pub struct SeriesTransform<A>
where
    A: SerialAlphabet,
{ /* private fields */ }

A normalized positional and/or symbolic series transform.

Implementations

impl<A> SeriesTransform<A>

where A: SerialAlphabet,

pub fn identity(cardinality: usize) -> SeriesTransform<A>

Constructs an identity transform for a known series cardinality.

pub fn retrograde(cardinality: usize) -> SeriesTransform<A>

Constructs a retrograde transform for a known series cardinality.

pub fn rotation(cardinality: usize, steps: usize) -> SeriesTransform<A>

Constructs a left position rotation reduced modulo the series cardinality.

pub fn block_partition(partition: BlockPartition) -> SeriesTransform<A>

Constructs the order transform induced by an exhaustive block partition.

pub fn ordinal_permutation(order_map: OrdinalMap) -> SeriesTransform<A>

Constructs a transform from a prevalidated ordinal permutation.

pub fn cyclic_relabeling( alphabet: A, steps: usize, ) -> Result<SeriesTransform<A>, SymbolBijectionError>

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

pub fn bijection(relabeling: SymbolBijection<A>) -> SeriesTransform<A>

Constructs a transform from a caller-supplied validated symbol bijection.

pub fn order_map(&self) -> Option<&OrdinalMap>

Returns the explicit order map, or None when positions are retained.

pub fn relabeling(&self) -> Option<&SymbolBijection<A>>

Returns the symbolic relabeling, or None when symbols are retained.

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

Composes self followed by next into one normalized transform.

pub fn inverse(&self) -> Result<SeriesTransform<A>, SeriesTransformError>

Returns the exact inverse transform.

pub fn canonical_form(&self) -> String

Returns a deterministic canonical representation of the normalized maps.

Trait Implementations

impl<A> Clone for SeriesTransform<A>

where A: Clone + SerialAlphabet,

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<A> Debug for SeriesTransform<A>

where A: Debug + SerialAlphabet,

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

Formats the value using the given formatter.

impl<A> Eq for SeriesTransform<A>

where A: Eq + SerialAlphabet,

impl<A> PartialEq for SeriesTransform<A>

where A: PartialEq + SerialAlphabet,

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

Equality operator ==.

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

Inequality operator !=.

impl<A> StructuralPartialEq for SeriesTransform<A>

where A: PartialEq + SerialAlphabet,