Dim

rssn::prelude::ndarray

Struct Dim

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

Expand description

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 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. Read more

impl<I> Add 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. Read more

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. Read more

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

fn add_assign(&mut self, rhs: usize)

Performs the += operation. Read more

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

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

Performs the += operation. Read more

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

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

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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

fn default() -> Dim<I>

Returns the “default value” for a type. Read more

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

Requires crate feature "serde"

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

Deserialize this value from the given Serde deserializer. Read more

impl<'de> Deserialize<'de> for Dim<IxDynImpl>

Requires crate feature "serde"

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

Deserialize this value from the given Serde deserializer. Read more

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>

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. Read more

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. Read more

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>

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. Read more

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. Read more

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>

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. Read more

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. Read more

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>

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. Read more

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. Read more

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>

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. Read more

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. Read more

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>

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. Read more

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. Read more

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>

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

impl<I> Mul 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. Read more

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. Read more

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

fn mul_assign(&mut self, rhs: usize)

Performs the *= operation. Read more

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

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

Performs the *= operation. Read more

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

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

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

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

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

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

Requires crate feature "serde"

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

Serialize this value into the given Serde serializer. Read more

impl Serialize for Dim<IxDynImpl>

Requires crate feature "serde"

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

Serialize this value into the given Serde serializer. Read more

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 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. Read more

impl<I> Sub 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. Read more

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. Read more

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

fn sub_assign(&mut self, rhs: usize)

Performs the -= operation. Read more

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

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

Performs the -= operation. Read more

impl Zero for Dim<[usize; 0]>

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

Returns the additive identity element of Self, 0. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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. Read more

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 NdIndex<Dim<[usize; 6]>> for (usize, usize, usize, usize, usize, usize)

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

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

impl<const N: usize> NdIndex<Dim<IxDynImpl>> for [usize; N]

impl<const N: usize> NdIndex<Dim<IxDynImpl>> for Dim<[usize; N]>

impl NdIndex<Dim<IxDynImpl>> for usize

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

Auto Trait Implementations§

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

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

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

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

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

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

Blanket Implementations§

impl<T> AlignerFor<1> for T

type Aligner = AlignTo1<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<1024> for T

type Aligner = AlignTo1024<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<128> for T

type Aligner = AlignTo128<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<16> for T

type Aligner = AlignTo16<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<16384> for T

type Aligner = AlignTo16384<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<2> for T

type Aligner = AlignTo2<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<2048> for T

type Aligner = AlignTo2048<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<256> for T

type Aligner = AlignTo256<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<32> for T

type Aligner = AlignTo32<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<32768> for T

type Aligner = AlignTo32768<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<4> for T

type Aligner = AlignTo4<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<4096> for T

type Aligner = AlignTo4096<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<512> for T

type Aligner = AlignTo512<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<64> for T

type Aligner = AlignTo64<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<8> for T

type Aligner = AlignTo8<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> AlignerFor<8192> for T

type Aligner = AlignTo8192<T>

The AlignTo* type which aligns Self to ALIGNMENT.

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<N, R, C, S> ArgminAdd<Matrix<N, R, C, S>, Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>> for N
where N: Scalar + ClosedAddAssign + Copy, R: Dim, C: Dim, S: Storage<N, R, C>, DefaultAllocator: Allocator<N, R, C>,

fn add( &self, other: &Matrix<N, R, C, S>, ) -> Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>

Add a T to self

impl<N, R, C, S> ArgminDot<Matrix<N, R, C, S>, Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>> for N
where N: Scalar + Copy + ClosedMulAssign, R: Dim, C: Dim, S: Storage<N, R, C>, DefaultAllocator: Allocator<N, R, C>,

fn dot( &self, other: &Matrix<N, R, C, S>, ) -> Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>

Dot/scalar product of T and self

impl<N, R, C, S> ArgminMul<Matrix<N, R, C, S>, Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>> for N
where N: Scalar + Copy + ClosedMulAssign, R: Dim, C: Dim, S: Storage<N, R, C>, DefaultAllocator: Allocator<N, R, C>,

fn mul( &self, other: &Matrix<N, R, C, S>, ) -> Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>

(Pointwise) Multiply a T with self

