Struct Matrix2

#[repr(C)]
pub struct Matrix2<T> {
    pub cols: Vec2<Vec2<T>>,
}

2x2 matrix.

Fields

cols: Vec2<Vec2<T>>

Implementations

impl<T> Mat2<T>

pub const ROW_COUNT: usize = 2usize

Convenience constant representing the number of rows for matrices of this type.

pub const COL_COUNT: usize = 2usize

Convenience constant representing the number of columns for matrices of this type.

pub fn identity() -> Mat2<T>

where T: Zero + One,

The identity matrix, which is also the default value for square matrices.

assert_eq!(Mat4::<f32>::default(), Mat4::<f32>::identity());

pub fn zero() -> Mat2<T>

where T: Zero,

The matrix with all elements set to zero.

pub fn apply<F>(&mut self, f: F)

where T: Copy, F: FnMut(T) -> T,

Applies the function f to each element of this matrix, in-place.

For an example, see the map() method.

pub fn apply2<F, S>(&mut self, other: Mat2<S>, f: F)

where T: Copy, F: FnMut(T, S) -> T,

Applies the function f to each element of this matrix, in-place.

For an example, see the map2() method.

pub fn numcast<D>(self) -> Option<Mat2<D>>

where T: NumCast, D: NumCast,

Returns a memberwise-converted copy of this matrix, using NumCast.

let m = Mat4::<f32>::identity();
let m: Mat4<i32> = m.numcast().unwrap();
assert_eq!(m, Mat4::identity());

pub fn broadcast_diagonal(val: T) -> Mat2<T>

where T: Zero + Copy,

Initializes a new matrix with elements of the diagonal set to val and the other to zero.

In a way, this is the same as single-argument matrix constructors in GLSL and GLM.

assert_eq!(Mat4::broadcast_diagonal(0), Mat4::zero());
assert_eq!(Mat4::broadcast_diagonal(1), Mat4::identity());
assert_eq!(Mat4::broadcast_diagonal(2), Mat4::new(
    2,0,0,0,
    0,2,0,0,
    0,0,2,0,
    0,0,0,2,
));

pub fn with_diagonal(d: Vec2<T>) -> Mat2<T>

where T: Zero + Copy,

Initializes a matrix by its diagonal, setting other elements to zero.

pub fn diagonal(self) -> Vec2<T>

Gets the matrix’s diagonal into a vector.

assert_eq!(Mat4::<u32>::zero().diagonal(), Vec4::zero());
assert_eq!(Mat4::<u32>::identity().diagonal(), Vec4::one());

let mut m = Mat4::zero();
m[(0, 0)] = 1;
m[(1, 1)] = 2;
m[(2, 2)] = 3;
m[(3, 3)] = 4;
assert_eq!(m.diagonal(), Vec4::new(1, 2, 3, 4));
assert_eq!(m.diagonal(), Vec4::iota() + 1);

pub fn trace(self) -> T

where T: Add<Output = T>,

The sum of the diagonal’s elements.

assert_eq!(Mat4::<u32>::zero().trace(), 0);
assert_eq!(Mat4::<u32>::identity().trace(), 4);

pub fn mul_memberwise(self, m: Mat2<T>) -> Mat2<T>

where T: Mul<Output = T>,

Multiply elements of this matrix with another’s.

let m = Mat4::new(
    0, 1, 2, 3,
    1, 2, 3, 4,
    2, 3, 4, 5,
    3, 4, 5, 6,
);
let r = Mat4::new(
    0, 1, 4, 9,
    1, 4, 9, 16,
    4, 9, 16, 25,
    9, 16, 25, 36,
);
assert_eq!(m.mul_memberwise(m), r);

pub fn row_count(&self) -> usize

Convenience for getting the number of rows of this matrix.

pub fn col_count(&self) -> usize

Convenience for getting the number of columns of this matrix.

pub fn is_packed(&self) -> bool

Are all elements of this matrix tightly packed together in memory ?

This might not be the case for matrices in the repr_simd module (it depends on the target architecture).

impl<T> Mat2<T>

pub fn map_cols<D, F>(self, f: F) -> Mat2<D>

where F: FnMut(Vec2<T>) -> Vec2<D>,

