Struct ga2::Rotor

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

The 2D bivector type.

Fields

scalar: T

The scalar component.

xy: T

The component representing the xy plane.

Implementations

impl<T> Rotor<T>

pub fn new(scalar: T, xy: 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, vector: Vector<T>) -> Vector<T>

Rotates a vector by the rotor. 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.

Trait Implementations

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

type Output = Rotor<T>

The resulting type after applying the + operator.

fn add(self, rhs: Rotor<T>) -> Rotor<T>

Performs the + operation.

impl<T: AddAssign> AddAssign<Rotor<T>> for Rotor<T>

fn add_assign(&mut self, rhs: Rotor<T>)

Performs the += operation.

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

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

Returns a copy 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: Real> Div<Rotor<T>> 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> 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> DivAssign<Rotor<T>> for Rotor<T>

fn div_assign(&mut self, other: 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> 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.

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.

impl<T: Real> DotProduct<Rotor<T>> 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.

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.

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.

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

fn from(scalar: T) -> Self

Converts to this type from the input type.

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

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

The scalar product.

fn magnitude2(self) -> T

The squared magnitude.

fn magnitude(self) -> Self::Scalar

The magnitude of a vector.

fn normalize(self) -> Self

The normalized vector.

fn angle(self, other: Self) -> Self::Scalar

The angle between two vectors.

fn with_magnitude(self, magnitude: Self::Scalar) -> Self

Sets the magnitude of a vector.

fn with_direction(self, dir: Self) -> Self

Sets the direction of a vector.

fn query_axis(self, dir: Self) -> Self::Scalar

The value of the vector along the specified axis.

fn normalized_project(self, dir: Self) -> Self

Projects a vector onto an already normalized direction vector.

fn project(self, dir: Self) -> Self

Projects a vector onto an arbitraty direction vector.

fn normalized_reject(self, dir: Self) -> Self

Rejects a vector from an already normalized direction vector.

fn reject(self, dir: Self) -> Self

Rejects a vector from an arbitraty direction vector.

fn normalized_reflect(self, dir: Self) -> Self

Reflects a vector from an already normalized direction vector.

fn reflect(self, dir: Self) -> Self

Reflects a vector from an arbitraty direction vector.

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

type Output = Rotor<T>

The result after applying the operator.

fn inv(self) -> Self

Returns the multiplicative inverse of self.

impl<T: Real> Mul<Rotor<T>> 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> 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> MulAssign<Rotor<T>> for Rotor<T>

fn mul_assign(&mut self, other: 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: 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

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

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

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

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

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

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

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

type Output = Rotor<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Rotor<T>) -> Rotor<T>

Performs the - operation.

impl<T: SubAssign> SubAssign<Rotor<T>> for Rotor<T>

fn sub_assign(&mut self, rhs: Rotor<T>)

Performs the -= operation.

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

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

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

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

impl<T> StructuralEq for Rotor<T>

impl<T> StructuralPartialEq for Rotor<T>