Trait ndarray::Dimension

pub trait Dimension: Clone + Eq + Debug + Send + Sync + Default + IndexMut<usize, Output = usize> + Add<Self, Output = Self> + AddAssign + for<'x> AddAssign<&'x Self> + Sub<Self, Output = Self> + SubAssign + for<'x> SubAssign<&'x Self> + Mul<usize, Output = Self> + Mul<Self, Output = Self> + MulAssign + for<'x> MulAssign<&'x Self> + MulAssign<usize> {
    type SliceArg: ?Sized + AsRef<[SliceOrIndex]>;
    type Pattern: IntoDimension<Dim = Self>;
    type Smaller: Dimension;
    type Larger: Dimension;

    const NDIM: Option<usize>;

    fn ndim(&self) -> usize;
    fn into_pattern(self) -> Self::Pattern;
    fn zeros(ndim: usize) -> Self;
    fn __private__(&self) -> PrivateMarker;

    fn size(&self) -> usize { ... }
    fn size_checked(&self) -> Option<usize> { ... }
    fn as_array_view(&self) -> ArrayView1<'_, Ix> { ... }
    fn as_array_view_mut(&mut self) -> ArrayViewMut1<'_, Ix> { ... }
    fn into_dyn(self) -> IxDyn { ... }
}

Array shape and index trait.

This trait defines a number of methods and operations that can be used on dimensions and indices.

Note: This trait can not be implemented outside the crate

Required Associated Types

type SliceArg: ?Sized + AsRef<[SliceOrIndex]>

SliceArg is the type which is used to specify slicing for this dimension.

For the fixed size dimensions it is a fixed size array of the correct size, which you pass by reference. For the dynamic dimension it is a slice.

• For Ix1: [SliceOrIndex; 1]
• For Ix2: [SliceOrIndex; 2]
• and so on..
• For IxDyn: [SliceOrIndex]

The easiest way to create a &SliceInfo<SliceArg, Do> is using the s![] macro.

type Pattern: IntoDimension<Dim = Self>

Pattern matching friendly form of the dimension value.

• For Ix1: usize,
• For Ix2: (usize, usize)
• and so on..
• For IxDyn: IxDyn

type Smaller: Dimension

Next smaller dimension (if applicable)

type Larger: Dimension

Next larger dimension

Required Associated Constants

const NDIM: Option<usize>

For fixed-size dimension representations (e.g. Ix2), this should be Some(ndim), and for variable-size dimension representations (e.g. IxDyn), this should be None.

Required Methods

fn ndim(&self) -> usize

Returns the number of dimensions (number of axes).

fn into_pattern(self) -> Self::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Self

Creates a dimension of all zeros with the specified ndim.

This method is useful for generalizing over fixed-size and variable-size dimension representations.

Panics if Self has a fixed size that is not ndim.

fn __private__(&self) -> PrivateMarker

This trait is private to implement; this method exists to make it impossible to implement outside the crate.

Provided Methods

fn size(&self) -> usize

Compute the size of the dimension (number of elements)

fn size_checked(&self) -> Option<usize>

Compute the size while checking for overflow.

fn as_array_view(&self) -> ArrayView1<'_, Ix>

Borrow as a read-only array view.

fn as_array_view_mut(&mut self) -> ArrayViewMut1<'_, Ix>

Borrow as a read-write array view.

fn into_dyn(self) -> IxDyn

Convert the dimensional into a dynamic dimensional (IxDyn).

Implementors

impl Dimension for Dim<[Ix; 0]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 0]

type Pattern = ()

type Smaller = Dim<[usize; 0]>

type Larger = Dim<[usize; 1]>

impl Dimension for Dim<[Ix; 1]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 1]

type Pattern = usize

type Smaller = Dim<[usize; 0]>

type Larger = Dim<[usize; 2]>

impl Dimension for Dim<[Ix; 2]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 2]

type Pattern = (usize, usize)

type Smaller = Dim<[usize; 1]>

type Larger = Dim<[usize; 3]>

impl Dimension for Dim<[Ix; 3]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 3]

type Pattern = (usize, usize, usize)

type Smaller = Dim<[usize; 2]>

type Larger = Dim<[usize; 4]>

impl Dimension for Dim<[Ix; 4]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 4]

type Pattern = (usize, usize, usize, usize)

type Smaller = Dim<[usize; 3]>

type Larger = Dim<[usize; 5]>

impl Dimension for Dim<[Ix; 5]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 5]

type Pattern = (usize, usize, usize, usize, usize)

type Smaller = Dim<[usize; 4]>

type Larger = Dim<[usize; 6]>

impl Dimension for Dim<[Ix; 6]>

const NDIM: Option<usize> = _

type SliceArg = [SliceOrIndex; 6]

type Pattern = (usize, usize, usize, usize, usize, usize)

type Smaller = Dim<[usize; 5]>

type Larger = Dim<IxDynImpl>

impl Dimension for IxDyn

IxDyn is a “dynamic” index, pretty hard to use when indexing, and memory wasteful, but it allows an arbitrary and dynamic number of axes.

const NDIM: Option<usize> = None

type SliceArg = [SliceOrIndex]

type Pattern = Dim<IxDynImpl>

type Smaller = Dim<IxDynImpl>

type Larger = Dim<IxDynImpl>