Struct Unit 

pub struct Unit<V>(/* private fields */);

A Vector with magnitude 1.0.

Implementations

impl<V> Unit<V>

pub fn get(&self) -> &V

Get the unit vector.

Trait Implementations

impl<V: Clone> Clone for Unit<V>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug> Debug for Unit<V>

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

Formats the value using the given formatter.

impl<'de, V> Deserialize<'de> for Unit<V>

where V: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<V: PartialEq> PartialEq for Unit<V>

fn eq(&self, other: &Unit<V>) -> 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<V> Serialize for Unit<V>

where V: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<const N: usize> TryFrom<[f64; N]> for Unit<Cartesian<N>>

fn try_from(value: [f64; N]) -> Result<Self, Self::Error>

Create a unit Cartesian vector by normalizing the given coordinates.

Example

use hoomd_vector::{Cartesian, Unit};

let n = Unit::<Cartesian<3>>::try_from([2.0, 0.0, 0.0])?;
assert_eq!(*n.get(), [1.0, 0.0, 0.0].into());

type Error = Error

The type returned in the event of a conversion error.

impl<V: Copy> Copy for Unit<V>

impl<V> StructuralPartialEq for Unit<V>