Trait nalgebra::base::allocator::Allocator

pub trait Allocator<R: Dim, C: Dim = U1>: Any + Sized {
    type Buffer<T: Scalar>: StorageMut<T, R, C> + IsContiguous + Clone + Debug;
    type BufferUninit<T: Scalar>: RawStorageMut<MaybeUninit<T>, R, C> + IsContiguous;

    // Required methods
    fn allocate_uninit<T: Scalar>(nrows: R, ncols: C) -> Self::BufferUninit<T>;
    unsafe fn assume_init<T: Scalar>(
        uninit: Self::BufferUninit<T>,
    ) -> Self::Buffer<T>;
    fn allocate_from_iterator<T: Scalar, I: IntoIterator<Item = T>>(
        nrows: R,
        ncols: C,
        iter: I,
    ) -> Self::Buffer<T>;

    // Provided method
    fn allocate_from_row_iterator<T: Scalar, I: IntoIterator<Item = T>>(
        nrows: R,
        ncols: C,
        iter: I,
    ) -> Self::Buffer<T> { ... }
}

A matrix allocator of a memory buffer that may contain R::to_usize() * C::to_usize() elements of type T.

An allocator is said to be: − static: if R and C both implement DimName. − dynamic: if either one (or both) of R or C is equal to Dyn.

Every allocator must be both static and dynamic. Though not all implementations may share the same Buffer type.

Required Associated Types

type Buffer<T: Scalar>: StorageMut<T, R, C> + IsContiguous + Clone + Debug

The type of buffer this allocator can instantiate.

type BufferUninit<T: Scalar>: RawStorageMut<MaybeUninit<T>, R, C> + IsContiguous

The type of buffer with uninitialized components this allocator can instantiate.

Required Methods

fn allocate_uninit<T: Scalar>(nrows: R, ncols: C) -> Self::BufferUninit<T>

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

unsafe fn assume_init<T: Scalar>( uninit: Self::BufferUninit<T>, ) -> Self::Buffer<T>

Assumes a data buffer to be initialized.

Safety

The user must make sure that every single entry of the buffer has been initialized, or Undefined Behavior will immediately occur.

fn allocate_from_iterator<T: Scalar, I: IntoIterator<Item = T>>( nrows: R, ncols: C, iter: I, ) -> Self::Buffer<T>

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

Provided Methods

fn allocate_from_row_iterator<T: Scalar, I: IntoIterator<Item = T>>( nrows: R, ncols: C, iter: I, ) -> Self::Buffer<T>

Allocates a buffer initialized with the content of the given row-major order iterator.

Object Safety

This trait is not object safe.

Implementors

impl<const R: usize, const C: usize> Allocator<Const<R>, Const<C>> for DefaultAllocator

type Buffer<T: Scalar> = ArrayStorage<T, R, C>

type BufferUninit<T: Scalar> = ArrayStorage<MaybeUninit<T>, R, C>