Trait nannou::math::Matrix

pub trait Matrix: VectorSpace + Index<usize, Output = Self::Column, Output = Self::Column> + IndexMut<usize> + AbsDiffEq<Self, Epsilon = Self::Scalar, Epsilon = Self::Scalar, Epsilon = Self::Scalar> + RelativeEq<Self> + UlpsEq<Self> where
    Self::Scalar: BaseFloat, {
    type Row: VectorSpace + Array;
    type Column: VectorSpace + Array;
    type Transpose: Matrix;
    pub fn row(&self, r: usize) -> Self::Row;
    pub fn swap_rows(&mut self, a: usize, b: usize);
    pub fn swap_columns(&mut self, a: usize, b: usize);
    pub fn swap_elements(&mut self, a: (usize, usize), b: (usize, usize));
    pub fn transpose(&self) -> Self::Transpose;

    pub fn as_ptr(&self) -> *const Self::Scalar { ... }
    pub fn as_mut_ptr(&mut self) -> *mut Self::Scalar { ... }
    pub fn replace_col(&mut self, c: usize, src: Self::Column) -> Self::Column { ... }
}

A column-major matrix of arbitrary dimensions.

Because this is constrained to the VectorSpace trait, this means that following operators are required to be implemented:

Matrix addition:

• Add<Output = Self>
• Sub<Output = Self>
• Neg<Output = Self>

Scalar multiplication:

• Mul<Self::Scalar, Output = Self>
• Div<Self::Scalar, Output = Self>
• Rem<Self::Scalar, Output = Self>

Note that matrix multiplication is not required for implementors of this trait. This is due to the complexities of implementing these operators with Rust’s current type system. For the multiplication of square matrices, see SquareMatrix.

Associated Types

type Row: VectorSpace + Array

The row vector of the matrix.

type Column: VectorSpace + Array

The column vector of the matrix.

type Transpose: Matrix

The result of transposing the matrix

Loading content...

Required methods

pub fn row(&self, r: usize) -> Self::Row

Get a row from this matrix by-value.

pub fn swap_rows(&mut self, a: usize, b: usize)

Swap two rows of this array.

pub fn swap_columns(&mut self, a: usize, b: usize)

Swap two columns of this array.

pub fn swap_elements(&mut self, a: (usize, usize), b: (usize, usize))

Swap the values at index a and b

pub fn transpose(&self) -> Self::Transpose

Transpose this matrix, returning a new matrix.

Loading content...

Provided methods

pub fn as_ptr(&self) -> *const Self::Scalar

Get the pointer to the first element of the array.

pub fn as_mut_ptr(&mut self) -> *mut Self::Scalar

Get a mutable pointer to the first element of the array.

pub fn replace_col(&mut self, c: usize, src: Self::Column) -> Self::Column

Replace a column in the array.

Loading content...

Implementors

impl<S> Matrix for Matrix2<S> where
    S: BaseFloat, 

type Column = Vector2<S>

type Row = Vector2<S>

type Transpose = Matrix2<S>

pub fn row(&self, r: usize) -> Vector2<S>

pub fn swap_rows(&mut self, a: usize, b: usize)

pub fn swap_columns(&mut self, a: usize, b: usize)

pub fn swap_elements(&mut self, a: (usize, usize), b: (usize, usize))

pub fn transpose(&self) -> Matrix2<S>

impl<S> Matrix for Matrix3<S> where
    S: BaseFloat, 

type Column = Vector3<S>

type Row = Vector3<S>

type Transpose = Matrix3<S>

pub fn row(&self, r: usize) -> Vector3<S>

pub fn swap_rows(&mut self, a: usize, b: usize)

pub fn swap_columns(&mut self, a: usize, b: usize)

pub fn swap_elements(&mut self, a: (usize, usize), b: (usize, usize))

pub fn transpose(&self) -> Matrix3<S>

impl<S> Matrix for Matrix4<S> where
    S: BaseFloat, 

type Column = Vector4<S>

type Row = Vector4<S>

type Transpose = Matrix4<S>

pub fn row(&self, r: usize) -> Vector4<S>

pub fn swap_rows(&mut self, a: usize, b: usize)

pub fn swap_columns(&mut self, a: usize, b: usize)

pub fn swap_elements(&mut self, a: (usize, usize), b: (usize, usize))

pub fn transpose(&self) -> Matrix4<S>

Loading content...