#[repr(transparent)]pub struct Mat2(_);
Expand description
A 2x2 column major matrix.
Implementations
sourceimpl Mat2
impl Mat2
sourcepub const IDENTITY: Mat2 = Self(InnerF32::IDENTITY)
pub const IDENTITY: Mat2 = Self(InnerF32::IDENTITY)
A 2x2 identity matrix, where all diagonal elements are 1
, and all off-diagonal elements are 0
.
sourcepub const fn zero() -> Mat2
👎 Deprecated: use Mat2::ZERO instead
pub const fn zero() -> Mat2
use Mat2::ZERO instead
Creates a 2x2 matrix with all elements set to 0.0
.
sourcepub const fn identity() -> Mat2
👎 Deprecated: use Mat2::IDENTITY instead
pub const fn identity() -> Mat2
use Mat2::IDENTITY instead
Creates a 2x2 identity matrix.
sourcepub fn from_cols(x_axis: Vec2, y_axis: Vec2) -> Mat2
pub fn from_cols(x_axis: Vec2, y_axis: Vec2) -> Mat2
Creates a 2x2 matrix from two column vectors.
sourcepub fn from_cols_array(m: &[f32; 4]) -> Mat2
pub fn from_cols_array(m: &[f32; 4]) -> Mat2
Creates a 2x2 matrix from a [S; 4]
array stored in column major order.
If your data is stored in row major you will need to transpose
the returned
matrix.
sourcepub fn to_cols_array(&self) -> [f32; 4]
pub fn to_cols_array(&self) -> [f32; 4]
Creates a [S; 4]
array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub fn from_cols_array_2d(m: &[[f32; 2]; 2]) -> Mat2
pub fn from_cols_array_2d(m: &[[f32; 2]; 2]) -> Mat2
Creates a 2x2 matrix from a [[S; 2]; 2]
2D array stored in column major order.
If your data is in row major order you will need to transpose
the returned
matrix.
sourcepub fn to_cols_array_2d(&self) -> [[f32; 2]; 2]
pub fn to_cols_array_2d(&self) -> [[f32; 2]; 2]
Creates a [[S; 2]; 2]
2D array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub fn from_diagonal(diagonal: Vec2) -> Mat2
pub fn from_diagonal(diagonal: Vec2) -> Mat2
Creates a 2x2 matrix with its diagonal set to diagonal
and all other entries set to 0.
sourcepub fn from_scale_angle(scale: Vec2, angle: f32) -> Mat2
pub fn from_scale_angle(scale: Vec2, angle: f32) -> Mat2
Creates a 2x2 matrix containing the combining non-uniform scale
and rotation of
angle
(in radians).
sourcepub fn from_angle(angle: f32) -> Mat2
pub fn from_angle(angle: f32) -> Mat2
Creates a 2x2 matrix containing a rotation of angle
(in radians).
pub fn from_scale(scale: Vec2) -> Mat2
Use from_diagonal() instead
sourcepub fn is_finite(&self) -> bool
pub fn is_finite(&self) -> bool
Returns true
if, and only if, all elements are finite.
If any element is either NaN
, positive or negative infinity, this will return false
.
sourcepub fn determinant(&self) -> f32
pub fn determinant(&self) -> f32
Returns the determinant of self
.
sourcepub fn inverse(&self) -> Mat2
pub fn inverse(&self) -> Mat2
Returns the inverse of self
.
If the matrix is not invertible the returned matrix will be invalid.
sourcepub fn mul_scalar(&self, other: f32) -> Mat2
pub fn mul_scalar(&self, other: f32) -> Mat2
Multiplies a 2x2 matrix by a scalar.
sourcepub fn abs_diff_eq(&self, other: &Mat2, max_abs_diff: f32) -> bool
pub fn abs_diff_eq(&self, other: &Mat2, max_abs_diff: f32) -> bool
Returns true if the absolute difference of all elements between self
and other
is less than or equal to max_abs_diff
.
This can be used to compare if two matrices contain similar elements. It works best
when comparing with a known value. The max_abs_diff
that should be used used
depends on the values being compared against.
For more see comparing floating point numbers.
pub fn as_f64(&self) -> DMat2
Trait Implementations
sourceimpl PartialOrd<Mat2> for Mat2
impl PartialOrd<Mat2> for Mat2
sourcefn partial_cmp(&self, other: &Mat2) -> Option<Ordering>
fn partial_cmp(&self, other: &Mat2) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Copy for Mat2
Auto Trait Implementations
impl RefUnwindSafe for Mat2
impl Send for Mat2
impl Sync for Mat2
impl Unpin for Mat2
impl UnwindSafe for Mat2
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more