Struct calcify::ThreeVec

source · [−]

pub struct ThreeVec { /* private fields */ }

Expand description

Three Vector

Implementations

source

impl ThreeVec

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

impl Add<ThreeVec> for ThreeVec

type Output = ThreeVec

The resulting type after applying the + operator.

source

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

Performs the + operation. Read more

source

impl AddAssign<ThreeVec> for ThreeVec

source

fn add_assign(&mut self, other: ThreeVec)

Performs the += operation. Read more

source

impl Clone for ThreeVec

source

fn clone(&self) -> ThreeVec

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for ThreeVec

source

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

Formats the value using the given formatter. Read more

source

impl Deserializable for ThreeVec

source

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

Return Self from string

source

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

source

impl Display for ThreeVec

source

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

Formats the value using the given formatter. Read more

source

impl Mul<ThreeVec> for f64

type Output = ThreeVec

The resulting type after applying the * operator.

source

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

Performs the * operation. Read more

source

impl Mul<ThreeVec> for ThreeVec

source

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.

source

impl Mul<ThreeVec> for ThreeMat

source

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