Struct RealVec3 

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

A vector with three components.

Examples

use laddu_physics::vectors::RealVec3;

let cross = RealVec3::x().cross(&RealVec3::y());
assert_eq!(cross, RealVec3::z());

Fields

x: f64

The x-component of the vector

y: f64

The y-component of the vector

z: f64

The z-component of the vector

Implementations

impl RealVec3

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

Create a new 3-vector from its components

pub const fn zero() -> Self

Create a zero vector

pub const fn x() -> Self

Create a unit vector pointing in the x-direction

pub const fn y() -> Self

Create a unit vector pointing in the y-direction

pub const fn z() -> Self

Create a unit vector pointing in the z-direction

pub fn px(&self) -> f64

Momentum in the x-direction

pub fn py(&self) -> f64

Momentum in the y-direction

pub fn pz(&self) -> f64

Momentum in the z-direction

pub fn with_mass(&self, mass: f64) -> RealVec4

Create a RealVec4 with this vector as the 3-momentum and the given mass

pub fn with_energy(&self, energy: f64) -> RealVec4

Create a RealVec4 with this vector as the 3-momentum and the given energy

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

Compute the dot product of this RealVec3 and another

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

Compute the cross product of this RealVec3 and another

pub fn mag(&self) -> f64

The magnitude of the vector

pub fn mag2(&self) -> f64

The squared magnitude of the vector

pub fn costheta(&self) -> LadduPhysicsResult<f64>

The cosine of the polar angle $\theta$

Errors

Returns LadduPhysicsError when the vector has zero or invalid magnitude.

pub fn theta(&self) -> LadduPhysicsResult<f64>

The polar angle $\theta$

Errors

Returns LadduPhysicsError when the vector has zero or invalid magnitude.

pub fn phi(&self) -> f64

The azimuthal angle $\phi$

pub fn unit(&self) -> LadduPhysicsResult<RealVec3>

Create a unit vector in the same direction as this RealVec3

Errors

Returns LadduPhysicsError when the vector has zero or invalid magnitude.

Trait Implementations

impl AbsDiffEq for RealVec3

type Epsilon = <f64 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> Self::Epsilon

The default tolerance to use when testing values that are close together.

fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.

impl Add for RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&RealVec3> for &RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&RealVec3> for RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&RealVec3> for &f64

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&RealVec3> for f64

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<&f64> for RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<RealVec3> for &RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<RealVec3> for &f64

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<RealVec3> for f64

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<f64> for RealVec3

type Output = RealVec3

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for RealVec3

fn clone(&self) -> RealVec3

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RealVec3

impl Debug for RealVec3

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

Formats the value using the given formatter.

impl Default for RealVec3

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RealVec3

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RealVec3

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

Formats the value using the given formatter.

impl Div<&f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the / operator.

fn div(self, rhs: &f64) -> Self::Output

Performs the / operation.

impl Div<&f64> for RealVec3

type Output = RealVec3

The resulting type after applying the / operator.

fn div(self, rhs: &f64) -> Self::Output

Performs the / operation.

impl Div<f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl Div<f64> for RealVec3

type Output = RealVec3

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl From<Matrix<f64, Const<3>, Const<1>, ArrayStorage<f64, 3, 1>>> for RealVec3

fn from(value: Vector3<f64>) -> Self

Converts to this type from the input type.

impl From<RealVec3> for Vector3<f64>

fn from(value: RealVec3) -> Self

Converts to this type from the input type.

impl From<RealVec3> for Vec<f64>

fn from(value: RealVec3) -> Self

Converts to this type from the input type.

impl From<RealVec3> for [f64; 3]

fn from(value: RealVec3) -> Self

Converts to this type from the input type.

impl From<RealVec3> for Vec3

fn from(value: RealVec3) -> Self

Converts to this type from the input type.

impl From<[f64; 3]> for RealVec3

fn from(value: [f64; 3]) -> Self

Converts to this type from the input type.

impl Mul<&RealVec3> for &f64

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: &RealVec3) -> Self::Output

Performs the * operation.

impl Mul<&RealVec3> for f64

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: &RealVec3) -> Self::Output

Performs the * operation.

impl Mul<&f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: &f64) -> Self::Output

Performs the * operation.

impl Mul<&f64> for RealVec3

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: &f64) -> Self::Output

Performs the * operation.

impl Mul<RealVec3> for &f64

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: RealVec3) -> Self::Output

Performs the * operation.

impl Mul<RealVec3> for f64

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: RealVec3) -> Self::Output

Performs the * operation.

impl Mul<f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Mul<f64> for RealVec3

type Output = RealVec3

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl Neg for &RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl PartialEq for RealVec3

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

Equality operator ==.

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

Inequality operator !=.

impl RelativeEq for RealVec3

fn default_max_relative() -> Self::Epsilon

The default relative tolerance for testing values that are far-apart.

fn relative_eq( &self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.

impl Serialize for RealVec3

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealVec3

impl Sub for RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&RealVec3> for &RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&RealVec3> for RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&RealVec3> for &f64

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&RealVec3> for f64

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<&f64> for RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<RealVec3> for &RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<RealVec3> for &f64

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<RealVec3> for f64

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for &RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<f64> for RealVec3

type Output = RealVec3

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sum for RealVec3

fn sum<I: Iterator<Item = Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl<'a> Sum<&'a RealVec3> for RealVec3

fn sum<I: Iterator<Item = &'a Self>>(iter: I) -> Self

Takes an iterator and generates Self from the elements by “summing up” the items.

impl TryFrom<Vec<f64>> for RealVec3

type Error = LadduPhysicsError

The type returned in the event of a conversion error.

fn try_from(value: Vec<f64>) -> Result<Self, Self::Error>

Performs the conversion.