pub struct Dim<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]));
Create a new dimension value with n axes, all zeros
The resulting type after applying the + operator.
The resulting type after applying the + operator.
Source§Available on crate feature serde only.
Requires crate feature "serde"
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The sum of the two dimensions.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
The resulting dimension type after broadcasting.
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size of the dimension (number of elements)
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size of the dimension (number of elements)
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size of the dimension (number of elements)
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Compute the size of the dimension (number of elements)
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size of the dimension (number of elements)
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size of the dimension (number of elements)
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
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.
Pattern matching friendly form of the dimension value. Read more
Next smaller dimension (if applicable)
Next larger dimension
Returns the number of dimensions (number of axes).
Convert the dimension into a pattern matching friendly value.
Creates a dimension of all zeros with the specified ndim. Read more
Compute the size of the dimension (number of elements)
Compute the size while checking for overflow.
Borrow as a read-only array view.
Borrow as a read-write array view.
Convert the dimensional into a dynamic dimensional (IxDyn).
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The returned type after indexing.
Performs the indexing (container[index]) operation. Read more
The resulting type after applying the * operator.
The resulting type after applying the * operator.
Tests for self and other values to be equal, and is used by ==.
Tests for !=. The default implementation is almost always sufficient,
and should not be overridden without very good reason.
Tests for self and other values to be equal, and is used by ==.
Tests for !=. The default implementation is almost always sufficient,
and should not be overridden without very good reason.
Remove the specified axis from a dimension.
Remove the specified axis from a dimension.
Remove the specified axis from a dimension.
Remove the specified axis from a dimension.
Remove the specified axis from a dimension.
Remove the specified axis from a dimension.
Remove the specified axis from a dimension.
Source§Available on crate feature serde only.
Requires crate feature "serde"
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
Dimensionality of the output array.
Returns the number of axes in the input array.
Returns the number of axes in the output array.
The resulting type after applying the - operator.
The resulting type after applying the - operator.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.
Returns the additive identity element of Self, 0. Read more
Returns true if self is equal to the additive identity.
Sets self to the additive identity element of Self, 0.