Skip to main content

Vector3d

Struct Vector3d 

Source
pub struct Vector3d<T: Float> {
    pub x: T,
    pub y: T,
    pub z: T,
}
Expand description

A generic 3-dimensional vector.

§Type Parameters

  • T - Floating-point numeric type.

§Examples

use mathrc::Vector3d;

let v = Vector3d::new(1.0, 2.0, 3.0);

assert_eq!(v.x, 1.0);
assert_eq!(v.y, 2.0);
assert_eq!(v.z, 3.0);

Fields§

§x: T

X component.

§y: T

Y component.

§z: T

Z component.

Implementations§

Source§

impl<T: Float> Vector3d<T>

Source

pub fn new(x: T, y: T, z: T) -> Self

Creates a new 3D vector.

§Examples
use mathrc::Vector3d;

let v = Vector3d::new(1.0, 2.0, 3.0);

assert_eq!(v.x, 1.0);
Source

pub fn to_vec(&self) -> Vector<T>

Converts this vector into a generic Vector.

§Examples
use mathrc::Vector3d;

let v = Vector3d::new(1.0, 2.0, 3.0);
let vec = v.to_vec();

assert_eq!(vec[0], 1.0);
assert_eq!(vec[1], 2.0);
assert_eq!(vec[2], 3.0);
Source

pub fn cross(&self, other: &Self) -> Self

Computes the cross product of two 3D vectors.

§Examples
use mathrc::Vector3d;

let a = Vector3d::new(1.0, 0.0, 0.0);
let b = Vector3d::new(0.0, 1.0, 0.0);

assert_eq!(
    a.cross(&b),
    Vector3d::new(0.0, 0.0, 1.0)
);

Trait Implementations§

Source§

impl<T: Float> Add for Vector3d<T>

Source§

fn add(self, rhs: Self) -> Self::Output

Adds two vectors component-wise.

Source§

type Output = Vector3d<T>

The resulting type after applying the + operator.
Source§

impl<T: Clone + Float> Clone for Vector3d<T>

Source§

fn clone(&self) -> Vector3d<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy + Float> Copy for Vector3d<T>

Source§

impl<T: Debug + Float> Debug for Vector3d<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Float + Display> Display for Vector3d<T>

Source§

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

Formats the vector as [x, y, z].

Source§

impl<T: Float> Mul<T> for Vector3d<T>

Source§

fn mul(self, scalar: T) -> Self::Output

Multiplies a vector by a scalar.

Source§

type Output = Vector3d<T>

The resulting type after applying the * operator.
Source§

impl<T: Float> Neg for Vector3d<T>

Source§

fn neg(self) -> Self::Output

Negates all vector components.

Source§

type Output = Vector3d<T>

The resulting type after applying the - operator.
Source§

impl<T: PartialEq + Float> PartialEq for Vector3d<T>

Source§

fn eq(&self, other: &Vector3d<T>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<T: Float> StructuralPartialEq for Vector3d<T>

Source§

impl<T: Float> Sub for Vector3d<T>

Source§

fn sub(self, rhs: Self) -> Self::Output

Subtracts two vectors component-wise.

Source§

type Output = Vector3d<T>

The resulting type after applying the - operator.
Source§

impl<T> VectorOps<T> for Vector3d<T>
where T: Float + Sum<T>,

Source§

fn dot(&self, other: &Self) -> Result<T, VectorErr>

Computes the dot product of two vectors.

§Examples
use mathrc::{Vector3d, VectorOps};

let a = Vector3d::new(1.0, 2.0, 3.0);
let b = Vector3d::new(4.0, 5.0, 6.0);

assert_eq!(a.dot(&b).unwrap(), 32.0);
Source§

fn magnitude(&self) -> T

Returns the Euclidean magnitude of the vector.

§Examples
use mathrc::{Vector3d, VectorOps};

let v = Vector3d::new(1.0, 2.0, 2.0);

assert_eq!(v.magnitude(), 3.0);
Source§

fn normalize(&self) -> Result<Self, VectorErr>

Returns a normalized vector.

§Errors

Returns VectorErr::ZeroVector if the vector magnitude is zero.

§Examples
use mathrc::{Vector3d, VectorOps};

let v: Vector3d<f64> = Vector3d::new(3.0, 4.0, 0.0);
let n: Vector3d<f64> = v.normalize().unwrap();

assert!((n.magnitude() - 1.0).abs() < 1e-10);

Auto Trait Implementations§

§

impl<T> Freeze for Vector3d<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Vector3d<T>
where T: RefUnwindSafe,

§

impl<T> Send for Vector3d<T>
where T: Send,

§

impl<T> Sync for Vector3d<T>
where T: Sync,

§

impl<T> Unpin for Vector3d<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Vector3d<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Vector3d<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.