Struct Inversion 

pub struct Inversion<T> {
    pub inversion: Vec<T>,
}

Contains a Inversion vector and methods to generate and trasnform them.

Fields

inversion: Vec<T>

Implementations

impl<T> Inversion<T>

where T: Copy + From<u8> + TryFrom<usize> + TryInto<usize> + Eq + SampleRange + PartialOrd + Sub + Display + Debug,

pub fn from_vec(vec: Vec<T>) -> Inversion<T>

Creates a Inversion object from the vector.

Example

use permu_rs::inversion::Inversion;
let inversion_vec = vec![0,0,1,1,4];
let my_inversion = Inversion::<u8>::from_vec(inversion_vec);

pub fn len(&self) -> usize

Returns the length of the inner inversion vector.

pub fn zeros(length: usize) -> Inversion<T>

Creates a Inversion filled with 0s.

Example

use permu_rs::inversion::Inversion;
assert_eq!(vec![0,0,0], Inversion::<u8>::zeros(3).inversion);

pub fn from_permu( permu: &Permutation<T>, inversion: &mut Inversion<T>, ) -> Result<(), Error>

Fills a given Inversion with the inversion representation of the given Permutation.

Errors

The length of the Inversion must be the size of the Permutation - 1. Otherwise, the function will return a LengthError.

Example

use permu_rs::*;
let permu = permutation::Permutation::<u8>::from_vec(vec![0,3,2,1]).unwrap();
let mut inversion_repr = inversion::Inversion::zeros(3);
inversion::Inversion::from_permu(&permu, &mut inversion_repr).unwrap();
assert_eq!(vec![0,2,1], inversion_repr.inversion);

pub fn to_permu(&self, out: &mut Permutation<T>) -> Result<(), Error>

Returns a Permutation created from the Inversion representation.

Errors

The length of the Inversion must be the size of the Permutation - 1. Otherwise, the function will return a LengthError error.

Example

use permu_rs::*;
let inversion = inversion::Inversion::<u8>::from_vec(vec![0,2,1]);
let mut permu = permutation::Permutation::<u8>::identity(4);
inversion.to_permu(&mut permu).unwrap();
assert_eq!(vec![0,3,2,1], permu.permu);

Trait Implementations

impl<T: Clone> Clone for Inversion<T>

fn clone(&self) -> Inversion<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Inversion<T>

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

Formats the value using the given formatter.

impl<T: PartialEq> PartialEq for Inversion<T>

fn eq(&self, other: &Inversion<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> StructuralPartialEq for Inversion<T>