Struct Axes

pub struct Axes(/* private fields */);

Axes used in reduce and permute operations. Just Box<usize>.

Implementations

impl Axes

pub fn len(&self) -> usize

Number of axes

pub fn is_empty(&self) -> bool

Is there no axes?

pub fn iter(&self) -> impl Iterator<Item = &usize> + '_

Iterate over axes

pub fn argsort(&self) -> Axes

Returns the indices that sort axes in ascending order by value.

pub fn contains(&self, a: usize) -> bool

Does self contain axis a?

pub fn vi64(&self) -> Vec<i64>

Get self as vector i64

pub fn permute(&self, axes: &Axes) -> Self

Permute shape’s dimensions with axes

Panics

Panics if axes is incorrect.

Trait Implementations

impl Clone for Axes

fn clone(&self) -> Axes

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Axes

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

Formats the value using the given formatter.

impl Display for Axes

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

Formats the value using the given formatter.

impl From<Axes> for Vec<usize>

fn from(val: Axes) -> Self

Converts to this type from the input type.

impl Index<i64> for Axes

type Output = usize

The returned type after indexing.

fn index(&self, index: i64) -> &Self::Output

Performs the indexing (container[index]) operation.

impl IntoAxes for &Axes

fn into_axes(self, rank: usize) -> Axes

Convert value into axes

impl IntoAxes for Axes

fn into_axes(self, rank: usize) -> Axes

Convert value into axes

impl<'a> IntoIterator for &'a Axes

type Item = &'a usize

The type of the elements being iterated over.

type IntoIter = <&'a [usize] as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Axes

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Axes

fn eq(&self, other: &Axes) -> 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 PartialOrd for Axes

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for Axes

impl StructuralPartialEq for Axes