Skip to main content

Matrix2x2

Struct Matrix2x2 

Source
pub struct Matrix2x2 { /* private fields */ }
Expand description

A 2×2 f32 matrix stored in row-major order.

use embedded_matrix::Matrix2x2;

let m = Matrix2x2::new([[1.0, 2.0], [3.0, 4.0]]);
assert!((m.det() - (-2.0)).abs() < 1e-5);
assert_eq!(m[(1, 0)], 3.0);

Implementations§

Source§

impl Matrix2x2

Source

pub const fn new(data: [[f32; 2]; 2]) -> Matrix2x2

Creates a matrix from a row-major array.

Source

pub const fn identity() -> Matrix2x2

Identity matrix.

Source

pub const fn zero() -> Matrix2x2

Zero matrix.

Source

pub const fn from_diagonal(d: [f32; 2]) -> Matrix2x2

Diagonal matrix.

Source

pub fn get(&self, row: usize, col: usize) -> f32

Returns the element at row row and column col (zero-indexed).

§Panics

Panics if row or col is 2 or greater.

Source

pub fn as_array(&self) -> &[[f32; 2]; 2]

Provides access to the raw row-major data.

Source

pub fn add(&self, rhs: &Matrix2x2) -> Matrix2x2

Element-wise addition.

Source

pub fn sub(&self, rhs: &Matrix2x2) -> Matrix2x2

Element-wise subtraction.

Source

pub fn mul(&self, rhs: &Matrix2x2) -> Matrix2x2

Standard matrix multiplication.

Source

pub fn scale(&self, s: f32) -> Matrix2x2

Scalar multiplication.

Source

pub fn mul_vec(&self, v: [f32; 2]) -> [f32; 2]

Matrix × column vector product.

Source

pub fn transpose(&self) -> Matrix2x2

Transpose.

Source

pub fn det(&self) -> f32

Determinant: ad - bc.

Source

pub fn trace(&self) -> f32

Trace (sum of the diagonal elements).

Source

pub fn solve(&self, b: [f32; 2]) -> Result<[f32; 2], MatrixError>

Solves the system A·x = b (Cramer’s rule).

More direct than inv() followed by a multiplication. For multiple right-hand sides with the same matrix, compute inv() only once.

use embedded_matrix::Matrix2x2;

let a = Matrix2x2::new([[2.0, 1.0], [1.0, 3.0]]);
let x = a.solve([3.0, 5.0]).unwrap();
assert!((x[0] - 0.8).abs() < 1e-6 && (x[1] - 1.4).abs() < 1e-6);
§Errors
Source

pub fn approx_eq(&self, other: &Matrix2x2, tol: f32) -> bool

Compares two matrices element-wise with an absolute tolerance. Returns false if an element is NaN.

Source

pub fn inv(&self) -> Result<Matrix2x2, MatrixError>

Matrix inverse.

§Errors

Trait Implementations§

Source§

impl Add for Matrix2x2

a + b: element-wise addition.

Source§

type Output = Matrix2x2

The resulting type after applying the + operator.
Source§

fn add(self, rhs: Matrix2x2) -> Matrix2x2

Performs the + operation. Read more
Source§

impl AddAssign for Matrix2x2

Source§

fn add_assign(&mut self, rhs: Matrix2x2)

Performs the += operation. Read more
Source§

impl Clone for Matrix2x2

Source§

fn clone(&self) -> Matrix2x2

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Matrix2x2

Source§

impl Debug for Matrix2x2

Source§

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

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

impl Default for Matrix2x2

Source§

fn default() -> Matrix2x2

Returns the “default value” for a type. Read more
Source§

impl From<[[f32; 2]; 2]> for Matrix2x2

Source§

fn from(data: [[f32; 2]; 2]) -> Matrix2x2

Converts to this type from the input type.
Source§

impl Index<(usize, usize)> for Matrix2x2

m[(row, column)]: panics if out of bounds.

Source§

type Output = f32

The returned type after indexing.
Source§

fn index(&self, _: (usize, usize)) -> &f32

Performs the indexing (container[index]) operation. Read more
Source§

impl Mul for Matrix2x2

a * b: matrix multiplication.

Source§

type Output = Matrix2x2

The resulting type after applying the * operator.
Source§

fn mul(self, rhs: Matrix2x2) -> Matrix2x2

Performs the * operation. Read more
Source§

impl Mul<[f32; 2]> for Matrix2x2

a * v: matrix × column vector.

Source§

type Output = [f32; 2]

The resulting type after applying the * operator.
Source§

fn mul(self, v: [f32; 2]) -> [f32; 2]

Performs the * operation. Read more
Source§

impl Mul<f32> for Matrix2x2

a * s: multiplication by an f32 scalar.

Source§

type Output = Matrix2x2

The resulting type after applying the * operator.
Source§

fn mul(self, s: f32) -> Matrix2x2

Performs the * operation. Read more
Source§

impl MulAssign for Matrix2x2

Source§

fn mul_assign(&mut self, rhs: Matrix2x2)

Performs the *= operation. Read more
Source§

impl MulAssign<f32> for Matrix2x2

Source§

fn mul_assign(&mut self, s: f32)

Performs the *= operation. Read more
Source§

impl Neg for Matrix2x2

-a: element-wise negation.

Source§

type Output = Matrix2x2

The resulting type after applying the - operator.
Source§

fn neg(self) -> Matrix2x2

Performs the unary - operation. Read more
Source§

impl PartialEq for Matrix2x2

Source§

fn eq(&self, other: &Matrix2x2) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Matrix2x2

Source§

impl Sub for Matrix2x2

a - b: element-wise subtraction.

Source§

type Output = Matrix2x2

The resulting type after applying the - operator.
Source§

fn sub(self, rhs: Matrix2x2) -> Matrix2x2

Performs the - operation. Read more
Source§

impl SubAssign for Matrix2x2

Source§

fn sub_assign(&mut self, rhs: Matrix2x2)

Performs the -= operation. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.