Struct ndarray::SliceInfo

#[repr(C)]
pub struct SliceInfo<T: ?Sized, D: Dimension> { /* private fields */ }

Represents all of the necessary information to perform a slice.

The type T is typically [SliceOrIndex; n], [SliceOrIndex], or Vec<SliceOrIndex>. The type D is the output dimension after calling .slice().

Implementations

impl<T, D> SliceInfo<T, D>where
    T: AsRef<[SliceOrIndex]>,
    D: Dimension,

pub fn new(indices: T) -> Result<SliceInfo<T, D>, ShapeError>

Returns a new SliceInfo instance.

Errors if D is not consistent with indices.

impl<T, D> SliceInfo<T, D>where
    T: AsRef<[SliceOrIndex]> + ?Sized,
    D: Dimension,

pub fn out_ndim(&self) -> usize

Returns the number of dimensions after calling .slice() (including taking subviews).

If D is a fixed-size dimension type, then this is equivalent to D::NDIM.unwrap(). Otherwise, the value is calculated by iterating over the ranges/indices.

Trait Implementations

impl<T, D> AsRef<[SliceOrIndex]> for SliceInfo<T, D>where
    T: AsRef<[SliceOrIndex]>,
    D: Dimension,

fn as_ref(&self) -> &[SliceOrIndex]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, D> AsRef<SliceInfo<[SliceOrIndex], D>> for SliceInfo<T, D>where
    T: AsRef<[SliceOrIndex]>,
    D: Dimension,

fn as_ref(&self) -> &SliceInfo<[SliceOrIndex], D>

Converts this type into a shared reference of the (usually inferred) input type.

impl<T, D> Clone for SliceInfo<T, D>where
    T: Clone,
    D: Dimension,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug + ?Sized, D: Debug + Dimension> Debug for SliceInfo<T, D>

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

Formats the value using the given formatter.

impl<T: ?Sized, D> Deref for SliceInfo<T, D>where
    D: Dimension,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T, D> Copy for SliceInfo<T, D>where
    T: Copy,
    D: Dimension,