Struct quick_maths::Matrix

pub struct Matrix<const M: usize, const N: usize, T = DefaultFloat>(pub Vector<N, Vector<M, T>>);

A matrix, where each vector represents a column

Implementations

impl<T, const M: usize, const N: usize> Matrix<M, N, T>

pub fn y_x_iter(&self) -> impl Iterator<Item = &T> + '_

Top-Bottom, Left-Right iterator.

pub fn x_y_iter(&self) -> impl Iterator<Item = &T> + '_

Left-Right, Top-Bottom iterator.

pub fn col_iter(&self) -> impl Iterator<Item = &Vector<M, T>>

impl<T: Float, const M: usize, const N: usize> Matrix<M, N, T>

pub fn dot(&self, vec: &Vector<N, T>) -> Vector<M, T>

pub fn t(&self) -> Matrix<N, M, T>

pub fn matmul<const P: usize>(&self, o: &Matrix<N, P, T>) -> Matrix<M, P, T>

Performs naive matrix multiplication

pub fn swap_rows(&mut self, cols: Range<usize>, a: usize, b: usize)

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

pub fn apply_fn<F, S>(&self, f: F) -> Matrix<M, N, S> where
    F: FnMut(T) -> S + Copy,
    S: Float, 

pub fn zxtend<const I: usize, const J: usize>(&self) -> Matrix<I, J, T>

Zero extend this matrix to a larger size

pub fn reduce<const I: usize, const J: usize>(&self) -> Matrix<I, J, T>

Take some subset of this matrix(only takes from the topt left)

pub fn frobenius(&self) -> T

impl<T: Float, const M: usize> Matrix<M, M, T>

pub fn from_diag(v: Vector<M, T>) -> Self

Creates a square matrix from a diagonal

pub fn diag(&self) -> impl Iterator<Item = T> + '_

Returns elements on the diagonal from top left to bottom right

pub fn off_diag(&self) -> impl Iterator<Item = T> + '_

Returns elements not on the diagonal in no specific order

pub fn ixtend<const I: usize>(&self) -> Matrix<I, I, T>

Identity extend this matrix to a larger size(ones along diagonal)

pub fn trace(&self) -> T

pub fn lup(&self) -> (Self, Self, Self)

LUP decomposes self into lower triangular, upper triangular and pivot matrix

pub fn usolve(&self, b: &Vector<M, T>) -> Vector<M, T>

Given an upper triangular matrix and a vector, compute the solution to the system of equations

pub fn lsolve(&self, b: &Vector<M, T>) -> Vector<M, T>

Given a lower triangular matrix and a vector, compute the solution to the system of equations

pub fn solve((l, u, p): &(Self, Self, Self), b: &Vector<M, T>) -> Vector<M, T>

Solves for x in the linear system Ax = b;

impl<T: Float> Matrix<3_usize, 3_usize, T>

pub fn new(c0: Vec3<T>, c1: Vec3<T>, c2: Vec3<T>) -> Self

pub fn det(&self) -> T

Computes the determinant of this matrix

pub fn inv(&self) -> Self

Inverts this matrix, does not handle non-invertible matrices

pub fn rot(around: &Vec3<T>, cos_t: T) -> Self

pub fn scale(by: &Vec3<T>) -> Self

pub fn translate(by: &Vec2<T>) -> Self

Translation operator for 2 space

pub fn project(normal: &Vec3<T>) -> Self

pub fn from_quat(q: Quat<T>) -> Self

https://en.wikipedia.org/wiki/Quaternions_and_spatial_rotation Converts a quaternion into an equivalent matrix

impl<T: Float> Matrix<2_usize, 2_usize, T>

pub fn det(&self) -> T

Computes the determinant of this matrix

pub fn inv(&self) -> Self

Inverts this matrix, does not handle non-invertible matrices

pub fn rot(theta: T) -> Self

Returns the rotation matrix given a theta in the counterclockwise direction

pub fn scale(sx: T, sy: T) -> Self

Returns the scale matrix given scale in each direction

impl<T: Float> Matrix<4_usize, 4_usize, T>

pub fn new(c0: Vec4<T>, c1: Vec4<T>, c2: Vec4<T>, c3: Vec4<T>) -> Self

pub fn translate(t: Vec3<T>) -> Self

Returns a translation matrix by t

pub fn translation(&self) -> Vec3<T>

Returns the translation encoded in this matrix

pub fn inv(&self) -> Self

Computes the inverse of this matrix if it exists

pub fn p_inv(&self) -> Self

Returns the pseudo-inverse of this matrix

impl<T, const M: usize> Matrix<M, 1, T>

pub fn squeeze(self) -> Vector<M, T>

impl<T: Float, const M: usize, const N: usize> Matrix<M, N, T>

pub fn cos(&self) -> Self

Element-wise cos .

pub fn sin(&self) -> Self

Element-wise sin .

pub fn tan(&self) -> Self

Element-wise tan .

pub fn acos(&self) -> Self

