Struct nalgebra::core::dimension::Dynamic

pub struct Dynamic { /* fields omitted */ }

Dim of dynamically-sized algebraic entities.

Methods

impl Dynamic

pub fn new(value: usize) -> Dynamic

A dynamic size equal to value.

Trait Implementations

impl Clone for Dynamic

fn clone(&self) -> Dynamic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Dynamic

impl Eq for Dynamic

impl PartialEq for Dynamic

fn eq(&self, __arg_0: &Dynamic) -> bool

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

fn ne(&self, __arg_0: &Dynamic) -> bool

This method tests for !=.

impl Debug for Dynamic

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl IsDynamic for Dynamic

impl IsNotStaticOne for Dynamic

impl Dim for Dynamic

fn try_to_usize() -> Option<usize>

Gets the compile-time value of Self. Returns None if it is not known, i.e., if Self = Dynamic.

fn from_usize(dim: usize) -> Self

Builds an instance of Self from a run-time value. Panics if Self is a type-level integer and dim != Self::try_to_usize().unwrap().

fn value(&self) -> usize

Gets the run-time value of self. For type-level integers, this is the same as Self::try_to_usize().unwrap().

fn is<D: Dim>() -> bool

impl Add<usize> for Dynamic

type Output = Dynamic

The resulting type after applying the + operator.

fn add(self, rhs: usize) -> Dynamic

Performs the + operation.

impl Sub<usize> for Dynamic

type Output = Dynamic

The resulting type after applying the - operator.

fn sub(self, rhs: usize) -> Dynamic

Performs the - operation.

impl<D: Dim> DimAdd<D> for Dynamic

type Output = Dynamic

fn add(self, other: D) -> Dynamic

impl<D: DimName> DimAdd<Dynamic> for D

type Output = Dynamic

fn add(self, other: Dynamic) -> Dynamic

impl<D: Dim> DimMul<D> for Dynamic

type Output = Dynamic

fn mul(self, other: D) -> Dynamic

impl<D: DimName> DimMul<Dynamic> for D

type Output = Dynamic

fn mul(self, other: Dynamic) -> Dynamic

impl<D: Dim> DimSub<D> for Dynamic

type Output = Dynamic

fn sub(self, other: D) -> Dynamic

impl<D: DimName> DimSub<Dynamic> for D

type Output = Dynamic

fn sub(self, other: Dynamic) -> Dynamic

impl<D: Dim> DimDiv<D> for Dynamic

type Output = Dynamic

fn div(self, other: D) -> Dynamic

impl<D: DimName> DimDiv<Dynamic> for D

type Output = Dynamic

fn div(self, other: Dynamic) -> Dynamic

impl<D: Dim> DimMin<D> for Dynamic

type Output = Dynamic

fn min(self, other: D) -> Dynamic

impl<D: DimName> DimMin<Dynamic> for D

type Output = Dynamic

fn min(self, other: Dynamic) -> Dynamic

impl<D: Dim> DimMax<D> for Dynamic

type Output = Dynamic

fn max(self, other: D) -> Dynamic

impl<D: DimName> DimMax<Dynamic> for D

type Output = Dynamic

fn max(self, other: Dynamic) -> Dynamic

impl<D: DimName> DimEq<D, Dynamic> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> DimEq<Dynamic, D> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> SameNumberOfRows<D, Dynamic> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> SameNumberOfRows<Dynamic, D> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> SameNumberOfColumns<D, Dynamic> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> SameNumberOfColumns<Dynamic, D> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> SameDimension<D, Dynamic> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<D: DimName> SameDimension<Dynamic, D> for ShapeConstraint

type Representative = D

This is either equal to D1 or D2, always choosing the one (if any) which is a type-level constant.

impl<N: Scalar, C: Dim> Allocator<N, Dynamic, C> for DefaultAllocator

type Buffer = MatrixVec<N, Dynamic, C>

The type of buffer this allocator can instanciate.

unsafe fn allocate_uninitialized(nrows: Dynamic, ncols: C) -> Self::Buffer

Allocates a buffer with the given number of rows and columns without initializing its content.

fn allocate_from_iterator<I: IntoIterator<Item = N>>(
    nrows: Dynamic,
    ncols: C,
    iter: I
) -> Self::Buffer

Allocates a buffer initialized with the content of the given iterator.

impl<N: Scalar, R: DimName> Allocator<N, R, Dynamic> for DefaultAllocator

type Buffer = MatrixVec<N, R, Dynamic>

The type of buffer this allocator can instanciate.

unsafe fn allocate_uninitialized(nrows: R, ncols: Dynamic) -> Self::Buffer

