Struct ndarray::Dim

pub struct Dim<I: ?Sized> { /* fields omitted */ }

Dimension description.

Dim describes the number of axes and the length of each axis in an array. It is also used as an index type.

See also the Dimension trait for its methods and operations.

Examples

To create an array with a particular dimension, you’d just pass a tuple (in this example (3, 2) is used), which is converted to Dim by the array constructor.

use ndarray::Array2;
use ndarray::Dim;

let mut array = Array2::zeros((3, 2));
array[[0, 0]] = 1.;
assert_eq!(array.raw_dim(), Dim([3, 2]));

Implementations

impl Dim<IxDynImpl>

pub fn zeros(n: usize) -> IxDyn

Create a new dimension value with n axes, all zeros

Trait Implementations

impl<I> Add<Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self

Performs the + operation.

impl Add<usize> for Dim<[Ix; 1]>

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Ix) -> Self

Performs the + operation.

impl<'a, I> AddAssign<&'a Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

fn add_assign(&mut self, rhs: &Self)

Performs the += operation.

impl<I> AddAssign<Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<usize> for Dim<[Ix; 1]>

fn add_assign(&mut self, rhs: Ix)

Performs the += operation.

impl<I: Clone + ?Sized> Clone for Dim<I>

fn clone(&self) -> Dim<I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I> Debug for Dim<I> where
    I: Debug, 

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

Formats the value using the given formatter.

impl<I: Default + ?Sized> Default for Dim<I>

fn default() -> Dim<I>

Returns the “default value” for a type.

impl<'de, I> Deserialize<'de> for Dim<I> where
    I: Deserialize<'de>, 

Requires crate feature "serde"

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl DimAdd<Dim<[usize; 0]>> for Dim<[usize; 1]>

type Output = Dim<[usize; 1]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 0]>> for Dim<[usize; 2]>

type Output = Dim<[usize; 2]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 0]>> for Dim<[usize; 3]>

type Output = Dim<[usize; 3]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 0]>> for Dim<[usize; 4]>

type Output = Dim<[usize; 4]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 0]>> for Dim<[usize; 5]>

type Output = Dim<[usize; 5]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 0]>> for Dim<[usize; 6]>

type Output = Dim<[usize; 6]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 1]>> for Dim<[usize; 1]>

type Output = Dim<[usize; 2]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 1]>> for Dim<[usize; 2]>

type Output = Dim<[usize; 3]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 1]>> for Dim<[usize; 3]>

type Output = Dim<[usize; 4]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 1]>> for Dim<[usize; 4]>

type Output = Dim<[usize; 5]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 1]>> for Dim<[usize; 5]>

type Output = Dim<[usize; 6]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 1]>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 2]>> for Dim<[usize; 1]>

type Output = Dim<[usize; 3]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 2]>> for Dim<[usize; 2]>

type Output = Dim<[usize; 4]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 2]>> for Dim<[usize; 3]>

type Output = Dim<[usize; 5]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 2]>> for Dim<[usize; 4]>

type Output = Dim<[usize; 6]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 2]>> for Dim<[usize; 5]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 2]>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 3]>> for Dim<[usize; 1]>

type Output = Dim<[usize; 4]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 3]>> for Dim<[usize; 2]>

type Output = Dim<[usize; 5]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 3]>> for Dim<[usize; 3]>

type Output = Dim<[usize; 6]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 3]>> for Dim<[usize; 4]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 3]>> for Dim<[usize; 5]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 3]>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 4]>> for Dim<[usize; 1]>

type Output = Dim<[usize; 5]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 4]>> for Dim<[usize; 2]>

type Output = Dim<[usize; 6]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 4]>> for Dim<[usize; 3]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 4]>> for Dim<[usize; 4]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 4]>> for Dim<[usize; 5]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 4]>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 5]>> for Dim<[usize; 1]>

type Output = Dim<[usize; 6]>

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 5]>> for Dim<[usize; 2]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 5]>> for Dim<[usize; 3]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 5]>> for Dim<[usize; 4]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 5]>> for Dim<[usize; 5]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 5]>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 6]>> for Dim<[usize; 1]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 6]>> for Dim<[usize; 2]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 6]>> for Dim<[usize; 3]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 6]>> for Dim<[usize; 4]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 6]>> for Dim<[usize; 5]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<[usize; 6]>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<IxDynImpl>> for Dim<[usize; 1]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<IxDynImpl>> for Dim<[usize; 2]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<IxDynImpl>> for Dim<[usize; 3]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<IxDynImpl>> for Dim<[usize; 4]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<IxDynImpl>> for Dim<[usize; 5]>

type Output = IxDyn

The sum of the two dimensions.

impl DimAdd<Dim<IxDynImpl>> for Dim<[usize; 6]>

