Struct calcify::ThreeMat

pub struct ThreeMat { /* private fields */ }

Three Matrix

Implementations

impl ThreeMat

pub fn new(r0: ThreeVec, r1: ThreeVec, r2: ThreeVec) -> ThreeMat

Returns a new ThreeMat from three ThreeVecs

Arguments

• r0 - calcify::ThreeVec
• r1 - calcify::ThreeVec
• r2 - calcify::ThreeVec

Example

use calcify::ThreeVec;
use calcify::ThreeMat;
let mat3 = ThreeMat::new(
              ThreeVec::new(1.0,2.0,3.0),
              ThreeVec::new(4.0,5.0,6.0),
              ThreeVec::new(7.0,8.0,9.0)
           );

pub fn from(slice: &[ThreeVec]) -> ThreeMat

Returns a new ThreeMat from a slice

Arguments

• slice - &ThreeVec

Panics

• slice length < 3

pub fn random(max: f64) -> ThreeMat

Returns a new ThreeMat with three random ThreeVecs using calcify::ThreeVec::random(max: f64)

Arguments

• max - f64: The absolute maximum value of each individule componant of the constituent ThreeVec

Example

use calcify::ThreeMat;
let mat3 = ThreeMat::random(10.0);

pub fn eye() -> ThreeMat

Returns a new ThreeMat identity matrix

Example

use calcify::ThreeMat;
let mat3 = ThreeMat::eye();

assert_eq!(*mat3.r1().x1(),1.0);

pub fn zero() -> ThreeMat

Returns a new ThreeMat zero matrix

Example

use calcify::ThreeMat;
let mat3 = ThreeMat::zero();

assert_eq!(*mat3.r1().x1(),0.0);

pub fn one() -> ThreeMat

Returns a new ThreeMat one matrix

Example

use calcify::ThreeMat;
let mat3 = ThreeMat::one();

assert_eq!(*mat3.r1().x1(),1.0);

pub fn r0(&self) -> &ThreeVec

Returns a reference to the first row of the matrix.

Example

use calcify::ThreeVec;
use calcify::ThreeMat;
let mat3 = ThreeMat::new(
              ThreeVec::new(1.0,2.0,3.0),
              ThreeVec::new(4.0,5.0,6.0),
              ThreeVec::new(7.0,8.0,9.0)
           );
let row_zero: ThreeVec = *mat3.r0();
let element_zero_zero: f64 = *mat3.r0().x0();
assert_eq!(row_zero,ThreeVec::new(1.0,2.0,3.0));
assert_eq!(element_zero_zero,1.0);

pub fn r1(&self) -> &ThreeVec

Returns a reference to the second row of the matrix.

Example

use calcify::ThreeVec;
use calcify::ThreeMat;
let mat3 = ThreeMat::new(
              ThreeVec::new(1.0,2.0,3.0),
              ThreeVec::new(4.0,5.0,6.0),
              ThreeVec::new(7.0,8.0,9.0)
           );
let row_one: ThreeVec = *mat3.r1();
let element_one_one: f64 = *mat3.r1().x1();
assert_eq!(row_one,ThreeVec::new(4.0,5.0,6.0));
assert_eq!(element_one_one,5.0);

pub fn r2(&self) -> &ThreeVec

Returns a reference to the third row of the matrix.

Example

use calcify::ThreeVec;
use calcify::ThreeMat;
let mat3 = ThreeMat::new(
              ThreeVec::new(1.0,2.0,3.0),
              ThreeVec::new(4.0,5.0,6.0),
              ThreeVec::new(7.0,8.0,9.0)
           );
let row_two: ThreeVec = *mat3.r2();
let element_two_two: f64 = *mat3.r2().x2();
assert_eq!(row_two,ThreeVec::new(7.0,8.0,9.0));
assert_eq!(element_two_two,9.0);

pub fn c0(&self) -> ThreeVec

Returns a new memory ThreeVec of the first column of the matrix.

Example

use calcify::ThreeVec;
use calcify::ThreeMat;
let mat3 = ThreeMat::new(
              ThreeVec::new(1.0,2.0,3.0),
              ThreeVec::new(4.0,5.0,6.0),
              ThreeVec::new(7.0,8.0,9.0)
           );
