Struct faer :: perm :: Perm Copy item path

impl<I: Index> Perm

pub fn as_ref(&self) -> PermRef<'_, I>

Convert self to a permutation view.

pub fn new_checked(forward: Box<[I]>, inverse: Box<[I]>) -> Self

Creates a new permutation, by checking the validity of the inputs.

§Panics

The function panics if any of the following conditions are violated: forward and inverse must have the same length which must be less than or equal to I::Signed::MAX, be valid permutations, and be inverse permutations of each other.

pub unsafe fn new_unchecked(forward: Box<[I]>, inverse: Box<[I]>) -> Self

Creates a new permutation reference, without checking the validity of the inputs.

§Safety

forward and inverse must have the same length which must be less than or equal to I::Signed::MAX, be valid permutations, and be inverse permutations of each other.

pub fn into_arrays(self) -> (Box<[I]>, Box<[I]>)

Returns the permutation as an array.

pub fn len(&self) -> usize

Returns the dimension of the permutation.

pub fn into_inverse(self) -> Self

Returns the inverse permutation.

Trait Implementations§

impl<I: Clone + Index> Clone for Perm

fn clone(&self) -> Perm

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl<I: Debug + Index> Debug for Perm

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

Formats the value using the given formatter. Read more

impl<I: Index, E: Conjugate> Mul<&Col<E>> for &Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Col<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Col<E>> for Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Col<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&ColMut<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &ColMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&ColMut<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &ColMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&ColRef<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &ColRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&ColRef<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &ColRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Mat<E>> for &Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Mat<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Mat<E>> for Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Mat<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&MatMut<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &MatMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&MatMut<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &MatMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&MatRef<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &MatRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&MatRef<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &MatRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for &Mat<E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for &MatMut<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for &MatRef<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<&Perm> for &Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<&Perm> for &PermRef<'_, I>

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for &Row<E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for &RowMut<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for &RowRef<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for Mat<E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for MatMut<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for MatRef<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<&Perm> for Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<&Perm> for PermRef<'_, I>

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for Row<E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for RowMut<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<&Perm> for RowRef<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: &Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<&PermRef<'_, I>> for &Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: &PermRef<'_, I>) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<&PermRef<'_, I>> for Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: &PermRef<'_, I>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Col<E>> for &Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Col<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Col<E>> for Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Col<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<ColMut<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: ColMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<ColMut<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: ColMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<ColRef<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: ColRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<ColRef<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Col<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: ColRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Mat<E>> for &Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Mat<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Mat<E>> for Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Mat<E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<MatMut<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: MatMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<MatMut<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: MatMut<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<MatRef<'_, E>> for &Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: MatRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<MatRef<'_, E>> for Perm
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: MatRef<'_, E>) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for &Mat<E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for &MatMut<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for &MatRef<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<Perm> for &Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<Perm> for &PermRef<'_, I>

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for &Row<E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for &RowMut<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for &RowRef<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for Mat<E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for MatMut<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for MatRef<'_, E>
where E::Canonical: ComplexField,

type Output = Mat<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<Perm> for PermRef<'_, I>

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for Row<E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for RowMut<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index, E: Conjugate> Mul<Perm> for RowRef<'_, E>
where E::Canonical: ComplexField,

type Output = Row<<E as Conjugate>::Canonical>

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<PermRef<'_, I>> for &Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: PermRef<'_, I>) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul<PermRef<'_, I>> for Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: PermRef<'_, I>) -> Self::Output

Performs the * operation. Read more

impl<I: Index> Mul for Perm

type Output = Perm

The resulting type after applying the * operator.

fn mul(self, other: Perm) -> Self::Output

Performs the * operation. Read more

impl<I: Index> PartialEq<Perm> for PermRef<'_, I>

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

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

1.0.0 · source§

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

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

impl<I: Index> PartialEq<PermRef<'_, I>> for Perm

fn eq(&self, other: &PermRef<'_, I>) -> bool

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

1.0.0 · source§

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

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

impl<I: Index> PartialEq for Perm

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

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

1.0.0 · source§

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

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

Auto Trait Implementations§

impl UnwindSafe for Perm
where I: UnwindSafe,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<T> Pointable for T

const ALIGN: usize = _

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for T
where U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.