Struct nalgebra::base::VecStorage [−][src]
Expand description
A Vec-based matrix data storage. It may be dynamically-sized.
Implementations
impl<T, R: Dim, C: Dim> VecStorage<T, R, C>
[src]
impl<T, R: Dim, C: Dim> VecStorage<T, R, C>
[src]pub fn new(nrows: R, ncols: C, data: Vec<T>) -> Self
[src]
pub fn new(nrows: R, ncols: C, data: Vec<T>) -> Self
[src]Creates a new dynamic matrix data storage from the given vector and shape.
pub unsafe fn as_vec_mut(&mut self) -> &mut Vec<T>
[src]
pub unsafe fn as_vec_mut(&mut self) -> &mut Vec<T>
[src]The underlying mutable data storage.
This is unsafe because this may cause UB if the size of the vector is changed by the user.
Trait Implementations
impl<T: Clone, R: Clone + Dim, C: Clone + Dim> Clone for VecStorage<T, R, C>
[src]
impl<T: Clone, R: Clone + Dim, C: Clone + Dim> Clone for VecStorage<T, R, C>
[src]fn clone(&self) -> VecStorage<T, R, C>
[src]
fn clone(&self) -> VecStorage<T, R, C>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<'a, T: 'a + Copy, R: Dim> Extend<&'a T> for VecStorage<T, R, Dynamic>
[src]
impl<'a, T: 'a + Copy, R: Dim> Extend<&'a T> for VecStorage<T, R, Dynamic>
[src]fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)
[src]
fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I)
[src]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)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T, R, RV, SV> Extend<Matrix<T, RV, Const<1_usize>, SV>> for VecStorage<T, R, Dynamic> where
T: Scalar,
R: Dim,
RV: Dim,
SV: Storage<T, RV>,
ShapeConstraint: SameNumberOfRows<R, RV>,
[src]
impl<T, R, RV, SV> Extend<Matrix<T, RV, Const<1_usize>, SV>> for VecStorage<T, R, Dynamic> where
T: Scalar,
R: Dim,
RV: Dim,
SV: Storage<T, RV>,
ShapeConstraint: SameNumberOfRows<R, RV>,
[src]fn extend<I: IntoIterator<Item = Vector<T, RV, SV>>>(&mut self, iter: I)
[src]
fn extend<I: IntoIterator<Item = Vector<T, RV, SV>>>(&mut self, iter: I)
[src]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)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T, R: Dim> Extend<T> for VecStorage<T, R, Dynamic>
[src]
impl<T, R: Dim> Extend<T> for VecStorage<T, R, Dynamic>
[src]fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)
[src]
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)
[src]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)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T> Extend<T> for VecStorage<T, Dynamic, U1>
[src]
impl<T> Extend<T> for VecStorage<T, Dynamic, U1>
[src]fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)
[src]
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)
[src]Extends the number of rows of the VecStorage
with elements
from the given iterator.
fn extend_one(&mut self, item: A)
[src]
fn extend_one(&mut self, item: A)
[src]extend_one
)Extends a collection with exactly one element.
fn extend_reserve(&mut self, additional: usize)
[src]
fn extend_reserve(&mut self, additional: usize)
[src]extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
impl<T: PartialEq, R: PartialEq + Dim, C: PartialEq + Dim> PartialEq<VecStorage<T, R, C>> for VecStorage<T, R, C>
[src]
impl<T: PartialEq, R: PartialEq + Dim, C: PartialEq + Dim> PartialEq<VecStorage<T, R, C>> for VecStorage<T, R, C>
[src]fn eq(&self, other: &VecStorage<T, R, C>) -> bool
[src]
fn eq(&self, other: &VecStorage<T, R, C>) -> bool
[src]This method tests for self
and other
values to be equal, and is used
by ==
. Read more
fn ne(&self, other: &VecStorage<T, R, C>) -> bool
[src]
fn ne(&self, other: &VecStorage<T, R, C>) -> bool
[src]This method tests for !=
.
impl<T, C1, C2> ReshapableStorage<T, Dynamic, C1, Dynamic, C2> for VecStorage<T, Dynamic, C1> where
T: Scalar,
C1: Dim,
C2: Dim,
[src]
impl<T, C1, C2> ReshapableStorage<T, Dynamic, C1, Dynamic, C2> for VecStorage<T, Dynamic, C1> where
T: Scalar,
C1: Dim,
C2: Dim,
[src]type Output = VecStorage<T, Dynamic, C2>
type Output = VecStorage<T, Dynamic, C2>
The reshaped storage type.
fn reshape_generic(self, nrows: Dynamic, ncols: C2) -> Self::Output
[src]
fn reshape_generic(self, nrows: Dynamic, ncols: C2) -> Self::Output
[src]Reshapes the storage into the output storage type.
impl<T, C1, R2> ReshapableStorage<T, Dynamic, C1, R2, Dynamic> for VecStorage<T, Dynamic, C1> where
T: Scalar,
C1: Dim,
R2: DimName,
[src]
impl<T, C1, R2> ReshapableStorage<T, Dynamic, C1, R2, Dynamic> for VecStorage<T, Dynamic, C1> where
T: Scalar,
C1: Dim,
R2: DimName,
[src]type Output = VecStorage<T, R2, Dynamic>
type Output = VecStorage<T, R2, Dynamic>
The reshaped storage type.
fn reshape_generic(self, nrows: R2, ncols: Dynamic) -> Self::Output
[src]
fn reshape_generic(self, nrows: R2, ncols: Dynamic) -> Self::Output
[src]Reshapes the storage into the output storage type.
impl<T, R1, C2> ReshapableStorage<T, R1, Dynamic, Dynamic, C2> for VecStorage<T, R1, Dynamic> where
T: Scalar,
R1: DimName,
C2: Dim,
[src]
impl<T, R1, C2> ReshapableStorage<T, R1, Dynamic, Dynamic, C2> for VecStorage<T, R1, Dynamic> where
T: Scalar,
R1: DimName,
C2: Dim,
[src]type Output = VecStorage<T, Dynamic, C2>
type Output = VecStorage<T, Dynamic, C2>
The reshaped storage type.
fn reshape_generic(self, nrows: Dynamic, ncols: C2) -> Self::Output
[src]
fn reshape_generic(self, nrows: Dynamic, ncols: C2) -> Self::Output
[src]Reshapes the storage into the output storage type.
impl<T, R1, R2> ReshapableStorage<T, R1, Dynamic, R2, Dynamic> for VecStorage<T, R1, Dynamic> where
T: Scalar,
R1: DimName,
R2: DimName,
[src]
impl<T, R1, R2> ReshapableStorage<T, R1, Dynamic, R2, Dynamic> for VecStorage<T, R1, Dynamic> where
T: Scalar,
R1: DimName,
R2: DimName,
[src]type Output = VecStorage<T, R2, Dynamic>
type Output = VecStorage<T, R2, Dynamic>
The reshaped storage type.
fn reshape_generic(self, nrows: R2, ncols: Dynamic) -> Self::Output
[src]
fn reshape_generic(self, nrows: R2, ncols: Dynamic) -> Self::Output
[src]Reshapes the storage into the output storage type.
impl<T: Scalar, C: Dim> Storage<T, Dynamic, C> for VecStorage<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
[src]
impl<T: Scalar, C: Dim> Storage<T, Dynamic, C> for VecStorage<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
[src]fn shape(&self) -> (Dynamic, C)
[src]
fn shape(&self) -> (Dynamic, C)
[src]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
fn strides(&self) -> (Self::RStride, Self::CStride)
[src]
fn strides(&self) -> (Self::RStride, Self::CStride)
[src]The spacing between consecutive row elements and consecutive column elements. Read more
fn is_contiguous(&self) -> bool
[src]
fn is_contiguous(&self) -> bool
[src]Indicates whether this data buffer stores its elements contiguously.
fn into_owned(self) -> Owned<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C>,
[src]
fn into_owned(self) -> Owned<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C>,
[src]Builds a matrix data storage that does not contain any reference.
fn clone_owned(&self) -> Owned<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C>,
[src]
fn clone_owned(&self) -> Owned<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C>,
[src]Clones this data storage to one that does not contain any reference.
fn linear_index(&self, irow: usize, icol: usize) -> usize
[src]
fn linear_index(&self, irow: usize, icol: usize) -> usize
[src]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
unsafe fn get_address_unchecked_linear(&self, i: usize) -> *const T
[src]
unsafe fn get_address_unchecked_linear(&self, i: usize) -> *const T
[src]Gets the address of the i-th matrix component without performing bound-checking.
unsafe fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T
[src]
unsafe fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T
[src]Gets the address of the i-th matrix component without performing bound-checking.
unsafe fn get_unchecked_linear(&self, i: usize) -> &T
[src]
unsafe fn get_unchecked_linear(&self, i: usize) -> &T
[src]Retrieves a reference to the i-th element without bound-checking.
unsafe fn get_unchecked(&self, irow: usize, icol: usize) -> &T
[src]
unsafe fn get_unchecked(&self, irow: usize, icol: usize) -> &T
[src]Retrieves a reference to the i-th element without bound-checking.
impl<T: Scalar, R: DimName> Storage<T, R, Dynamic> for VecStorage<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
[src]
impl<T: Scalar, R: DimName> Storage<T, R, Dynamic> for VecStorage<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
[src]type CStride = R
type CStride = R
The static stride of this storage’s columns.
fn shape(&self) -> (R, Dynamic)
[src]
fn shape(&self) -> (R, Dynamic)
[src]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
fn strides(&self) -> (Self::RStride, Self::CStride)
[src]
fn strides(&self) -> (Self::RStride, Self::CStride)
[src]The spacing between consecutive row elements and consecutive column elements. Read more
fn is_contiguous(&self) -> bool
[src]
fn is_contiguous(&self) -> bool
[src]Indicates whether this data buffer stores its elements contiguously.
fn into_owned(self) -> Owned<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic>,
[src]
fn into_owned(self) -> Owned<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic>,
[src]Builds a matrix data storage that does not contain any reference.
fn clone_owned(&self) -> Owned<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic>,
[src]
fn clone_owned(&self) -> Owned<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic>,
[src]Clones this data storage to one that does not contain any reference.
fn linear_index(&self, irow: usize, icol: usize) -> usize
[src]
fn linear_index(&self, irow: usize, icol: usize) -> usize
[src]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
unsafe fn get_address_unchecked_linear(&self, i: usize) -> *const T
[src]
unsafe fn get_address_unchecked_linear(&self, i: usize) -> *const T
[src]Gets the address of the i-th matrix component without performing bound-checking.
unsafe fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T
[src]
unsafe fn get_address_unchecked(&self, irow: usize, icol: usize) -> *const T
[src]Gets the address of the i-th matrix component without performing bound-checking.
unsafe fn get_unchecked_linear(&self, i: usize) -> &T
[src]
unsafe fn get_unchecked_linear(&self, i: usize) -> &T
[src]Retrieves a reference to the i-th element without bound-checking.
unsafe fn get_unchecked(&self, irow: usize, icol: usize) -> &T
[src]
unsafe fn get_unchecked(&self, irow: usize, icol: usize) -> &T
[src]Retrieves a reference to the i-th element without bound-checking.
impl<T: Scalar, C: Dim> StorageMut<T, Dynamic, C> for VecStorage<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
[src]
impl<T: Scalar, C: Dim> StorageMut<T, Dynamic, C> for VecStorage<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
[src]fn as_mut_slice(&mut self) -> &mut [T]
[src]
fn as_mut_slice(&mut self) -> &mut [T]
[src]Retrieves the mutable data buffer as a contiguous slice. Read more
unsafe fn get_address_unchecked_linear_mut(&mut self, i: usize) -> *mut T
[src]
unsafe fn get_address_unchecked_linear_mut(&mut self, i: usize) -> *mut T
[src]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 T
[src]
unsafe fn get_address_unchecked_mut(
&mut self,
irow: usize,
icol: usize
) -> *mut T
[src]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
[src]
unsafe fn get_unchecked_linear_mut(&mut self, i: usize) -> &mut T
[src]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
[src]
unsafe fn get_unchecked_mut(&mut self, irow: usize, icol: usize) -> &mut T
[src]Retrieves a mutable reference to the element at (irow, icol)
without bound-checking.
unsafe fn swap_unchecked_linear(&mut self, i1: usize, i2: usize)
[src]
unsafe fn swap_unchecked_linear(&mut self, i1: usize, i2: usize)
[src]Swaps two elements using their linear index without bound-checking.
impl<T: Scalar, R: DimName> StorageMut<T, R, Dynamic> for VecStorage<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
[src]
impl<T: Scalar, R: DimName> StorageMut<T, R, Dynamic> for VecStorage<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
[src]fn as_mut_slice(&mut self) -> &mut [T]
[src]
fn as_mut_slice(&mut self) -> &mut [T]
[src]Retrieves the mutable data buffer as a contiguous slice. Read more
unsafe fn get_address_unchecked_linear_mut(&mut self, i: usize) -> *mut T
[src]
unsafe fn get_address_unchecked_linear_mut(&mut self, i: usize) -> *mut T
[src]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 T
[src]
unsafe fn get_address_unchecked_mut(
&mut self,
irow: usize,
icol: usize
) -> *mut T
[src]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
[src]
unsafe fn get_unchecked_linear_mut(&mut self, i: usize) -> &mut T
[src]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
[src]
unsafe fn get_unchecked_mut(&mut self, irow: usize, icol: usize) -> &mut T
[src]Retrieves a mutable reference to the element at (irow, icol)
without bound-checking.
unsafe fn swap_unchecked_linear(&mut self, i1: usize, i2: usize)
[src]
unsafe fn swap_unchecked_linear(&mut self, i1: usize, i2: usize)
[src]Swaps two elements using their linear index without bound-checking.
impl<T: Scalar, C: Dim> ContiguousStorage<T, Dynamic, C> for VecStorage<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
[src]
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
impl<T: Scalar, R: DimName> ContiguousStorage<T, R, Dynamic> for VecStorage<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
[src]
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
impl<T: Scalar, C: Dim> ContiguousStorageMut<T, Dynamic, C> for VecStorage<T, Dynamic, C> where
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
[src]
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
impl<T: Scalar, R: DimName> ContiguousStorageMut<T, R, Dynamic> for VecStorage<T, R, Dynamic> where
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
[src]
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
impl<T: Eq, R: Eq + Dim, C: Eq + Dim> Eq for VecStorage<T, R, C>
[src]
impl<T, R: Dim, C: Dim> StructuralEq for VecStorage<T, R, C>
[src]
impl<T, R: Dim, C: Dim> StructuralPartialEq for VecStorage<T, R, C>
[src]
Auto Trait Implementations
impl<T, R, C> RefUnwindSafe for VecStorage<T, R, C> where
C: RefUnwindSafe,
R: RefUnwindSafe,
T: RefUnwindSafe,
C: RefUnwindSafe,
R: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, R, C> Send for VecStorage<T, R, C> where
T: Send,
T: Send,
impl<T, R, C> Sync for VecStorage<T, R, C> where
T: Sync,
T: Sync,
impl<T, R, C> Unpin for VecStorage<T, R, C> where
C: Unpin,
R: Unpin,
T: Unpin,
C: Unpin,
R: Unpin,
T: Unpin,
impl<T, R, C> UnwindSafe for VecStorage<T, R, C> where
C: UnwindSafe,
R: UnwindSafe,
T: UnwindSafe,
C: UnwindSafe,
R: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]
impl<SS, SP> SupersetOf<SS> for SP where
SS: SubsetOf<SP>,
[src]pub fn to_subset(&self) -> Option<SS>
[src]
pub fn to_subset(&self) -> Option<SS>
[src]The inverse inclusion map: attempts to construct self
from the equivalent element of its
superset. Read more
pub fn is_in_subset(&self) -> bool
[src]
pub fn is_in_subset(&self) -> bool
[src]Checks if self
is actually part of its subset T
(and can be converted to it).
pub fn to_subset_unchecked(&self) -> SS
[src]
pub fn to_subset_unchecked(&self) -> SS
[src]Use with care! Same as self.to_subset
but without any property checks. Always succeeds.
pub fn from_subset(element: &SS) -> SP
[src]
pub fn from_subset(element: &SS) -> SP
[src]The inclusion map: converts self
to the equivalent element of its superset.
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,