Struct three_d::core::math::Matrix2

#[repr(C)]
pub struct Matrix2<S> {
    pub x: Vector2<S>,
    pub y: Vector2<S>,
}

A 2 x 2, column major matrix

This type is marked as #[repr(C)].

Fields

x: Vector2<S>

The first column of the matrix.

y: Vector2<S>

The second column of the matrix.

Implementations

impl<S> Matrix2<S>

pub const fn new(c0r0: S, c0r1: S, c1r0: S, c1r1: S) -> Matrix2<S>

Create a new matrix, providing values for each index.

pub const fn from_cols(c0: Vector2<S>, c1: Vector2<S>) -> Matrix2<S>

Create a new matrix, providing columns.

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

pub fn look_at(dir: Vector2<S>, up: Vector2<S>) -> Matrix2<S>

Create a transformation matrix that will cause unit_x() to point at dir. unit_y() will be perpendicular to dir, and the closest to up.

pub fn look_at_stable(dir: Vector2<S>, flip: bool) -> Matrix2<S>

Crate a transformation that will cause unit_x() to point at dir. This is similar to look_at, but does not take an up vector. This will not cause unit_y() to flip when dir crosses over the up vector.

pub fn from_angle<A>(theta: A) -> Matrix2<S> where
    A: Into<Rad<S>>, 

pub fn is_finite(&self) -> bool

Are all entries in the matrix finite.

impl<S> Matrix2<S> where
    S: NumCast + Copy, 

pub fn cast<T>(&self) -> Option<Matrix2<T>> where
    T: NumCast, 

Component-wise casting to another type

Trait Implementations

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

type Epsilon = <S as AbsDiffEq<S>>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <S as AbsDiffEq<S>>::Epsilon

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

