Struct nalgebra::base::VecStorage

#[repr(C)]
pub struct VecStorage<N, R: Dim, C: Dim> { /* fields omitted */ }

A Vec-based matrix data storage. It may be dynamically-sized.

Implementations

impl<N, R: Dim, C: Dim> VecStorage<N, R, C>

pub fn new(nrows: R, ncols: C, data: Vec<N>) -> Self

Creates a new dynamic matrix data storage from the given vector and shape.

pub fn as_vec(&self) -> &Vec<N>

The underlying data storage.

pub unsafe fn as_vec_mut(&mut self) -> &mut Vec<N>

The underlying mutable data storage.

This is unsafe because this may cause UB if the size of the vector is changed by the user.

pub unsafe fn resize(self, sz: usize) -> Vec<N>

Resizes the underlying mutable data storage and unwraps it.

If sz is larger than the current size, additional elements are uninitialized. If sz is smaller than the current size, additional elements are truncated.

pub fn len(&self) -> usize

The number of elements on the underlying vector.

pub fn is_empty(&self) -> bool

Returns true if the underlying vector contains no elements.

Trait Implementations

impl<N: Clone, R: Clone + Dim, C: Clone + Dim> Clone for VecStorage<N, R, C>

fn clone(&self) -> VecStorage<N, R, C>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N: Debug, R: Debug + Dim, C: Debug + Dim> Debug for VecStorage<N, R, C>

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

Formats the value using the given formatter.

impl<'a, N: 'a + Copy, R: Dim> Extend<&'a N> for VecStorage<N, R, Dynamic>

fn extend<I: IntoIterator<Item = &'a N>>(&mut self, iter: I)

Extends the number of columns of the VecStorage with elements from the given iterator.

Panics

This function panics if the number of elements yielded by the given iterator is not a multiple of the number of rows of the VecStorage.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<N, R, RV, SV> Extend<Matrix<N, RV, U1, SV>> for VecStorage<N, R, Dynamic> where
    N: Scalar,
    R: Dim,
    RV: Dim,
    SV: Storage<N, RV>,
    ShapeConstraint: SameNumberOfRows<R, RV>, 

fn extend<I: IntoIterator<Item = Vector<N, RV, SV>>>(&mut self, iter: I)

Extends the number of columns of the VecStorage with vectors from the given iterator.

Panics

This function panics if the number of rows of each Vector yielded by the iterator is not equal to the number of rows of this VecStorage.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<N, R: Dim> Extend<N> for VecStorage<N, R, Dynamic>

fn extend<I: IntoIterator<Item = N>>(&mut self, iter: I)

Extends the number of columns of the VecStorage with elements from the given iterator.

Panics

This function panics if the number of elements yielded by the given iterator is not a multiple of the number of rows of the VecStorage.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<N> Extend<N> for VecStorage<N, Dynamic, U1>

fn extend<I: IntoIterator<Item = N>>(&mut self, iter: I)

Extends the number of rows of the VecStorage with elements from the given iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<N, R: Dim, C: Dim> Into<Vec<N, Global>> for VecStorage<N, R, C>

fn into(self) -> Vec<N>

Performs the conversion.

impl<N: PartialEq, R: PartialEq + Dim, C: PartialEq + Dim> PartialEq<VecStorage<N, R, C>> for VecStorage<N, R, C>

fn eq(&self, other: &VecStorage<N, R, C>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &VecStorage<N, R, C>) -> bool

This method tests for !=.

impl<N, C1, C2> ReshapableStorage<N, Dynamic, C1, Dynamic, C2> for VecStorage<N, Dynamic, C1> where
    N: Scalar,
    C1: Dim,
    C2: Dim, 

type Output = VecStorage<N, Dynamic, C2>

The reshaped storage type.

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

Reshapes the storage into the output storage type.

impl<N, C1, R2> ReshapableStorage<N, Dynamic, C1, R2, Dynamic> for VecStorage<N, Dynamic, C1> where
    N: Scalar,
    C1: Dim,
    R2: DimName, 

type Output = VecStorage<N, R2, Dynamic>

The reshaped storage type.

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

Reshapes the storage into the output storage type.

impl<N, R1, C2> ReshapableStorage<N, R1, Dynamic, Dynamic, C2> for VecStorage<N, R1, Dynamic> where
    N: Scalar,
    R1: DimName,
    C2: Dim, 

type Output = VecStorage<N, Dynamic, C2>

The reshaped storage type.

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

Reshapes the storage into the output storage type.

impl<N, R1, R2> ReshapableStorage<N, R1, Dynamic, R2, Dynamic> for VecStorage<N, R1, Dynamic> where
    N: Scalar,
    R1: DimName,
    R2: DimName, 

type Output = VecStorage<N, R2, Dynamic>

The reshaped storage type.

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

Reshapes the storage into the output storage type.

impl<N: Scalar, C: Dim> Storage<N, Dynamic, C> for VecStorage<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C, Buffer = Self>, 

type RStride = U1

The static stride of this storage’s rows.

type CStride = Dynamic

The static stride of this storage’s columns.

fn ptr(&self) -> *const N

The matrix data pointer.

fn shape(&self) -> (Dynamic, 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.

fn into_owned(self) -> Owned<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C>, 

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

fn clone_owned(&self) -> Owned<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C>, 

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

fn as_slice(&self) -> &[N]

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:

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

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

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

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

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

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

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

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

impl<N: Scalar, R: DimName> Storage<N, R, Dynamic> for VecStorage<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic, Buffer = Self>, 

type RStride = U1

The static stride of this storage’s rows.

type CStride = R

The static stride of this storage’s columns.

fn ptr(&self) -> *const N

The matrix data pointer.

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

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.

fn into_owned(self) -> Owned<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic>, 

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

fn clone_owned(&self) -> Owned<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic>, 

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

fn as_slice(&self) -> &[N]

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:

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

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

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

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

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

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

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

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

impl<N: Scalar, C: Dim> StorageMut<N, Dynamic, C> for VecStorage<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C, Buffer = Self>, 

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

The matrix mutable data pointer.

fn as_mut_slice(&mut self) -> &mut [N]

Retrieves the mutable data buffer as a contiguous slice.

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

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

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

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 N

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

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

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<N: Scalar, R: DimName> StorageMut<N, R, Dynamic> for VecStorage<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic, Buffer = Self>, 

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

The matrix mutable data pointer.

fn as_mut_slice(&mut self) -> &mut [N]

Retrieves the mutable data buffer as a contiguous slice.

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

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

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

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 N

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

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

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<N: Scalar, C: Dim> ContiguousStorage<N, Dynamic, C> for VecStorage<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C, Buffer = Self>, 

impl<N: Scalar, R: DimName> ContiguousStorage<N, R, Dynamic> for VecStorage<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic, Buffer = Self>, 

impl<N: Scalar, C: Dim> ContiguousStorageMut<N, Dynamic, C> for VecStorage<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C, Buffer = Self>, 

impl<N: Scalar, R: DimName> ContiguousStorageMut<N, R, Dynamic> for VecStorage<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic, Buffer = Self>, 

impl<N: Eq, R: Eq + Dim, C: Eq + Dim> Eq for VecStorage<N, R, C>

impl<N, R: Dim, C: Dim> StructuralEq for VecStorage<N, R, C>

impl<N, R: Dim, C: Dim> StructuralPartialEq for VecStorage<N, R, C>