Element-wise acos .

pub fn asin(&self) -> Self

Element-wise asin .

pub fn atan(&self) -> Self

Element-wise atan .

pub fn acosh(&self) -> Self

Element-wise acosh .

pub fn asinh(&self) -> Self

Element-wise asinh .

pub fn atanh(&self) -> Self

Element-wise atanh .

pub fn atan2(&self, v: T) -> Self

Element-wise atan2 .

pub fn hypot(&self, v: T) -> Self

Element-wise hypot .

pub fn ceil(&self) -> Self

Element-wise ceil .

pub fn floor(&self) -> Self

Element-wise floor .

pub fn round(&self) -> Self

Element-wise round .

pub fn fract(&self) -> Self

Element-wise fract .

pub fn trunc(&self) -> Self

Element-wise trunc .

pub fn abs_sub(&self, v: T) -> Self

Element-wise abs_sub .

pub fn abs(&self) -> Self

Element-wise abs .

pub fn signum(&self) -> Self

Element-wise signum .

pub fn recip(&self) -> Self

Element-wise recip .

pub fn log2(&self) -> Self

Element-wise log2 .

pub fn log10(&self) -> Self

Element-wise log10 .

pub fn ln(&self) -> Self

Element-wise ln .

pub fn ln_1p(&self) -> Self

Element-wise ln_1p .

pub fn exp(&self) -> Self

Element-wise exp .

pub fn exp2(&self) -> Self

Element-wise exp2 .

pub fn exp_m1(&self) -> Self

Element-wise exp_m1 .

pub fn sqrt(&self) -> Self

Element-wise sqrt .

pub fn cbrt(&self) -> Self

Element-wise cbrt .

pub fn powf(&self, v: T) -> Self

Element-wise powf .

pub fn powi(&self, v: i32) -> Self

pub fn log(&self, v: T) -> Self

Element-wise log .

pub fn max(&self, v: T) -> Self

Element-wise max .

pub fn min(&self, v: T) -> Self

Element-wise min .

pub fn to_degrees(&self) -> Self

Element-wise to_degrees .

pub fn to_radians(&self) -> Self

Element-wise to_radians .

impl<T: Copy, const N: usize, const M: usize> Matrix<M, N, T>

pub fn dyn_tensor(self) -> DynTensor<2, T>

Trait Implementations

impl<T: Float, const M: usize, const N: usize> Add<Matrix<M, N, T>> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, o: Self) -> Self

Performs the + operation.

impl<T: Float, const M: usize, const N: usize> Add<T> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the + operator.

fn add(self, o: T) -> Self

Performs the + operation.

impl<const M: usize, const N: usize, T: Clone> Clone for Matrix<M, N, T>

fn clone(&self) -> Matrix<M, N, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const M: usize, const N: usize, T: Copy> Copy for Matrix<M, N, T>

impl<const M: usize, const N: usize, T: Debug> Debug for Matrix<M, N, T>

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

Formats the value using the given formatter.

impl<T: Float, const M: usize, const N: usize> Div<Matrix<M, N, T>> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the / operator.

fn div(self, o: Self) -> Self

Performs the / operation.

impl<T: Float, const M: usize, const N: usize> Div<T> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the / operator.

fn div(self, o: T) -> Self

Performs the / operation.

impl<const M: usize, const N: usize, T: Eq> Eq for Matrix<M, N, T>

impl<T, const M: usize, const N: usize> Index<usize> for Matrix<M, N, T>

type Output = Vector<M, T>

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T, const M: usize, const N: usize> IndexMut<usize> for Matrix<M, N, T>

fn index_mut(&mut self, i: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<T: Float, const M: usize, const N: usize> Mul<Matrix<M, N, T>> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, o: Self) -> Self

Performs the * operation.

impl<T: Float, const M: usize, const N: usize> Mul<T> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the * operator.

fn mul(self, o: T) -> Self

Performs the * operation.

impl<T: Float, const M: usize> One for Matrix<M, M, T>

Multiplicative identity

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl<const M: usize, const N: usize, T: PartialEq> PartialEq<Matrix<M, N, T>> for Matrix<M, N, T>

fn eq(&self, other: &Matrix<M, N, T>) -> bool

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

fn ne(&self, other: &Matrix<M, N, T>) -> bool

This method tests for !=.

impl<const M: usize, const N: usize, T> StructuralEq for Matrix<M, N, T>

impl<const M: usize, const N: usize, T> StructuralPartialEq for Matrix<M, N, T>

impl<T: Float, const M: usize, const N: usize> Sub<Matrix<M, N, T>> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, o: Self) -> Self

Performs the - operation.

impl<T: Float, const M: usize, const N: usize> Sub<T> for Matrix<M, N, T>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, o: T) -> Self

Performs the - operation.

impl<T: Float, const M: usize, const N: usize> Zero for Matrix<M, N, T>

fn zero() -> Self

Returns the additive identity element of Self, 0. # Purity

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.