Struct ViewStorage

pub struct ViewStorage<'a, T, R, C, RStride, CStride>
where
    R: Dim,
    C: Dim,
    RStride: Dim,
    CStride: Dim,
{ /* private fields */ }

A matrix data storage for a matrix view. Only contains an internal reference to another matrix data storage.

Implementations

impl<'a, T, R, C, RStride, CStride> ViewStorage<'a, T, R, C, RStride, CStride>

where R: Dim, C: Dim, RStride: Dim, CStride: Dim,

pub unsafe fn from_raw_parts( ptr: *const T, shape: (R, C), strides: (RStride, CStride), ) -> ViewStorage<'a, T, R, C, RStride, CStride>

where RStride: Dim, CStride: Dim,

Create a new matrix view without bounds checking and from a raw pointer.

Safety

*ptr must point to memory that is valid [T; R * C].

impl<'a, T, R, C> ViewStorage<'a, T, R, C, Dyn, Dyn>

where R: Dim, C: Dim,

pub unsafe fn new_unchecked<RStor, CStor, S>( storage: &'a S, start: (usize, usize), shape: (R, C), ) -> ViewStorage<'a, T, R, C, <S as RawStorage<T, RStor, CStor>>::RStride, <S as RawStorage<T, RStor, CStor>>::CStride>

where RStor: Dim, CStor: Dim, S: RawStorage<T, RStor, CStor>,

Create a new matrix view without bounds checking.

Safety

storage contains sufficient elements beyond start + R * C such that all accesses are within bounds.

pub unsafe fn new_with_strides_unchecked<S, RStor, CStor, RStride, CStride>( storage: &'a S, start: (usize, usize), shape: (R, C), strides: (RStride, CStride), ) -> ViewStorage<'a, T, R, C, RStride, CStride>

where RStor: Dim, CStor: Dim, S: RawStorage<T, RStor, CStor>, RStride: Dim, CStride: Dim,

Create a new matrix view without bounds checking.

Safety

strides must be a valid stride indexing.

impl<'a, T, R, C, RStride, CStride> ViewStorage<'a, T, R, C, RStride, CStride>

where R: Dim, C: Dim, RStride: Dim, CStride: Dim, ViewStorage<'a, T, R, C, RStride, CStride>: RawStorage<T, R, C> + IsContiguous,

pub fn into_slice(self) -> &'a [T]

Extracts the original slice from this storage.

Trait Implementations

impl<'a, T, R, C, RStride, CStride> Clone for ViewStorage<'a, T, R, C, RStride, CStride>

where T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim,

fn clone(&self) -> ViewStorage<'a, T, R, C, RStride, CStride>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T, R, C, RStride, CStride> Debug for ViewStorage<'a, T, R, C, RStride, CStride>

where T: Debug, R: Debug + Dim, C: Debug + Dim, RStride: Debug + Dim, CStride: Debug + Dim,

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

Formats the value using the given formatter.

impl<'a, T, R, C, RStride, CStride> RawStorage<T, R, C> for ViewStorage<'a, T, R, C, RStride, CStride>

where R: Dim, C: Dim, RStride: Dim, CStride: Dim,

type RStride = RStride

The static stride of this storage’s rows.

type CStride = CStride

The static stride of this storage’s columns.

fn ptr(&self) -> *const T

The matrix data pointer.

fn shape(&self) -> (R, C)

The dimension of the matrix at run-time. Arr length of zero indicates the additive identity element of any dimension. Must be equal to Self::dimension() if it is not None.

fn strides( &self, ) -> (<ViewStorage<'a, T, R, C, RStride, CStride> as RawStorage<T, R, C>>::RStride, <ViewStorage<'a, T, R, C, RStride, CStride> as RawStorage<T, R, C>>::CStride)

The spacing between consecutive row elements and consecutive column elements.

fn is_contiguous(&self) -> bool

Indicates whether this data buffer stores its elements contiguously.

unsafe fn as_slice_unchecked(&self) -> &[T]

Retrieves the data buffer as a contiguous slice.

fn linear_index(&self, irow: usize, icol: usize) -> usize

Compute the index corresponding to the irow-th row and icol-th column of this matrix. The index must be such that the following holds:

fn get_address_unchecked_linear(&self, i: usize) -> *const T

Gets the address of the i-th matrix component without performing bound-checking.

fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T

Gets the address of the i-th matrix component without performing bound-checking.

unsafe fn get_unchecked_linear(&self, i: usize) -> &T

Retrieves a reference to the i-th element without bound-checking.

unsafe fn get_unchecked(&self, irow: usize, icol: usize) -> &T

Retrieves a reference to the i-th element without bound-checking.

impl<'a, T, R1, C1, R2, C2> ReshapableStorage<T, R1, C1, R2, C2> for ViewStorage<'a, T, R1, C1, Const<1>, R1>

where T: Scalar, R1: Dim, C1: Dim, R2: Dim, C2: Dim,

type Output = ViewStorage<'a, T, R2, C2, Const<1>, R2>

The reshaped storage type.

fn reshape_generic( self, nrows: R2, ncols: C2, ) -> <ViewStorage<'a, T, R1, C1, Const<1>, R1> as ReshapableStorage<T, R1, C1, R2, C2>>::Output

Reshapes the storage into the output storage type.

impl<'a, T, R, C, RStride, CStride> Storage<T, R, C> for ViewStorage<'a, T, R, C, RStride, CStride>

where T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim,

fn into_owned(self) -> <DefaultAllocator as Allocator<R, C>>::Buffer<T>

where DefaultAllocator: Allocator<R, C>,

Builds a matrix data storage that does not contain any reference.

fn clone_owned(&self) -> <DefaultAllocator as Allocator<R, C>>::Buffer<T>

where DefaultAllocator: Allocator<R, C>,

Clones this data storage to one that does not contain any reference.

fn forget_elements(self)

Drops the storage without calling the destructors on the contained elements.

impl<'a, T, R, C, RStride, CStride> Copy for ViewStorage<'a, T, R, C, RStride, CStride>

where T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim,

impl<'a, T, R, C> IsContiguous for ViewStorage<'a, T, R, C, Const<1>, R>

where R: DimName, C: Dim + IsNotStaticOne,

impl<'a, T, R, CStride> IsContiguous for ViewStorage<'a, T, R, Const<1>, Const<1>, CStride>

where R: Dim, CStride: Dim,

impl<'a, T, R, C, RStride, CStride> Send for ViewStorage<'a, T, R, C, RStride, CStride>

where T: Send, R: Dim, C: Dim, RStride: Dim, CStride: Dim,

impl<'a, T, R, C, RStride, CStride> Sync for ViewStorage<'a, T, R, C, RStride, CStride>

where T: Sync, R: Dim, C: Dim, RStride: Dim, CStride: Dim,