let col_one: ThreeVec = mat3.c0();
let element_one_one: f64 = *mat3.c0().x0();
assert_eq!(col_one,ThreeVec::new(1.0,4.0,7.0));
assert_eq!(element_one_one,1.0);

pub fn c1(&self) -> ThreeVec

pub fn c2(&self) -> ThreeVec

Trait Implementations

impl Add<ThreeMat> for ThreeMat

type Output = ThreeMat

The resulting type after applying the + operator.

fn add(self, other: ThreeMat) -> ThreeMat

Performs the + operation.

impl AddAssign<ThreeMat> for ThreeMat

fn add_assign(&mut self, other: ThreeMat)

Performs the += operation.

impl Clone for ThreeMat

fn clone(&self) -> ThreeMat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ThreeMat

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

Formats the value using the given formatter.

impl Deserializable for ThreeMat

fn from_json(s: &str) -> Result<Self, Box<dyn Error>>

Return Self from string

fn from_msg(bytes: &[u8]) -> Result<(Self, &[u8]), Box<dyn Error>>

Return a tuple of Self and a &u8 of remaining unparsed bytes from a byte array

impl Display for ThreeMat

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

Formats the value using the given formatter.

impl Mul<ThreeMat> for f64

type Output = ThreeMat

The resulting type after applying the * operator.

fn mul(self, vec: ThreeMat) -> ThreeMat

Performs the * operation.

impl Mul<ThreeMat> for ThreeMat

fn mul(self, other: ThreeMat) -> ThreeMat

Matrix multiplication

Example

use calcify::ThreeMat;
use calcify::ThreeVec;

let mat3 = ThreeMat::new(ThreeVec::new(1.0,2.0,3.0),
                            ThreeVec::new(4.0,5.0,6.0),
                            ThreeVec::new(7.0,8.0,9.0));

assert_eq!(
    mat3*mat3,
    ThreeMat::new(ThreeVec::new(30.0,36.0,42.0),
                ThreeVec::new(66.0,81.0,96.0),
                ThreeVec::new(102.0,126.0,150.0)));

type Output = ThreeMat

The resulting type after applying the * operator.

impl Mul<ThreeVec> for ThreeMat

fn mul(self, other: ThreeVec) -> ThreeVec

Matrix multiplication with vector

Note

Only works in one direction ThreeMat*ThreeVec, implying ThreeVec as a column vector.

Example

use calcify::ThreeMat;
use calcify::ThreeVec;

let mat3 = ThreeMat::new(ThreeVec::new(1.0,2.0,3.0),
                            ThreeVec::new(1.0,2.0,3.0),
                            ThreeVec::new(1.0,2.0,3.0));

assert_eq!(
    mat3*ThreeVec::new(2.0,2.0,2.0),
    ThreeVec::new(12.0,12.0,12.0)
);

type Output = ThreeVec

The resulting type after applying the * operator.

impl Mul<f64> for ThreeMat

type Output = ThreeMat

The resulting type after applying the * operator.

fn mul(self, coef: f64) -> ThreeMat

Performs the * operation.

impl Neg for ThreeMat

type Output = ThreeMat

The resulting type after applying the - operator.

fn neg(self) -> ThreeMat

Performs the unary - operation.

impl PartialEq<ThreeMat> for ThreeMat

fn eq(&self, other: &ThreeMat) -> bool

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

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

This method tests for !=.

impl Serializable for ThreeMat

fn to_json(&self) -> String

Return object intensive json string

fn to_msg(&self) -> Result<Vec<u8>, ValueWriteError>

Return Result wrapped Vec in MsgPack Format is not like to_json it is array intensive not object

impl Sub<ThreeMat> for ThreeMat

type Output = ThreeMat

The resulting type after applying the - operator.

fn sub(self, other: ThreeMat) -> ThreeMat

Performs the - operation.

impl SubAssign<ThreeMat> for ThreeMat

fn sub_assign(&mut self, other: ThreeMat)

Performs the -= operation.

impl Copy for ThreeMat

impl StructuralPartialEq for ThreeMat