PermutationSequence in nalgebra::linalg - Rust
Description: A sequence of row or column permutations.
Keywords: rust, rustlang, rust-lang, PermutationSequence

# Struct nalgebra::linalg::PermutationSequence

source ·

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

Expand description

A sequence of row or column permutations.

## Implementations§

source§

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

source

#### pub fn identity() -> Self

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

source§

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

source

#### pub fn identity(n: usize) -> Self

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

source§

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

source

#### pub fn identity_generic(dim: D) -> Self

Creates a new sequence of D identity permutations.

source

#### 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.

source

#### 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`.

source

#### 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`.

source

#### 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`.

source

#### 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`.

source

#### pub fn len(&self) -> usize

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

source

#### pub fn is_empty(&self) -> bool

Returns true if the permutation sequence contains no elements.

source

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

The determinant of the matrix corresponding to this permutation.

## Trait Implementations§

source§

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

source§

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

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
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

## Auto Trait Implementations§

§

### impl<D> !RefUnwindSafe for PermutationSequence<D>

§

### impl<D> !Send for PermutationSequence<D>

§

### impl<D> !Sync for PermutationSequence<D>

§

### impl<D> !Unpin for PermutationSequence<D>

§

### impl<D> !UnwindSafe for PermutationSequence<D>

## Blanket Implementations§

source§

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

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

const: unstable · source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source§

#### fn into(self) -> U

Calls `U::from(self)`.

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

source§

### impl<T> Same<T> for T

§

#### type Output = T

Should always be `Self`
source§

### impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

source§

#### fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct `self` from the equivalent element of its superset. Read more
source§

#### fn is_in_subset(&self) -> bool

Checks if `self` is actually part of its subset `T` (and can be converted to it).
source§

#### fn to_subset_unchecked(&self) -> SS

Use with care! Same as `self.to_subset` but without any property checks. Always succeeds.
source§

#### fn from_subset(element: &SS) -> SP

The inclusion map: converts `self` to the equivalent element of its superset.
source§

### impl<T> ToOwned for Twhere
T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

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

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

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

### impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.