Struct Direction

Source

pub struct Direction<const D: usize> { /* private fields */ }

Expand description

Represent a cardinal direction

Implementations§

Source §

Convert the direction into a vector of norm a;

Source

pub const fn dim() -> usize

Returns the dimension

Source

pub fn to_unit_vector(self) -> SVector<Real, D>

Convert the direction into a vector of norm 1;

Source

pub fn from_vector(v: &SVector<Real, D>) -> Self

Find the direction the vector point the most. For a zero vector return DirectionEnum::XPos.

§Example

assert_eq!(
    Direction::from_vector(&nalgebra::Vector4::new(1_f64, 0_f64, 0_f64, 0_f64)),
    Direction::<4>::new(0, true).ok_or(ImplementationError::OptionWithUnexpectedNone)?
);
assert_eq!(
    Direction::from_vector(&nalgebra::Vector4::new(0_f64, -1_f64, 0_f64, 0_f64)),
    Direction::<4>::new(1, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?
);
assert_eq!(
    Direction::from_vector(&nalgebra::Vector4::new(0.5_f64, 1_f64, 0_f64, 2_f64)),
    Direction::<4>::new(3, true).ok_or(ImplementationError::OptionWithUnexpectedNone)?
);

Trait Implementations§

Source §

impl<const D: usize> Clone for Direction<D>

Source §

fn clone(&self) -> Direction<D>

Returns a duplicate 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<const D: usize> Debug for Direction<D>

Source §

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

Formats the value using the given formatter. Read more

Source §

fn from(d: &Direction<D>) -> Self

Converts to this type from the input type.

Source §

impl<const D: usize> From<&Direction<D>> for usize

Return Direction::to_index.

Source §

fn from(d: &Direction<D>) -> Self

Converts to this type from the input type.

Source §

impl From<&DirectionEnum> for Direction<4>

Source §

fn from(d: &DirectionEnum) -> Self

Converts to this type from the input type.

Source §

impl<const D: usize> From<&Matrix<f64, Const<D>, Const<1>, ArrayStorage<f64, D, 1>>> for Direction<D>

Return DirectionEnum::from_vector.

impl<const D: usize> PartialOrd for Direction<D>

Partial ordering is set as follows: two directions can be compared if they have the same index or the same direction sign. In the first case a positive direction is greater than a negative direction In the latter case the ordering is done on the index.

§Example

use std::cmp::Ordering;

let dir_1 =
    Direction::<4>::new(1, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
let dir_2 =
    Direction::<4>::new(1, true).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
assert!(dir_1 < dir_2);
assert_eq!(dir_1.partial_cmp(&dir_2), Some(Ordering::Less));
//--------
let dir_3 =
    Direction::<4>::new(3, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
let dir_4 =
    Direction::<4>::new(1, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
assert!(dir_3 > dir_4);
assert_eq!(dir_3.partial_cmp(&dir_4), Some(Ordering::Greater));
//--------
let dir_5 =
    Direction::<4>::new(3, true).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
let dir_6 =
    Direction::<4>::new(1, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
assert_eq!(dir_5.partial_cmp(&dir_6), None);
//--------
let dir_5 =
    Direction::<4>::new(1, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
let dir_6 =
    Direction::<4>::new(1, false).ok_or(ImplementationError::OptionWithUnexpectedNone)?;
assert_eq!(dir_5.partial_cmp(&dir_6), Some(Ordering::Equal));

Source §

impl<const D: usize> StructuralPartialEq for Direction<D>

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

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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

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

Source §

fn to_subset_unchecked(&self) -> SS

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

Source §

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,

Source §

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 §

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source §

Direction

Struct Direction Copy item path

Implementations§

impl<const D: usize> Direction<D>

pub const fn new(index_dir: usize, is_positive: bool) -> Option<Self>

pub fn positives_vec() -> Vec<Self>

pub fn directions_vec() -> Vec<Self>

pub const fn directions_array<const IS_POSITIVE: bool>() -> [Self; D]

pub const fn negative_directions() -> [Self; D]

pub const fn positive_directions() -> [Self; D]

pub const fn is_positive(&self) -> bool

pub const fn is_negative(&self) -> bool

pub const fn to_positive(self) -> Self

§Example

pub const fn index(&self) -> usize

§Example

pub fn to_vector(self, a: f64) -> SVector<Real, D>

pub const fn dim() -> usize

pub fn to_unit_vector(self) -> SVector<Real, D>

pub fn from_vector(v: &SVector<Real, D>) -> Self

§Example

Trait Implementations§

impl<const D: usize> Clone for Direction<D>

fn clone(&self) -> Direction<D>

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

impl<const D: usize> Debug for Direction<D>

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

impl<'de, const D: usize> Deserialize<'de> for Direction<D>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl DirectionList for Direction<1usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<10usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<100usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<101usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<102usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<103usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<104usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<105usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<106usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<107usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<108usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<109usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<11usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<110usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<111usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<112usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

impl DirectionList for Direction<113usize>

fn directions() -> &'static [Self]

fn positive_directions() -> &'static [Self]

Struct Direction

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,