Struct ndarray::Dim

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

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 = Dim<I>

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 = Dim<[usize; 1]>

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

Requires crate feature "rustc-serialize"

fn decode<E: Decoder>(d: &mut E) -> Result<Self, E::Error>

Deserialize a value using a Decoder.

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-1"

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

Deserialize this value from the given Serde deserializer.

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 = Dim<[usize; 0]>

Next smaller dimension (if applicable)

type Larger = Dim<[usize; 1]>

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

Creates a dimension of all zeros with the specified ndim.

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 = usize

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[usize; 0]>

Next smaller dimension (if applicable)

type Larger = Dim<[usize; 2]>

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

Creates a dimension of all zeros with the specified ndim.

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; 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 = (usize, usize)

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[usize; 1]>

Next smaller dimension (if applicable)

type Larger = Dim<[usize; 3]>

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

Creates a dimension of all zeros with the specified ndim.

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; 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 = (usize, usize, usize)

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[usize; 2]>

Next smaller dimension (if applicable)

type Larger = Dim<[usize; 4]>

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 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 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 = (usize, usize, usize, usize)

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[usize; 3]>

Next smaller dimension (if applicable)

type Larger = Dim<[usize; 5]>

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

Creates a dimension of all zeros with the specified ndim.

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 = (usize, usize, usize, usize, usize)

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[usize; 4]>

Next smaller dimension (if applicable)

type Larger = Dim<[usize; 6]>

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

Creates a dimension of all zeros with the specified ndim.

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 = (usize, usize, usize, usize, usize, usize)

Pattern matching friendly form of the dimension value.

type Smaller = Dim<[usize; 5]>

Next smaller dimension (if applicable)

type Larger = Dim<IxDynImpl>

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

Creates a dimension of all zeros with the specified ndim.

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

Requires crate feature "rustc-serialize"

fn encode<E: Encoder>(&self, s: &mut E) -> Result<(), E::Error>

Serialize a value using an Encoder.

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,
    Self: Sized,

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 = Dim<I>

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 = Dim<I>

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<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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 RemoveAxis for Dim<IxDynImpl>

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

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

Requires crate feature "serde-1"

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

Serialize this value into the given Serde serializer.

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

type Output = Dim<I>

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 = Dim<[usize; 1]>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl NdIndex<Dim<IxDynImpl>> for Ix

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

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