Struct nalgebra::linalg::PermutationSequence

pub struct PermutationSequence<D: Dim> where
    DefaultAllocator: Allocator<(usize, usize), D>,  { /* fields omitted */ }

A sequence of row or column permutations.

Implementations

impl<D: DimName> PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>, 

pub fn identity() -> Self

Creates a new statically-allocated sequence of D identity permutations.

impl PermutationSequence<Dynamic> where
    DefaultAllocator: Allocator<(usize, usize), Dynamic>, 

pub fn identity(n: usize) -> Self

Creates a new dynamically-allocated sequence of n identity permutations.

impl<D: Dim> PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>, 

pub fn identity_generic(dim: D) -> Self

Creates a new sequence of D identity permutations.

pub fn append_permutation(&mut self, i: usize, i2: usize)

Adds the interchange of the row (or column) i with the row (or column) i2 to this sequence of permutations.

pub fn permute_rows<T: Scalar, R2: Dim, C2: Dim, S2>(
    &self,
    rhs: &mut Matrix<T, R2, C2, S2>
) where
    S2: StorageMut<T, R2, C2>, 

Applies this sequence of permutations to the rows of rhs.

pub fn inv_permute_rows<T: Scalar, R2: Dim, C2: Dim, S2>(
    &self,
    rhs: &mut Matrix<T, R2, C2, S2>
) where
    S2: StorageMut<T, R2, C2>, 

Applies this sequence of permutations in reverse to the rows of rhs.

pub fn permute_columns<T: Scalar, R2: Dim, C2: Dim, S2>(
    &self,
    rhs: &mut Matrix<T, R2, C2, S2>
) where
    S2: StorageMut<T, R2, C2>, 

Applies this sequence of permutations to the columns of rhs.

pub fn inv_permute_columns<T: Scalar, R2: Dim, C2: Dim, S2>(
    &self,
    rhs: &mut Matrix<T, R2, C2, S2>
) where
    S2: StorageMut<T, R2, C2>, 

Applies this sequence of permutations in reverse to the columns of rhs.

pub fn len(&self) -> usize

The number of non-identity permutations applied by this sequence.

pub fn is_empty(&self) -> bool

Returns true if the permutation sequence contains no elements.

pub fn determinant<T: One + ClosedNeg>(&self) -> T

The determinant of the matrix corresponding to this permutation.

Trait Implementations

impl<D: Clone + Dim> Clone for PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>, 

fn clone(&self) -> PermutationSequence<D>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<D: Debug + Dim> Debug for PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>, 

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

Formats the value using the given formatter.

impl<'de, D: Dim> Deserialize<'de> for PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>,
    DefaultAllocator: Allocator<(usize, usize), D>,
    OVector<(usize, usize), D>: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<D: Dim> Serialize for PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>,
    DefaultAllocator: Allocator<(usize, usize), D>,
    OVector<(usize, usize), D>: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<D: Dim> Copy for PermutationSequence<D> where
    DefaultAllocator: Allocator<(usize, usize), D>,
    OVector<(usize, usize), D>: Copy,