Struct RealVec4 

pub struct RealVec4 {
    pub e: f64,
    pub px: f64,
    pub py: f64,
    pub pz: f64,
}

A four-vector (Lorentz vector) stored in (E, p_x, p_y, p_z) order.

Examples

use laddu_physics::vectors::{RealVec3, RealVec4};

let momentum = RealVec3::new(1.0, 0.0, 0.0);
let four_vector = momentum.with_mass(2.0);
assert!((four_vector.m2() - 4.0).abs() < 1e-12);

Fields

e: f64

Energy component.

px: f64

Momentum in the x direction.

py: f64

Momentum in the y direction.

pz: f64

Momentum in the z direction.

Implementations

impl RealVec4

pub fn new(e: f64, px: f64, py: f64, pz: f64) -> RealVec4

Create a four-vector in metric order (E, p_x, p_y, p_z).

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 e(&self) -> f64

The energy of the 4-vector

pub fn momentum(&self) -> RealVec3

The 3-momentum

pub fn gamma(&self) -> Result<f64, LadduPhysicsError>

The $\gamma$ factor $\frac{1}{\sqrt{1 - \beta^2}}$.

Errors

Returns LadduPhysicsError when the energy is not positive or the resulting velocity is not subluminal.

pub fn beta(&self) -> Result<RealVec3, LadduPhysicsError>

The $\vec{\beta}$ vector $\frac{\vec{p}}{E}$.

Errors

Returns LadduPhysicsError when the four-momentum energy is not positive.

pub fn m(&self) -> Result<f64, LadduPhysicsError>

The invariant mass corresponding to this 4-momentum

Errors

Returns LadduPhysicsError when the invariant mass squared is non-finite or negative.

pub fn m_unchecked(&self) -> f64

Return the invariant mass without checking for a spacelike vector.

pub fn signed_m(&self) -> Result<f64, LadduPhysicsError>

Return the signed invariant mass.

Errors

Returns LadduPhysicsError when the invariant mass squared is non-finite.

pub fn signed_m_unchecked(&self) -> f64

Return the signed invariant mass without checking for finite components.

pub fn m2(&self) -> f64

The squared invariant mass corresponding to this 4-momentum

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

Compute the Lorentz inner product with another four-vector.

pub fn to_p4_string(&self) -> String

Pretty-prints the four-momentum.

pub fn mag(&self) -> Result<f64, LadduPhysicsError>

Alias for Self::m using the $+---$ metric.

Errors

Returns LadduPhysicsError for non-finite or spacelike four-vectors, where m2 < 0.

pub fn signed_mag(&self) -> Result<f64, LadduPhysicsError>

Signed invariant mass useful for diagnostics:

• sqrt(mag2) for timelike/null vectors
• -sqrt(-mag2) for spacelike vectors

Errors

Returns LadduPhysicsError when the invariant magnitude squared is non-finite.

pub fn signed_mag_unchecked(&self) -> f64

Return the signed magnitude without checking for finite components.

pub fn mag2(&self) -> f64

Alias for Self::m2, the squared invariant mass in the $+---$ metric.

pub fn boost(&self, beta: &RealVec3) -> RealVec4

Gives the vector boosted along a $\vec{\beta}$ vector.

pub fn vec3(&self) -> RealVec3

The 3-vector contained in this 4-vector

Trait Implementations

impl AbsDiffEq for RealVec4

type Epsilon = <f64 as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.

fn default_epsilon() -> <RealVec4 as AbsDiffEq>::Epsilon

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

fn abs_diff_eq( &self, other: &RealVec4, epsilon: <RealVec4 as AbsDiffEq>::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 RealVec4

type Output = RealVec4

The resulting type after applying the + operator.

fn add(self, rhs: RealVec4) -> <RealVec4 as Add>::Output

Performs the + operation.

impl Add<&RealVec4> for &RealVec4

type Output = RealVec4

The resulting type after applying the + operator.

fn add(self, rhs: &RealVec4) -> <&RealVec4 as Add<&RealVec4>>::Output

Performs the + operation.

impl Add<&RealVec4> for RealVec4

type Output = RealVec4

The resulting type after applying the + operator.

fn add(self, rhs: &RealVec4) -> <RealVec4 as Add<&RealVec4>>::Output

Performs the + operation.

impl Add<RealVec4> for &RealVec4

type Output = RealVec4

The resulting type after applying the + operator.

fn add(self, rhs: RealVec4) -> <&RealVec4 as Add<RealVec4>>::Output

Performs the + operation.

impl Clone for RealVec4

fn clone(&self) -> RealVec4

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RealVec4

impl Debug for RealVec4

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RealVec4

fn deserialize<__D>( __deserializer: __D, ) -> Result<RealVec4, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RealVec4

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

Formats the value using the given formatter.

impl From<Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>> for RealVec4

fn from( value: Matrix<f64, Const<4>, Const<1>, ArrayStorage<f64, 4, 1>>, ) -> RealVec4

Converts to this type from the input type.

impl From<[f64; 4]> for RealVec4

fn from(value: [f64; 4]) -> RealVec4

Converts to this type from the input type.

impl Neg for &RealVec4

type Output = RealVec4

The resulting type after applying the - operator.

fn neg(self) -> <&RealVec4 as Neg>::Output

Performs the unary - operation.

impl Neg for RealVec4

type Output = RealVec4

The resulting type after applying the - operator.

fn neg(self) -> <RealVec4 as Neg>::Output

Performs the unary - operation.

impl PartialEq for RealVec4

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

Equality operator ==.

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

Inequality operator !=.

impl RelativeEq for RealVec4

fn default_max_relative() -> <RealVec4 as AbsDiffEq>::Epsilon

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

fn relative_eq( &self, other: &RealVec4, epsilon: <RealVec4 as AbsDiffEq>::Epsilon, max_relative: <RealVec4 as AbsDiffEq>::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 RealVec4

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RealVec4

impl Sub for RealVec4

type Output = RealVec4

The resulting type after applying the - operator.

fn sub(self, rhs: RealVec4) -> <RealVec4 as Sub>::Output

Performs the - operation.

impl Sub<&RealVec4> for &RealVec4

type Output = RealVec4

The resulting type after applying the - operator.

fn sub(self, rhs: &RealVec4) -> <&RealVec4 as Sub<&RealVec4>>::Output

Performs the - operation.

impl Sub<&RealVec4> for RealVec4

type Output = RealVec4

The resulting type after applying the - operator.

fn sub(self, rhs: &RealVec4) -> <RealVec4 as Sub<&RealVec4>>::Output

Performs the - operation.

impl Sub<RealVec4> for &RealVec4

type Output = RealVec4

The resulting type after applying the - operator.

fn sub(self, rhs: RealVec4) -> <&RealVec4 as Sub<RealVec4>>::Output

Performs the - operation.

impl Sum for RealVec4

fn sum<I>(iter: I) -> RealVec4

where I: Iterator<Item = RealVec4>,

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

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

fn sum<I>(iter: I) -> RealVec4

where I: Iterator<Item = &'a RealVec4>,

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

impl TryFrom<Vec<f64>> for RealVec4

type Error = LadduPhysicsError

The type returned in the event of a conversion error.

fn try_from( value: Vec<f64>, ) -> Result<RealVec4, <RealVec4 as TryFrom<Vec<f64>>>::Error>

Performs the conversion.