Struct Mat 

pub struct Mat<const ROWS: usize, const COLS: usize, E, Descriptor>(/* private fields */)
where
    E: MatEl;

A matrix structure.

Implementations

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

pub fn _fill(scalar: E) -> Self

where E: MatEl,

Fill matrix with a scalar value.

pub const fn as_ptr(&self) -> *const E

Returns a raw pointer to the matrix buffer.

pub fn as_mut_ptr(&mut self) -> *mut E

Returns an unsafe mutable pointer to the slice’s buffer.

pub const fn rows(&self) -> usize

Returns the number of rows in the matrix.

pub const fn cols(&self) -> usize

Returns the number of columns in the matrix.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

pub fn dim(&self) -> <Self as Indexable>::Index

Dimensions of the matrix.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl, Self: RawSliceMut<Scalar = E>,

pub fn from_row_major<const N: usize>(scalars: impl ArrayRef<E, N>) -> Self

Creates a matrix assuming the input to be in row major order

pub fn from_column_major<const N: usize>(scalars: impl ArrayRef<E, N>) -> Self

Creates a matrix assuming the input to be in column major order

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl, Self: RawSlice,

pub fn raw_slice(&self) -> &[<Self as Collection>::Scalar]

Returns a reference to the underlying data as a flat array.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl, Self: RawSliceMut,

pub fn as_raw_slice_mut(&mut self) -> &mut [<Self as Collection>::Scalar]

Returns a mutable reference to the underlying data as a flat array.

Returns

• A mutable slice of the scalar data.

pub fn set_raw_slice(&mut self, scalars: &[<Self as Collection>::Scalar])

Sets the underlying data from a slice of scalars.

Arguments

• scalars: A slice of scalars to set the data.

pub fn set_raw<const N: usize>( self, scalars: [<Self as Collection>::Scalar; N], ) -> Self

Sets the underlying data from an array of scalars.

Arguments

• scalars: An array of scalars to set the data.

pub fn set_data<const N: usize>( self, scalars: [<Self as Collection>::Scalar; N], ) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in row major order. The resulting data will conform to the type of matrix used - row major or column major.

Arguments

• scalars: An array of scalars to set the data.

pub fn set_row_major(self, scalars: &[<Self as Collection>::Scalar]) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in row major order. The resulting data will conform to the type of matrix used - row major or column major.

Arguments

• scalars: An array of scalars to set the data.

pub fn set_column_major(self, scalars: &[<Self as Collection>::Scalar]) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in column major order. The resulting data will conform to the type of matrix used - row major or column major.

/// # Arguments

• scalars: An array of scalars to set the data.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Self: IndexingRef,

