VecStorage in nalgebra::base - Rust
Description: A Vec-based matrix data storage. It may be dynamically-sized.
Keywords: rust, rustlang, rust-lang, VecStorage

# Struct nalgebra::base::VecStorage

source ·

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

Expand description

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

## Implementations§

source§

### impl<T, R: Dim, C: Dim> VecStorage<T, R, C>

source

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

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

source

#### pub fn as_vec(&self) -> &Vec<T>

The underlying data storage.

source

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

The underlying mutable data storage.

##### Safety

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

source

#### pub unsafe fn resize(self, sz: usize) -> Vec<MaybeUninit<T>>

Resizes the underlying mutable data storage and unwraps it.

##### Safety

- If `sz` is larger than the current size, additional elements are uninitialized.
- If `sz` is smaller than the current size, additional elements are truncated but not dropped. It is the responsibility of the caller of this method to drop these elements.

source

#### pub fn len(&self) -> usize

The number of elements on the underlying vector.

source

#### pub fn is_empty(&self) -> bool

Returns true if the underlying vector contains no elements.

source

#### pub fn as_slice(&self) -> &[T]

A slice containing all the components stored in this storage in column-major order.

source

#### pub fn as_mut_slice(&mut self) -> &mut [T]

A mutable slice containing all the components stored in this storage in column-major order.

## Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

### impl<'a, T: 'a + Copy, R: Dim> Extend<&'a T> for VecStorage<T, R, Dyn>

source§

#### fn extend<I: IntoIterator<Item = &'a T>>(&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`.

source§

#### fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (`extend_one`)
Extends a collection with exactly one element.
source§

#### 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. Read more
source§

### impl<T, R, RV, SV> Extend<Matrix<T, RV, Const<1>, SV>> for VecStorage<T, R, Dyn>where
T: Scalar,
R: Dim,
RV: Dim,
SV: RawStorage<T, RV>,
ShapeConstraint: SameNumberOfRows<R, RV>,

source§

#### fn extend<I: IntoIterator<Item = Vector<T, 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`.

source§

#### fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (`extend_one`)
Extends a collection with exactly one element.
source§

#### 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. Read more
source§

### impl<T> Extend<T> for VecStorage<T, Dyn, U1>

source§

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

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

source§

#### fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (`extend_one`)
Extends a collection with exactly one element.
source§

#### 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. Read more
source§

### impl<T, R: Dim> Extend<T> for VecStorage<T, R, Dyn>

source§

#### fn extend<I: IntoIterator<Item = T>>(&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`.

source§

#### fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (`extend_one`)
Extends a collection with exactly one element.
source§

#### 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. Read more
source§

### impl<T, R: Dim, C: Dim> From<VecStorage<T, R, C>> for Vec<T>

source§

#### fn from(vec: VecStorage<T, R, C>) -> Self

Converts to this type from the input type.
source§

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

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more
1.0.0 · source§

#### fn ne(&self, other: &Rhs) -> bool

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
source§

### impl<T, C: Dim> RawStorage<T, Dyn, C> for VecStorage<T, Dyn, C>

§

#### type RStride = Const<1>

The static stride of this storage’s rows.
§

#### type CStride = Dyn

The static stride of this storage’s columns.
source§

#### fn ptr(&self) -> *const T

The matrix data pointer.
source§

#### fn shape(&self) -> (Dyn, 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`. Read more
source§

#### 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

Indicates whether this data buffer stores its elements contiguously. Read more
source§

#### 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

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

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

Gets the address of the i-th matrix component without performing bound-checking. Read more
source§

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

Retrieves a reference to the i-th element without bound-checking. Read more
source§

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

Retrieves a reference to the i-th element without bound-checking. Read more
source§

### impl<T, R: DimName> RawStorage<T, R, Dyn> for VecStorage<T, R, Dyn>

§

#### type RStride = Const<1>

The static stride of this storage’s rows.
§

#### type CStride = R

The static stride of this storage’s columns.
source§

#### fn ptr(&self) -> *const T

The matrix data pointer.
source§

