Trait ndarray::Dimension[][src]

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> + Clone + Debug + PartialEq + Eq + Default;
    type Smaller: Dimension;
    type Larger: Dimension + RemoveAxis;

    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

Associated Types

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

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> + Clone + Debug + PartialEq + Eq + Default[src]

Pattern matching friendly form of the dimension value.

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

type Smaller: Dimension[src]

Next smaller dimension (if applicable)

type Larger: Dimension + RemoveAxis[src]

Next larger dimension

Loading content...

Associated Constants

const NDIM: Option<usize>[src]

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.

Loading content...

Required methods

fn ndim(&self) -> usize[src]

Returns the number of dimensions (number of axes).

fn into_pattern(self) -> Self::Pattern[src]

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Self[src]

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

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

Loading content...

Provided methods

fn size(&self) -> usize[src]

Compute the size of the dimension (number of elements)

fn size_checked(&self) -> Option<usize>[src]

Compute the size while checking for overflow.

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

Borrow as a read-only array view.

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

Borrow as a read-write array view.

fn into_dyn(self) -> IxDyn[src]

Convert the dimensional into a dynamic dimensional (IxDyn).

Loading content...

Implementors

impl Dimension for Dim<[Ix; 0]>[src]

type SliceArg = [SliceOrIndex; 0]

type Pattern = ()

type Smaller = Self

type Larger = Ix1

impl Dimension for Dim<[Ix; 1]>[src]

type SliceArg = [SliceOrIndex; 1]

type Pattern = Ix

type Smaller = Ix0

type Larger = Ix2

fn stride_offset(index: &Self, stride: &Self) -> isize[src]

fn stride_offset_checked(&self, stride: &Self, index: &Self) -> Option<isize>[src]

impl Dimension for Dim<[Ix; 2]>[src]

type SliceArg = [SliceOrIndex; 2]

type Pattern = (Ix, Ix)

type Smaller = Ix1

type Larger = Ix3

fn stride_offset(index: &Self, strides: &Self) -> isize[src]

fn stride_offset_checked(&self, strides: &Self, index: &Self) -> Option<isize>[src]

impl Dimension for Dim<[Ix; 3]>[src]

type SliceArg = [SliceOrIndex; 3]

type Pattern = (Ix, Ix, Ix)

type Smaller = Ix2

type Larger = Ix4

fn stride_offset(index: &Self, strides: &Self) -> isize[src]

fn stride_offset_checked(&self, strides: &Self, index: &Self) -> Option<isize>[src]

impl Dimension for Dim<[Ix; 4]>[src]

type SliceArg = [SliceOrIndex; 4]

type Pattern = (Ix, Ix, Ix, Ix)

type Smaller = Dim<[Ix; 3]>

type Larger = Ix5

impl Dimension for Dim<[Ix; 5]>[src]

type SliceArg = [SliceOrIndex; 5]

type Pattern = (Ix, Ix, Ix, Ix, Ix)

type Smaller = Dim<[Ix; 4]>

type Larger = Ix6

impl Dimension for Dim<[Ix; 6]>[src]

type SliceArg = [SliceOrIndex; 6]

type Pattern = (Ix, Ix, Ix, Ix, Ix, Ix)

type Smaller = Dim<[Ix; 5]>

type Larger = IxDyn

impl Dimension for IxDyn[src]

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

type SliceArg = [SliceOrIndex]

type Pattern = Self

type Smaller = Self

type Larger = Self

Loading content...