Struct Matrix

Source

#[non_exhaustive]
#[repr(transparent)]
pub struct Matrix<T, const R: usize, const C: usize, const LEN: usize> {
    pub data: [T; LEN],
}

Available on crate feature alg only.

Expand description

⊕ A static R × C matrix backed by a contiguous row-major array.

^{📍 num/alg::Matrix}

R is the number of rows and C is the number of columns.

Elements are stored in row-major order: all columns of the first row, followed by all columns of the second row, and so on.

LEN is the number of stored elements and must equal R * C. It is an explicit parameter because stable Rust cannot yet generally use R * C as an array length involving outer const parameters.

The shape relationship is validated by its constructors.

§Coordinates

Element coordinates use (row, column) order.

use devela::Matrix;

let matrix = Matrix::<_, 2, 3, 6>::new([
    1, 2, 3,
    4, 5, 6,
]);
assert_eq!(matrix[(0, 2)], 3);
assert_eq!(matrix[(1, 0)], 4);

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

§data: [T; LEN]

The matrix elements in contiguous row-major order.

Struct Matrix Copy item path

§Coordinates

Fields (Non-exhaustive)§

Implementations§

impl<T, const R: usize, const C: usize, const LEN: usize> Matrix<T, R, C, LEN>

pub const ROWS: usize = R

pub const COLUMNS: usize = C

pub const ELEMENTS: usize = LEN

pub const fn new(data: [T; LEN]) -> Self

§Panics

pub const fn row_count(&self) -> usize

pub const fn column_count(&self) -> usize

pub const fn len(&self) -> usize

pub const fn is_empty(&self) -> bool

pub const fn is_square(&self) -> bool

pub const fn get_index(row: usize, column: usize) -> Option<usize> ⓘ

pub const fn get(&self, row: usize, column: usize) -> Option<&T> ⓘ

pub const fn get_mut(&mut self, row: usize, column: usize) -> Option<&mut T> ⓘ

pub const fn at_ref(&self, row: usize, column: usize) -> &T

§Panics

pub const fn at_mut(&mut self, row: usize, column: usize) -> &mut T

§Panics

impl<T: Copy, const R: usize, const C: usize, const LEN: usize> Matrix<T, R, C, LEN>

pub const fn at(&self, row: usize, column: usize) -> T

§Panics

pub const fn splat(value: T) -> Self

pub const fn transpose(&self) -> Matrix<T, C, R, LEN>

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i8, R, C, LEN>

pub const ZERO: Self

pub const fn add(self, other: Self) -> Self

pub const fn sub(self, other: Self) -> Self

pub const fn mul_scalar(self, scalar: i8) -> Self

pub const fn mul_vector(&self, vector: &Vector<i8, C>) -> Vector<i8, R>

pub const fn product<const INNER: usize, const LEFT_LEN: usize, const RIGHT_LEN: usize>( left: &Matrix<i8, R, INNER, LEFT_LEN>, right: &Matrix<i8, INNER, C, RIGHT_LEN>, ) -> Self

§Panics

impl<const N: usize, const LEN: usize> Matrix<i8, N, N, LEN>

pub const IDENTITY: Self

pub const fn mul_square(&self, other: &Self) -> Self

pub const fn trace(&self) -> i8

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i8, R, C, LEN>

pub const fn div_scalar(self, scalar: i8) -> Self

§Panics

pub const fn checked_div_scalar(self, scalar: i8) -> Option<Self> ⓘ

pub const fn checked_product<const INNER: usize, const LEFT_LEN: usize, const RIGHT_LEN: usize>( left: &Matrix<i8, R, INNER, LEFT_LEN>, right: &Matrix<i8, INNER, C, RIGHT_LEN>, ) -> Option<Self> ⓘ

impl<const N: usize, const LEN: usize> Matrix<i8, N, N, LEN>

pub const fn checked_mul_square(&self, other: &Self) -> Option<Self> ⓘ

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i8, R, C, LEN>

pub const fn neg(self) -> Self

pub const fn checked_neg(self) -> Option<Self> ⓘ

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i16, R, C, LEN>

pub const ZERO: Self

pub const fn add(self, other: Self) -> Self

pub const fn sub(self, other: Self) -> Self

pub const fn mul_scalar(self, scalar: i16) -> Self

pub const fn mul_vector(&self, vector: &Vector<i16, C>) -> Vector<i16, R>

pub const fn product<const INNER: usize, const LEFT_LEN: usize, const RIGHT_LEN: usize>( left: &Matrix<i16, R, INNER, LEFT_LEN>, right: &Matrix<i16, INNER, C, RIGHT_LEN>, ) -> Self

§Panics

impl<const N: usize, const LEN: usize> Matrix<i16, N, N, LEN>

pub const IDENTITY: Self

pub const fn mul_square(&self, other: &Self) -> Self

pub const fn trace(&self) -> i16

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i16, R, C, LEN>

pub const fn div_scalar(self, scalar: i16) -> Self

§Panics

pub const fn checked_div_scalar(self, scalar: i16) -> Option<Self> ⓘ

pub const fn checked_product<const INNER: usize, const LEFT_LEN: usize, const RIGHT_LEN: usize>( left: &Matrix<i16, R, INNER, LEFT_LEN>, right: &Matrix<i16, INNER, C, RIGHT_LEN>, ) -> Option<Self> ⓘ

impl<const N: usize, const LEN: usize> Matrix<i16, N, N, LEN>

pub const fn checked_mul_square(&self, other: &Self) -> Option<Self> ⓘ

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i16, R, C, LEN>

pub const fn neg(self) -> Self

pub const fn checked_neg(self) -> Option<Self> ⓘ

impl<const R: usize, const C: usize, const LEN: usize> Matrix<i32, R, C, LEN>

pub const ZERO: Self

pub const fn add(self, other: Self) -> Self

pub const fn sub(self, other: Self) -> Self

pub const fn mul_scalar(self, scalar: i32) -> Self

pub const fn mul_vector(&self, vector: &Vector<i32, C>) -> Vector<i32, R>

pub const fn product<const INNER: usize, const LEFT_LEN: usize, const RIGHT_LEN: usize>( left: &Matrix<i32, R, INNER, LEFT_LEN>, right: &Matrix<i32, INNER, C, RIGHT_LEN>, ) -> Self

§Panics

impl<const N: usize, const LEN: usize> Matrix<i32, N, N, LEN>

Struct Matrix