pub fn lane_iter( &self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = &<Self as Collection>::Scalar>

Iterate over scalars of a single 1D lane.

Parameters

• varying_dim: The dimension that varies (0 for rows, 1 for columns).
• lane: The index of the lane (row or column) to iterate over.

Returns

• An iterator over references to the scalars in the specified lane.

pub fn lane_indexed_iter( &self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &<Self as Collection>::Scalar)>

Iterate over scalars of a single 1D lane with indices.

Parameters

• varying_dim: The dimension that varies (0 for rows, 1 for columns).
• lane: The index of the lane (row or column) to iterate over.

Returns

• An iterator over tuples of indices and references to the scalars in the specified lane.

pub fn iter_unstable( &self, ) -> impl Iterator<Item = &<Self as Collection>::Scalar>

Iterate over all scalars. Order of iteration is not specified.

Returns

• An iterator over references to all scalars in the matrix.

pub fn iter_indexed_unstable( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &<Self as Collection>::Scalar)>

Iterate over all scalars with indices. Order of iteration is not specified.

Returns

• An iterator over tuples of indices and references to all scalars in the matrix.

pub fn iter_lsfirst( &self, ) -> impl Iterator<Item = &<Self as Collection>::Scalar>

Iterate over all scalars in least significant dimension order.

Returns

• An iterator over references to all scalars in the matrix.

pub fn iter_indexed_lsfirst( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &<Self as Collection>::Scalar)>

Iterate over all scalars with indices in least significant dimension order.

Returns

• An iterator over tuples of indices and references to all scalars in the matrix.

pub fn iter_msfirst( &self, ) -> impl Iterator<Item = &<Self as Collection>::Scalar>

Iterate over all scalars in most significant dimension order.

Returns

• An iterator over references to all scalars in the matrix.

pub fn iter_indexed_msfirst( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &<Self as Collection>::Scalar)>

Iterate over all scalars with indices in most significant dimension order.

Returns

• An iterator over tuples of indices and references to all scalars in the matrix.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Self: IndexingMut,

pub fn lane_iter_mut( &mut self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = &mut <Self as Collection>::Scalar>

Iterate over scalars of a single 1D lane with mutable access.

Parameters

• varying_dim: The dimension that varies (0 for rows, 1 for columns).
• lane: The index of the lane (row or column) to iterate over.

Returns

• An iterator over mutable references to the scalars in the specified lane.

pub fn lane_iter_indexed_mut( &mut self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut <Self as Collection>::Scalar)>

Iterate over scalars of a single 1D lane with indices and mutable access.

Parameters

• varying_dim: The dimension that varies (0 for rows, 1 for columns).
• lane: The index of the lane (row or column) to iterate over.

Returns

• An iterator over tuples of indices and mutable references to the scalars in the specified lane.

pub fn iter_unstable_mut( &mut self, ) -> impl Iterator<Item = &mut <Self as Collection>::Scalar>

Iterate over all scalars with mutable access. Order of iteration is not specified.

Returns

• An iterator over mutable references to all scalars in the matrix.

pub fn iter_indexed_unstable_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut <Self as Collection>::Scalar)>

Iterate over all scalars with indices and mutable access. Order of iteration is not specified.

Returns

• An iterator over tuples of indices and mutable references to all scalars in the matrix.

pub fn iter_lsfirst_mut( &mut self, ) -> impl Iterator<Item = &mut <Self as Collection>::Scalar>

Iterate over all scalars in least significant dimension order with mutable access.

Returns

• An iterator over mutable references to all scalars in the matrix.

pub fn iter_indexed_lsfirst_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut <Self as Collection>::Scalar)>

Iterate over all scalars with indices in least significant dimension order with mutable access.

Returns

• An iterator over tuples of indices and mutable references to all scalars in the matrix.

pub fn iter_msfirst_mut( &mut self, ) -> impl Iterator<Item = &mut <Self as Collection>::Scalar>

Iterate over all scalars in most significant dimension order with mutable access.

Returns

• An iterator over mutable references to all scalars in the matrix.

pub fn iter_indexed_msfirst_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut <Self as Collection>::Scalar)>

Iterate over all scalars with indices in most significant dimension order with mutable access.

Returns

• An iterator over tuples of indices and mutable references to all scalars in the matrix.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Self: ScalarRef,

pub fn scalar_ref( &self, index: <Self as Indexable>::Index, ) -> &<Self as Collection>::Scalar

Get a reference to a scalar at a specified index.

Parameters

• index: The index of the scalar to access.

Returns

• A mutable reference to the scalar at the specified index.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Self: ScalarMut,

pub fn scalar_mut( &mut self, index: <Self as Indexable>::Index, ) -> &mut <Self as Collection>::Scalar

Get a mutable reference to a scalar at a specified index.

Parameters

• index: The index of the scalar to access.

Returns

• A mutable reference to the scalar at the specified index.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl, Self: ConstLayout,

pub fn scalar_offset(index: <Self as Indexable>::Index) -> usize

Get offset for a specified scalar from beginning of underlying buffer.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

pub fn transpose(&self) -> Mat<COLS, ROWS, E, Descriptor>

where E: NdFloat + Default + Copy, Self: IndexingRef<Scalar = E>, Mat<COLS, ROWS, E, Descriptor>: IndexingMut<Scalar = E>,

Transpose, rarranging data in memory, not just shape descriptor.

impl<E, Descriptor> Mat<2, 2, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: RawSliceMut<Scalar = E> + ScalarMut<Scalar = E, Index = Ix2> + ConstLayout<Index = Ix2> + IndexingMut<Scalar = E, Index = Ix2>,

pub fn determinant(&self) -> E

Computes the determinant of the matrix

