Struct ndarray::Axis

pub struct Axis(pub usize);

An axis index.

An axis one of an array’s “dimensions”; an n-dimensional array has n axes. Axis 0 is the array’s outermost axis and n-1 is the innermost.

All array axis arguments use this type to make the code easier to write correctly and easier to understand.

For example: in a method like index_axis(axis, index) the code becomes self-explanatory when it’s called like .index_axis(Axis(1), i); it’s evident which integer is the axis number and which is the index.

Note: This type does not implement From/Into usize and similar trait based conversions, because we want to preserve code readability and quality.

Axis(1) in itself is a very clear code style and the style that should be avoided is code like 1.into().

Tuple Fields

0: usize

Implementations

impl Axis

pub fn index(self) -> usize

Return the index of the axis.

Trait Implementations

impl Clone for Axis

fn clone(&self) -> Axis

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Axis

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

Formats the value using the given formatter.

impl Hash for Axis

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Axis

fn cmp(&self, other: &Axis) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Axis> for Axis

fn eq(&self, other: &Axis) -> bool

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

fn ne(&self, other: &Axis) -> bool

This method tests for !=.

impl PartialOrd<Axis> for Axis

fn partial_cmp(&self, other: &Axis) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Axis

impl Eq for Axis

impl StructuralEq for Axis

impl StructuralPartialEq for Axis