Allocates a buffer with the given number of rows and columns without initializing its content.

fn allocate_from_iterator<I: IntoIterator<Item = N>>(
    nrows: R,
    ncols: Dynamic,
    iter: I
) -> Self::Buffer

Allocates a buffer initialized with the content of the given iterator.

impl<N: Scalar, RFrom, CFrom, CTo> Reallocator<N, RFrom, CFrom, Dynamic, CTo> for DefaultAllocator where
    RFrom: DimName,
    CFrom: DimName,
    CTo: Dim,
    RFrom::Value: Mul<CFrom::Value>,
    Prod<RFrom::Value, CFrom::Value>: ArrayLength<N>, 

unsafe fn reallocate_copy(
    rto: Dynamic,
    cto: CTo,
    buf: MatrixArray<N, RFrom, CFrom>
) -> MatrixVec<N, Dynamic, CTo>

Reallocates a buffer of shape (RTo, CTo), possibly reusing a previously allocated buffer buf. Data stored by buf are linearly copied to the output:

impl<N: Scalar, RFrom, CFrom, RTo> Reallocator<N, RFrom, CFrom, RTo, Dynamic> for DefaultAllocator where
    RFrom: DimName,
    CFrom: DimName,
    RTo: DimName,
    RFrom::Value: Mul<CFrom::Value>,
    Prod<RFrom::Value, CFrom::Value>: ArrayLength<N>, 

unsafe fn reallocate_copy(
    rto: RTo,
    cto: Dynamic,
    buf: MatrixArray<N, RFrom, CFrom>
) -> MatrixVec<N, RTo, Dynamic>

Reallocates a buffer of shape (RTo, CTo), possibly reusing a previously allocated buffer buf. Data stored by buf are linearly copied to the output:

impl<N: Scalar, CFrom: Dim, CTo: Dim> Reallocator<N, Dynamic, CFrom, Dynamic, CTo> for DefaultAllocator

unsafe fn reallocate_copy(
    rto: Dynamic,
    cto: CTo,
    buf: MatrixVec<N, Dynamic, CFrom>
) -> MatrixVec<N, Dynamic, CTo>

Reallocates a buffer of shape (RTo, CTo), possibly reusing a previously allocated buffer buf. Data stored by buf are linearly copied to the output:

impl<N: Scalar, CFrom: Dim, RTo: DimName> Reallocator<N, Dynamic, CFrom, RTo, Dynamic> for DefaultAllocator

unsafe fn reallocate_copy(
    rto: RTo,
    cto: Dynamic,
    buf: MatrixVec<N, Dynamic, CFrom>
) -> MatrixVec<N, RTo, Dynamic>

Reallocates a buffer of shape (RTo, CTo), possibly reusing a previously allocated buffer buf. Data stored by buf are linearly copied to the output:

impl<N: Scalar, RFrom: DimName, CTo: Dim> Reallocator<N, RFrom, Dynamic, Dynamic, CTo> for DefaultAllocator

unsafe fn reallocate_copy(
    rto: Dynamic,
    cto: CTo,
    buf: MatrixVec<N, RFrom, Dynamic>
) -> MatrixVec<N, Dynamic, CTo>

Reallocates a buffer of shape (RTo, CTo), possibly reusing a previously allocated buffer buf. Data stored by buf are linearly copied to the output:

impl<N: Scalar, RFrom: DimName, RTo: DimName> Reallocator<N, RFrom, Dynamic, RTo, Dynamic> for DefaultAllocator

unsafe fn reallocate_copy(
    rto: RTo,
    cto: Dynamic,
    buf: MatrixVec<N, RFrom, Dynamic>
) -> MatrixVec<N, RTo, Dynamic>

Reallocates a buffer of shape (RTo, CTo), possibly reusing a previously allocated buffer buf. Data stored by buf are linearly copied to the output:

impl<N: Scalar, C: Dim> Storage<N, Dynamic, C> for MatrixVec<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 concecutive 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.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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 MatrixVec<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 concecutive 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.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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 MatrixVec<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.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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 MatrixVec<N, Dynamic, C> where
    DefaultAllocator: Allocator<N, Dynamic, C, Buffer = Self>, 

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

impl<N: Scalar, R: DimName> StorageMut<N, R, Dynamic> for MatrixVec<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.

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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

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

Important traits for &'a mut I

impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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> ContiguousStorage<N, R, Dynamic> for MatrixVec<N, R, Dynamic> where
    DefaultAllocator: Allocator<N, R, Dynamic, Buffer = Self>, 

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