Struct tract_core::internal::tract_ndarray::SliceInfo[−][src]

pub struct SliceInfo<T, Din, Dout> where
    Din: Dimension,
    Dout: Dimension,  { /* fields omitted */ }
Expand description

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, [src]

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

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[src]

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[src]

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, [src]

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

Notable traits for &'_ [u8]

impl<'_> Read for &'_ [u8]impl<'_> Write for &'_ mut [u8]
[src]

Performs the conversion.

impl<T, Din, Dout> Clone for SliceInfo<T, Din, Dout> where
    T: Clone,
    Din: Dimension,
    Dout: Dimension, [src]

pub fn clone(&self) -> SliceInfo<T, Din, Dout>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0[src]

Performs copy-assignment from source. Read more

impl<T, Din, Dout> Debug for SliceInfo<T, Din, Dout> where
    T: Debug,
    Din: Debug + Dimension,
    Dout: Debug + Dimension, [src]

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

Formats the value using the given formatter. Read more

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

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &<SliceInfo<T, Din, Dout> as Deref>::Target[src]

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, [src]

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

Performs the conversion.

impl<T, Dout> SliceArg<Dim<[usize; 0]>> for SliceInfo<T, Dim<[usize; 0]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<T, Dout> SliceArg<Dim<[usize; 1]>> for SliceInfo<T, Dim<[usize; 1]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<T, Dout> SliceArg<Dim<[usize; 2]>> for SliceInfo<T, Dim<[usize; 2]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<T, Dout> SliceArg<Dim<[usize; 3]>> for SliceInfo<T, Dim<[usize; 3]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<T, Dout> SliceArg<Dim<[usize; 4]>> for SliceInfo<T, Dim<[usize; 4]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<T, Dout> SliceArg<Dim<[usize; 5]>> for SliceInfo<T, Dim<[usize; 5]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<T, Dout> SliceArg<Dim<[usize; 6]>> for SliceInfo<T, Dim<[usize; 6]>, Dout> where
    T: AsRef<[SliceInfoElem]>,
    Dout: Dimension, [src]

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

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

type OutDim = Dout

Dimensionality of the output array.

pub fn in_ndim(&self) -> usize[src]

Returns the number of axes in the input array.

pub fn out_ndim(&self) -> usize[src]

Returns the number of axes in the output array.

fn __private__(&self) -> PrivateMarker[src]

This trait is private to implement; this method exists to make it impossible to implement outside the crate. Read more

impl<'a, Din, Dout> TryFrom<&'a [SliceInfoElem]> for SliceInfo<&'a [SliceInfoElem], Din, Dout> where
    Din: Dimension,
    Dout: Dimension, [src]

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ShapeError

The type returned in the event of a conversion error.

pub fn try_from(
    indices: Vec<SliceInfoElem, Global>
) -> Result<SliceInfo<Vec<SliceInfoElem, Global>, Din, Dout>, ShapeError>[src]

Performs the conversion.

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

Auto Trait Implementations

impl<T, Din, Dout> RefUnwindSafe for SliceInfo<T, Din, Dout> where
    Din: RefUnwindSafe,
    Dout: RefUnwindSafe,
    T: RefUnwindSafe, 

impl<T, Din, Dout> Send for SliceInfo<T, Din, Dout> where
    T: Send, 

impl<T, Din, Dout> Sync for SliceInfo<T, Din, Dout> where
    T: Sync, 

impl<T, Din, Dout> Unpin for SliceInfo<T, Din, Dout> where
    Din: Unpin,
    Dout: Unpin,
    T: Unpin, 

impl<T, Din, Dout> UnwindSafe for SliceInfo<T, Din, Dout> where
    Din: UnwindSafe,
    Dout: UnwindSafe,
    T: UnwindSafe, 

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any, [src]

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>ⓘ

Notable traits for Box<R, Global>

impl<R> Read for Box<R, Global> where
    R: Read + ?Sized, impl<W> Write for Box<W, Global> where
    W: Write + ?Sized, impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static,  type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    A: Allocator,
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;
[src]

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>[src]

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)[src]

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)[src]

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync, [src]

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Sync + Send>[src]

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> DynClone for T where
    T: Clone, [src]

pub fn __clone_box(&self, Private) -> *mut ()[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

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

pub fn clone_into(&self, target: &mut T)[src]

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

recently added

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

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.