type Output = IxDyn

The sum of the two dimensions.

impl DimMax<Dim<[usize; 0]>> for Ix1

type Output = Ix1

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 0]>> for Ix2

type Output = Ix2

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 0]>> for Ix3

type Output = Ix3

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 0]>> for Ix4

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 0]>> for Ix5

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 0]>> for Ix6

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 0]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for Ix0

type Output = Ix1

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for Ix2

type Output = Ix2

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for Ix3

type Output = Ix3

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for Ix4

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for Ix5

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for Ix6

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 1]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for Ix0

type Output = Ix2

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for Ix1

type Output = Ix2

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for Ix3

type Output = Ix3

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for Ix4

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for Ix5

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for Ix6

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 2]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for Ix0

type Output = Ix3

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for Ix1

type Output = Ix3

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for Ix2

type Output = Ix3

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for Ix4

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for Ix5

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for Ix6

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 3]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for Ix0

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for Ix1

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for Ix2

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for Ix3

type Output = Ix4

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for Ix5

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for Ix6

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 4]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for Ix0

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for Ix1

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for Ix2

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for Ix3

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for Ix4

type Output = Ix5

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for Ix6

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 5]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for Ix0

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for Ix1

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for Ix2

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for Ix3

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for Ix4

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for Ix5

type Output = Ix6

The resulting dimension type after broadcasting.

impl DimMax<Dim<[usize; 6]>> for IxDyn

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix0

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix1

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix2

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix3

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix4

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix5

type Output = IxDyn

The resulting dimension type after broadcasting.

impl DimMax<Dim<IxDynImpl>> for Ix6

type Output = IxDyn

The resulting dimension type after broadcasting.

impl Dimension for Dim<[Ix; 0]>

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.

type Pattern = ()

Pattern matching friendly form of the dimension value.

type Smaller = Self

Next smaller dimension (if applicable)

type Larger = Ix1

Next larger dimension

fn ndim(&self) -> usize

Returns the number of dimensions (number of axes).

fn slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

fn _fastest_varying_stride_order(&self) -> Self

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.

fn next_for(&self, _index: Self) -> Option<Self>

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, _ignore: Axis) -> Self::Smaller

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).

fn __private__(&self) -> PrivateMarker

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

impl Dimension for Dim<[Ix; 1]>

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.

type Pattern = Ix

Pattern matching friendly form of the dimension value.

type Smaller = Ix0

Next smaller dimension (if applicable)

type Larger = Ix2

Next larger dimension

fn ndim(&self) -> usize

Returns the number of dimensions (number of axes).

fn slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

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.

fn next_for(&self, index: Self) -> Option<Self>

fn equal(&self, rhs: &Self) -> bool

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 default_strides(&self) -> Self

fn _fastest_varying_stride_order(&self) -> Self

fn min_stride_axis(&self, _: &Self) -> Axis

fn max_stride_axis(&self, _: &Self) -> Axis

fn first_index(&self) -> Option<Self>

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

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

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, axis: Axis) -> Self::Smaller

fn from_dimension<D2: Dimension>(d: &D2) -> Option<Self>

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).

fn __private__(&self) -> PrivateMarker

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

impl Dimension for Dim<[Ix; 2]>

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.

type Pattern = (Ix, Ix)

Pattern matching friendly form of the dimension value.

type Smaller = Ix1

Next smaller dimension (if applicable)

type Larger = Ix3

Next larger dimension

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 slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

fn zeros(ndim: usize) -> Self

Creates a dimension of all zeros with the specified ndim.

fn next_for(&self, index: Self) -> Option<Self>

fn equal(&self, rhs: &Self) -> bool

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 last_elem(&self) -> usize

fn set_last_elem(&mut self, i: usize)

fn default_strides(&self) -> Self

fn fortran_strides(&self) -> Self

fn _fastest_varying_stride_order(&self) -> Self

fn min_stride_axis(&self, strides: &Self) -> Axis

fn first_index(&self) -> Option<Self>

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

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

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, axis: Axis) -> Self::Smaller

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).

fn __private__(&self) -> PrivateMarker

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

impl Dimension for Dim<[Ix; 3]>

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.

type Pattern = (Ix, Ix, Ix)

Pattern matching friendly form of the dimension value.

type Smaller = Ix2

Next smaller dimension (if applicable)

type Larger = Ix4

Next larger dimension

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 slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

fn size(&self) -> usize

Compute the size of the dimension (number of elements)

fn zeros(ndim: usize) -> Self

Creates a dimension of all zeros with the specified ndim.

fn next_for(&self, index: Self) -> Option<Self>

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

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

fn _fastest_varying_stride_order(&self) -> Self

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, axis: Axis) -> Self::Smaller

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).

