extendr_api::prelude

Struct SliceInfo

Source 
pub struct SliceInfo<T, Din, Dout>
where
    Din: Dimension,
    Dout: Dimension,
{
    in_dim: PhantomData<Din>,
    out_dim: PhantomData<Dout>,
    indices: T,
}
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.

Fields§

§in_dim: PhantomData<Din>§out_dim: PhantomData<Dout>§indices: T

Implementations§

Source§

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

Source

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.

Source

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.

Source

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§

Source§

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

Source§

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

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

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

Source§

fn clone(&self) -> SliceInfo<T, Din, Dout>

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

type Target = T

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

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,

Source§

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

Converts to this type from the input type.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type OutDim = Dout

Dimensionality of the output array.
Source§

fn in_ndim(&self) -> usize

Returns the number of axes in the input array.
Source§

fn out_ndim(&self) -> usize

Returns the number of axes in the output array.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

type Error = ShapeError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Auto Trait Implementations§

§

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

§

impl<T, Din, Dout> RefUnwindSafe for SliceInfo<T, Din, Dout>
where T: RefUnwindSafe, Din: RefUnwindSafe, Dout: 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 T: Unpin, Din: Unpin, Dout: Unpin,

§

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

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'short, T, Target> AsGeneralizedRef<'short, &'short Target> for T
where T: AsRef<Target> + ?Sized, Target: ?Sized,

§

fn as_generalized_ref(&'short self) -> &'short Target

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.