Struct ndarray::SliceInfo

pub struct SliceInfo<T, Din: Dimension, Dout: Dimension> { /* private fields */ }

Represents all of the necessary information to perform a slice.

The type T is typically [SliceInfoElem; n], &[SliceInfoElem], or Vec<SliceInfoElem>. The type Din is the dimension of the array to be sliced, and Dout is the output dimension after calling .slice(). Note that if Din is a fixed dimension type (Ix0, Ix1, Ix2, etc.), the SliceInfo instance can still be used to slice an array with dimension IxDyn as long as the number of axes matches.

Implementations

impl<T, Din, Dout> SliceInfo<T, Din, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Din: Dimension,
    Dout: Dimension, 

pub unsafe fn new(indices: T) -> Result<SliceInfo<T, Din, Dout>, ShapeError>

Returns a new SliceInfo instance.

Errors if Din or Dout is not consistent with indices.

For common types, a safe alternative is to use TryFrom instead.

Safety

The caller must ensure indices.as_ref() always returns the same value when called multiple times.

pub fn in_ndim(&self) -> usize

Returns the number of dimensions of the input array for .slice().

If Din is a fixed-size dimension type, then this is equivalent to Din::NDIM.unwrap(). Otherwise, the value is calculated by iterating over the SliceInfoElem elements.

pub fn out_ndim(&self) -> usize

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

If Dout is a fixed-size dimension type, then this is equivalent to Dout::NDIM.unwrap(). Otherwise, the value is calculated by iterating over the SliceInfoElem elements.

Trait Implementations

impl<T, Din, Dout> AsRef<[SliceInfoElem]> for SliceInfo<T, Din, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Din: Dimension,
    Dout: Dimension, 

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

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

impl<T, Din, Dout> Clone for SliceInfo<T, Din, Dout> where
    T: Clone,
    Din: Dimension,
    Dout: 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, Din: Debug + Dimension, Dout: Debug + Dimension> Debug for SliceInfo<T, Din, Dout>

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

Formats the value using the given formatter.

impl<T, Din, Dout> Deref for SliceInfo<T, Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T, Din, Dout> From<&'a SliceInfo<T, Din, Dout>> for SliceInfo<&'a [SliceInfoElem], Din, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Din: Dimension,
    Dout: Dimension, 

fn from(
    info: &'a SliceInfo<T, Din, Dout>
) -> SliceInfo<&'a [SliceInfoElem], Din, Dout>

Converts to this type from the input type.

impl<T, Dout> SliceArg<Dim<[usize; 0]>> for SliceInfo<T, Ix0, 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, Ix1, 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, Ix2, 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, Ix3, 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, Ix4, 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, Ix5, 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, Ix6, 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, 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<'a, Din, Dout> TryFrom<&'a [SliceInfoElem]> for SliceInfo<&'a [SliceInfoElem], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: &'a [SliceInfoElem]
) -> Result<SliceInfo<&'a [SliceInfoElem], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 0]> for SliceInfo<[SliceInfoElem; 0], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 0]
) -> Result<SliceInfo<[SliceInfoElem; 0], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 1]> for SliceInfo<[SliceInfoElem; 1], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 1]
) -> Result<SliceInfo<[SliceInfoElem; 1], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 2]> for SliceInfo<[SliceInfoElem; 2], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 2]
) -> Result<SliceInfo<[SliceInfoElem; 2], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 3]> for SliceInfo<[SliceInfoElem; 3], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 3]
) -> Result<SliceInfo<[SliceInfoElem; 3], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 4]> for SliceInfo<[SliceInfoElem; 4], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 4]
) -> Result<SliceInfo<[SliceInfoElem; 4], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 5]> for SliceInfo<[SliceInfoElem; 5], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 5]
) -> Result<SliceInfo<[SliceInfoElem; 5], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 6]> for SliceInfo<[SliceInfoElem; 6], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 6]
) -> Result<SliceInfo<[SliceInfoElem; 6], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 7]> for SliceInfo<[SliceInfoElem; 7], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 7]
) -> Result<SliceInfo<[SliceInfoElem; 7], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<[SliceInfoElem; 8]> for SliceInfo<[SliceInfoElem; 8], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: [SliceInfoElem; 8]
) -> Result<SliceInfo<[SliceInfoElem; 8], Din, Dout>, ShapeError>

Performs the conversion.

impl<Din, Dout> TryFrom<Vec<SliceInfoElem, Global>> for SliceInfo<Vec<SliceInfoElem>, Din, Dout> where
    Din: Dimension,
    Dout: Dimension, 

type Error = ShapeError

The type returned in the event of a conversion error.

fn try_from(
    indices: Vec<SliceInfoElem>
) -> Result<SliceInfo<Vec<SliceInfoElem>, Din, Dout>, ShapeError>

Performs the conversion.

impl<T, Din, Dout> Copy for SliceInfo<T, Din, Dout> where
    T: Copy,
    Din: Dimension,
    Dout: Dimension,