impl<N, R, C, S> ArgminSub<Matrix<N, R, C, S>, Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>> for N
where N: Scalar + Copy + Sub<Output = N>, R: Dim, C: Dim, S: Storage<N, R, C>, DefaultAllocator: Allocator<N, R, C>,

fn sub( &self, other: &Matrix<N, R, C, S>, ) -> Matrix<N, R, C, <DefaultAllocator as Allocator<R, C>>::Buffer<N>>

Subtract a T from self

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<D> DimMax<D> for D
where D: Dimension,

type Output = D

The resulting dimension type after broadcasting.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

const WITNESS: W = W::MAKE

A constant of the type witness

impl<T> Identity for T
where T: ?Sized,

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<D> IntoDimension for D
where D: Dimension,

type Dim = D

fn into_dimension(self) -> D

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

impl<N, A, B> MulAcc<A, B> for N
where &'x A: for<'x> Mul<&'x B, Output = N>, N: AddAssign,

fn mul_acc(&mut self, a: &A, b: &B)

Multiply and accumulate in this variable, formally *self += a * b.

impl<D> NdIndex<D> for D
where D: Dimension,

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

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

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<'a, T> RCowCompatibleRef<'a> for T
where T: Clone + 'a,

type RefC = &'a T

The (preferably) ffi-safe equivalent of &Self.

type ROwned = T

The owned version of Self::RefC.

fn as_c_ref(from: &'a T) -> <T as RCowCompatibleRef<'a>>::RefC

Converts a reference to an FFI-safe type

fn as_rust_ref(from: <T as RCowCompatibleRef<'a>>::RefC) -> &'a T

Converts an FFI-safe type to a reference

impl<S> ROExtAcc for S

fn f_get<F>(&self, offset: FieldOffset<S, F, Aligned>) -> &F

Gets a reference to a field, determined by offset. Read more

fn f_get_mut<F>(&mut self, offset: FieldOffset<S, F, Aligned>) -> &mut F

Gets a muatble reference to a field, determined by offset. Read more

fn f_get_ptr<F, A>(&self, offset: FieldOffset<S, F, A>) -> *const F

Gets a const pointer to a field, the field is determined by offset. Read more

fn f_get_mut_ptr<F, A>(&mut self, offset: FieldOffset<S, F, A>) -> *mut F

Gets a mutable pointer to a field, determined by offset. Read more

impl<S> ROExtOps<Aligned> for S

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Aligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Aligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Aligned>) -> F
where F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

impl<S> ROExtOps<Unaligned> for S

fn f_replace<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, value: F) -> F

Replaces a field (determined by offset) with value, returning the previous value of the field. Read more

fn f_swap<F>(&mut self, offset: FieldOffset<S, F, Unaligned>, right: &mut S)

Swaps a field (determined by offset) with the same field in right. Read more

fn f_get_copy<F>(&self, offset: FieldOffset<S, F, Unaligned>) -> F
where F: Copy,

Gets a copy of a field (determined by offset). The field is determined by offset. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> SelfOps for T
where T: ?Sized,

fn eq_id(&self, other: &Self) -> bool

Compares the address of self with the address of other. Read more

fn piped<F, U>(self, f: F) -> U
where F: FnOnce(Self) -> U, Self: Sized,

Emulates the pipeline operator, allowing method syntax in more places. Read more

