Struct rin::math::Dynamic

pub struct Dynamic { /* fields omitted */ }

Dim of dynamically-sized algebraic entities.

Implementations

impl Dynamic

pub fn new(value: usize) -> Dynamic

A dynamic size equal to value.

Trait Implementations

impl Add<usize> for Dynamic

type Output = Dynamic

The resulting type after applying the + operator.

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

Performs the + operation.

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

type Buffer = VecStorage<N, Dynamic, C>

The type of buffer this allocator can instanciate.

pub unsafe fn allocate_uninitialized(
    nrows: Dynamic,
    ncols: C
) -> <DefaultAllocator as Allocator<N, Dynamic, C>>::Buffer

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

pub fn allocate_from_iterator<I>(
    nrows: Dynamic,
    ncols: C,
    iter: I
) -> <DefaultAllocator as Allocator<N, Dynamic, C>>::Buffer where
    I: IntoIterator<Item = N>, 

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

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

type Buffer = VecStorage<N, R, Dynamic>

The type of buffer this allocator can instanciate.

pub unsafe fn allocate_uninitialized(
    nrows: R,
    ncols: Dynamic
) -> <DefaultAllocator as Allocator<N, R, Dynamic>>::Buffer

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

pub fn allocate_from_iterator<I>(
    nrows: R,
    ncols: Dynamic,
    iter: I
) -> <DefaultAllocator as Allocator<N, R, Dynamic>>::Buffer where
    I: IntoIterator<Item = N>, 

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

impl Clone for Dynamic

pub fn clone(&self) -> Dynamic

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dynamic

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Dynamic

pub fn deserialize<D>(
    deserializer: D
) -> Result<Dynamic, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Dim for Dynamic

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

pub fn from_usize(dim: usize) -> Dynamic

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().

pub 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().

pub fn is<D>() -> bool where
    D: Dim, 

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

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> DimEq<Dynamic, D> for ShapeConstraint where
    D: DimName, 

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> DimMax<D> for Dynamic where
    D: Dim, 

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

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

type Output = Dynamic

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

impl PartialEq<Dynamic> for Dynamic

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

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

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

This method tests for !=.

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

pub unsafe fn reallocate_copy(
    rto: Dynamic,
    cto: CTo,
    buf: VecStorage<N, Dynamic, CFrom>
) -> VecStorage<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, CFrom, RTo> Reallocator<N, Dynamic, CFrom, RTo, Dynamic> for DefaultAllocator where
    N: Scalar,
    RTo: DimName,
    CFrom: Dim, 

pub unsafe fn reallocate_copy(
    rto: RTo,
    cto: Dynamic,
    buf: VecStorage<N, Dynamic, CFrom>
) -> VecStorage<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, RFrom, CFrom, CTo> Reallocator<N, RFrom, CFrom, Dynamic, CTo> for DefaultAllocator where
    N: Scalar,
    CTo: Dim,
    RFrom: DimName,
    CFrom: DimName,
    <RFrom as DimName>::Value: Mul<<CFrom as DimName>::Value>,
    <<RFrom as DimName>::Value as Mul<<CFrom as DimName>::Value>>::Output: ArrayLength<N>, 

pub unsafe fn reallocate_copy(
    rto: Dynamic,
    cto: CTo,
    buf: ArrayStorage<N, RFrom, CFrom>
) -> VecStorage<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, RFrom, CFrom, RTo> Reallocator<N, RFrom, CFrom, RTo, Dynamic> for DefaultAllocator where
    N: Scalar,
    RTo: DimName,
    RFrom: DimName,
    CFrom: DimName,
    <RFrom as DimName>::Value: Mul<<CFrom as DimName>::Value>,
    <<RFrom as DimName>::Value as Mul<<CFrom as DimName>::Value>>::Output: ArrayLength<N>, 

pub unsafe fn reallocate_copy(
    rto: RTo,
    cto: Dynamic,
    buf: ArrayStorage<N, RFrom, CFrom>
) -> VecStorage<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, RFrom, CTo> Reallocator<N, RFrom, Dynamic, Dynamic, CTo> for DefaultAllocator where
    N: Scalar,
    CTo: Dim,
    RFrom: DimName, 

pub unsafe fn reallocate_copy(
    rto: Dynamic,
    cto: CTo,
    buf: VecStorage<N, RFrom, Dynamic>
) -> VecStorage<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, RFrom, RTo> Reallocator<N, RFrom, Dynamic, RTo, Dynamic> for DefaultAllocator where
    N: Scalar,
    RTo: DimName,
    RFrom: DimName, 

