[−][src]Struct vex::Matrix3

#[repr(C, packed)]pub struct Matrix3 {
    pub m: [f32; 9],
}

Fields

m: [f32; 9]

Methods

`impl Matrix3`[src]

`pub fn new() -> Matrix3`[src]

Creates a matrix set to its identity

Examples

use vex::Matrix3;
use vex::matrix3::IDENTITY;
let actual = Matrix3::new();
assert_eq!(actual, IDENTITY);

`pub fn make( m11: f32, m21: f32, m31: f32, m12: f32, m22: f32, m32: f32, m13: f32, m23: f32, m33: f32 ) -> Matrix3`[src]

Creates a matrix from the provided values

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let expected = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0];
assert_eq!(actual.m, expected);

`pub fn m11(&self) -> f32`[src]

Gets the value for the m11 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m11(), 1.0);

`pub fn m21(&self) -> f32`[src]

Gets the value for the m21 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m21(), 2.0);

`pub fn m31(&self) -> f32`[src]

Gets the value for the m31 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m31(), 3.0);

`pub fn m12(&self) -> f32`[src]

Gets the value for the m12 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m12(), 4.0);

`pub fn m22(&self) -> f32`[src]

Gets the value for the m22 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m22(), 5.0);

`pub fn m32(&self) -> f32`[src]

Gets the value for the m32 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m32(), 6.0);

`pub fn m13(&self) -> f32`[src]

Gets the value for the m13 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m13(), 7.0);

`pub fn m23(&self) -> f32`[src]

Gets the value for the m23 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m23(), 8.0);

`pub fn m33(&self) -> f32`[src]

Gets the value for the m33 element

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual.m33(), 9.0);

`pub fn set_m11(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m11(1.0);
let expected = [1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m21(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m21(1.0);
let expected = [0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m31(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m31(1.0);
let expected = [0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m12(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m12(1.0);
let expected = [0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m22(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m22(1.0);
let expected = [0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m32(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m32(1.0);
let expected = [0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m13(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m13(1.0);
let expected = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m23(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m23(1.0);
let expected = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0];
assert_eq!(actual.m, expected);

`pub fn set_m33(&mut self, v: f32)`[src]

Sets the value for the m11 element

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0);
actual.set_m33(1.0);
let expected = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0];
assert_eq!(actual.m, expected);

`pub fn set( &mut self, m11: f32, m21: f32, m31: f32, m12: f32, m22: f32, m32: f32, m13: f32, m23: f32, m33: f32 )`[src]

Sets the internal contents of the matrix

Examples

use vex::Matrix3;
let mut actual = Matrix3::new();
actual.set(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let expected = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert_eq!(actual, expected);

`pub fn transpose(&mut self)`[src]

Transposes the matrix's elements

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual.transpose();
let expected = Matrix3::make(1.0, 4.0, 7.0, 2.0, 5.0, 8.0, 3.0, 6.0, 9.0);
assert_eq!(actual, expected);

`pub fn determinant(&self) -> f32`[src]

Find the matrix's determinant

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0).determinant();
assert_eq!(actual, 0.0);

`pub fn inverse(&mut self) -> bool`[src]

Inverses the matrix

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 0.0, 5.0, 2.0, 1.0, 6.0, 3.0, 4.0, 0.0);
actual.inverse();
let expected = Matrix3::make(-24.0, 20.0, -5.0, 18.0, -15.0, 4.0, 5.0, -4.0, 1.0);
assert_eq!(actual, expected);

`pub fn is_valid(&self) -> bool`[src]

Determine whether or not all elements of the matrix are valid

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
assert!(actual.is_valid());

Trait Implementations

`impl Add<Matrix3> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the + operator.

`fn add(self, _rhs: Matrix3) -> Matrix3`[src]

Add two matrices

Examples

use vex::Matrix3;
let a = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let b = Matrix3::make(9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0);
let actual = a + b;
let expected = Matrix3::make(10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0);
assert_eq!(actual, expected);

`impl Add<f32> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the + operator.

`fn add(self, _rhs: f32) -> Matrix3`[src]

Find the resulting matrix by adding a scalar to a matrix's elements

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0) + 1.0;
let expected = Matrix3::make(2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0);
assert_eq!(actual, expected);

`impl AddAssign<Matrix3> for Matrix3`[src]

`fn add_assign(&mut self, _rhs: Matrix3)`[src]

Increment a matrix by another matrix

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual += Matrix3::make(9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0);
let expected = Matrix3::make(10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0, 10.0);
assert_eq!(actual, expected);

`impl AddAssign<f32> for Matrix3`[src]

`fn add_assign(&mut self, _rhs: f32)`[src]

Increment a matrix by a scalar

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual += 10.0;
let expected = Matrix3::make(11.0, 12.0, 13.0, 14.0, 15.0, 16.0, 17.0, 18.0, 19.0);
assert_eq!(actual, expected);

`impl Clone for Matrix3`[src]

`fn clone(&self) -> Matrix3`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Copy for Matrix3`[src]