#### fn shape(&self) -> (R, Dyn)

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`. Read more
source§

#### 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

Indicates whether this data buffer stores its elements contiguously. Read more
source§

#### 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

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

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

Gets the address of the i-th matrix component without performing bound-checking. Read more
source§

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

Retrieves a reference to the i-th element without bound-checking. Read more
source§

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

Retrieves a reference to the i-th element without bound-checking. Read more
source§

### impl<T, C: Dim> RawStorageMut<T, Dyn, C> for VecStorage<T, Dyn, C>

source§

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

The matrix mutable data pointer.
source§

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

Retrieves the mutable data buffer as a contiguous slice. Read more
source§

#### 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. Read more
source§

#### 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. Read more
source§

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

Retrieves a mutable reference to the i-th element without bound-checking. Read more
source§

#### 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. Read more
source§

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

Swaps two elements using their linear index without bound-checking. Read more
source§

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

Swaps two elements without bound-checking. Read more
source§

### impl<T, R: DimName> RawStorageMut<T, R, Dyn> for VecStorage<T, R, Dyn>

source§

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

The matrix mutable data pointer.
source§

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

Retrieves the mutable data buffer as a contiguous slice. Read more
source§

#### 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. Read more
source§

#### 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. Read more
source§

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

Retrieves a mutable reference to the i-th element without bound-checking. Read more
source§

#### 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. Read more
source§

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

Swaps two elements using their linear index without bound-checking. Read more
source§

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

Swaps two elements without bound-checking. Read more
source§

### impl<T, C1, C2> ReshapableStorage<T, Dyn, C1, Dyn, C2> for VecStorage<T, Dyn, C1>where
T: Scalar,
C1: Dim,
C2: Dim,

§

#### type Output = VecStorage<T, Dyn, C2>

The reshaped storage type.
source§

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

Reshapes the storage into the output storage type.
source§

### impl<T, C1, R2> ReshapableStorage<T, Dyn, C1, R2, Dyn> for VecStorage<T, Dyn, C1>where
T: Scalar,
C1: Dim,
R2: DimName,

§

#### type Output = VecStorage<T, R2, Dyn>

The reshaped storage type.
source§

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

Reshapes the storage into the output storage type.
source§

### impl<T, R1, C2> ReshapableStorage<T, R1, Dyn, Dyn, C2> for VecStorage<T, R1, Dyn>where
T: Scalar,
R1: DimName,
C2: Dim,

§

#### type Output = VecStorage<T, Dyn, C2>

The reshaped storage type.
source§

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

Reshapes the storage into the output storage type.
source§

### impl<T, R1, R2> ReshapableStorage<T, R1, Dyn, R2, Dyn> for VecStorage<T, R1, Dyn>where
T: Scalar,
R1: DimName,
R2: DimName,

§

#### type Output = VecStorage<T, R2, Dyn>

The reshaped storage type.
source§

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

Reshapes the storage into the output storage type.
source§

### impl<T: Scalar, C: Dim> Storage<T, Dyn, C> for VecStorage<T, Dyn, C>where
DefaultAllocator: Allocator<T, Dyn, C, Buffer = Self>,

source§

#### fn into_owned(self) -> Owned<T, Dyn, C>where
DefaultAllocator: Allocator<T, Dyn, C>,

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

#### fn clone_owned(&self) -> Owned<T, Dyn, C>where
DefaultAllocator: Allocator<T, Dyn, C>,

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

### impl<T: Scalar, R: DimName> Storage<T, R, Dyn> for VecStorage<T, R, Dyn>where
DefaultAllocator: Allocator<T, R, Dyn, Buffer = Self>,

source§

#### fn into_owned(self) -> Owned<T, R, Dyn>where
DefaultAllocator: Allocator<T, R, Dyn>,

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

#### fn clone_owned(&self) -> Owned<T, R, Dyn>where
DefaultAllocator: Allocator<T, R, Dyn>,

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

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

source§

### impl<T, R: Dim, C: Dim> IsContiguous for VecStorage<T, R, C>

source§

### impl<T, R: Dim, C: Dim> StructuralEq for VecStorage<T, R, C>

source§

### impl<T, R: Dim, C: Dim> StructuralPartialEq for VecStorage<T, R, C>

## Auto Trait Implementations§

§

### impl<T, R, C> RefUnwindSafe for VecStorage<T, R, C>where
C: RefUnwindSafe,
R: RefUnwindSafe,
T: RefUnwindSafe,

§

### impl<T, R, C> Send for VecStorage<T, R, C>where
T: Send,

§

### impl<T, R, C> Sync for VecStorage<T, R, C>where
T: Sync,

§

### impl<T, R, C> Unpin for VecStorage<T, R, C>where
C: Unpin,
R: Unpin,
T: Unpin,

§

### impl<T, R, C> UnwindSafe for VecStorage<T, R, C>where
C: UnwindSafe,
R: UnwindSafe,
T: UnwindSafe,

## Blanket Implementations§

source§

### impl<T> Any for Twhere
T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

### impl<T> From<T> for T

const: unstable · source§

#### fn from(t: T) -> T

Returns the argument unchanged.

source§

### impl<T, U> Into<U> for Twhere
U: From<T>,

const: unstable · source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source§

### impl<T> Same<T> for T

§

#### type Output = T

Should always be `Self`
source§

### impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,

source§

#### fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct `self` from the equivalent element of its superset. Read more
source§

#### 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

Use with care! Same as `self.to_subset` but without any property checks. Always succeeds.
source§

#### fn from_subset(element: &SS) -> SP

The inclusion map: converts `self` to the equivalent element of its superset.
source§

### impl<T> ToOwned for Twhere
T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

### impl<S, T, R, C> StorageMut<T, R, C> for Swhere
R: Dim,
C: Dim,
S: Storage<T, R, C> + RawStorageMut<T, R, C>,