Struct nalgebra::base::ViewStorage
source · pub struct ViewStorage<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> { /* private fields */ }
Expand description
A matrix data storage for a matrix view. Only contains an internal reference to another matrix data storage.
Implementations§
source§impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorage<'a, T, R, C, RStride, CStride>
sourcepub unsafe fn from_raw_parts(
ptr: *const T,
shape: (R, C),
strides: (RStride, CStride)
) -> Self
pub unsafe fn from_raw_parts( ptr: *const T, shape: (R, C), strides: (RStride, CStride) ) -> Self
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]
.
source§impl<'a, T, R: Dim, C: Dim> ViewStorage<'a, T, R, C, Dyn, Dyn>
impl<'a, T, R: Dim, C: Dim> ViewStorage<'a, T, R, C, Dyn, Dyn>
sourcepub unsafe fn new_unchecked<RStor, CStor, S>(
storage: &'a S,
start: (usize, usize),
shape: (R, C)
) -> ViewStorage<'a, T, R, C, S::RStride, S::CStride>
pub unsafe fn new_unchecked<RStor, CStor, S>( storage: &'a S, start: (usize, usize), shape: (R, C) ) -> ViewStorage<'a, T, R, C, S::RStride, S::CStride>
Create a new matrix view without bounds checking.
§Safety
storage
contains sufficient elements beyond start + R * C
such that all
accesses are within bounds.
sourcepub 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>
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>
source§impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorage<'a, T, R, C, RStride, CStride>where
Self: RawStorage<T, R, C> + IsContiguous,
impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> ViewStorage<'a, T, R, C, RStride, CStride>where
Self: RawStorage<T, R, C> + IsContiguous,
sourcepub fn into_slice(self) -> &'a [T]
pub fn into_slice(self) -> &'a [T]
Extracts the original slice from this storage.
Trait Implementations§
source§impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Clone for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Clone for ViewStorage<'a, T, R, C, RStride, CStride>
source§impl<'a, T: Debug, R: Debug + Dim, C: Debug + Dim, RStride: Debug + Dim, CStride: Debug + Dim> Debug for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T: Debug, R: Debug + Dim, C: Debug + Dim, RStride: Debug + Dim, CStride: Debug + Dim> Debug for ViewStorage<'a, T, R, C, RStride, CStride>
source§impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> RawStorage<T, R, C> for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T, R: Dim, C: Dim, RStride: Dim, CStride: Dim> RawStorage<T, R, C> for ViewStorage<'a, T, R, C, RStride, CStride>
source§fn shape(&self) -> (R, C)
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
.source§fn strides(&self) -> (Self::RStride, Self::CStride)
fn strides(&self) -> (Self::RStride, Self::CStride)
The spacing between consecutive row elements and consecutive column elements. Read more
source§fn is_contiguous(&self) -> bool
fn is_contiguous(&self) -> bool
Indicates whether this data buffer stores its elements contiguously. Read more
source§unsafe fn as_slice_unchecked(&self) -> &[T]
unsafe fn as_slice_unchecked(&self) -> &[T]
Retrieves the data buffer as a contiguous slice. Read more
source§fn linear_index(&self, irow: usize, icol: usize) -> usize
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: Read more
source§fn get_address_unchecked_linear(&self, i: usize) -> *const T
fn get_address_unchecked_linear(&self, i: usize) -> *const T
Gets the address of the i-th matrix component without performing bound-checking. Read more
source§fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T
fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T
Gets the address of the i-th matrix component without performing bound-checking. Read more
source§impl<'a, T, R1, C1, R2, C2> ReshapableStorage<T, R1, C1, R2, C2> for ViewStorage<'a, T, R1, C1, U1, R1>
impl<'a, T, R1, C1, R2, C2> ReshapableStorage<T, R1, C1, R2, C2> for ViewStorage<'a, T, R1, C1, U1, R1>
§type Output = ViewStorage<'a, T, R2, C2, Const<1>, R2>
type Output = ViewStorage<'a, T, R2, C2, Const<1>, R2>
The reshaped storage type.
source§fn reshape_generic(self, nrows: R2, ncols: C2) -> Self::Output
fn reshape_generic(self, nrows: R2, ncols: C2) -> Self::Output
Reshapes the storage into the output storage type.
source§impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Storage<T, R, C> for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Storage<T, R, C> for ViewStorage<'a, T, R, C, RStride, CStride>
source§fn into_owned(self) -> Owned<T, R, C>where
DefaultAllocator: Allocator<R, C>,
fn into_owned(self) -> Owned<T, R, C>where
DefaultAllocator: Allocator<R, C>,
Builds a matrix data storage that does not contain any reference.
source§fn clone_owned(&self) -> Owned<T, R, C>where
DefaultAllocator: Allocator<R, C>,
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.
source§fn forget_elements(self)
fn forget_elements(self)
Drops the storage without calling the destructors on the contained elements.
impl<'a, T: Scalar, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Copy for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T, R: DimName, C: Dim + IsNotStaticOne> IsContiguous for ViewStorage<'a, T, R, C, U1, R>
impl<'a, T, R: Dim, CStride: Dim> IsContiguous for ViewStorage<'a, T, R, U1, U1, CStride>
impl<'a, T: Send, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Send for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T: Sync, R: Dim, C: Dim, RStride: Dim, CStride: Dim> Sync for ViewStorage<'a, T, R, C, RStride, CStride>
Auto Trait Implementations§
impl<'a, T, R, C, RStride, CStride> Freeze for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T, R, C, RStride, CStride> RefUnwindSafe for ViewStorage<'a, T, R, C, RStride, CStride>where
T: RefUnwindSafe,
R: RefUnwindSafe,
C: RefUnwindSafe,
RStride: RefUnwindSafe,
CStride: RefUnwindSafe,
impl<'a, T, R, C, RStride, CStride> Unpin for ViewStorage<'a, T, R, C, RStride, CStride>
impl<'a, T, R, C, RStride, CStride> UnwindSafe for ViewStorage<'a, T, R, C, RStride, CStride>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read moresource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.