Struct Dim 

pub struct Dim<const NDIM: usize>(/* private fields */);

A statically-dimensioned shape with exactly NDIM axes, known at compile time.

Dim<N> is the preferred dimension type when the number of axes is determined by the code structure rather than runtime data. Passing typed arguments to shape-manipulating operations (e.g. [u64; 2] to reshape, usize to insert_axis) causes the compiler to select Dim<N> automatically, so callers rarely need to name this type explicitly.

Neighbors

Dim<N>::Smaller = Dim<N-1> (for N >= 1; Dim<0>::Smaller = DimDyn). Dim<N>::Larger = Dim<N+1> (for N <= 7; Dim<8>::Larger = DimDyn).

This means that N consecutive insert_axis(0) calls on a Dim<M> array produce a Dim<M+N> result, as long as M + N <= 8.

Implementations

impl<const NDIM: usize> Dim<NDIM>

pub fn from_array(arr: [u64; NDIM]) -> Self

Construct a Dim<NDIM> from a fixed-size array of axis sizes.

Trait Implementations

impl<const NDIM: usize> Clone for Dim<NDIM>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dim<0>

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

Formats the value using the given formatter.

impl Debug for Dim<1>

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

Formats the value using the given formatter.

impl Debug for Dim<2>

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

Formats the value using the given formatter.

impl Debug for Dim<3>

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

Formats the value using the given formatter.

impl Debug for Dim<4>

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

Formats the value using the given formatter.

impl Debug for Dim<5>

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

Formats the value using the given formatter.

impl Debug for Dim<6>

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

Formats the value using the given formatter.

impl Debug for Dim<7>

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

Formats the value using the given formatter.

impl Debug for Dim<8>

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

Formats the value using the given formatter.

impl Dimension for Dim<0>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = DimDyn

The dimension type that results from removing one axis.

type Larger = Dim<1>

The dimension type that results from adding one axis.

type Index<'a> = ()

The type of the index pattern for this dimension.

type Vec<T> = [T; 0]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<1>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = u64

The type of the index pattern for this dimension.

type Vec<T> = [T; 1]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<2>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 2]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<3>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 3]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<4>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64, u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 4]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<5>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64, u64, u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 5]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<6>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64, u64, u64, u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 6]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<7>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<{ $dim - 1 }>

The dimension type that results from removing one axis.

type Larger = Dim<{ $dim + 1 }>

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64, u64, u64, u64, u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 7]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Dimension for Dim<8>

const NDIM: Option<usize>

The number of axes, if known at compile time.

type Smaller = Dim<7>

The dimension type that results from removing one axis.

type Larger = DimDyn

The dimension type that results from adding one axis.

type Index<'a> = (u64, u64, u64, u64, u64, u64, u64, u64)

The type of the index pattern for this dimension.

type Vec<T> = [T; 8]

A vec-like container that can hold one value per axis for this dimension type.

fn from_fn(ndim: usize, f: impl FnMut(usize) -> u64) -> Self

Construct a Dimension by calling f(i) for each axis index i in 0..ndim.

fn as_slice(&self) -> &[u64]

Return the shape as a slice, with one element per dimension.

fn as_mut_slice(&mut self) -> &mut [u64]

Return the shape as a mutable slice, with one element per dimension.

fn to_index(&self) -> Self::Index<'_>

Convert the dimension into its index pattern type.

fn vec<T>(ndim: usize, f: impl FnMut(usize) -> T) -> Self::Vec<T>

Build a vec-like container with one value per axis, by applying f to each axis index.

fn from_slice(slice: &[u64]) -> Self

where Self: Sized,

Construct a Dimension value from a shape slice.

fn ndim(&self) -> usize

Return the number of dimensions.

fn size(&self, dim: usize) -> u64

Return the size of dimension dim.

impl Index<usize> for Dim<0>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<1>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<2>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<3>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<4>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<5>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<6>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<7>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl Index<usize> for Dim<8>

type Output = u64

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Dim<0>

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

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

impl IndexMut<usize> for Dim<1>

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

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

impl IndexMut<usize> for Dim<2>

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

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

impl IndexMut<usize> for Dim<3>

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

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

impl IndexMut<usize> for Dim<4>

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

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

impl IndexMut<usize> for Dim<5>

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

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

impl IndexMut<usize> for Dim<6>

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

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

impl IndexMut<usize> for Dim<7>

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

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

impl IndexMut<usize> for Dim<8>

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

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

impl IntoDimension for Dim<0>

type Dim = Dim<[usize; 0]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<1>

type Dim = Dim<[usize; 1]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<2>

type Dim = Dim<[usize; 2]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<3>

type Dim = Dim<[usize; 3]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<4>

type Dim = Dim<[usize; 4]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<5>

type Dim = Dim<[usize; 5]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<6>

type Dim = Dim<[usize; 6]>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<7>

type Dim = Dim<IxDynImpl>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.

impl IntoDimension for Dim<8>

type Dim = Dim<IxDynImpl>

The concrete type of the resultant dimension.

fn into_dimension(self) -> Self::Dim

Convert into a type that implements Dimension.