pub unsafe fn reallocate_copy(
    rto: RTo,
    cto: Dynamic,
    buf: VecStorage<N, RFrom, Dynamic>
) -> VecStorage<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, C1, C2> ReshapableStorage<N, Dynamic, C1, Dynamic, C2> for VecStorage<N, Dynamic, C1> where
    N: Scalar,
    C2: Dim,
    C1: Dim, 

type Output = VecStorage<N, Dynamic, C2>

The reshaped storage type.

pub fn reshape_generic(
    self,
    nrows: Dynamic,
    ncols: C2
) -> <VecStorage<N, Dynamic, C1> as ReshapableStorage<N, Dynamic, C1, Dynamic, C2>>::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.

pub fn reshape_generic(
    self,
    nrows: R2,
    ncols: Dynamic
) -> <VecStorage<N, Dynamic, C1> as ReshapableStorage<N, Dynamic, C1, R2, Dynamic>>::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,
    C2: Dim,
    R1: DimName, 

type Output = VecStorage<N, Dynamic, C2>

The reshaped storage type.

pub fn reshape_generic(
    self,
    nrows: Dynamic,
    ncols: C2
) -> <VecStorage<N, R1, Dynamic> as ReshapableStorage<N, R1, Dynamic, Dynamic, C2>>::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.

pub fn reshape_generic(
    self,
    nrows: R2,
    ncols: Dynamic
) -> <VecStorage<N, R1, Dynamic> as ReshapableStorage<N, R1, Dynamic, R2, Dynamic>>::Output

Reshapes the storage into the output storage type.

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

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> SameDimension<Dynamic, D> for ShapeConstraint where
    D: DimName, 

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> SameNumberOfColumns<D, Dynamic> for ShapeConstraint where
    D: DimName, 

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> SameNumberOfColumns<Dynamic, D> for ShapeConstraint where
    D: DimName, 

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> SameNumberOfRows<D, Dynamic> for ShapeConstraint where
    D: DimName, 

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> SameNumberOfRows<Dynamic, D> for ShapeConstraint where
    D: DimName, 

type Representative = D

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

impl Serialize for Dynamic

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

pub fn ptr(&self) -> *const N

The matrix data pointer.

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

pub fn strides(
    &self
) -> (<VecStorage<N, Dynamic, C> as Storage<N, Dynamic, C>>::RStride, <VecStorage<N, Dynamic, C> as Storage<N, Dynamic, C>>::CStride)

The spacing between consecutive row elements and consecutive column elements.

pub fn is_contiguous(&self) -> bool

Indicates whether this data buffer stores its elements contiguously.

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

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

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

Retrieves the data buffer as a contiguous slice.

pub 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:

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

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

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

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

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

pub 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 VecStorage<N, R, Dynamic> where
    N: Scalar,
    R: DimName,
    DefaultAllocator: Allocator<N, R, Dynamic>,
    <DefaultAllocator as Allocator<N, R, Dynamic>>::Buffer == VecStorage<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.

pub fn ptr(&self) -> *const N

The matrix data pointer.

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

pub fn strides(
    &self
) -> (<VecStorage<N, R, Dynamic> as Storage<N, R, Dynamic>>::RStride, <VecStorage<N, R, Dynamic> as Storage<N, R, Dynamic>>::CStride)

The spacing between consecutive row elements and consecutive column elements.

pub fn is_contiguous(&self) -> bool

Indicates whether this data buffer stores its elements contiguously.

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

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

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

Retrieves the data buffer as a contiguous slice.

pub 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:

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

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

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

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

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

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

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

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

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

The matrix mutable data pointer.

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

Retrieves the mutable data buffer as a contiguous slice.

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

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

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

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

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

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

Swaps two elements using their linear index without bound-checking.

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

Swaps two elements without bound-checking.

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

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

The matrix mutable data pointer.

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

Retrieves the mutable data buffer as a contiguous slice.

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

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

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

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

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

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

Swaps two elements using their linear index without bound-checking.

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

Swaps two elements without bound-checking.

impl Sub<usize> for Dynamic

type Output = Dynamic

The resulting type after applying the - operator.

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

Performs the - operation.

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

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

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

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

impl Copy for Dynamic

impl Eq for Dynamic

impl IsDynamic for Dynamic

impl IsNotStaticOne for Dynamic

impl StructuralEq for Dynamic

impl StructuralPartialEq for Dynamic