Struct plexus::geometry::Unit

pub struct Unit<S> where
    S: InnerSpace,  { /* private fields */ }

Unit vector.

Primarily represents a direction within an InnerSpace.

Implementations

impl<S> Unit<S> where
    S: InnerSpace, 

pub fn try_from_inner(inner: S) -> Option<Unit<S>>

Creates a Unit from a non-zero magnitude vector.

The given vector is normalized. If the vector’s magnitude is zero, then None is returned.

Examples

use nalgebra::Vector3;
use theon::query::Unit;
use theon::space::Basis;

type R3 = Vector3<f64>;

let unit = Unit::<R3>::try_from_inner(Basis::i()).unwrap();

pub fn into_inner(self) -> S

pub fn x() -> Unit<S> where
    S: Basis + FiniteDimensional,
    <S as FiniteDimensional>::N: Cmp<UTerm>,
    <<S as FiniteDimensional>::N as Cmp<UTerm>>::Output == Greater, 

pub fn y() -> Unit<S> where
    S: Basis + FiniteDimensional,
    <S as FiniteDimensional>::N: Cmp<UInt<UTerm, B1>>,
    <<S as FiniteDimensional>::N as Cmp<UInt<UTerm, B1>>>::Output == Greater, 

pub fn z() -> Unit<S> where
    S: Basis + FiniteDimensional,
    <S as FiniteDimensional>::N: Cmp<UInt<UInt<UTerm, B1>, B0>>,
    <<S as FiniteDimensional>::N as Cmp<UInt<UInt<UTerm, B1>, B0>>>::Output == Greater, 

pub fn get(&self) -> &S

pub fn try_set(&mut self, inner: S) -> Option<&S>

pub fn reverse(self) -> Unit<S>

Trait Implementations

impl<S> AsRef<S> for Unit<S> where
    S: InnerSpace, 

fn as_ref(&self) -> &S

Converts this type into a shared reference of the (usually inferred) input type.

impl<S> Clone for Unit<S> where
    S: Clone + InnerSpace, 

fn clone(&self) -> Unit<S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Debug for Unit<S> where
    S: Debug + InnerSpace, 

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

Formats the value using the given formatter.

impl<S> Default for Unit<S> where
    S: Basis + InnerSpace, 

fn default() -> Unit<S>

Returns the “default value” for a type.

impl<S> Neg for Unit<S> where
    S: InnerSpace, 

type Output = Unit<S>

The resulting type after applying the - operator.

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

Performs the unary - operation.

impl<S> PartialEq<Unit<S>> for Unit<S> where
    S: PartialEq<S> + InnerSpace, 

fn eq(&self, other: &Unit<S>) -> bool

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

fn ne(&self, other: &Unit<S>) -> bool

This method tests for !=.

impl<S> Copy for Unit<S> where
    S: Copy + InnerSpace, 

impl<S> StructuralPartialEq for Unit<S> where
    S: InnerSpace,