Struct rin::math::core::MatrixVec

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

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

Methods

impl<N, R, C> MatrixVec<N, R, C> where     C: Dim,     R: Dim,

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

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

Important traits for Vec<u8>

impl Write for Vec<u8>

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

The underlying data storage.

Important traits for Vec<u8>

impl Write for Vec<u8>

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

The underlying mutable data storage.

This is unsafe because this may cause UB if the vector is modified by the user.

Important traits for Vec<u8>

impl Write for Vec<u8>

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.

Methods from Deref<Target = Vec<N>>

pub fn capacity(&self) -> usize

Returns the number of elements the vector can hold without reallocating.

Examples

let vec: Vec<i32> = Vec::with_capacity(10);
assert_eq!(vec.capacity(), 10);

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

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

Extracts a slice containing the entire vector.

Equivalent to &s[..].

Examples

use std::io::{self, Write};
let buffer = vec![1, 2, 3, 5, 8];
io::sink().write(buffer.as_slice()).unwrap();

pub fn len(&self) -> usize

Returns the number of elements in the vector, also referred to as its 'length'.

Examples

let a = vec![1, 2, 3];
assert_eq!(a.len(), 3);

pub fn is_empty(&self) -> bool

Returns true if the vector contains no elements.

Examples

let mut v = Vec::new();
assert!(v.is_empty());

v.push(1);
assert!(!v.is_empty());

Trait Implementations

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

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

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

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

This method tests for !=.

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

impl<N, C> ContiguousStorage<N, Dynamic, C> for MatrixVec<N, Dynamic, C> where     C: Dim,     N: Scalar,     DefaultAllocator: Allocator<N, Dynamic, C>,     <DefaultAllocator as Allocator<N, Dynamic, C>>::Buffer == MatrixVec<N, Dynamic, C>,

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

impl<N, R> StorageMut<N, R, Dynamic> for MatrixVec<N, R, Dynamic> where     N: Scalar,     R: DimName,     DefaultAllocator: Allocator<N, R, Dynamic>,     <DefaultAllocator as Allocator<N, R, Dynamic>>::Buffer == MatrixVec<N, R, Dynamic>,

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

The matrix mutable data pointer.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

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, C> StorageMut<N, Dynamic, C> for MatrixVec<N, Dynamic, C> where     C: Dim,     N: Scalar,     DefaultAllocator: Allocator<N, Dynamic, C>,     <DefaultAllocator as Allocator<N, Dynamic, C>>::Buffer == MatrixVec<N, Dynamic, C>,

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

The matrix mutable data pointer.

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

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, C> Storage<N, Dynamic, C> for MatrixVec<N, Dynamic, C> where     C: Dim,     N: Scalar,     DefaultAllocator: Allocator<N, Dynamic, C>,     <DefaultAllocator as Allocator<N, Dynamic, C>>::Buffer == MatrixVec<N, Dynamic, C>,

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 ) -> (<MatrixVec<N, Dynamic, C> as Storage<N, Dynamic, C>>::RStride, <MatrixVec<N, Dynamic, C> as Storage<N, Dynamic, C>>::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) -> <DefaultAllocator as Allocator<N, Dynamic, C>>::Buffer where     DefaultAllocator: Allocator<N, Dynamic, C>,

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

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

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

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

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, R> Storage<N, R, Dynamic> for MatrixVec<N, R, Dynamic> where     N: Scalar,     R: DimName,     DefaultAllocator: Allocator<N, R, Dynamic>,     <DefaultAllocator as Allocator<N, R, Dynamic>>::Buffer == MatrixVec<N, R, Dynamic>,

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 ) -> (<MatrixVec<N, R, Dynamic> as Storage<N, R, Dynamic>>::RStride, <MatrixVec<N, R, Dynamic> as Storage<N, R, Dynamic>>::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) -> <DefaultAllocator as Allocator<N, R, Dynamic>>::Buffer where     DefaultAllocator: Allocator<N, R, Dynamic>,

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

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

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

Important traits for &'a mut [u8]

impl<'a> Write for &'a mut [u8]impl<'a> Read for &'a [u8]

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, R, C> Deref for MatrixVec<N, R, C> where     C: Dim,     R: Dim,

type Target = Vec<N>

The resulting type after dereferencing.

fn deref(&self) -> &<MatrixVec<N, R, C> as Deref>::Target

Dereferences the value.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<N, R> Extend<N> for MatrixVec<N, R, Dynamic> where     R: Dim,

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

Extends the number of columns of the MatrixVec 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 MatrixVec.

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

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

Extends the number of columns of the MatrixVec 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 MatrixVec.

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

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

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

impl<N, R, C> Into<Vec<N>> for MatrixVec<N, R, C> where     C: Dim,     R: Dim,

Important traits for Vec<u8>

impl Write for Vec<u8>

fn into(self) -> Vec<N>

Performs the conversion.

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

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

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

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

Formats the value using the given formatter.

impl<N, R, C> Serialize for MatrixVec<N, R, C> where     C: Dim + Serialize,     N: Serialize,     R: Dim + Serialize,

fn serialize<__S>(     &self,     __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error> where     __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'de, N, R, C> Deserialize<'de> for MatrixVec<N, R, C> where     C: Dim + Deserialize<'de>,     N: Deserialize<'de>,     R: Dim + Deserialize<'de>,

fn deserialize<__D>(     __deserializer: __D ) -> Result<MatrixVec<N, R, C>, <__D as Deserializer<'de>>::Error> where     __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.