Returns a column-wise-converted copy of this matrix, using the given conversion closure.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<f32>::new(
    0.25, 1.25, 5.56, 8.66,
    8.53, 2.92, 3.86, 9.36,
    1.02, 0.28, 5.52, 6.06,
    6.20, 7.01, 4.90, 5.26
);
let m = m.map_cols(|col| col.map(|x| x.round() as i32));
assert_eq!(m, Mat4::new(
    0, 1, 6, 9,
    9, 3, 4, 9,
    1, 0, 6, 6,
    6, 7, 5, 5
));

pub fn into_col_array(self) -> [T; 4]

Converts this matrix into a fixed-size array of elements.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
    0, 4, 8, 12,
    1, 5, 9, 13,
    2, 6, 10, 14,
    3, 7, 11, 15
];
assert_eq!(m.into_col_array(), array);

pub fn into_col_arrays(self) -> [[T; 2]; 2]

Converts this matrix into a fixed-size array of fixed-size arrays of elements.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
    [ 0, 4,  8, 12, ],
    [ 1, 5,  9, 13, ],
    [ 2, 6, 10, 14, ],
    [ 3, 7, 11, 15, ],
];
assert_eq!(m.into_col_arrays(), array);

pub fn from_col_array(array: [T; 4]) -> Mat2<T>

Converts a fixed-size array of elements into a matrix.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
    0, 4, 8, 12,
    1, 5, 9, 13,
    2, 6, 10, 14,
    3, 7, 11, 15
];
assert_eq!(m, Mat4::from_col_array(array));

pub fn from_col_arrays(array: [[T; 2]; 2]) -> Mat2<T>

Converts a fixed-size array of fixed-size arrays of elements into a matrix.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
    [ 0, 4,  8, 12, ],
    [ 1, 5,  9, 13, ],
    [ 2, 6, 10, 14, ],
    [ 3, 7, 11, 15, ],
];
assert_eq!(m, Mat4::from_col_arrays(array));

pub fn into_row_array(self) -> [T; 4]

Converts this matrix into a fixed-size array of elements.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
];
assert_eq!(m.into_row_array(), array);

pub fn into_row_arrays(self) -> [[T; 2]; 2]

Converts this matrix into a fixed-size array of fixed-size arrays of elements.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
    [  0,  1,  2,  3, ],
    [  4,  5,  6,  7, ],
    [  8,  9, 10, 11, ],
    [ 12, 13, 14, 15, ],
];
assert_eq!(m.into_row_arrays(), array);

pub fn from_row_array(array: [T; 4]) -> Mat2<T>

Converts a fixed-size array of elements into a matrix.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
];
assert_eq!(m, Mat4::from_row_array(array));

pub fn from_row_arrays(array: [[T; 2]; 2]) -> Mat2<T>

Converts a fixed-size array of fixed-size array of elements into a matrix.

use vek::mat::repr_c::column_major::Mat4;

let m = Mat4::<u32>::new(
     0,  1,  2,  3,
     4,  5,  6,  7,
     8,  9, 10, 11,
    12, 13, 14, 15
);
let array = [
    [  0,  1,  2,  3, ],
    [  4,  5,  6,  7, ],
    [  8,  9, 10, 11, ],
    [ 12, 13, 14, 15, ],
];
assert_eq!(m, Mat4::from_row_arrays(array));

pub fn as_col_ptr(&self) -> *const T

Gets a const pointer to this matrix’s elements.

Panics

Panics if the matrix’s elements are not tightly packed in memory, which may be the case for matrices in the repr_simd module. You may check this with the is_packed() method.

pub fn as_mut_col_ptr(&mut self) -> *mut T

Gets a mut pointer to this matrix’s elements.

Panics

Panics if the matrix’s elements are not tightly packed in memory, which may be the case for matrices in the repr_simd module. You may check this with the is_packed() method.

pub fn as_col_slice(&self) -> &[T]

View this matrix as an immutable slice.

Panics

Panics if the matrix’s elements are not tightly packed in memory, which may be the case for matrices in the repr_simd module. You may check this with the is_packed() method.

pub fn as_mut_col_slice(&mut self) -> &mut [T]

View this matrix as a mutable slice.

Panics

Panics if the matrix’s elements are not tightly packed in memory, which may be the case for matrices in the repr_simd module. You may check this with the is_packed() method.

impl<T> Mat2<T>

pub const GL_SHOULD_TRANSPOSE: bool = false

The transpose parameter to pass to OpenGL glUniformMatrix*() functions.