pub fn inverse(&self) -> Option<Self>

Computes the inverse of the matrix. If the determinant is zero - return None

impl<E, Descriptor> Mat<3, 3, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: RawSliceMut<Scalar = E> + ScalarMut<Scalar = E, Index = Ix2> + ConstLayout<Index = Ix2> + IndexingMut<Scalar = E, Index = Ix2>,

pub fn determinant(&self) -> E

Computes the determinant of the matrix

pub fn inverse(&self) -> Option<Self>

Computes the inverse of the matrix. If the determinant is zero - return None

pub fn from_scale_rotation_translation<Vec>( scale: Vec, rotation: E, translation: Vec, ) -> Self

where Vec: VectorIter<E, 2>,

Creates a transformation matrix from scale, rotation( angle ) and translation

impl<E, Descriptor> Mat<3, 3, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: RawSlice<Scalar = E>,

pub fn to_array(&self) -> [E; 9]

Converts the matrix to an array

pub fn to_homogenous(&self) -> Mat4<E, Descriptor>

where Mat4<E, Descriptor>: RawSliceMut<Scalar = E>,

Converts the matrix to a 4x4 homogenous matrix

pub fn truncate(&self) -> Mat<2, 2, E, Descriptor>

where Mat<2, 2, E, Descriptor>: RawSliceMut<Scalar = E>,

Convertes this matrix into the 3x3 matrix

impl<E, Descriptor> Mat<3, 3, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: RawSliceMut<Scalar = E>,

pub fn from_cols(x: Vector<E, 3>, y: Vector<E, 3>, z: Vector<E, 3>) -> Self

Construct a matrix from columns

pub fn from_quat(quat: Quat<E>) -> Self

Creates a rotation matrix from a unit quaternion

impl<E, Descriptor> Mat<4, 4, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: ScalarMut<Scalar = E, Index = Ix2> + RawSliceMut<Scalar = E> + ConstLayout<Index = Ix2> + IndexingMut<Scalar = E, Index = Ix2>,

pub fn determinant(&self) -> E

where Mat<3, 3, E, Descriptor>: RawSliceMut<Scalar = E> + ScalarMut<Scalar = E, Index = Ix2> + ConstLayout<Index = Ix2> + IndexingMut<Scalar = E, Index = Ix2>,

Computes the determinant of the matrix

pub fn inverse(&self) -> Option<Self>

where Mat<3, 3, E, Descriptor>: RawSliceMut<Scalar = E> + ScalarMut<Scalar = E, Index = Ix2> + ConstLayout<Index = Ix2> + IndexingMut<Scalar = E, Index = Ix2>,

Computes the inverse of the matrix. If the determinant is zero - return None

impl<E, Descriptor> Mat<4, 4, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: RawSlice<Scalar = E>,

pub fn to_array(&self) -> [E; 16]

Converts the matrix to an array

pub fn truncate(&self) -> Mat<3, 3, E, Descriptor>

where Mat<3, 3, E, Descriptor>: RawSliceMut<Scalar = E>,

Convertes this matrix into the 3x3 matrix

impl<E, Descriptor> Mat<4, 4, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Self: ScalarMut<Scalar = E> + IndexingMut<Scalar = E, Index = Ix2>,

pub fn from_scale_rotation_translation<Vec, Q>( scale: Vec, rotation: Q, translation: Vec, ) -> Self

where Vec: VectorIter<E, 3>, Q: Into<Quat<E>>,

Creates a transformation matrix from scale, rotation and translation

Trait Implementations

impl<E, const ROWS: usize, const COLS: usize, Descriptor> AbsDiffEq for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: PartialEq + Descriptor, Self: Collection<Scalar = E>, Mat<ROWS, COLS, E, Descriptor>: RawSlice, E: AbsDiffEq + MatEl, E::Epsilon: Copy,

type Epsilon = <E as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> Add<&Mat<ROWS, COLS, E, Descriptor>> for &Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingMut<Scalar = E>,

type Output = Mat<ROWS, COLS, E, Descriptor>

The resulting type after applying the + operator.

fn add(self, rhs: &Mat<ROWS, COLS, E, Descriptor>) -> Self::Output

Performs the + operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> Add for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Descriptor: Descriptor, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingMut<Scalar = E>,

