Struct ndarray::Axis [−][src]
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.
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()
.
Implementations
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Auto Trait Implementations
impl RefUnwindSafe for Axis
impl UnwindSafe for Axis
Blanket Implementations
Mutably borrows from an owned value. Read more