Struct calcify::FourVec

pub struct FourVec { /* private fields */ }

Four Vector

Implementations

impl FourVec

pub fn new(m0: f64, m1: f64, m2: f64, m3: f64) -> FourVec

Returns a new FourVec from four f64s

Arguments

• m0 - f64
• m1 - f64
• m2 - f64
• m3 - f64

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,2.0,3.0,4.0);

pub fn from(slice: &[f64]) -> FourVec

Returns a new FourVec from a slice

Arguments

• slice - &f64

Example

use calcify::FourVec;
let vec4: FourVec = FourVec::from(&[1.0,1.0,1.0,1.0]);

Panics

• slice length < 4

pub fn from_3vec(t: f64, x: ThreeVec) -> FourVec

Returns a new FourVec from one f64 and a ThreeVec

Arguments

• t - f64
• x - calcify::ThreeVec

Example

use calcify::FourVec;
use calcify::ThreeVec;

let vec4 = FourVec::from_3vec(1.0,ThreeVec::new(2.0,3.0,4.0));

pub fn m0(&self) -> &f64

Returns a reference to the first element of the vector

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,2.0,3.0,4.0);
let element_zero: f64 = *vec4.m0();
assert_eq!(element_zero,1.0);

pub fn m1(&self) -> &f64

Returns a reference to the second element of the vector

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,2.0,3.0,4.0);
let element_one: f64 = *vec4.m1();
assert_eq!(element_one,2.0);

pub fn m2(&self) -> &f64

Returns a reference to the third element of the vector

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,2.0,3.0,4.0);
let element_two: f64 = *vec4.m2();
assert_eq!(element_two,3.0);

pub fn m3(&self) -> &f64

Returns a reference to the forth element of the vector

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,2.0,3.0,4.0);
let element_three: f64 = *vec4.m3();
assert_eq!(element_three,4.0);

pub fn cov(self) -> FourVec

Returns the covariant vector with metric [1,-1,-1,-1].

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,2.0,3.0,4.0);
let cov_vec4: FourVec = vec4.cov();
assert_eq!(cov_vec4,FourVec::new(1.0,-2.0,-3.0,-4.0));

assert_eq!(vec4.cov()*vec4, -28.0)

pub fn s2(&self) -> Sinv

Returns the space-time invariant classification S^2 of a space-time vector. Returns a variant of the calcify::Sinv enum

Example

use calcify::FourVec;
use calcify::Sinv;
let vec4 = FourVec::new(10.0,2.0,2.0,2.0);
let ss: Sinv = vec4.s2();
assert_eq!(ss,Sinv::TimeLike);

pub fn s(&self) -> f64

Returns the invariant of the FourVec.

Example

use calcify::FourVec;
let vec4 = FourVec::new(1.0,0.0,0.0,0.0);
assert_eq!(vec4.s(),1.0);

Trait Implementations

impl Add<FourVec> for FourVec

type Output = FourVec

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<FourVec> for FourVec

fn add_assign(&mut self, other: FourVec)

Performs the += operation.

impl Clone for FourVec

fn clone(&self) -> FourVec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FourVec

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

Formats the value using the given formatter.

impl Deserializable for FourVec

fn from_json(s: &str) -> Result<Self, Box<dyn Error>>

Return Self from string

fn from_msg(bytes: &[u8]) -> Result<(Self, &[u8]), Box<dyn Error>>

Return a tuple of Self and a &u8 of remaining unparsed bytes from a byte array

impl Display for FourVec

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

Formats the value using the given formatter.

impl Mul<FourVec> for f64

type Output = FourVec

The resulting type after applying the * operator.

fn mul(self, vec: FourVec) -> FourVec

Performs the * operation.

impl Mul<FourVec> for FourVec

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

Standard scalar product,

Example

use calcify::FourVec;
let vec4 = FourVec::new(2.0,2.0,2.0,2.0);

assert_eq!(
   vec4*vec4,
   16.0
);

type Output = f64

The resulting type after applying the * operator.

impl Mul<FourVec> for FourMat

fn mul(self, other: FourVec) -> FourVec

Matrix multiplication with vector

Note

Only works in one direction FourMat*FourVec, implying FourVec as a column vector.

Example

use calcify::FourMat;
use calcify::FourVec;

let mat4 = FourMat::new(FourVec::new(1.0,2.0,3.0,4.0),
                            FourVec::new(1.0,2.0,3.0,4.0),
                            FourVec::new(1.0,2.0,3.0,4.0),
                            FourVec::new(1.0,2.0,3.0,4.0));

assert_eq!(
    mat4*FourVec::new(2.0,2.0,2.0,2.0),
    FourVec::new(20.0,20.0,20.0,20.0)
);

type Output = FourVec

The resulting type after applying the * operator.

impl Mul<f64> for FourVec

type Output = FourVec

The resulting type after applying the * operator.

fn mul(self, coef: f64) -> FourVec

Performs the * operation.

impl Neg for FourVec

type Output = FourVec

The resulting type after applying the - operator.

fn neg(self) -> FourVec

Performs the unary - operation.

impl PartialEq<FourVec> for FourVec

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

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

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

This method tests for !=.

impl Serializable for FourVec

fn to_json(&self) -> String

Return object intensive json string

fn to_msg(&self) -> Result<Vec<u8>, ValueWriteError>

Return Result wrapped Vec in MsgPack Format is not like to_json it is array intensive not object

impl Sub<FourVec> for FourVec

type Output = FourVec

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<FourVec> for FourVec

fn sub_assign(&mut self, other: FourVec)

Performs the -= operation.

impl Sum<FourVec> for FourVec

fn sum<I>(iter: I) -> FourVec where
    I: Iterator<Item = FourVec>, 

Method which takes an iterator and generates Self from the elements by “summing up” the items.

impl Copy for FourVec

impl StructuralPartialEq for FourVec