Struct calcify::ThreeVec

pub struct ThreeVec { /* fields omitted */ }

Three Vector

Methods

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

fn to_json(&self) -> String

impl Clone for ThreeVec

fn clone(&self) -> ThreeVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ThreeVec

impl PartialEq<ThreeVec> for ThreeVec

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

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

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

This method tests for !=.

impl Display for ThreeVec

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

Formats the value using the given formatter.

impl Debug for ThreeVec

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

Formats the value using the given formatter.

impl FromStr for ThreeVec

type Err = ParseFloatError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Add<ThreeVec> for ThreeVec

type Output = ThreeVec

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<ThreeVec> for ThreeVec

type Output = ThreeVec

The resulting type after applying the - operator.

fn sub(self, other: 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<ThreeVec> for f64

type Output = ThreeVec

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<ThreeVec> for ThreeVec

type Output = f64

The resulting type after applying the * operator.

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
);

impl Mul<ThreeVec> for ThreeMat

type Output = ThreeVec

The resulting type after applying the * operator.

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)
);

impl Neg for ThreeVec

type Output = ThreeVec

The resulting type after applying the - operator.

fn neg(self) -> ThreeVec

Performs the unary - operation.

impl AddAssign<ThreeVec> for ThreeVec

fn add_assign(&mut self, other: ThreeVec)

Performs the += operation.

impl SubAssign<ThreeVec> for ThreeVec

fn sub_assign(&mut self, other: ThreeVec)

Performs the -= operation.