type Output = Mat<ROWS, COLS, E, Descriptor>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<const ROWS: usize, const COLS: usize, E, Descriptor: Clone> Clone for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + Clone,

fn clone(&self) -> Mat<ROWS, COLS, E, Descriptor>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Collection for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

type Scalar = E

The scalar type contained in the collection.

impl<E, const ROWS: usize, const COLS: usize> ConstLayout for Mat<ROWS, COLS, E, DescriptorOrderColumnMajor>

where E: MatEl,

fn scalar_offset(index: <Self as Indexable>::Index) -> usize

Get offset for a specified scalar from beginning of underlying buffer.

impl<E, const ROWS: usize, const COLS: usize> ConstLayout for Mat<ROWS, COLS, E, DescriptorOrderRowMajor>

where E: MatEl,

fn scalar_offset(index: <Self as Indexable>::Index) -> usize

Get offset for a specified scalar from beginning of underlying buffer.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Debug for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + Debug, Self: IndexingRef<Scalar = E>,

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

Formats the value using the given formatter.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Default for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

fn default() -> Self

Returns the “default value” for a type.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> Div<E> for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Self: Indexable<Index = Ix2> + ScalarMut<Scalar = E>,

type Output = Mat<ROWS, COLS, E, Descriptor>

The resulting type after applying the / operator.

fn div(self, rhs: E) -> Self::Output

Performs the / operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> DivAssign<E> for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Self: Indexable<Index = Ix2> + ScalarMut<Scalar = E>,

fn div_assign(&mut self, rhs: E)

Performs the /= operation.

impl<const ROWS: usize, const COLS: usize, E, Descriptor: Hash> Hash for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + Hash,

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> Indexable for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

type Index = Dim<[usize; 2]>

The type representing the dimension of the object.

fn dim(&self) -> Self::Index

Returns the dimension of the object.

impl<E, const ROWS: usize, const COLS: usize> IndexingMut for Mat<ROWS, COLS, E, DescriptorOrderColumnMajor>

where E: MatEl + NdFloat,