pub fn gl_should_transpose(&self) -> bool

Gets the transpose parameter to pass to OpenGL glUniformMatrix*() functions.

The return value is a plain bool which you may directly cast to a GLboolean.

This takes &self to prevent surprises when changing the type of matrix you plan to send.

impl<T> Mat2<T>

pub fn map<D, F>(self, f: F) -> Mat2<D>

where F: FnMut(T) -> D,

Returns an element-wise-converted copy of this matrix, using the given conversion closure.

use vek::mat::repr_c::row_major::Mat4;

let m = Mat4::<f32>::new(
    0.25, 1.25, 5.56, 8.66,
    8.53, 2.92, 3.86, 9.36,
    1.02, 0.28, 5.52, 6.06,
    6.20, 7.01, 4.90, 5.26
);
let m = m.map(|x| x.round() as i32);
assert_eq!(m, Mat4::new(
    0, 1, 6, 9,
    9, 3, 4, 9,
    1, 0, 6, 6,
    6, 7, 5, 5
));

pub fn as_<D>(self) -> Mat2<D>

where T: AsPrimitive<D>, D: 'static + Copy,

Returns a memberwise-converted copy of this matrix, using AsPrimitive.

Examples

let v = Vec4::new(0_f32, 1., 2., 3.);
let i: Vec4<i32> = v.as_();
assert_eq!(i, Vec4::new(0, 1, 2, 3));

Safety

