Struct ndarray::Axis

[+] Show declaration

pub struct Axis(pub usize);

[−] Expand description

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.

Methods

impl Axis[−]

pub fn index(self) -> usize[−]

Return the index of the axis.

Trait Implementations

impl Clone for Axis[+]

[+] Show hidden undocumented items

fn clone(&self) -> Axis[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Copy for Axis

impl Debug for Axis[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl Eq for Axis

impl Hash for Axis[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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

This method returns an [Ordering] between self and other.

[+] Expand attributes

#[must_use] fn max(self, other: Self) -> Self[−]

Compares and returns the maximum of two values.

[+] Expand attributes

#[must_use] fn min(self, other: Self) -> Self[−]

Compares and returns the minimum of two values.

[+] Expand attributes

#[must_use] fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Axis> for Axis[+]

[+] Show hidden undocumented items

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[+]

[+] Show hidden undocumented items

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: &Axis) -> bool[−]

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

fn le(&self, other: &Axis) -> bool[−]

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

fn gt(&self, other: &Axis) -> bool[−]

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

fn ge(&self, other: &Axis) -> bool[−]

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

impl StructuralEq for Axis

impl StructuralPartialEq for Axis