Struct hilbert::permutation::Permutation

pub struct Permutation { /* fields omitted */ }

Defines a one-to-one mapping from one ordering of values to another. This can be used to rearrange the coordinates in a Point.

No coordinate value is lost or duplicated, so long as every value from 0 to dimensions - 1 is present in the moves_to collection.

Implementations

impl Permutation

pub fn identity(dimensions: usize) -> Self

Create a Permutation that causes no changes to the order of dimensions if applied to a Point.

pub fn new(moves: &[usize]) -> Self

Create a Permutation that performs the given set of moves.

pub fn random(dimensions: usize) -> Self

Create a random permutation which will cause almost every dimension to be shifted to a new position.

pub fn swap(&self, first_dimension: usize, second_dimension: usize) -> Self

Create a new Permutation where the two given dimensions are swapped.

This is useful for controlled permutation, unlike the chaotically scrambled Permutations generated by the random method.

pub fn dimensions(&self) -> usize

Number of dimensions of points that can be handled by the permutation.

pub fn apply<T>(&self, unpermuted_data: &[T]) -> Vec<T> where
    T: Clone, 

Apply the Permutation to data, cloning and reordering the input values appropriately.

Trait Implementations

impl Clone for Permutation

fn clone(&self) -> Permutation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Permutation

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

Formats the value using the given formatter.

impl PartialEq<Permutation> for Permutation

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

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

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

This method tests for !=.

impl StructuralPartialEq for Permutation