Struct StridedBaseArray 

pub struct StridedBaseArray<Data, const NDIM: usize> { /* private fields */ }

Array implementation with explicit non-negative strides.

A logical index maps to the storage offset sum(index[axis] * stride[axis]). The layout may contain gaps, but distinct logical indices may not alias.

Implementations

impl<Data: DataContainer, const NDIM: usize> StridedBaseArray<Data, NDIM>

pub fn new(data: Data, shape: [usize; NDIM], stride: [usize; NDIM]) -> Self

Combine a data container with a shape and stride.

The container may be longer than the reachable storage span.

Panics

Panics if NDIM is zero, the computed data requirement exceeds the container length, or two computed logical offsets are equal. Shape/stride arithmetic uses ordinary usize operations, so callers must provide metadata whose products, offsets, and storage span are representable.

Trait Implementations

impl<Data: DataContainer, const NDIM: usize> BaseItem for StridedBaseArray<Data, NDIM>

type Item = <Data as DataContainer>::Item

Item type.

impl<Data: ContainerType, const NDIM: usize> ContainerType for StridedBaseArray<Data, NDIM>

type Type = <Data as ContainerType>::Type

The type for the container.

fn type_as_str(&self) -> &'static str

Returns the type hint for the container as string ref.

impl<Data: RawAccessDataContainer, const NDIM: usize> RawAccess for StridedBaseArray<Data, NDIM>

fn data(&self) -> Option<&[Self::Item]>

Get a slice of the complete backing storage.

impl<Data: MutableRawAccessDataContainer, const NDIM: usize> RawAccessMut for StridedBaseArray<Data, NDIM>

fn data_mut(&mut self) -> Option<&mut [Self::Item]>

Get a mutable slice of the whole data.

impl<Data: DataContainer, const NDIM: usize> Shape<NDIM> for StridedBaseArray<Data, NDIM>

fn shape(&self) -> [usize; NDIM]

Return the shape of the object.

fn len(&self) -> usize

Return the length, which for n dimension is the product of the dimensions.

fn is_empty(&self) -> bool

Return true if the array is empty.

impl<Data: StableRawAccessDataContainer, const NDIM: usize> StableRawAccessMut for StridedBaseArray<Data, NDIM>

impl<Data, const NDIM: usize> Stride<NDIM> for StridedBaseArray<Data, NDIM>

fn stride(&self) -> [usize; NDIM]

Return the stride of the object.

fn memory_layout(&self) -> MemoryLayout

where Self: Shape<NDIM>,

Return the memory layout.

fn is_contiguous(&self) -> bool

where Self: Shape<NDIM>,

Return true if the array is contiguous in memory.

impl<Data: DisjointRefDataContainerMut, const NDIM: usize> UnsafeDisjointRandom1DAccessMut for StridedBaseArray<Data, NDIM>

impl<Data: RefDataContainer, const NDIM: usize> UnsafeRandom1DAccessByRef for StridedBaseArray<Data, NDIM>

unsafe fn get_1d_unchecked(&self, index: usize) -> &Self::Item

Return a reference to the element at position determined by index.

impl<Data: ValueDataContainer, const NDIM: usize> UnsafeRandom1DAccessByValue for StridedBaseArray<Data, NDIM>

unsafe fn get_value_1d_unchecked(&self, index: usize) -> Self::Item

Return the element at position determined by index.

impl<Data: RefDataContainerMut, const NDIM: usize> UnsafeRandom1DAccessMut for StridedBaseArray<Data, NDIM>

unsafe fn get_1d_unchecked_mut(&mut self, index: usize) -> &mut Self::Item

Return a mutable reference to the element at position determined by index.

impl<Data: RefDataContainer, const NDIM: usize> UnsafeRandomAccessByRef<NDIM> for StridedBaseArray<Data, NDIM>

unsafe fn get_unchecked(&self, multi_index: [usize; NDIM]) -> &Self::Item

Return a reference to the element at position determined by multi_index.

impl<Data: ValueDataContainer, const NDIM: usize> UnsafeRandomAccessByValue<NDIM> for StridedBaseArray<Data, NDIM>

unsafe fn get_value_unchecked(&self, multi_index: [usize; NDIM]) -> Self::Item

Return the element at position determined by multi_index.

impl<Data: RefDataContainerMut, const NDIM: usize> UnsafeRandomAccessMut<NDIM> for StridedBaseArray<Data, NDIM>

unsafe fn get_unchecked_mut( &mut self, multi_index: [usize; NDIM], ) -> &mut Self::Item

Return a mutable reference to the element at position determined by multi_index.