Struct valence_math::DMat2
source · #[repr(C)]pub struct DMat2 {
pub x_axis: DVec2,
pub y_axis: DVec2,
}
Expand description
A 2x2 column major matrix.
Fields§
§x_axis: DVec2
§y_axis: DVec2
Implementations§
source§impl DMat2
impl DMat2
sourcepub const IDENTITY: DMat2 = _
pub const IDENTITY: DMat2 = _
A 2x2 identity matrix, where all diagonal elements are 1
, and all off-diagonal elements are 0
.
sourcepub const fn from_cols(x_axis: DVec2, y_axis: DVec2) -> DMat2
pub const fn from_cols(x_axis: DVec2, y_axis: DVec2) -> DMat2
Creates a 2x2 matrix from two column vectors.
sourcepub const fn from_cols_array(m: &[f64; 4]) -> DMat2
pub const fn from_cols_array(m: &[f64; 4]) -> DMat2
Creates a 2x2 matrix from a [f64; 4]
array stored in column major order.
If your data is stored in row major you will need to transpose
the returned
matrix.
sourcepub const fn to_cols_array(&self) -> [f64; 4]
pub const fn to_cols_array(&self) -> [f64; 4]
Creates a [f64; 4]
array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub const fn from_cols_array_2d(m: &[[f64; 2]; 2]) -> DMat2
pub const fn from_cols_array_2d(m: &[[f64; 2]; 2]) -> DMat2
Creates a 2x2 matrix from a [[f64; 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 const fn to_cols_array_2d(&self) -> [[f64; 2]; 2]
pub const fn to_cols_array_2d(&self) -> [[f64; 2]; 2]
Creates a [[f64; 2]; 2]
2D array storing data in column major order.
If you require data in row major order transpose
the matrix first.
sourcepub const fn from_diagonal(diagonal: DVec2) -> DMat2
pub const fn from_diagonal(diagonal: DVec2) -> DMat2
Creates a 2x2 matrix with its diagonal set to diagonal
and all other entries set to 0.
sourcepub fn from_scale_angle(scale: DVec2, angle: f64) -> DMat2
pub fn from_scale_angle(scale: DVec2, angle: f64) -> DMat2
Creates a 2x2 matrix containing the combining non-uniform scale
and rotation of
angle
(in radians).
sourcepub fn from_angle(angle: f64) -> DMat2
pub fn from_angle(angle: f64) -> DMat2
Creates a 2x2 matrix containing a rotation of angle
(in radians).
sourcepub fn from_mat3(m: DMat3) -> DMat2
pub fn from_mat3(m: DMat3) -> DMat2
Creates a 2x2 matrix from a 3x3 matrix, discarding the 2nd row and column.
sourcepub fn from_mat3_minor(m: DMat3, i: usize, j: usize) -> DMat2
pub fn from_mat3_minor(m: DMat3, i: usize, j: usize) -> DMat2
Creates a 2x2 matrix from the minor of the given 3x3 matrix, discarding the i
th column
and j
th row.
§Panics
Panics if i
or j
is greater than 2.
sourcepub const fn from_cols_slice(slice: &[f64]) -> DMat2
pub const fn from_cols_slice(slice: &[f64]) -> DMat2
Creates a 2x2 matrix from the first 4 values in slice
.
§Panics
Panics if slice
is less than 4 elements long.
sourcepub fn write_cols_to_slice(self, slice: &mut [f64])
pub fn write_cols_to_slice(self, slice: &mut [f64])
Writes the columns of self
to the first 4 elements in slice
.
§Panics
Panics if slice
is less than 4 elements long.
sourcepub fn col_mut(&mut self, index: usize) -> &mut DVec2
pub fn col_mut(&mut self, index: usize) -> &mut DVec2
Returns a mutable reference to the matrix column for the given index
.
§Panics
Panics if index
is greater than 1.
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) -> f64
pub fn determinant(&self) -> f64
Returns the determinant of self
.
sourcepub fn inverse(&self) -> DMat2
pub fn inverse(&self) -> DMat2
Returns the inverse of self
.
If the matrix is not invertible the returned matrix will be invalid.
§Panics
Will panic if the determinant of self
is zero when glam_assert
is enabled.
sourcepub fn mul_scalar(&self, rhs: f64) -> DMat2
pub fn mul_scalar(&self, rhs: f64) -> DMat2
Multiplies a 2x2 matrix by a scalar.
sourcepub fn div_scalar(&self, rhs: f64) -> DMat2
pub fn div_scalar(&self, rhs: f64) -> DMat2
Divides a 2x2 matrix by a scalar.
sourcepub fn abs_diff_eq(&self, rhs: DMat2, max_abs_diff: f64) -> bool
pub fn abs_diff_eq(&self, rhs: DMat2, max_abs_diff: f64) -> bool
Returns true if the absolute difference of all elements between self
and rhs
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_mat2(&self) -> Mat2
Trait Implementations§
source§impl AddAssign for DMat2
impl AddAssign for DMat2
source§fn add_assign(&mut self, rhs: DMat2)
fn add_assign(&mut self, rhs: DMat2)
+=
operation. Read moresource§impl DivAssign<f64> for DMat2
impl DivAssign<f64> for DMat2
source§fn div_assign(&mut self, rhs: f64)
fn div_assign(&mut self, rhs: f64)
/=
operation. Read moresource§impl MulAssign<f64> for DMat2
impl MulAssign<f64> for DMat2
source§fn mul_assign(&mut self, rhs: f64)
fn mul_assign(&mut self, rhs: f64)
*=
operation. Read moresource§impl MulAssign for DMat2
impl MulAssign for DMat2
source§fn mul_assign(&mut self, rhs: DMat2)
fn mul_assign(&mut self, rhs: DMat2)
*=
operation. Read moresource§impl SubAssign for DMat2
impl SubAssign for DMat2
source§fn sub_assign(&mut self, rhs: DMat2)
fn sub_assign(&mut self, rhs: DMat2)
-=
operation. Read moreimpl Copy for DMat2
Auto Trait Implementations§
impl Freeze for DMat2
impl RefUnwindSafe for DMat2
impl Send for DMat2
impl Sync for DMat2
impl Unpin for DMat2
impl UnwindSafe for DMat2
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)