In Rust versions before 1.45.0, some uses of the as operator were not entirely safe. In particular, it was undefined behavior if a truncated floating point value could not fit in the target integer type (#10184);

let x: u8 = (1.04E+17).as_(); // UB

pub fn map2<D, F, S>(self, other: Mat2<S>, f: F) -> Mat2<D>

where F: FnMut(T, S) -> D,

Applies the function f to each element of two matrices, pairwise, and returns the result.

use vek::mat::repr_c::row_major::Mat4;

let a = Mat4::<f32>::new(
    0.25, 1.25, 2.52, 2.99,
    0.25, 1.25, 2.52, 2.99,
    0.25, 1.25, 2.52, 2.99,
    0.25, 1.25, 2.52, 2.99
);
let b = Mat4::<i32>::new(
    0, 1, 0, 0,
    1, 0, 0, 0,
    0, 0, 1, 0,
    0, 0, 0, 1
);
let m = a.map2(b, |a, b| a.round() as i32 + b);
assert_eq!(m, Mat4::new(
    0, 2, 3, 3,
    1, 1, 3, 3,
    0, 1, 4, 3,
    0, 1, 3, 4
));

pub fn transposed(self) -> Mat2<T>

The matrix’s transpose.

let m = Mat2::new(
    0, 1,
    4, 5
);
let t = Mat2::new(
    0, 4,
    1, 5
);
assert_eq!(m.transposed(), t);
assert_eq!(m, m.transposed().transposed());

pub fn transpose(&mut self)

Transpose this matrix.

let mut m = Mat2::new(
    0, 1,
    4, 5
);
let t = Mat2::new(
    0, 4,
    1, 5
);
m.transpose();
assert_eq!(m, t);

pub fn determinant(self) -> T

where T: Mul<Output = T> + Sub<Output = T>,

Get this matrix’s determinant.

A matrix is invertible if its determinant is non-zero.

let (a,b,c,d) = (0,1,2,3);
let m = Mat2::new(a,b,c,d);
assert_eq!(m.determinant(), a*d - c*b);

pub fn rotate_z(&mut self, angle_radians: T)

where T: Real + MulAdd<Output = T>,

Rotates this matrix around the Z axis (counter-clockwise rotation in 2D).

pub fn rotated_z(self, angle_radians: T) -> Mat2<T>

where T: Real + MulAdd<Output = T>,

Rotates this matrix around the Z axis (counter-clockwise rotation in 2D).

pub fn rotation_z(angle_radians: T) -> Mat2<T>

where T: Real,

Creates a matrix that rotates around the Z axis (counter-clockwise rotation in 2D).

pub fn scale_2d<V>(&mut self, v: V)

where V: Into<Vec2<T>>, T: Real + MulAdd<Output = T>,

Scales this matrix in 2D.

pub fn scaled_2d<V>(self, v: V) -> Mat2<T>

where V: Into<Vec2<T>>, T: Real + MulAdd<Output = T>,

Returns this matrix scaled in 2D.

pub fn scaling_2d<V>(v: V) -> Mat2<T>

where V: Into<Vec2<T>>, T: Zero,

Creates a 2D scaling matrix.

pub fn shear_x(&mut self, k: T)

where T: Real + MulAdd<Output = T>,

Shears this matrix along the X axis.

pub fn sheared_x(self, k: T) -> Mat2<T>

where T: Real + MulAdd<Output = T>,

Returns this matrix sheared along the X axis.

pub fn shearing_x(k: T) -> Mat2<T>

where T: Zero + One,

Creates a 2D shearing matrix along the X axis.

pub fn shear_y(&mut self, k: T)

where T: Real + MulAdd<Output = T>,

Shears this matrix along the Y axis.

pub fn sheared_y(self, k: T) -> Mat2<T>

where T: Real + MulAdd<Output = T>,

Returns this matrix sheared along the Y axis.

pub fn shearing_y(k: T) -> Mat2<T>

where T: Zero + One,

Creates a 2D shearing matrix along the Y axis.

impl<T> Mat2<T>

pub fn new(m00: T, m01: T, m10: T, m11: T) -> Mat2<T>

Creates a new 2x2 matrix from elements in a layout-agnostic way.

The parameters are named mij where i is the row index and j the column index. Their order is always the same regardless of the matrix’s layout.

Trait Implementations

impl<T> AbsDiffEq for Mat2<T>

where T: AbsDiffEq, <T as AbsDiffEq>::Epsilon: Copy,

type Epsilon = <T as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

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

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

fn abs_diff_eq( &self, other: &Mat2<T>, epsilon: <Mat2<T> as AbsDiffEq>::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<T> Add<T> for Mat2<T>

where T: Copy + Add<Output = T>,

type Output = Mat2<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <Mat2<T> as Add<T>>::Output

Performs the + operation.

impl<T> Add for Mat2<T>

where T: Add<Output = T>,

type Output = Mat2<T>

The resulting type after applying the + operator.

fn add(self, rhs: Mat2<T>) -> <Mat2<T> as Add>::Output

Performs the + operation.

impl<T> AddAssign<T> for Mat2<T>

where T: Add<Output = T> + Copy,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T> AddAssign for Mat2<T>

where T: Add<Output = T> + Copy,

fn add_assign(&mut self, rhs: Mat2<T>)

Performs the += operation.

impl<T> Clone for Mat2<T>

where T: Clone,

fn clone(&self) -> Mat2<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Mat2<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for Mat2<T>

where T: Zero + One,

The default value for a square matrix is the identity.

assert_eq!(Mat4::<f32>::default(), Mat4::<f32>::identity());

fn default() -> Mat2<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for Mat2<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Mat2<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Mat2<T>

where T: Display,

Displays this matrix using the following format:

(i being the number of rows and j the number of columns)

( m00 ... m0j
  ... ... ...
  mi0 ... mij )

Note that elements are not comma-separated. This format doesn’t depend on the matrix’s storage layout.

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

Formats the value using the given formatter.

impl<T> Div<T> for Mat2<T>

where T: Copy + Div<Output = T>,

type Output = Mat2<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> <Mat2<T> as Div<T>>::Output

Performs the / operation.

impl<T> Div for Mat2<T>

where T: Div<Output = T>,

type Output = Mat2<T>

The resulting type after applying the / operator.

fn div(self, rhs: Mat2<T>) -> <Mat2<T> as Div>::Output

Performs the / operation.

impl<T> DivAssign<T> for Mat2<T>

where T: Div<Output = T> + Copy,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T> DivAssign for Mat2<T>

where T: Div<Output = T> + Copy,

fn div_assign(&mut self, rhs: Mat2<T>)

Performs the /= operation.

impl<S> FixedMatrix2<S> for Matrix2<S>

where S: Fixed,

fn from_num<N: ToFixed>(num: Matrix2<N>) -> Self

fn wrapping_from_num<N: ToFixed>(num: Matrix2<N>) -> Self

impl<S, U, V> From<Mat2<S>> for Transform2<S, U, V>

where S: Zero + One,

fn from(matrix: Matrix2<S>) -> Self

Converts to this type from the input type.

impl<T> From<Mat2<T>> for Mat2<T>

fn from(m: Mat2<T>) -> Mat2<T>

Converts to this type from the input type.

impl<T> From<Mat2<T>> for Mat3<T>

where T: Zero + One,

fn from(m: Mat2<T>) -> Mat3<T>

Converts to this type from the input type.

impl<T> From<Mat2<T>> for Mat4<T>

where T: Zero + One,

fn from(m: Mat2<T>) -> Mat4<T>

Converts to this type from the input type.

impl<T> From<Mat3<T>> for Mat2<T>

fn from(m: Mat3<T>) -> Mat2<T>

Converts to this type from the input type.

impl<T> From<Mat4<T>> for Mat2<T>

fn from(m: Mat4<T>) -> Mat2<T>

Converts to this type from the input type.

impl<T> Hash for Mat2<T>

where T: Hash,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Index<(usize, usize)> for Mat2<T>

Index this matrix in a layout-agnostic way with an (i, j) (row index, column index) tuple.

Matrices cannot be indexed by Vec2s because that would be likely to cause confusion: should x be the row index (because it’s the first element) or the column index (because it’s a horizontal position) ?

type Output = T

The returned type after indexing.

fn index( &self, t: (usize, usize), ) -> &<Mat2<T> as Index<(usize, usize)>>::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<(usize, usize)> for Mat2<T>

fn index_mut( &mut self, t: (usize, usize), ) -> &mut <Mat2<T> as Index<(usize, usize)>>::Output

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

impl<S: Ring> LinearMap<S, Vec2<S>, Vec2<S>> for Matrix2<S>

fn determinant(self) -> S

fn transpose(self) -> Self

impl<T> Mul<CubicBezier2<T>> for Mat2<T>

where T: Real + MulAdd<Output = T>,

type Output = CubicBezier2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: CubicBezier2<T>) -> CubicBezier2<T>

Performs the * operation.

impl<T> Mul<Mat2<T>> for Mat2<T>

where T: Mul<Output = T> + MulAdd<Output = T> + Copy,

Multiplies a column-major matrix with a row-major matrix.

use vek::mat::row_major::Mat4 as Rows4;
use vek::mat::column_major::Mat4 as Cols4;

let m = Cols4::<u32>::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let b = Rows4::from(m);
let r = Rows4::<u32>::new(
    26, 32, 18, 24,
    82, 104, 66, 88,
    38, 56, 74, 92,
    54, 68, 42, 56
);
assert_eq!(m * b, r);
assert_eq!(m * Rows4::<u32>::identity(), m.into());
assert_eq!(Cols4::<u32>::identity() * b, m.into());

type Output = Mat2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Mat2<T>) -> <Mat2<T> as Mul<Mat2<T>>>::Output