fn abs_diff_eq(
    &self,
    other: &Matrix2<S>,
    epsilon: <S as AbsDiffEq<S>>::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<'a, S> Add<&'a Matrix2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the + operator.

fn add(self, other: &'a Matrix2<S>) -> Matrix2<S>

Performs the + operation.

impl<'a, 'b, S> Add<&'a Matrix2<S>> for &'b Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the + operator.

fn add(self, other: &'a Matrix2<S>) -> Matrix2<S>

Performs the + operation.

impl<'a, S> Add<Matrix2<S>> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the + operator.

fn add(self, other: Matrix2<S>) -> Matrix2<S>

Performs the + operation.

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

type Output = Matrix2<S>

The resulting type after applying the + operator.

fn add(self, other: Matrix2<S>) -> Matrix2<S>

Performs the + operation.

impl<S> AddAssign<Matrix2<S>> for Matrix2<S> where
    S: BaseFloat + AddAssign<S>, 

fn add_assign(&mut self, other: Matrix2<S>)

Performs the += operation.

impl<S> AsMut<[[S; 2]; 2]> for Matrix2<S>

fn as_mut(&mut self) -> &mut [[S; 2]; 2]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S> AsMut<[S; 4]> for Matrix2<S>

fn as_mut(&mut self) -> &mut [S; 4]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S> AsRef<[[S; 2]; 2]> for Matrix2<S>

fn as_ref(&self) -> &[[S; 2]; 2]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> AsRef<[S; 4]> for Matrix2<S>

fn as_ref(&self) -> &[S; 4]

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> Clone for Matrix2<S> where
    S: Clone, 

fn clone(&self) -> Matrix2<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Matrix2<S> where
    S: Debug, 

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

Formats the value using the given formatter.

impl<'a, S> Div<S> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the / operator.

fn div(self, other: S) -> Matrix2<S>

Performs the / operation.

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

type Output = Matrix2<S>

The resulting type after applying the / operator.

fn div(self, other: S) -> Matrix2<S>

Performs the / operation.

impl<S> DivAssign<S> for Matrix2<S> where
    S: BaseFloat + DivAssign<S>, 

fn div_assign(&mut self, scalar: S)

Performs the /= operation.

impl<'a, S> From<&'a [[S; 2]; 2]> for &'a Matrix2<S>

fn from(m: &'a [[S; 2]; 2]) -> &'a Matrix2<S>

Converts to this type from the input type.

impl<'a, S> From<&'a [S; 4]> for &'a Matrix2<S>

fn from(m: &'a [S; 4]) -> &'a Matrix2<S>

Converts to this type from the input type.

impl<'a, S> From<&'a mut [[S; 2]; 2]> for &'a mut Matrix2<S>

fn from(m: &'a mut [[S; 2]; 2]) -> &'a mut Matrix2<S>

Converts to this type from the input type.

impl<'a, S> From<&'a mut [S; 4]> for &'a mut Matrix2<S>

fn from(m: &'a mut [S; 4]) -> &'a mut Matrix2<S>

Converts to this type from the input type.

impl<S> From<[[S; 2]; 2]> for Matrix2<S> where
    S: Copy, 

fn from(m: [[S; 2]; 2]) -> Matrix2<S>

Converts to this type from the input type.

impl<S> From<Basis2<S>> for Matrix2<S> where
    S: BaseFloat, 

fn from(b: Basis2<S>) -> Matrix2<S>

Converts to this type from the input type.

impl<S> From<Matrix2<S>> for Matrix3<S> where
    S: BaseFloat, 

fn from(m: Matrix2<S>) -> Matrix3<S>

Clone the elements of a 2-dimensional matrix into the top-left corner of a 3-dimensional identity matrix.

impl<S> From<Matrix2<S>> for Matrix4<S> where
    S: BaseFloat, 

fn from(m: Matrix2<S>) -> Matrix4<S>

Clone the elements of a 2-dimensional matrix into the top-left corner of a 4-dimensional identity matrix.

impl<S> Index<usize> for Matrix2<S>

type Output = Vector2<S>

The returned type after indexing.

fn index(&'a self, i: usize) -> &'a Vector2<S>

Performs the indexing (container[index]) operation.

impl<S> IndexMut<usize> for Matrix2<S>

fn index_mut(&'a mut self, i: usize) -> &'a mut Vector2<S>

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

impl<S> Into<[[S; 2]; 2]> for Matrix2<S>

fn into(self) -> [[S; 2]; 2]

Converts this type into the (usually inferred) input type.

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

type Column = Vector2<S>

The column vector of the matrix.

type Row = Vector2<S>

The row vector of the matrix.

type Transpose = Matrix2<S>

The result of transposing the matrix

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

Get a row from this matrix by-value.

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

Swap two rows of this array.

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

Swap two columns of this array.

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

Swap the values at index a and b

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

Transpose this matrix, returning a new matrix.

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

Get the pointer to the first element of the array.

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

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

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

Replace a column in the array.

impl<'a, 'b, S> Mul<&'a Matrix2<S>> for &'b Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the * operator.

fn mul(self, other: &'a Matrix2<S>) -> Matrix2<S>

Performs the * operation.

impl<'a, S> Mul<&'a Matrix2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the * operator.

fn mul(self, other: &'a Matrix2<S>) -> Matrix2<S>

Performs the * operation.

impl<'a, 'b, S> Mul<&'a Vector2<S>> for &'b Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<'a, S> Mul<&'a Vector2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: &'a Vector2<S>) -> Vector2<S>

Performs the * operation.

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

type Output = Matrix2<S>

The resulting type after applying the * operator.

fn mul(self, other: Matrix2<S>) -> Matrix2<S>

Performs the * operation.

impl<'a, S> Mul<Matrix2<S>> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the * operator.

fn mul(self, other: Matrix2<S>) -> Matrix2<S>

Performs the * operation.

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

type Output = Matrix2<S>

The resulting type after applying the * operator.

fn mul(self, other: S) -> Matrix2<S>

Performs the * operation.

impl<'a, S> Mul<S> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the * operator.

fn mul(self, other: S) -> Matrix2<S>

Performs the * operation.

impl<'a, S> Mul<Vector2<S>> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<S> Mul<Vector2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Vector2<S>

The resulting type after applying the * operator.

fn mul(self, other: Vector2<S>) -> Vector2<S>

Performs the * operation.

impl<S> MulAssign<S> for Matrix2<S> where
    S: BaseFloat + MulAssign<S>, 

fn mul_assign(&mut self, scalar: S)

Performs the *= operation.

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

type Output = Matrix2<S>

The resulting type after applying the - operator.

fn neg(self) -> Matrix2<S>

Performs the unary - operation.

impl<'a, S> Neg for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the - operator.

fn neg(self) -> Matrix2<S>

Performs the unary - operation.

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

fn one() -> Matrix2<S>

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

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

fn is_one(&self) -> bool where
    Self: PartialEq<Self>, 

Returns true if self is equal to the multiplicative identity.

impl<S> PartialEq<Matrix2<S>> for Matrix2<S> where
    S: PartialEq<S>, 

fn eq(&self, other: &Matrix2<S>) -> bool

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

fn ne(&self, other: &Matrix2<S>) -> bool

This method tests for !=.

impl<'a, S> Product<&'a Matrix2<S>> for Matrix2<S> where
    S: 'a + BaseFloat, 

fn product<I>(iter: I) -> Matrix2<S> where
    I: Iterator<Item = &'a Matrix2<S>>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

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

fn product<I>(iter: I) -> Matrix2<S> where
    I: Iterator<Item = Matrix2<S>>, 

Method which takes an iterator and generates Self from the elements by multiplying the items.

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

fn default_max_relative() -> <S as AbsDiffEq<S>>::Epsilon

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

fn relative_eq(
    &self,
    other: &Matrix2<S>,
    epsilon: <S as AbsDiffEq<S>>::Epsilon,
    max_relative: <S as AbsDiffEq<S>>::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<'a, S> Rem<S> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the % operator.

fn rem(self, other: S) -> Matrix2<S>

Performs the % operation.

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

type Output = Matrix2<S>

The resulting type after applying the % operator.

fn rem(self, other: S) -> Matrix2<S>

Performs the % operation.

impl<S> RemAssign<S> for Matrix2<S> where
    S: BaseFloat + RemAssign<S>, 

fn rem_assign(&mut self, scalar: S)

Performs the %= operation.

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

type ColumnRow = Vector2<S>

The row/column vector of the matrix.

fn from_value(value: S) -> Matrix2<S>

Create a new diagonal matrix using the supplied value.

fn from_diagonal(value: Vector2<S>) -> Matrix2<S>

Create a matrix from a non-uniform scale

fn transpose_self(&mut self)

Transpose this matrix in-place.

fn determinant(&self) -> S

Take the determinant of this matrix.

fn diagonal(&self) -> Vector2<S>

Return a vector containing the diagonal of this matrix.

fn invert(&self) -> Option<Matrix2<S>>

Invert this matrix, returning a new matrix. m.mul_m(m.invert()) is the identity matrix. Returns None if this matrix is not invertible (has a determinant of zero).

fn is_diagonal(&self) -> bool

Test if this is a diagonal matrix. That is, every element outside of the diagonal is 0.

fn is_symmetric(&self) -> bool

Test if this matrix is symmetric. That is, it is equal to its transpose.

fn identity() -> Self

The identity matrix. Multiplying this matrix with another should have no effect.

fn trace(&self) -> Self::Scalar

Return the trace of this matrix. That is, the sum of the diagonal.

fn is_invertible(&self) -> bool where
    Self::Scalar: UlpsEq<Self::Scalar>, 

Test if this matrix is invertible.

fn is_identity(&self) -> bool where
    Self: UlpsEq<Self>, 

Test if this matrix is the identity matrix. That is, it is diagonal and every element in the diagonal is one.

impl<'a, S> Sub<&'a Matrix2<S>> for Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the - operator.

fn sub(self, other: &'a Matrix2<S>) -> Matrix2<S>

Performs the - operation.

impl<'a, 'b, S> Sub<&'a Matrix2<S>> for &'b Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the - operator.

fn sub(self, other: &'a Matrix2<S>) -> Matrix2<S>

Performs the - operation.

impl<'a, S> Sub<Matrix2<S>> for &'a Matrix2<S> where
    S: BaseFloat, 

type Output = Matrix2<S>

The resulting type after applying the - operator.

fn sub(self, other: Matrix2<S>) -> Matrix2<S>

Performs the - operation.

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

type Output = Matrix2<S>

The resulting type after applying the - operator.

fn sub(self, other: Matrix2<S>) -> Matrix2<S>

Performs the - operation.

impl<S> SubAssign<Matrix2<S>> for Matrix2<S> where
    S: BaseFloat + SubAssign<S>, 

fn sub_assign(&mut self, other: Matrix2<S>)

Performs the -= operation.

impl<'a, S> Sum<&'a Matrix2<S>> for Matrix2<S> where
    S: 'a + BaseFloat, 

fn sum<I>(iter: I) -> Matrix2<S> where
    I: Iterator<Item = &'a Matrix2<S>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

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

fn sum<I>(iter: I) -> Matrix2<S> where
    I: Iterator<Item = Matrix2<S>>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

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

fn default_max_ulps() -> u32

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

fn ulps_eq(
    &self,
    other: &Matrix2<S>,
    epsilon: <S as AbsDiffEq<S>>::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<S> VectorSpace for Matrix2<S> where
    S: BaseFloat, 

type Scalar = S

The associated scalar.

fn lerp(self, other: Self, amount: Self::Scalar) -> Self

Returns the result of linearly interpolating the vector towards other by the specified amount.

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

fn zero() -> Matrix2<S>

Returns the additive identity element of Self, 0.

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.

impl<S> Copy for Matrix2<S> where
    S: Copy, 

impl<S> StructuralPartialEq for Matrix2<S>

impl<T: UniformDataType + PrimitiveDataType> UniformDataType for Matrix2<T>