Struct agnes::permute::Permutation

pub struct Permutation<I> { /* fields omitted */ }

A structure containing information about the permutation status of a field. I represents the underlying permutation implementation type (such as Vec<usize> or &usize).

Methods

impl Permutation<Vec<usize>>

pub fn update_indices(
    self,
    new_permutation: &[usize]
) -> Permutation<Vec<usize>>

Consumes this Permutation and returns a new Permutation with new values from new_permutation.

impl<'_> Permutation<&'_ [usize]>

pub fn map_index(&self, requested: usize) -> usize

Returns the re-organized index of a requested index.

pub fn len(&self) -> Option<usize>

Returns the length of this permutation, if it exists. None means that no permutation exists (the full field in its original order can be used).

pub fn is_permuted(&self) -> bool

Returns whether or not a permutation actually exists.

impl Permutation<Vec<usize>>

pub fn map_index(&self, requested: usize) -> usize

Returns the re-organized index of a requested index.

pub fn len(&self) -> Option<usize>

Returns the length of this permutation, if it exists. None means that no permutation exists (the full field in its original order can be used).

pub fn is_permuted(&self) -> bool

Returns whether or not a permutation actually exists.

Trait Implementations

impl<I: Eq> Eq for Permutation<I>

impl<I: PartialEq> PartialEq<Permutation<I>> for Permutation<I>

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

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

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

This method tests for !=.

impl<I: Clone> Clone for Permutation<I>

fn clone(&self) -> Permutation<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Default for Permutation<I>

fn default() -> Permutation<I>

Returns the "default value" for a type.

impl<'a> From<&'a [usize]> for Permutation<&'a [usize]>

fn from(orig: &'a [usize]) -> Permutation<&'a [usize]>

Performs the conversion.

impl From<Vec<usize>> for Permutation<Vec<usize>>

fn from(orig: Vec<usize>) -> Permutation<Vec<usize>>

Performs the conversion.

impl<I: Debug> Debug for Permutation<I>

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

Formats the value using the given formatter.

impl<I: Hash> Hash for Permutation<I>

fn hash<__HI: Hasher>(&self, state: &mut __HI)

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].