Struct oxygen_quark::vector::vector3d::Vector3D

pub struct Vector3D {
    pub x: Fraction,
    pub y: Fraction,
    pub z: Fraction,
}

Fields

x: Fraction

y: Fraction

z: Fraction

Implementations

impl Vector3D

pub fn new(x: Fraction, y: Fraction, z: Fraction) -> Vector3D

Generates a new Vector3D

extern crate oxygen_quark as quark;
use quark::vector::vector3d::*;
use quark::fraction::Fraction;
 
let x = Fraction::new(3, 1);
let y = Fraction::new(6, 1);
let z = Fraction::new(2, 1);
let vector = Vector3D::new(x, y, z);
 
 
// Prints out "(x: 3, y: 6, z: 2)"
println!("{}", vector);

pub fn add(&self, other: &Vector3D) -> Vector3D

Adds two Vector3Ds and returns their sum.

let vector1 = Vector3D::new(x1, y1, z1);
let vector2 = Vector3D { x: x2, y: y2, z: z2 };
 
let result_vector = vector1.add(&vector2);
 
 
// Prints out "(x: 5, y: 11, z: (7/2))"
println!("{}", result_vector);

pub fn subtract(&self, other: &Vector3D) -> Vector3D

Subtracts two Vector3Ds and returns their difference.

let vector1 = Vector3D::new(x1, y1, z1);
let vector2 = Vector3D { x: x2, y: y2, z: z2 };
 
let result_vector = vector1.subtract(&vector2);
 
 
// Prints out "(x: 1, y: 1, z: (1/2))"
println!("{}", result_vector);

pub fn component_product(&self, other: &Vector3D) -> Vector3D

Returns a new Vector3D containing the product of every component in a Vector3D with the corresponding component in another one.

let vector1 = Vector3D::new(x1, y1, z1);
let vector2 = Vector3D::new(x2, y2, z2);
 
let result_vector = vector1.component_product(&vector2);
 
 
// Prints out "(x: 6, y: 30, 3)"
println!("{}", result_vector);

pub fn dot_product(&self, other: &Vector3D) -> Fraction

Returns a Fraction that is the result of the dot-product between two Vector3Ds.

use quark::fraction::Fraction;
 
let vector1 = Vector3D::new(x1, y1, z1);
let vector2 = Vector3D::new(x2, y2, z2);
 
let result = vector1.dot_product(&vector2);
 
 
// Prints out "39"
println!("{}", result);

pub fn cross_product(&self, other: &Vector3D) -> Vector3D

Returns a Vector3D that is the cross-product between two other Vector3Ds.

let vector1 = Vector3D::new(x1, y1, z1);
let vector2 = Vector3D::new(x2, y2, z2);
 
let result_vector = vector1.cross_product(&vector2);
 
 
// Prints out "(x: -1, y: (-1/2), z: 3)"
println!("{}", result_vector);

pub fn scale(&self, scale: Fraction) -> Vector3D

Returns a scaled Vector3D.

let vector = Vector3D::new(x, y, z);
let scale = Fraction::new(5, 1);
 
 
// Prints out "(x: 25, y: 15, z: 30)"
println!("{}", vector.scale(scale));  

pub fn norm(&self) -> Fraction

Returns a Fraction, the norm of the vector.

use quark::fraction::Fraction;
 
let vector = Vector3D::new(x, y, z);

 
// Prints out "7"
println!("{}", vector.norm());

pub fn normalise(&self) -> Vector3D

Returns a normalised version of the Vector3D that was fed in.

let vector = Vector3D::new(x, y, z);
 
 
// Prints out "(x: (3/7), y: (6/7), z: (2/7))"
println!("{}", vector.normalise());

Trait Implementations

impl Debug for Vector3D

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

Formats the value using the given formatter.

impl Display for Vector3D

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

Formats the value using the given formatter.

impl Ord for Vector3D

fn cmp(&self, other: &Vector3D) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Vector3D> for Vector3D

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Vector3D> for Vector3D

fn partial_cmp(&self, other: &Vector3D) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Vector3D