Performs the * operation.

impl<T> Mul<Mat2<T>> for Vec2<T>

where T: Mul<Output = T> + MulAdd<Output = T> + Copy,

Multiplies a row vector with a column-major matrix, giving a row vector.

use vek::mat::column_major::Mat4;
use vek::vec::Vec4;

let m = Mat4::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let v = Vec4::new(0, 1, 2, 3);
let r = Vec4::new(26, 32, 18, 24);
assert_eq!(v * m, r);

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Mat2<T>) -> <Vec2<T> as Mul<Mat2<T>>>::Output

Performs the * operation.

impl<T> Mul<QuadraticBezier2<T>> for Mat2<T>

where T: Real + MulAdd<Output = T>,

type Output = QuadraticBezier2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: QuadraticBezier2<T>) -> QuadraticBezier2<T>

Performs the * operation.

impl<T> Mul<T> for Mat2<T>

where T: Zero<Output = T> + Add + Mul<Output = T> + Copy,

type Output = Mat2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <Mat2<T> as Mul<T>>::Output

Performs the * operation.

impl<T> Mul<Vec2<T>> for Mat2<T>

where T: Mul<Output = T> + MulAdd<Output = T> + Copy,

Multiplies a column-major matrix with a column vector, giving a column vector.

With SIMD vectors, this is the most efficient way.

use vek::mat::column_major::Mat4;
use vek::vec::Vec4;

let m = Mat4::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let v = Vec4::new(0, 1, 2, 3);
let r = Vec4::new(14, 38, 12, 26);
assert_eq!(m * v, r);

type Output = Vec2<T>

The resulting type after applying the * operator.

fn mul(self, v: Vec2<T>) -> <Mat2<T> as Mul<Vec2<T>>>::Output