fn piped_ref<'a, F, U>(&'a self, f: F) -> U
where F: FnOnce(&'a Self) -> U,

The same as piped except that the function takes &Self Useful for functions that take &Self instead of Self. Read more

fn piped_mut<'a, F, U>(&'a mut self, f: F) -> U
where F: FnOnce(&'a mut Self) -> U,

The same as piped, except that the function takes &mut Self. Useful for functions that take &mut Self instead of Self.

fn mutated<F>(self, f: F) -> Self
where F: FnOnce(&mut Self), Self: Sized,

Mutates self using a closure taking self by mutable reference, passing it along the method chain. Read more

fn observe<F>(self, f: F) -> Self
where F: FnOnce(&Self), Self: Sized,

Observes the value of self, passing it along unmodified. Useful in long method chains. Read more

fn into_<T>(self) -> T
where Self: Into<T>,

Performs a conversion with Into. using the turbofish .into_::<_>() syntax. Read more

fn as_ref_<T>(&self) -> &T
where Self: AsRef<T>, T: ?Sized,

Performs a reference to reference conversion with AsRef, using the turbofish .as_ref_::<_>() syntax. Read more

fn as_mut_<T>(&mut self) -> &mut T
where Self: AsMut<T>, T: ?Sized,

Performs a mutable reference to mutable reference conversion with AsMut, using the turbofish .as_mut_::<_>() syntax. Read more

fn drop_(self)
where Self: Sized,

Drops self using method notation. Alternative to std::mem::drop. Read more

impl<T> ShapeArg for T
where T: IntoDimension,

type Dim = <T as IntoDimension>::Dim

fn into_shape_and_order(self) -> (<T as ShapeArg>::Dim, Option<Order>)

impl<T> ShapeBuilder for T
where T: IntoDimension,

type Dim = <T as IntoDimension>::Dim

type Strides = T

fn into_shape_with_order(self) -> Shape<<T as ShapeBuilder>::Dim>

fn f(self) -> Shape<<T as ShapeBuilder>::Dim>

fn set_f(self, is_f: bool) -> Shape<<T as ShapeBuilder>::Dim>

fn strides(self, st: T) -> StrideShape<<T as ShapeBuilder>::Dim>

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<This> TransmuteElement for This
where This: ?Sized,

unsafe fn transmute_element<T>(self) -> Self::TransmutedPtr
where Self: CanTransmuteElement<T>,

Transmutes the element type of this pointer.. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> TypeIdentity for T
where T: ?Sized,

type Type = T

This is always Self.

fn into_type(self) -> Self::Type
where Self: Sized, Self::Type: Sized,

Converts a value back to the original type.

fn as_type(&self) -> &Self::Type

Converts a reference back to the original type.

fn as_type_mut(&mut self) -> &mut Self::Type

Converts a mutable reference back to the original type.

fn into_type_box(self: Box<Self>) -> Box<Self::Type>

Converts a box back to the original type.

fn into_type_arc(this: Arc<Self>) -> Arc<Self::Type>

Converts an Arc back to the original type. Read more

fn into_type_rc(this: Rc<Self>) -> Rc<Self::Type>

Converts an Rc back to the original type. Read more

fn from_type(this: Self::Type) -> Self
where Self: Sized, Self::Type: Sized,

Converts a value back to the original type.

fn from_type_ref(this: &Self::Type) -> &Self

Converts a reference back to the original type.

fn from_type_mut(this: &mut Self::Type) -> &mut Self

Converts a mutable reference back to the original type.

fn from_type_box(this: Box<Self::Type>) -> Box<Self>

Converts a box back to the original type.

fn from_type_arc(this: Arc<Self::Type>) -> Arc<Self>

Converts an Arc back to the original type.

fn from_type_rc(this: Rc<Self::Type>) -> Rc<Self>

Converts an Rc back to the original type.

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

fn vzip(self) -> V

impl<T, Right> ClosedAdd<Right> for T
where T: Add<Right, Output = T> + AddAssign<Right>,

impl<T, Right> ClosedAdd<Right> for T
where T: Add<Right, Output = T> + AddAssign<Right>,

impl<T, Right> ClosedAddAssign<Right> for T
where T: ClosedAdd<Right> + AddAssign<Right>,

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

impl<T, Right> ClosedMul<Right> for T
where T: Mul<Right, Output = T> + MulAssign<Right>,

impl<T, Right> ClosedMulAssign<Right> for T
where T: ClosedMul<Right> + MulAssign<Right>,

impl<T, Right> ClosedSub<Right> for T
where T: Sub<Right, Output = T> + SubAssign<Right>,

impl<T, Right> ClosedSub<Right> for T
where T: Sub<Right, Output = T> + SubAssign<Right>,

impl<T, Right> ClosedSubAssign<Right> for T
where T: ClosedSub<Right> + SubAssign<Right>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

impl<T> SendAlias for T

impl<T> SyncAlias for T

impl<This> ValidTag_Bounds for This
where This: Debug + Clone + PartialEq,