Struct ThreeVec 

pub struct ThreeVec { /* private fields */ }

Three Vector

Implementations

impl ThreeVec

pub fn new(x0: f64, x1: f64, x2: f64) -> ThreeVec

Returns a new ThreeVec from three f64s

Arguments

• x0 - f64
• x1 - f64
• x2 - f64

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::new(1.0,2.0,3.0);

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

Returns a new ThreeVec from a slice

Arguments

• slice - &f64

Example

use calcify::ThreeVec;
let vec3: ThreeVec = ThreeVec::from(&[1.0,1.0,1.0]);

Panics

• slice length < 3

pub fn random(max: f64) -> ThreeVec

Returns a new ThreeVec with three random f64 from rand::Uniform between -1 and 1

Arguments

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

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::random(10.0);

pub fn x0(&self) -> &f64

Returns a reference to the first element of the vector

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::new(1.0,2.0,3.0);
let element_zero: f64 = *vec3.x0();
assert_eq!(element_zero,1.0);

pub fn x1(&self) -> &f64

Returns a reference to the second element of the vector

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::new(1.0,2.0,3.0);
let element_one: f64 = *vec3.x1();
assert_eq!(element_one,2.0);

pub fn x2(&self) -> &f64

Returns a reference to the third element of the vector

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::new(1.0,2.0,3.0);
let element_two: f64 = *vec3.x2();
assert_eq!(element_two,3.0);

pub fn r(&self) -> f64

Returns the length of the vector

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::new(1.0,0.0,0.0);
assert_eq!(vec3.r(),1.0);

Trait Implementations

impl Add for ThreeVec

type Output = ThreeVec

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for ThreeVec

fn add_assign(&mut self, other: ThreeVec)

Performs the += operation.

impl Clone for ThreeVec

fn clone(&self) -> ThreeVec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ThreeVec

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

Formats the value using the given formatter.

impl Deserializable for ThreeVec

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 ThreeVec

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

Formats the value using the given formatter.

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<ThreeVec> for f64

type Output = ThreeVec

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f64> for ThreeVec

type Output = ThreeVec

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for ThreeVec

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

Dot product

Example

use calcify::ThreeVec;
let vec3 = ThreeVec::new(2.0,2.0,2.0);

assert_eq!(
   vec3*vec3,
   12.0
);

type Output = f64

The resulting type after applying the * operator.

impl Neg for ThreeVec

type Output = ThreeVec

The resulting type after applying the - operator.

fn neg(self) -> ThreeVec

Performs the unary - operation.

impl PartialEq for ThreeVec

fn eq(&self, other: &ThreeVec) -> 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 Serializable for ThreeVec

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 for ThreeVec

type Output = ThreeVec

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for ThreeVec

fn sub_assign(&mut self, other: ThreeVec)

Performs the -= operation.

impl Sum for ThreeVec

fn sum<I>(iter: I) -> ThreeVec

where I: Iterator<Item = ThreeVec>,

Takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for ThreeVec

impl StructuralPartialEq for ThreeVec