fn __private__(&self) -> PrivateMarker

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

impl Dimension for Dim<[Ix; 4]>

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.

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

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[Ix; 3]>

Next smaller dimension (if applicable)

type Larger = Ix5

Next larger dimension

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 slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

fn zeros(ndim: usize) -> Self

Creates a dimension of all zeros with the specified ndim.

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, axis: Axis) -> Self::Smaller

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).

fn __private__(&self) -> PrivateMarker

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

impl Dimension for Dim<[Ix; 5]>

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.

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

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[Ix; 4]>

Next smaller dimension (if applicable)

type Larger = Ix6

Next larger dimension

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 slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

fn zeros(ndim: usize) -> Self

Creates a dimension of all zeros with the specified ndim.

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, axis: Axis) -> Self::Smaller

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).

fn __private__(&self) -> PrivateMarker

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

impl Dimension for Dim<[Ix; 6]>

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.

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

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[Ix; 5]>

Next smaller dimension (if applicable)

type Larger = IxDyn

Next larger dimension

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 slice(&self) -> &[Ix]

fn slice_mut(&mut self) -> &mut [Ix]

fn zeros(ndim: usize) -> Self

Creates a dimension of all zeros with the specified ndim.

fn insert_axis(&self, axis: Axis) -> Self::Larger

fn try_remove_axis(&self, axis: Axis) -> Self::Smaller

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).

fn __private__(&self) -> PrivateMarker

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

impl<I: Hash + ?Sized> Hash for Dim<I>

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 Index<usize> for Dim<[Ix; 0]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<[Ix; 1]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<[Ix; 2]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<[Ix; 3]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<[Ix; 4]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<[Ix; 5]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<[Ix; 6]>

type Output = usize

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<IxDynImpl>

type Output = <IxDynImpl as Index<usize>>::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 0]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 1]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 2]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 3]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 4]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 5]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<[Ix; 6]>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl IndexMut<usize> for Dim<IxDynImpl>

fn index_mut(&mut self, index: usize) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<I> Mul<Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self

Performs the * operation.

impl<I> Mul<usize> for Dim<I> where
    Dim<I>: Dimension, 

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Ix) -> Self

Performs the * operation.

impl<'a, I> MulAssign<&'a Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

fn mul_assign(&mut self, rhs: &Self)

Performs the *= operation.

impl<I> MulAssign<Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl<I> MulAssign<usize> for Dim<I> where
    Dim<I>: Dimension, 

fn mul_assign(&mut self, rhs: Ix)

Performs the *= operation.

impl NdIndex<Dim<[usize; 0]>> for ()

fn index_checked(&self, dim: &Ix0, strides: &Ix0) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix0) -> isize

impl NdIndex<Dim<[usize; 0]>> for [Ix; 0]

fn index_checked(&self, dim: &Ix0, strides: &Ix0) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix0) -> isize

impl NdIndex<Dim<[usize; 1]>> for Ix

fn index_checked(&self, dim: &Ix1, strides: &Ix1) -> Option<isize>

fn index_unchecked(&self, strides: &Ix1) -> isize

impl NdIndex<Dim<[usize; 1]>> for [Ix; 1]

fn index_checked(&self, dim: &Ix1, strides: &Ix1) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix1) -> isize

impl NdIndex<Dim<[usize; 2]>> for (Ix, Ix)

fn index_checked(&self, dim: &Ix2, strides: &Ix2) -> Option<isize>

fn index_unchecked(&self, strides: &Ix2) -> isize

impl NdIndex<Dim<[usize; 2]>> for [Ix; 2]

fn index_checked(&self, dim: &Ix2, strides: &Ix2) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix2) -> isize

impl NdIndex<Dim<[usize; 3]>> for (Ix, Ix, Ix)

fn index_checked(&self, dim: &Ix3, strides: &Ix3) -> Option<isize>

fn index_unchecked(&self, strides: &Ix3) -> isize

impl NdIndex<Dim<[usize; 3]>> for [Ix; 3]

fn index_checked(&self, dim: &Ix3, strides: &Ix3) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix3) -> isize

impl NdIndex<Dim<[usize; 4]>> for (Ix, Ix, Ix, Ix)

fn index_checked(&self, dim: &Ix4, strides: &Ix4) -> Option<isize>

fn index_unchecked(&self, strides: &Ix4) -> isize

impl NdIndex<Dim<[usize; 4]>> for [Ix; 4]

fn index_checked(&self, dim: &Ix4, strides: &Ix4) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix4) -> isize

impl NdIndex<Dim<[usize; 5]>> for (Ix, Ix, Ix, Ix, Ix)

fn index_checked(&self, dim: &Ix5, strides: &Ix5) -> Option<isize>

fn index_unchecked(&self, strides: &Ix5) -> isize

