Struct extendr_api::prelude::Dim

pub struct Dim<I> where
    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) -> Dim<IxDynImpl>

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: Dim<I>) -> Dim<I>

Performs the + operation.

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

type Output = Dim<[usize; 1]>

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Dim<[usize; 1]>

Performs the + operation.

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

fn add_assign(&mut self, rhs: &Dim<I>)

Performs the += operation.

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

fn add_assign(&mut self, rhs: Dim<I>)

Performs the += operation.

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

fn add_assign(&mut self, rhs: usize)

Performs the += operation.

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

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<(), Error>

Formats the value using the given formatter.

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

fn default() -> Dim<I>

Returns the “default value” for a type.

impl<D> DimAdd<D> for Dim<[usize; 0]> where
    D: Dimension, 

type Output = D

The sum of the two dimensions.

impl<D> DimAdd<D> for Dim<IxDynImpl> where
    D: Dimension, 

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

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

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

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

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

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

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

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

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<IxDynImpl>

The sum of the two dimensions.

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

type Output = Dim<[usize; 1]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 2]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 3]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 1]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 2]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 3]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 2]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 2]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 3]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 3]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 3]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 3]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 4]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 5]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<[usize; 6]>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

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

type Output = Dim<IxDynImpl>

The resulting dimension type after broadcasting.

impl Dimension for Dim<[usize; 0]>

const NDIM: Option<usize> = Some(0)

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 = 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) -> <Dim<[usize; 0]> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<[usize; 0]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<[usize; 1]>

const NDIM: Option<usize> = Some(1)

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 = 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) -> <Dim<[usize; 1]> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<[usize; 1]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<[usize; 2]>

const NDIM: Option<usize> = Some(2)

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 = (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) -> <Dim<[usize; 2]> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<[usize; 2]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<[usize; 3]>

const NDIM: Option<usize> = Some(3)

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 = (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) -> <Dim<[usize; 3]> as Dimension>::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) -> Dim<[usize; 3]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<[usize; 4]>

const NDIM: Option<usize> = Some(4)

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 = (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) -> <Dim<[usize; 4]> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<[usize; 4]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<[usize; 5]>

const NDIM: Option<usize> = Some(5)

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 = (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) -> <Dim<[usize; 5]> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<[usize; 5]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<[usize; 6]>

const NDIM: Option<usize> = Some(6)

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 = (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) -> <Dim<[usize; 6]> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<[usize; 6]>

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

impl Dimension for Dim<IxDynImpl>

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

const NDIM: Option<usize> = None

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

Pattern matching friendly form of the dimension value.

type Smaller = Dim<IxDynImpl>

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) -> <Dim<IxDynImpl> as Dimension>::Pattern

Convert the dimension into a pattern matching friendly value.

fn zeros(ndim: usize) -> Dim<IxDynImpl>

Creates a dimension of all zeros with the specified ndim.

fn into_dyn(self) -> Dim<IxDynImpl>

Convert the dimensional into a dynamic dimensional (IxDyn).

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) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>

Borrow as a read-only array view.

fn as_array_view_mut(
    &mut self
) -> ArrayBase<ViewRepr<&mut usize>, Dim<[usize; 1]>>

Borrow as a read-write array view.

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

fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 0]> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 1]> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 2]> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 3]> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 4]> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 5]> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

type Output = usize

The returned type after indexing.

fn index(&self, index: usize) -> &<Dim<[usize; 6]> as Index<usize>>::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) -> &<Dim<IxDynImpl> as Index<usize>>::Output

Performs the indexing (container[index]) operation.

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 0]> as Index<usize>>::Output

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

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 1]> as Index<usize>>::Output

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

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 2]> as Index<usize>>::Output

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

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 3]> as Index<usize>>::Output

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

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 4]> as Index<usize>>::Output

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

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 5]> as Index<usize>>::Output

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

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

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<[usize; 6]> as Index<usize>>::Output

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

impl IndexMut<usize> for Dim<IxDynImpl>

fn index_mut(
    &mut self,
    index: usize
) -> &mut <Dim<IxDynImpl> as Index<usize>>::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: Dim<I>) -> Dim<I>

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: usize) -> Dim<I>

Performs the * operation.

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

fn mul_assign(&mut self, rhs: &Dim<I>)

Performs the *= operation.

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

fn mul_assign(&mut self, rhs: Dim<I>)

Performs the *= operation.

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

fn mul_assign(&mut self, rhs: usize)

Performs the *= operation.

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

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> PartialEq<I> for Dim<I> where
    I: PartialEq<I> + ?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 !=.

impl RemoveAxis for Dim<[usize; 1]>

fn remove_axis(&self, axis: Axis) -> Dim<[usize; 0]>

impl RemoveAxis for Dim<[usize; 2]>

fn remove_axis(&self, axis: Axis) -> Dim<[usize; 1]>

impl RemoveAxis for Dim<[usize; 3]>

fn remove_axis(&self, axis: Axis) -> <Dim<[usize; 3]> as Dimension>::Smaller

impl RemoveAxis for Dim<[usize; 4]>

fn remove_axis(&self, axis: Axis) -> <Dim<[usize; 4]> as Dimension>::Smaller

impl RemoveAxis for Dim<[usize; 5]>

fn remove_axis(&self, axis: Axis) -> <Dim<[usize; 5]> as Dimension>::Smaller

impl RemoveAxis for Dim<[usize; 6]>

fn remove_axis(&self, axis: Axis) -> <Dim<[usize; 6]> as Dimension>::Smaller

impl RemoveAxis for Dim<IxDynImpl>

fn remove_axis(&self, axis: Axis) -> Dim<IxDynImpl>

impl<T, Dout> SliceArg<Dim<[usize; 0]>> for SliceInfo<T, Dim<[usize; 0]>, 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.

impl<T, Dout> SliceArg<Dim<[usize; 1]>> for SliceInfo<T, Dim<[usize; 1]>, 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.

impl<T, Dout> SliceArg<Dim<[usize; 2]>> for SliceInfo<T, Dim<[usize; 2]>, 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.

impl<T, Dout> SliceArg<Dim<[usize; 3]>> for SliceInfo<T, Dim<[usize; 3]>, 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.

impl<T, Dout> SliceArg<Dim<[usize; 4]>> for SliceInfo<T, Dim<[usize; 4]>, 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.

impl<T, Dout> SliceArg<Dim<[usize; 5]>> for SliceInfo<T, Dim<[usize; 5]>, 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.

impl<T, Dout> SliceArg<Dim<[usize; 6]>> for SliceInfo<T, Dim<[usize; 6]>, 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.

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

type OutDim = Dim<IxDynImpl>

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.

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.

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: Dim<I>) -> Dim<I>

Performs the - operation.

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

type Output = Dim<[usize; 1]>

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Dim<[usize; 1]>

Performs the - operation.

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

fn sub_assign(&mut self, rhs: &Dim<I>)

Performs the -= operation.

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

fn sub_assign(&mut self, rhs: Dim<I>)

Performs the -= operation.

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

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation.

impl Zero for Dim<[usize; 0]>

fn zero() -> Dim<[usize; 0]>

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

fn zero() -> Dim<[usize; 1]>

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<[usize; 2]>

fn zero() -> Dim<[usize; 2]>

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<[usize; 3]>

fn zero() -> Dim<[usize; 3]>

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<[usize; 4]>

fn zero() -> Dim<[usize; 4]>

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<[usize; 5]>

fn zero() -> Dim<[usize; 5]>

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<[usize; 6]>

fn zero() -> Dim<[usize; 6]>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl NdIndex<Dim<IxDynImpl>> for usize

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

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