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]));

Trait Implementations

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

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

Performs the mutable indexing (container[index]) 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.

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 IndexMut<usize> for Dim<[Ix; 1]>

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

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

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.

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 IndexMut<usize> for Dim<[Ix; 2]>

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

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

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.

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 IndexMut<usize> for Dim<[Ix; 3]>

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

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

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.

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 IndexMut<usize> for Dim<[Ix; 4]>

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

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

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.

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 IndexMut<usize> for Dim<[Ix; 5]>

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

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

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.

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 IndexMut<usize> for Dim<[Ix; 6]>

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

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

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.

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

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: PartialEq + ?Sized> PartialEq 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: Eq + ?Sized> Eq for Dim<I>

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

fn default() -> Dim<I>

Returns the "default value" for a type.

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<I: ?Sized> Hash for Dim<I> where     Dim<I>: Dimension,

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<I> Debug for Dim<I> where     I: Debug,

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

Formats the value using the given formatter.

impl<I> Add 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<I> AddAssign for Dim<I> where     Dim<I>: Dimension,

fn add_assign(&mut self, rhs: 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 Add<Ix> for Dim<[Ix; 1]>

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

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

fn add_assign(&mut self, rhs: Ix)

Performs the += operation.

impl<I> Sub 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<I> SubAssign for Dim<I> where     Dim<I>: Dimension,

fn sub_assign(&mut self, rhs: 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 Sub<Ix> for Dim<[Ix; 1]>

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

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

fn sub_assign(&mut self, rhs: Ix)

Performs the -= operation.

impl<I> Mul 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> MulAssign for Dim<I> where     Dim<I>: Dimension,

fn mul_assign(&mut self, rhs: 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> Mul<Ix> 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<I> MulAssign<Ix> for Dim<I> where     Dim<I>: Dimension,

fn mul_assign(&mut self, rhs: Ix)

Performs the *= operation.

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 SliceArg = [SliceOrIndex; 0]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 SliceArg = [SliceOrIndex; 1]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 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 SliceArg = [SliceOrIndex; 2]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 SliceArg = [SliceOrIndex; 3]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 SliceArg = [SliceOrIndex; 4]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 SliceArg = [SliceOrIndex; 5]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 SliceArg = [SliceOrIndex; 6]

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

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

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 zero_index_with_ndim(ndim: usize) -> Self

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 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<IxDynImpl>

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

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

impl RemoveAxis for Dim<IxDynImpl>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl RemoveAxis for Dim<[Ix; 1]>

fn remove_axis(&self, _: 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