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§
Trait Implementations§
source§impl<'a, I> AddAssign<&'a Dim<I>> for Dim<I>where
Dim<I>: Dimension,
impl<'a, I> AddAssign<&'a Dim<I>> for Dim<I>where Dim<I>: Dimension,
source§fn add_assign(&mut self, rhs: &Dim<I>)
fn add_assign(&mut self, rhs: &Dim<I>)
Performs the
+= operation. Read moresource§impl<I> AddAssign<Dim<I>> for Dim<I>where
Dim<I>: Dimension,
impl<I> AddAssign<Dim<I>> for Dim<I>where Dim<I>: Dimension,
source§fn add_assign(&mut self, rhs: Dim<I>)
fn add_assign(&mut self, rhs: Dim<I>)
Performs the
+= operation. Read moresource§impl AddAssign<usize> for Dim<[usize; 1]>
impl AddAssign<usize> for Dim<[usize; 1]>
source§fn add_assign(&mut self, rhs: usize)
fn add_assign(&mut self, rhs: usize)
Performs the
+= operation. Read moresource§impl Dimension for Dim<[usize; 0]>
impl Dimension for Dim<[usize; 0]>
source§const NDIM: Option<usize> = Some(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.source§fn into_pattern(self) -> <Dim<[usize; 0]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 0]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 0]>
fn zeros(ndim: usize) -> Dim<[usize; 0]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<[usize; 1]>
impl Dimension for Dim<[usize; 1]>
source§const NDIM: Option<usize> = Some(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.source§fn into_pattern(self) -> <Dim<[usize; 1]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 1]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 1]>
fn zeros(ndim: usize) -> Dim<[usize; 1]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<[usize; 2]>
impl Dimension for Dim<[usize; 2]>
source§const NDIM: Option<usize> = Some(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.source§fn into_pattern(self) -> <Dim<[usize; 2]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 2]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 2]>
fn zeros(ndim: usize) -> Dim<[usize; 2]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<[usize; 3]>
impl Dimension for Dim<[usize; 3]>
source§const NDIM: Option<usize> = Some(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)
type Pattern = (usize, usize, usize)
Pattern matching friendly form of the dimension value. Read more
source§fn into_pattern(self) -> <Dim<[usize; 3]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 3]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 3]>
fn zeros(ndim: usize) -> Dim<[usize; 3]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<[usize; 4]>
impl Dimension for Dim<[usize; 4]>
source§const NDIM: Option<usize> = Some(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)
type Pattern = (usize, usize, usize, usize)
Pattern matching friendly form of the dimension value. Read more
source§fn into_pattern(self) -> <Dim<[usize; 4]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 4]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 4]>
fn zeros(ndim: usize) -> Dim<[usize; 4]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<[usize; 5]>
impl Dimension for Dim<[usize; 5]>
source§const NDIM: Option<usize> = Some(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)
type Pattern = (usize, usize, usize, usize, usize)
Pattern matching friendly form of the dimension value. Read more
source§fn into_pattern(self) -> <Dim<[usize; 5]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 5]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 5]>
fn zeros(ndim: usize) -> Dim<[usize; 5]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<[usize; 6]>
impl Dimension for Dim<[usize; 6]>
source§const NDIM: Option<usize> = Some(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)
type Pattern = (usize, usize, usize, usize, usize, usize)
Pattern matching friendly form of the dimension value. Read more
source§fn into_pattern(self) -> <Dim<[usize; 6]> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<[usize; 6]> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<[usize; 6]>
fn zeros(ndim: usize) -> Dim<[usize; 6]>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
fn as_array_view(&self) -> ArrayBase<ViewRepr<&usize>, Dim<[usize; 1]>>
Borrow as a read-only array view.
source§impl Dimension for Dim<IxDynImpl>
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.
source§const NDIM: Option<usize> = None
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.source§fn into_pattern(self) -> <Dim<IxDynImpl> as Dimension>::Pattern
fn into_pattern(self) -> <Dim<IxDynImpl> as Dimension>::Pattern
Convert the dimension into a pattern matching friendly value.
source§fn zeros(ndim: usize) -> Dim<IxDynImpl>
fn zeros(ndim: usize) -> Dim<IxDynImpl>
Creates a dimension of all zeros with the specified ndim. Read more
source§fn into_dyn(self) -> Dim<IxDynImpl>
fn into_dyn(self) -> Dim<IxDynImpl>
Convert the dimensional into a dynamic dimensional (IxDyn).
source§fn size_checked(&self) -> Option<usize>
fn size_checked(&self) -> Option<usize>
Compute the size while checking for overflow.
source§impl<'a, I> MulAssign<&'a Dim<I>> for Dim<I>where
Dim<I>: Dimension,
impl<'a, I> MulAssign<&'a Dim<I>> for Dim<I>where Dim<I>: Dimension,
source§fn mul_assign(&mut self, rhs: &Dim<I>)
fn mul_assign(&mut self, rhs: &Dim<I>)
Performs the
*= operation. Read moresource§impl<I> MulAssign<Dim<I>> for Dim<I>where
Dim<I>: Dimension,
impl<I> MulAssign<Dim<I>> for Dim<I>where Dim<I>: Dimension,
source§fn mul_assign(&mut self, rhs: Dim<I>)
fn mul_assign(&mut self, rhs: Dim<I>)
Performs the
*= operation. Read moresource§impl<I> MulAssign<usize> for Dim<I>where
Dim<I>: Dimension,
impl<I> MulAssign<usize> for Dim<I>where Dim<I>: Dimension,
source§fn mul_assign(&mut self, rhs: usize)
fn mul_assign(&mut self, rhs: usize)
Performs the
*= operation. Read moresource§impl<I> PartialEq<Dim<I>> for Dim<I>where
I: PartialEq<I> + ?Sized,
impl<I> PartialEq<Dim<I>> for Dim<I>where I: PartialEq<I> + ?Sized,
source§impl<'a, I> SubAssign<&'a Dim<I>> for Dim<I>where
Dim<I>: Dimension,
impl<'a, I> SubAssign<&'a Dim<I>> for Dim<I>where Dim<I>: Dimension,
source§fn sub_assign(&mut self, rhs: &Dim<I>)
fn sub_assign(&mut self, rhs: &Dim<I>)
Performs the
-= operation. Read moresource§impl<I> SubAssign<Dim<I>> for Dim<I>where
Dim<I>: Dimension,
impl<I> SubAssign<Dim<I>> for Dim<I>where Dim<I>: Dimension,
source§fn sub_assign(&mut self, rhs: Dim<I>)
fn sub_assign(&mut self, rhs: Dim<I>)
Performs the
-= operation. Read moresource§impl SubAssign<usize> for Dim<[usize; 1]>
impl SubAssign<usize> for Dim<[usize; 1]>
source§fn sub_assign(&mut self, rhs: usize)
fn sub_assign(&mut self, rhs: usize)
Performs the
-= operation. Read moreimpl<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; 1]>> for [usize; 1]
impl NdIndex<Dim<[usize; 1]>> for usize
impl NdIndex<Dim<[usize; 2]>> for [usize; 2]
impl NdIndex<Dim<[usize; 3]>> for [usize; 3]
impl NdIndex<Dim<[usize; 4]>> for [usize; 4]
impl NdIndex<Dim<[usize; 5]>> for [usize; 5]
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,
Auto Trait Implementations§
impl<I: ?Sized> RefUnwindSafe for Dim<I>where I: RefUnwindSafe,
impl<I: ?Sized> Send for Dim<I>where I: Send,
impl<I: ?Sized> Sync for Dim<I>where I: Sync,
impl<I: ?Sized> Unpin for Dim<I>where I: Unpin,
impl<I: ?Sized> UnwindSafe for Dim<I>where I: UnwindSafe,
Blanket Implementations§
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,
§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Checks if this value is equivalent to the given key. Read more
source§impl<D> IntoDimension for Dwhere
D: Dimension,
impl<D> IntoDimension for Dwhere D: Dimension,
type Dim = D
fn into_dimension(self) -> D
source§impl<T> ShapeArg for Twhere
T: IntoDimension,
impl<T> ShapeArg for Twhere T: IntoDimension,
source§impl<T> ShapeBuilder for Twhere
T: IntoDimension,
impl<T> ShapeBuilder for Twhere T: IntoDimension,
type Dim = <T as IntoDimension>::Dim
type Strides = T
fn into_shape(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 SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
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
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.