Struct OrdinalMap 

pub struct OrdinalMap { /* private fields */ }

A complete bijection from output positions to input positions.

Entry i names the input position copied into output position i. The constructor validates the complete finite map before it can be applied.

Implementations

impl OrdinalMap

pub fn try_new(output_to_input: Vec<usize>) -> Result<Self, OrdinalMapError>

Validates a complete bijection over 0..output_to_input.len().

pub fn identity(cardinality: usize) -> Self

Constructs the identity map of the requested cardinality.

pub fn retrograde(cardinality: usize) -> Self

Constructs a retrograde map of the requested cardinality.

pub fn rotation(cardinality: usize, steps: usize) -> Self

Constructs a left rotation by steps, reduced modulo the cardinality.

pub fn cardinality(&self) -> usize

Returns the finite domain cardinality.

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

Returns the validated output-to-input ordinal map.

pub fn is_identity(&self) -> bool

Returns whether this map preserves every position.

pub fn apply<T: Clone>(&self, source: &[T]) -> Result<Vec<T>, OrdinalMapError>

Applies this map to a slice after checking its cardinality.

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

Returns the exact inverse map.

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

Composes self followed by next into one canonical map.

pub fn canonical_form(&self) -> String

Returns the deterministic canonical ordinal representation.

Trait Implementations

impl Clone for OrdinalMap

fn clone(&self) -> OrdinalMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrdinalMap

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

Formats the value using the given formatter.

impl Eq for OrdinalMap

impl Hash for OrdinalMap

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 Ord for OrdinalMap

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

Restrict a value to a certain interval.

impl PartialEq for OrdinalMap

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OrdinalMap

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for OrdinalMap