Struct nalgebra::Unit

pub struct Unit<T> { /* fields omitted */ }

A wrapper that ensures the undelying algebraic entity has a unit norm.

Use .as_ref() or .unwrap() to obtain the undelying value by-reference or by-move.

Methods

impl<T: Norm> Unit<T>

fn new(v: &T) -> Self

Normalize the given value and return it wrapped on a Unit structure.

fn try_new(v: &T, min_norm: T::NormType) -> Option<Self>

Attempts to normalize the given value and return it wrapped on a Unit structure.

Returns None if the norm was smaller or equal to min_norm.

fn new_and_get(v: T) -> (Self, T::NormType)

Normalize the given value and return it wrapped on a Unit structure and its norm.

fn try_new_and_get(v: T, min_norm: T::NormType) -> Option<(Self, T::NormType)>

Normalize the given value and return it wrapped on a Unit structure and its norm.

Returns None if the norm was smaller or equal to min_norm.

fn renormalize(&mut self) -> T::NormType

Normalizes this value again. This is useful when repeated computations might cause a drift in the norm because of float inaccuracies.

Returns the norm before re-normalization (should be close to 1.0).

impl<T> Unit<T>

fn from_unit_value_unchecked(v: T) -> Self

Wraps the given value, assuming it is already normalized.

This function is not safe because v is not verified to be actually normalized.

fn unwrap(self) -> T

Retrieves the underlying value.

Trait Implementations

impl<T: Eq> Eq for Unit<T>

impl<T: PartialEq> PartialEq for Unit<T>

fn eq(&self, __arg_0: &Unit<T>) -> bool

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

fn ne(&self, __arg_0: &Unit<T>) -> bool

This method tests for !=.

impl<T: Encodable> Encodable for Unit<T>

fn encode<__ST: Encoder>(&self, __arg_0: &mut __ST) -> Result<(), __ST::Error>

impl<T: Decodable> Decodable for Unit<T>

fn decode<__DT: Decoder>(__arg_0: &mut __DT) -> Result<Unit<T>, __DT::Error>

impl<T: Clone> Clone for Unit<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Hash> Hash for Unit<T>

fn hash<__HT: Hasher>(&self, __arg_0: &mut __HT)

Feeds this value into the state given, updating the hasher as necessary.

fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher

Feeds a slice of this type into the state provided.

impl<T: Debug> Debug for Unit<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Copy> Copy for Unit<T>

impl<T> AsRef<T> for Unit<T>

fn as_ref(&self) -> &T

Performs the conversion.