Struct theon::query::Unit

source · [−]

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

Expand description

Unit vector.

Primarily represents a direction within an InnerSpace.

Implementations

source

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

source

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

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();

source

pub fn into_inner(self) -> S

source

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

source

pub fn y() -> Self where
S: Basis + FiniteDimensional,
S::N: Cmp<U1, Output = Greater>,

source

pub fn z() -> Self where
S: Basis + FiniteDimensional,
S::N: Cmp<U2, Output = Greater>,

source

pub fn get(&self) -> &S

source

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

source

pub fn reverse(self) -> Self

Trait Implementations

source

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

source

fn as_ref(&self) -> &S

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

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

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

type Output = Unit<S>

The resulting type after applying the - operator.

source

fn neg(self) -> Self::Output

Performs the unary - operation. Read more

source

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

source

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

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

source

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

This method tests for !=.

source

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

source

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

Auto Trait Implementations

impl<S> RefUnwindSafe for Unit<S> where
S: RefUnwindSafe,

impl<S> Send for Unit<S> where
S: Send,

impl<S> Sync for Unit<S> where
S: Sync,

impl<S> Unpin for Unit<S> where
S: Unpin,

impl<S> UnwindSafe for Unit<S> where
S: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,

source

fn inlined_clone(&self) -> T

Performance hack: Clone doesn’t get inlined for Copy types in debug mode, so make it inline anyway.

source

fn is<T>() -> bool where
T: Scalar,

Tests if Self the same as the type T Read more

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct theon::query::Unit

Implementations

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

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

Examples

pub fn into_inner(self) -> S

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

pub fn y() -> Self where S: Basis + FiniteDimensional, S::N: Cmp<U1, Output = Greater>,

pub fn z() -> Self where S: Basis + FiniteDimensional, S::N: Cmp<U2, Output = Greater>,

pub fn get(&self) -> &S

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

pub fn reverse(self) -> Self

Trait Implementations

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

fn as_ref(&self) -> &S

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

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

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

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

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

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

fn default() -> Self

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

type Output = Unit<S>

fn neg(self) -> Self::Output

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

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

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

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

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

Auto Trait Implementations

impl<S> RefUnwindSafe for Unit<S> where S: RefUnwindSafe,

impl<S> Send for Unit<S> where S: Send,

impl<S> Sync for Unit<S> where S: Sync,

impl<S> Unpin for Unit<S> where S: Unpin,

impl<S> UnwindSafe for Unit<S> where S: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> Scalar for T where T: Copy + PartialEq<T> + Debug + Any,

fn inlined_clone(&self) -> T

fn is<T>() -> bool where T: Scalar,

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

fn is_in_subset(&self) -> bool

fn to_subset_unchecked(&self) -> SS

fn from_subset(element: &SS) -> SP

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

impl<T> ClosedNeg for T where T: Neg<Output = T>,

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

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

pub fn y() -> Self where
S: Basis + FiniteDimensional,
S::N: Cmp<U1, Output = Greater>,

pub fn z() -> Self where
S: Basis + FiniteDimensional,
S::N: Cmp<U2, Output = Greater>,

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

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

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

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

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

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

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

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

impl<S> RefUnwindSafe for Unit<S> where
S: RefUnwindSafe,

impl<S> Send for Unit<S> where
S: Send,

impl<S> Sync for Unit<S> where
S: Sync,

impl<S> Unpin for Unit<S> where
S: Unpin,

impl<S> UnwindSafe for Unit<S> where
S: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> Scalar for T where
T: Copy + PartialEq<T> + Debug + Any,

fn is<T>() -> bool where
T: Scalar,

impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<T> ClosedNeg for T where
T: Neg<Output = T>,