Struct Rotor 

pub struct Rotor<T> {
    pub scalar: T,
    pub xy: T,
    pub xz: T,
    pub yz: T,
}

The 3D rotor type.

Fields

scalar: T

The scalar component.

xy: T

The component representing the xy plane.

xz: T

The component representing the xz plane.

yz: T

The component representing the yz plane.

Implementations

impl<T> Rotor<T>

pub fn new(scalar: T, xy: T, xz: T, yz: T) -> Self

Creates a new rotor from its components.

impl<T: Real> Rotor<T>

pub fn rotate(self, vector: Vector<T>) -> Vector<T>

Rotates a vector by the rotor.

pub fn rotate_normalized(self, v: Vector<T>) -> Vector<T>

Rotates a vector by the rotor using the sandwich product R v R†. The rotor has to be normalized already.

pub fn rotate_bivector(self, bivector: Bivector<T>) -> Bivector<T>

Rotates a bivector by the rotor.

pub fn rotate_bivector_normalized(self, b: Bivector<T>) -> Bivector<T>

Rotates a bivector by the rotor using the sandwich product R B R†. The rotor has to be normalized already.

pub fn reverse(self) -> Self

The reverse of the rotor.

impl<T: Zero> Rotor<T>

pub fn scalar(scalar: T) -> Self

Creates a new scalar rotor.

pub fn xy(xy: T) -> Self

Creates a new rotor along the xy plane.

pub fn xz(xz: T) -> Self

Creates a new rotor along the xz plane.

pub fn yz(yz: T) -> Self

Creates a new rotor along the yz plane.

Trait Implementations

impl<T> Add for Rotor<T>

where T: Add<Output = T>,

type Output = Rotor<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T> AddAssign for Rotor<T>

where T: AddAssign,

fn add_assign(&mut self, __rhs: Self)

Performs the += operation.

impl<T: Clone> Clone for Rotor<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Rotor<T>

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

Formats the value using the given formatter.

impl<T: Display> Display for Rotor<T>

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

Formats the value using the given formatter.

impl<T> Div<T> for Rotor<T>

where T: Div<Output = T> + Copy,

type Output = Rotor<T>

The resulting type after applying the / operator.

fn div(self, other: T) -> Self

Performs the / operation.

impl<T: Real> Div for Rotor<T>

type Output = Rotor<T>

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl<T> DivAssign<T> for Rotor<T>

where T: DivAssign + Copy,

fn div_assign(&mut self, other: T)

Performs the /= operation.

impl<T: Real> DivAssign for Rotor<T>

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<T: Real> DotProduct<Bivector<T>> for Rotor<T>

type Output = Rotor<T>

The output type of the dot product.

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

The dot product (contraction).

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

The scalar product (positive-definite).

impl<T: Real> DotProduct<Rotor<T>> for Bivector<T>

type Output = Rotor<T>

The output type of the dot product.

fn dot(&self, other: &Rotor<T>) -> Rotor<T>

The dot product (contraction).

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

The scalar product (positive-definite).

impl<T: Real> DotProduct<Rotor<T>> for Vector<T>

type Output = Vector<T>

The output type of the dot product.

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

The dot product (contraction).

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

The scalar product (positive-definite).

impl<T: Real> DotProduct<Vector<T>> for Rotor<T>

type Output = Vector<T>

The output type of the dot product.

fn dot(&self, other: &Vector<T>) -> Vector<T>

The dot product (contraction).

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

The scalar product (positive-definite).

impl<T: Real> DotProduct for Rotor<T>

type Output = <Rotor<T> as VectorSpace>::Scalar

The output type of the dot product.

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

The dot product (contraction).

fn scalar(&self, other: &Self) -> T

The scalar product (positive-definite).

impl<T: Real> From<T> for Rotor<T>

fn from(scalar: T) -> Self

Converts to this type from the input type.

impl<T: FromStr> FromStr for Rotor<T>

type Err = ParseRotorError

The associated error which can be returned from parsing.

fn from_str(source: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<T: Real> Inv for Rotor<T>

type Output = Rotor<T>

fn inv(self) -> Self

impl<T> Mul<T> for Rotor<T>

where T: Mul<Output = T> + Copy,

type Output = Rotor<T>

The resulting type after applying the * operator.

fn mul(self, other: T) -> Self

Performs the * operation.

impl<T: Real> Mul for Rotor<T>

type Output = Rotor<T>

The resulting type after applying the * operator.

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

Performs the * operation.

impl<T> MulAssign<T> for Rotor<T>

where T: MulAssign + Copy,

fn mul_assign(&mut self, other: T)

Performs the *= operation.

impl<T: Real> MulAssign for Rotor<T>

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl<T: Neg<Output = T>> Neg for Rotor<T>

type Output = Rotor<T>

The resulting type after applying the - operator.

fn neg(self) -> Rotor<T>

Performs the unary - operation.

impl<T: Real> One for Rotor<T>

fn one() -> Self

fn is_one(&self) -> bool

impl<T: PartialEq> PartialEq for Rotor<T>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Sub for Rotor<T>

where T: Sub<Output = T>,

type Output = Rotor<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T> SubAssign for Rotor<T>

where T: SubAssign,

fn sub_assign(&mut self, __rhs: Self)

Performs the -= operation.

impl<T: Real> Transform<Bivector<T>> for Rotor<T>

fn apply_point(&self, bivector: Bivector<T>) -> Bivector<T>

Applies this transformation to a point.

impl<T: Real> Transform<Vector<T>> for Rotor<T>

fn apply_point(&self, point: Vector<T>) -> Vector<T>

Applies this transformation to a point.

impl<T: Real> VectorSpace for Rotor<T>

type Scalar = T

The scalar type of the vector space.

impl<T: Zero> Zero for Rotor<T>

fn zero() -> Self

fn is_zero(&self) -> bool

impl<T: Copy> Copy for Rotor<T>

impl<T: Eq> Eq for Rotor<T>

impl<T> StructuralPartialEq for Rotor<T>