Struct ViewStorageMut

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

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

Implementations

impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorageMut<'a, T, R, C, RStride, CStride>

pub unsafe fn from_raw_parts( ptr: *mut T, shape: (R, C), strides: (RStride, CStride), ) -> Self

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: Dim, C: Dim> ViewStorageMut<'a, T, R, C, Dyn, Dyn>

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

where RStor: Dim, CStor: Dim, S: RawStorageMut<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 mut S, start: (usize, usize), shape: (R, C), strides: (RStride, CStride), ) -> ViewStorageMut<'a, T, R, C, RStride, CStride>

where RStor: Dim, CStor: Dim, S: RawStorageMut<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: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorageMut<'a, T, R, C, RStride, CStride>

where Self: RawStorage<T, R, C> + IsContiguous,

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

Extracts the original slice from this storage.

impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorageMut<'a, T, R, C, RStride, CStride>

where Self: RawStorageMut<T, R, C> + IsContiguous,

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

Extracts the original slice from this storage

Trait Implementations

impl<'a, T: Debug, R: Debug + Dim, C: Debug + Dim, RStride: Debug + Dim, CStride: Debug + Dim> Debug for ViewStorageMut<'a, T, R, C, RStride, CStride>

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

Formats the value using the given formatter.

impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> RawStorage<T, R, C> for ViewStorageMut<'a, T, R, C, RStride, CStride>

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) -> (Self::RStride, Self::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, R: Dim, C: Dim, RStride: Dim, CStride: Dim> RawStorageMut<T, R, C> for ViewStorageMut<'a, T, R, C, RStride, CStride>

fn ptr_mut(&mut self) -> *mut T

The matrix mutable data pointer.

unsafe fn as_mut_slice_unchecked(&mut self) -> &mut [T]

Retrieves the mutable data buffer as a contiguous slice.

fn get_address_unchecked_linear_mut(&mut self, i: usize) -> *mut T

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

fn get_address_unchecked_mut(&mut self, irow: usize, icol: usize) -> *mut T

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

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

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

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

Retrieves a mutable reference to the element at (irow, icol) without bound-checking.

unsafe fn swap_unchecked_linear(&mut self, i1: usize, i2: usize)

Swaps two elements using their linear index without bound-checking.

unsafe fn swap_unchecked( &mut self, row_col1: (usize, usize), row_col2: (usize, usize), )

Swaps two elements without bound-checking.

impl<'a, T, R1, C1, R2, C2> ReshapableStorage<T, R1, C1, R2, C2> for ViewStorageMut<'a, T, R1, C1, U1, R1>

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

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

The reshaped storage type.

fn reshape_generic(self, nrows: R2, ncols: C2) -> Self::Output

Reshapes the storage into the output storage type.

impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Storage<T, R, C> for ViewStorageMut<'a, T, R, C, RStride, CStride>

fn into_owned(self) -> Owned<T, R, C>

where DefaultAllocator: Allocator<R, C>,

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

fn clone_owned(&self) -> Owned<T, R, C>

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: DimName, C: Dim + IsNotStaticOne> IsContiguous for ViewStorageMut<'a, T, R, C, U1, R>

impl<'a, T, R: Dim, CStride: Dim> IsContiguous for ViewStorageMut<'a, T, R, U1, U1, CStride>

impl<'a, T: Send, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Send for ViewStorageMut<'a, T, R, C, RStride, CStride>

impl<'a, T: Sync, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Sync for ViewStorageMut<'a, T, R, C, RStride, CStride>