fn lane_iter_mut( &mut self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over scalars of a single 1D lane with mutable access.

fn lane_iter_indexed_mut( &mut self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over scalars of a single 1D lane with indices and mutable access.

fn iter_unstable_mut(&mut self) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over all scalars with mutable access. Order of iteration is not specified.

fn iter_indexed_unstable_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over all scalars with indices and mutable access. Order of iteration is not specified.

fn iter_lsfirst_mut(&mut self) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over all scalars in least significant dimension order with mutable access.

fn iter_indexed_lsfirst_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over all scalars with indices in least significant dimension order with mutable access.

fn iter_msfirst_mut(&mut self) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over all scalars in most significant dimension order with mutable access.

fn iter_indexed_msfirst_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over all scalars with indices in most significant dimension order with mutable access.

impl<E, const ROWS: usize, const COLS: usize> IndexingMut for Mat<ROWS, COLS, E, DescriptorOrderRowMajor>

where E: MatEl + NdFloat,

fn lane_iter_mut( &mut self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over scalars of a single 1D lane with mutable access.

fn lane_iter_indexed_mut( &mut self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over scalars of a single 1D lane with indices and mutable access.

fn iter_unstable_mut(&mut self) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over all scalars with mutable access. Order of iteration is not specified.

fn iter_indexed_unstable_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over all scalars with indices and mutable access. Order of iteration is not specified.

fn iter_lsfirst_mut(&mut self) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over all scalars in least significant dimension order with mutable access.

fn iter_indexed_lsfirst_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over all scalars with indices in least significant dimension order with mutable access.

fn iter_msfirst_mut(&mut self) -> impl Iterator<Item = &mut Self::Scalar>

Iterate over all scalars in most significant dimension order with mutable access.

fn iter_indexed_msfirst_mut( &mut self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &mut Self::Scalar)>

Iterate over all scalars with indices in most significant dimension order with mutable access.

impl<E, const ROWS: usize, const COLS: usize> IndexingRef for Mat<ROWS, COLS, E, DescriptorOrderColumnMajor>

where E: MatEl + NdFloat,

fn lane_iter( &self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = &Self::Scalar>

Iterate over scalars of a single 1D lane.

fn lane_indexed_iter( &self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over scalars of a single 1D lane with indices.

fn iter_unstable(&self) -> impl Iterator<Item = &Self::Scalar>

Iterate over all scalars. Order of iteration is not specified.

fn iter_indexed_unstable( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over all scalars with indices. Order of iteration is not specified.

fn iter_lsfirst(&self) -> impl Iterator<Item = &Self::Scalar>

Iterate over all scalars in least significant dimension order.

fn iter_indexed_lsfirst( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over all scalars with indices in least significant dimension order.

fn iter_msfirst(&self) -> impl Iterator<Item = &Self::Scalar>

Iterate over all scalars in most significant dimension order.

fn iter_indexed_msfirst( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over all scalars with indices in most significant dimension order.

impl<E, const ROWS: usize, const COLS: usize> IndexingRef for Mat<ROWS, COLS, E, DescriptorOrderRowMajor>

where E: MatEl + NdFloat,

fn lane_iter( &self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = &Self::Scalar>

Iterate over scalars of a single 1D lane.

fn lane_indexed_iter( &self, varying_dim: usize, lane: usize, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over scalars of a single 1D lane with indices.

fn iter_unstable(&self) -> impl Iterator<Item = &Self::Scalar>

Iterate over all scalars. Order of iteration is not specified.

fn iter_indexed_unstable( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over all scalars with indices. Order of iteration is not specified.

fn iter_lsfirst(&self) -> impl Iterator<Item = &Self::Scalar>

Iterate over all scalars in least significant dimension order.

fn iter_indexed_lsfirst( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over all scalars with indices in least significant dimension order.

fn iter_msfirst(&self) -> impl Iterator<Item = &Self::Scalar>

Iterate over all scalars in most significant dimension order.

fn iter_indexed_msfirst( &self, ) -> impl Iterator<Item = (<Self as Indexable>::Index, &Self::Scalar)>

Iterate over all scalars with indices in most significant dimension order.

impl<E, const ROWS: usize, const COLS: usize, const COLS2: usize, Descriptor> Mul<&Mat<COLS, COLS2, E, Descriptor>> for &Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingMut<Scalar = E>, Mat<COLS, COLS2, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>, Mat<ROWS, COLS2, E, Descriptor>: Indexable<Index = Ix2> + ScalarMut<Scalar = E>,

type Output = Mat<ROWS, COLS2, E, Descriptor>

The resulting type after applying the * operator.

fn mul(self, rhs: &Mat<COLS, COLS2, E, Descriptor>) -> Self::Output

Performs the * operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> Mul<&Vector<E, COLS>> for &Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>,

type Output = Vector<E, COLS>

The resulting type after applying the * operator.

fn mul(self, rhs: &Vector<E, COLS>) -> Self::Output

Performs the * operation.

impl<E, const ROWS: usize, const COLS: usize, const COLS2: usize, Descriptor> Mul<Mat<COLS, COLS2, E, Descriptor>> for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingMut<Scalar = E>, Mat<COLS, COLS2, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>, Mat<ROWS, COLS2, E, Descriptor>: Indexable<Index = Ix2> + ScalarMut<Scalar = E>,

type Output = Mat<ROWS, COLS2, E, Descriptor>

The resulting type after applying the * operator.

fn mul(self, rhs: Mat<COLS, COLS2, E, Descriptor>) -> Self::Output

Performs the * operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> Mul<Vector<E, COLS>> for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>,

type Output = Vector<E, COLS>

The resulting type after applying the * operator.

fn mul(self, rhs: Vector<E, COLS>) -> Self::Output

Performs the * operation.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> MulAssign<Mat<ROWS, COLS, E, Descriptor>> for Vector<E, COLS>

where Descriptor: Descriptor, E: MatEl + NdFloat, Mat<ROWS, COLS, E, Descriptor>: Indexable<Index = Ix2> + IndexingRef<Scalar = E>,

fn mul_assign(&mut self, rhs: Mat<ROWS, COLS, E, Descriptor>)

Performs the *= operation.

impl<const ROWS: usize, const COLS: usize, E, Descriptor: PartialEq> PartialEq for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + PartialEq,

fn eq(&self, other: &Mat<ROWS, COLS, E, Descriptor>) -> 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<const ROWS: usize, const COLS: usize, E, Descriptor: PartialOrd> PartialOrd for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + PartialOrd,

fn partial_cmp( &self, other: &Mat<ROWS, COLS, E, Descriptor>, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> RawSlice for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

fn raw_slice(&self) -> &[Self::Scalar]

Returns a reference to the underlying data as a flat array.

impl<E, const ROWS: usize, const COLS: usize> RawSliceMut for Mat<ROWS, COLS, E, DescriptorOrderColumnMajor>

where E: MatEl, Self: Collection<Scalar = E>,

fn raw_slice_mut(&mut self) -> &mut [Self::Scalar]

Returns a mutable reference to the underlying data as a flat array.

fn raw_set_slice(&mut self, scalars: &[Self::Scalar])

Sets the underlying data from a slice of scalars.

fn raw_set<const N: usize>(self, scalars: [Self::Scalar; N]) -> Self

Sets the underlying data from an array of scalars.

fn with_row_major(self, scalars: &[Self::Scalar]) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in row major order. The resulting data will conform to the type of matrix used - row major or column major.

fn with_column_major(self, scalars: &[Self::Scalar]) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in column major order. The resulting data will conform to the type of matrix used - row major or column major.

fn set<const N: usize>(self, scalars: [Self::Scalar; N]) -> Self

where Self: Sized,

The same as from_major_row.

impl<E, const ROWS: usize, const COLS: usize> RawSliceMut for Mat<ROWS, COLS, E, DescriptorOrderRowMajor>

where E: MatEl, Self: Collection<Scalar = E>,

fn raw_slice_mut(&mut self) -> &mut [Self::Scalar]

Returns a mutable reference to the underlying data as a flat array.

fn raw_set_slice(&mut self, scalars: &[Self::Scalar])

Sets the underlying data from a slice of scalars.

fn raw_set<const N: usize>(self, scalars: [Self::Scalar; N]) -> Self

Sets the underlying data from an array of scalars.

fn with_row_major(self, scalars: &[Self::Scalar]) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in row major order. The resulting data will conform to the type of matrix used - row major or column major.

fn with_column_major(self, scalars: &[Self::Scalar]) -> Self

Sets the underlying data from an array of scalars, assuming the input to be in column major order. The resulting data will conform to the type of matrix used - row major or column major.

fn set<const N: usize>(self, scalars: [Self::Scalar; N]) -> Self

where Self: Sized,

The same as from_major_row.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> RelativeEq for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: PartialEq + Descriptor, Self: Collection<Scalar = E>, Mat<ROWS, COLS, E, Descriptor>: RawSlice, E: RelativeEq + MatEl, E::Epsilon: Copy,

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> ScalarMut for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Self: ConstLayout + RawSliceMut,

fn scalar_mut(&mut self, index: <Self as Indexable>::Index) -> &mut Self::Scalar

Get a mutable reference to a scalar at a specified index.

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> ScalarRef for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + NdFloat, Self: ConstLayout,

fn scalar_ref(&self, index: <Self as Indexable>::Index) -> &Self::Scalar

Get a reference to a scalar at a specified index.

impl<E, const ROWS: usize, const COLS: usize, Descriptor> UlpsEq for Mat<ROWS, COLS, E, Descriptor>

where Descriptor: PartialEq + Descriptor, Self: Collection<Scalar = E>, Mat<ROWS, COLS, E, Descriptor>: RawSlice, E: UlpsEq + MatEl, E::Epsilon: Copy,

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart.

fn ulps_eq(&self, other: &Self, epsilon: Self::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

impl<const ROWS: usize, const COLS: usize, E, Descriptor: Copy> Copy for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl + Copy,

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> MatWithShape<ROWS, COLS> for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

impl<E, const ROWS: usize, const COLS: usize, Descriptor: Descriptor> MatWithShapeMut<ROWS, COLS> for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,

impl<const ROWS: usize, const COLS: usize, E, Descriptor> StructuralPartialEq for Mat<ROWS, COLS, E, Descriptor>

where E: MatEl,