Struct vec3D::Vec3D

pub struct Vec3D {
    pub x: f64,
    pub y: f64,
    pub z: f64,
}

Fields

x: f64

y: f64

z: f64

Methods

impl Vec3D

pub fn new(x: f64, y: f64, z: f64) -> Vec3D

pub fn new_from_spherical_coordinates(
    r: f64,
    theta: f64,
    phi: f64
) -> Result<Vec3D, Vec3DError>

Creates a new 3D vector from spherical coordinates

• r - radial distance
• theta - polar angle
• phi - azimuthal angle

Errors

Will return a Vec3DError if:

• r < 0
• theta < 0
• theta > PI

pub fn new_from_cylindrical_coordinates(
    r: f64,
    phi: f64,
    z: f64
) -> Result<Vec3D, Vec3DError>

Creates a new 3D vector from cylindrical coordinates

• r - radial distance
• phi - angle
• z - height along z-axis

Errors

Will return a Vec3DError if:

• r < 0

pub fn zeros() -> Vec3D

Returns a new vector with a value of 0.0 in each axis

pub fn ones() -> Vec3D

Returns a new vector with a value of 1.0 in each axis

pub fn x_proj(&self) -> Vec3D

Returns the projection of the vector in the x-axis

pub fn y_proj(&self) -> Vec3D

Returns the projection of the vector in the y-axis

pub fn z_proj(&self) -> Vec3D

Returns the projection of the vector in the z-axis

pub fn theta(&self) -> f64

Returns the vector's theta value in spherical coordinates

pub fn phi(&self) -> f64

Returns the vector's phi value in spherical/cylindrical coordinates

pub fn mag(&self) -> f64

Returns the vector's magnitude

pub fn mag2(&self) -> f64

Returns the vector's magnitude^2

pub fn norm(&self) -> Vec3D

Returns a new vector of the current vector normalised

pub fn unit(&self) -> Vec3D

Alias for Vec3D::norm

pub fn inner_product(&self, other: Vec3D) -> f64

Returns the inner product of this vector with another vector

pub fn dot(&self, other: Vec3D) -> f64

Alias for Vec3D::inner_product

pub fn distance_to(&self, other: Vec3D) -> f64

Returns the distance between this vector and another vector

pub fn distance_to2(&self, other: Vec3D) -> f64

Returns the distance^2 between this vector and another vector

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

Returns the cross product of this vector with another vector

pub fn pseudo_rapidity(&self) -> f64

Returns the pseudo-rapidity of the vector w.r.t the z-axis

See: https://en.wikipedia.org/wiki/Pseudorapidity

pub fn rotate_x(&mut self, angle: f64)

Rotates the vector around the x-axis

pub fn rotated_x(&self, angle: f64) -> Vec3D

Returns a new vector of the current vector rotated around the x-axis

pub fn rotate_y(&mut self, angle: f64)

Rotates the vector around the y-axis

pub fn rotated_y(&self, angle: f64) -> Vec3D

Returns a new vector of the current vector rotated around the y-axis

pub fn rotate_z(&mut self, angle: f64)

Rotates the vector around the z-axis

pub fn rotated_z(&self, angle: f64) -> Vec3D

Returns a new vector of the current vector rotated around the z-axis

pub fn approx_eq(self, other: Vec3D) -> bool

Returns true if points are approximately equal

Trait Implementations

impl Eq for Vec3D

impl Clone for Vec3D

fn clone(&self) -> Vec3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Vec3D

impl PartialEq<Vec3D> for Vec3D

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

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

#[must_use]

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

This method tests for !=.

impl Add<Vec3D> for Vec3D

type Output = Vec3D

The resulting type after applying the + operator.

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

Performs the + operation.

impl Sub<Vec3D> for Vec3D

type Output = Vec3D

The resulting type after applying the - operator.

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

Performs the - operation.

impl Mul<f64> for Vec3D

type Output = Vec3D

The resulting type after applying the * operator.

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

Performs the * operation.

impl Div<f64> for Vec3D

type Output = Vec3D

The resulting type after applying the / operator.

fn div(self, other: f64) -> Vec3D

Performs the / operation.

impl Neg for Vec3D

type Output = Vec3D

The resulting type after applying the - operator.

fn neg(self) -> Vec3D

Performs the unary - operation.

impl AddAssign<Vec3D> for Vec3D

fn add_assign(&mut self, other: Vec3D)

Performs the += operation.

impl SubAssign<Vec3D> for Vec3D

fn sub_assign(&mut self, other: Vec3D)

Performs the -= operation.

impl MulAssign<f64> for Vec3D

fn mul_assign(&mut self, other: f64)

Performs the *= operation.

impl DivAssign<f64> for Vec3D

fn div_assign(&mut self, other: f64)

Performs the /= operation.

impl Debug for Vec3D

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

Formats the value using the given formatter.

impl Display for Vec3D

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

Formats the value using the given formatter.