Performs the * operation.

impl<T> Mul for Mat2<T>

where T: Mul<Output = T> + MulAdd<Output = T> + Copy,

Multiplies a column-major matrix with another.

use vek::mat::column_major::Mat4;

let m = Mat4::<u32>::new(
    0, 1, 2, 3,
    4, 5, 6, 7,
    8, 9, 0, 1,
    2, 3, 4, 5
);
let r = Mat4::<u32>::new(
    26, 32, 18, 24,
    82, 104, 66, 88,
    38, 56, 74, 92,
    54, 68, 42, 56
);
assert_eq!(m * m, r);
assert_eq!(m, m * Mat4::<u32>::identity());
assert_eq!(m, Mat4::<u32>::identity() * m);

type Output = Mat2<T>

The resulting type after applying the * operator.

fn mul(self, rhs: Mat2<T>) -> <Mat2<T> as Mul>::Output

Performs the * operation.

impl<T> MulAssign<T> for Mat2<T>

where T: Zero<Output = T> + Add + Mul<Output = T> + Copy,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T> MulAssign for Mat2<T>

where T: Add<Output = T> + Mul<Output = T> + Copy + MulAdd<Output = T> + Zero,

fn mul_assign(&mut self, rhs: Mat2<T>)

Performs the *= operation.

impl<T> Neg for Mat2<T>

where T: Neg<Output = T>,

type Output = Mat2<T>

The resulting type after applying the - operator.

fn neg(self) -> <Mat2<T> as Neg>::Output

Performs the unary - operation.

impl<T> One for Mat2<T>

where T: Zero + One + Copy + MulAdd<Output = T>,

fn one() -> Mat2<T>

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,

Returns true if self is equal to the multiplicative identity.

impl<T> PartialEq for Mat2<T>

where T: PartialEq,

fn eq(&self, other: &Mat2<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> RelativeEq for Mat2<T>

where T: RelativeEq, <T as AbsDiffEq>::Epsilon: Copy,

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

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

fn relative_eq( &self, other: &Mat2<T>, epsilon: <T as AbsDiffEq>::Epsilon, max_relative: <T as AbsDiffEq>::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<T> Rem<T> for Mat2<T>

where T: Copy + Rem<Output = T>,

type Output = Mat2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: T) -> <Mat2<T> as Rem<T>>::Output

Performs the % operation.

impl<T> Rem for Mat2<T>

where T: Rem<Output = T>,

type Output = Mat2<T>

The resulting type after applying the % operator.

fn rem(self, rhs: Mat2<T>) -> <Mat2<T> as Rem>::Output

Performs the % operation.

impl<T> RemAssign<T> for Mat2<T>

where T: Rem<Output = T> + Copy,

fn rem_assign(&mut self, rhs: T)

Performs the %= operation.

impl<T> RemAssign for Mat2<T>

where T: Rem<Output = T> + Copy,

fn rem_assign(&mut self, rhs: Mat2<T>)

Performs the %= operation.

impl<T> Serialize for Mat2<T>

where T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Sub<T> for Mat2<T>

where T: Copy + Sub<Output = T>,

type Output = Mat2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> <Mat2<T> as Sub<T>>::Output

Performs the - operation.

impl<T> Sub for Mat2<T>

where T: Sub<Output = T>,

type Output = Mat2<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Mat2<T>) -> <Mat2<T> as Sub>::Output

Performs the - operation.

impl<T> SubAssign<T> for Mat2<T>

where T: Sub<Output = T> + Copy,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T> SubAssign for Mat2<T>

where T: Sub<Output = T> + Copy,

fn sub_assign(&mut self, rhs: Mat2<T>)

Performs the -= operation.

impl<T> UlpsEq for Mat2<T>

where T: UlpsEq, <T as AbsDiffEq>::Epsilon: Copy,

fn default_max_ulps() -> u32

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

fn ulps_eq( &self, other: &Mat2<T>, epsilon: <T as AbsDiffEq>::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<T> Zero for Mat2<T>

where T: Zero + PartialEq,

fn zero() -> Mat2<T>

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<T> Copy for Mat2<T>

where T: Copy,

impl<T> Eq for Mat2<T>

where T: Eq,

impl<S: Ring> MultiplicativeMonoid for Matrix2<S>

impl<T> StructuralPartialEq for Mat2<T>