`impl Debug for Matrix3`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Display for Matrix3`[src]

`fn fmt(&self, f: &mut Formatter) -> Result`[src]

`impl Div<f32> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the / operator.

`fn div(self, _rhs: f32) -> Matrix3`[src]

Find the resulting matrix by dividing a scalar to a matrix's elements

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0) / 2.0;
let expected = Matrix3::make(0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0, 4.5);
assert_eq!(actual, expected);

`impl DivAssign<f32> for Matrix3`[src]

`fn div_assign(&mut self, _rhs: f32)`[src]

Divide a matrix by a scalar

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual /= 2.0;
let expected = Matrix3::make(0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.5, 4.0, 4.5);
assert_eq!(actual, expected);

`impl Mul<Matrix3> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the * operator.

`fn mul(self, _rhs: Matrix3) -> Matrix3`[src]

Multiply two matrices

Examples

use vex::Matrix3;
let a = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let b = Matrix3::make(9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0);
let actual = a * b;
let expected = Matrix3::make(90.0, 114.0, 138.0, 54.0, 69.0, 84.0, 18.0, 24.0, 30.0);
assert_eq!(actual, expected);

`impl Mul<f32> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the * operator.

`fn mul(self, _rhs: f32) -> Matrix3`[src]

Find the resulting matrix by multiplying a scalar to a matrix's elements

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0) * 2.0;
let expected = Matrix3::make(2.0, 4.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0, 18.0);
assert_eq!(actual, expected);

`impl MulAssign<Matrix3> for Matrix3`[src]

`fn mul_assign(&mut self, _rhs: Matrix3)`[src]

Multiply a matrix by another matrix

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual *= Matrix3::make(9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0);
let expected = Matrix3::make(90.0, 114.0, 138.0, 54.0, 69.0, 84.0, 18.0, 24.0, 30.0);
assert_eq!(actual, expected);

`impl MulAssign<f32> for Matrix3`[src]

`fn mul_assign(&mut self, _rhs: f32)`[src]

Multiply a matrix by a scalar

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual *= 2.0;
let expected = Matrix3::make(2.0, 4.0, 6.0, 8.0, 10.0, 12.0, 14.0, 16.0, 18.0);
assert_eq!(actual, expected);

`impl Neg for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the - operator.

`fn neg(self) -> Matrix3`[src]

Negates the matrix's elements

Examples

use vex::Matrix3;
let actual = -Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let expected = Matrix3::make(-1.0, -2.0, -3.0, -4.0, -5.0, -6.0, -7.0, -8.0, -9.0);
assert_eq!(actual, expected);

`impl PartialEq<Matrix3> for Matrix3`[src]

`fn eq(&self, _rhs: &Matrix3) -> bool`[src]

Determines if two matrices' elements are equivalent

Examples

use vex::Matrix3;
assert!(Matrix3::new() == Matrix3::new());

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl Sub<Matrix3> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the - operator.

`fn sub(self, _rhs: Matrix3) -> Matrix3`[src]

Subtract two matrices

Examples

use vex::Matrix3;
let a = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
let b = Matrix3::make(9.0, 8.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.0, 1.0);
let actual = a - b;
let expected = Matrix3::make(-8.0, -6.0, -4.0, -2.0, 0.0, 2.0, 4.0, 6.0, 8.0);
assert_eq!(actual, expected);

`impl Sub<f32> for Matrix3`[src]

`type Output = Matrix3`

The resulting type after applying the - operator.

`fn sub(self, _rhs: f32) -> Matrix3`[src]

Find the resulting matrix by subtracting a scalar from a matrix's elements

Examples

use vex::Matrix3;
let actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0) - 10.0;
let expected = Matrix3::make(-9.0, -8.0, -7.0, -6.0, -5.0, -4.0, -3.0, -2.0, -1.0);
assert_eq!(actual, expected);

`impl SubAssign<Matrix3> for Matrix3`[src]

`fn sub_assign(&mut self, _rhs: Matrix3)`[src]

Decrement a matrix by another matrix

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0);
actual -= Matrix3::make(1.0, 3.0, 4.0, 5.0, 5.0, 7.0, 8.0, 9.0, 9.0);
assert_eq!(actual, Matrix3::new());

`impl SubAssign<f32> for Matrix3`[src]

`fn sub_assign(&mut self, _rhs: f32)`[src]

Decrement a matrix by a scalar

Examples

use vex::Matrix3;
let mut actual = Matrix3::make(1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0);
actual -= 1.0;
let expected = Matrix3::make(0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0);
assert_eq!(actual, expected);

Auto Trait Implementations

`impl RefUnwindSafe for Matrix3`

`impl Send for Matrix3`

`impl Sync for Matrix3`

`impl Unpin for Matrix3`

`impl UnwindSafe for Matrix3`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

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

The type returned in the event of a conversion error.

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