impl NdIndex<Dim<[usize; 5]>> for [Ix; 5]

fn index_checked(&self, dim: &Ix5, strides: &Ix5) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix5) -> isize

impl NdIndex<Dim<[usize; 6]>> for [Ix; 6]

fn index_checked(&self, dim: &Ix6, strides: &Ix6) -> Option<isize>

fn index_unchecked(&self, _strides: &Ix6) -> isize

impl NdIndex<Dim<IxDynImpl>> for Ix

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 0]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 4]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 5]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 5]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 6]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 6]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl<'a> NdIndex<Dim<IxDynImpl>> for &'a IxDyn

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl<'a> NdIndex<Dim<IxDynImpl>> for &'a [Ix]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 0]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 1]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 1]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 2]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 2]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 3]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for [Ix; 3]

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl NdIndex<Dim<IxDynImpl>> for Dim<[Ix; 4]>

fn index_checked(&self, dim: &IxDyn, strides: &IxDyn) -> Option<isize>

fn index_unchecked(&self, strides: &IxDyn) -> isize

impl<I: PartialEq + ?Sized> PartialEq<Dim<I>> for Dim<I>

fn eq(&self, other: &Dim<I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Dim<I>) -> bool

This method tests for !=.

impl<I: ?Sized> PartialEq<I> for Dim<I> where
    I: PartialEq, 

fn eq(&self, rhs: &I) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl RemoveAxis for Dim<IxDynImpl>

fn remove_axis(&self, axis: Axis) -> Self

impl RemoveAxis for Dim<[Ix; 1]>

fn remove_axis(&self, axis: Axis) -> Ix0

impl RemoveAxis for Dim<[Ix; 2]>

fn remove_axis(&self, axis: Axis) -> Ix1

impl RemoveAxis for Dim<[Ix; 3]>

fn remove_axis(&self, axis: Axis) -> Self::Smaller

impl RemoveAxis for Dim<[Ix; 4]>

fn remove_axis(&self, axis: Axis) -> Self::Smaller

impl RemoveAxis for Dim<[Ix; 5]>

fn remove_axis(&self, axis: Axis) -> Self::Smaller

impl RemoveAxis for Dim<[Ix; 6]>

fn remove_axis(&self, axis: Axis) -> Self::Smaller

impl<I> Serialize for Dim<I> where
    I: Serialize, 

Requires crate feature "serde"

fn serialize<Se>(&self, serializer: Se) -> Result<Se::Ok, Se::Error> where
    Se: Serializer, 

Serialize this value into the given Serde serializer.

impl<T, Dout> SliceArg<Dim<[usize; 0]>> for SliceInfo<T, Ix0, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Dout> SliceArg<Dim<[usize; 1]>> for SliceInfo<T, Ix1, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Dout> SliceArg<Dim<[usize; 2]>> for SliceInfo<T, Ix2, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Dout> SliceArg<Dim<[usize; 3]>> for SliceInfo<T, Ix3, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Dout> SliceArg<Dim<[usize; 4]>> for SliceInfo<T, Ix4, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Dout> SliceArg<Dim<[usize; 5]>> for SliceInfo<T, Ix5, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Dout> SliceArg<Dim<[usize; 6]>> for SliceInfo<T, Ix6, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<T, Din, Dout> SliceArg<Dim<IxDynImpl>> for SliceInfo<T, Din, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Din: Dimension,
    Dout: Dimension, 

type OutDim = Dout

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl SliceArg<Dim<IxDynImpl>> for [SliceInfoElem]

type OutDim = IxDyn

Dimensionality of the output array.

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker

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

impl<I> Sub<Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self

Performs the - operation.

impl Sub<usize> for Dim<[Ix; 1]>

type Output = Self

The resulting type after applying the - operator.

fn sub(self, rhs: Ix) -> Self

Performs the - operation.

impl<'a, I> SubAssign<&'a Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

fn sub_assign(&mut self, rhs: &Self)

Performs the -= operation.

impl<I> SubAssign<Dim<I>> for Dim<I> where
    Dim<I>: Dimension, 

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubAssign<usize> for Dim<[Ix; 1]>

fn sub_assign(&mut self, rhs: Ix)

Performs the -= operation.

impl Zero for Dim<[Ix; 0]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zero for Dim<[Ix; 1]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zero for Dim<[Ix; 2]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zero for Dim<[Ix; 3]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zero for Dim<[Ix; 4]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zero for Dim<[Ix; 5]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Zero for Dim<[Ix; 6]>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<I: Copy + ?Sized> Copy for Dim<I>

impl<I: Eq + ?Sized> Eq for Dim<I>

impl<I: ?Sized> StructuralEq for Dim<I>

impl<I: ?Sized> StructuralPartialEq for Dim<I>