nalgebra/src/base/default_allocator.rs

340 lines
11 KiB
Rust
Raw Normal View History

2017-02-13 01:17:09 +08:00
//! The default matrix data storage allocator.
//!
//! This will use stack-allocated buffers for matrices with dimensions known at compile-time, and
//! heap-allocated buffers for matrices with at least one dimension unknown at compile-time.
use std::cmp;
use std::ptr;
2018-05-24 23:17:34 +08:00
#[cfg(all(feature = "alloc", not(feature = "std")))]
2018-07-20 22:10:12 +08:00
use alloc::vec::Vec;
2018-05-24 23:17:34 +08:00
use super::Const;
use crate::base::allocator::{Allocator, Reallocator};
2020-04-06 00:49:48 +08:00
use crate::base::array_storage::ArrayStorage;
#[cfg(any(feature = "alloc", feature = "std"))]
use crate::base::dimension::Dynamic;
2019-03-23 21:29:07 +08:00
use crate::base::dimension::{Dim, DimName};
use crate::base::storage::{RawStorage, RawStorageMut};
#[cfg(any(feature = "std", feature = "alloc"))]
2019-03-23 21:29:07 +08:00
use crate::base::vec_storage::VecStorage;
use crate::base::Scalar;
use std::mem::{ManuallyDrop, MaybeUninit};
2021-07-15 06:21:22 +08:00
/*
*
* Allocator.
*
*/
/// An allocator based on `GenericArray` and `VecStorage` for statically-sized and dynamically-sized
/// matrices respectively.
2021-07-28 07:18:29 +08:00
#[derive(Copy, Clone, Debug)]
pub struct DefaultAllocator;
// Static - Static
impl<T: Scalar, const R: usize, const C: usize> Allocator<T, Const<R>, Const<C>>
for DefaultAllocator
{
2021-04-11 17:00:38 +08:00
type Buffer = ArrayStorage<T, R, C>;
type BufferUninit = ArrayStorage<MaybeUninit<T>, R, C>;
2021-08-04 17:19:57 +08:00
#[inline(always)]
fn allocate_uninit(_: Const<R>, _: Const<C>) -> ArrayStorage<MaybeUninit<T>, R, C> {
2021-07-18 02:01:03 +08:00
// SAFETY: An uninitialized `[MaybeUninit<_>; _]` is valid.
let array: [[MaybeUninit<T>; R]; C] = unsafe { MaybeUninit::uninit().assume_init() };
2021-07-17 17:36:14 +08:00
ArrayStorage(array)
2021-07-15 06:21:22 +08:00
}
2021-08-04 17:19:57 +08:00
#[inline(always)]
2021-07-30 01:33:45 +08:00
unsafe fn assume_init(uninit: ArrayStorage<MaybeUninit<T>, R, C>) -> ArrayStorage<T, R, C> {
// Safety:
2021-07-16 12:56:58 +08:00
// * The caller guarantees that all elements of the array are initialized
// * `MaybeUninit<T>` and T are guaranteed to have the same layout
2021-08-04 17:19:57 +08:00
// * `MaybeUninit` does not drop, so there are no double-frees
2021-07-16 12:56:58 +08:00
// And thus the conversion is safe
ArrayStorage((&uninit as *const _ as *const [_; C]).read())
2021-07-15 06:21:22 +08:00
}
2021-07-18 02:01:03 +08:00
#[inline]
fn allocate_from_iterator<I: IntoIterator<Item = T>>(
nrows: Const<R>,
ncols: Const<C>,
iter: I,
) -> Self::Buffer {
let mut res = Self::allocate_uninit(nrows, ncols);
let mut count = 0;
// Safety: conversion to a slice is OK because the Buffer is known to be contiguous.
let res_slice = unsafe { res.as_mut_slice_unchecked() };
for (res, e) in res_slice.iter_mut().zip(iter.into_iter()) {
*res = MaybeUninit::new(e);
count += 1;
}
assert!(
count == nrows.value() * ncols.value(),
"Matrix init. from iterator: iterator not long enough."
);
// Safety: the assertion above made sure that the iterator
// yielded enough elements to initialize our matrix.
unsafe { <Self as Allocator<T, Const<R>, Const<C>>>::assume_init(res) }
2021-07-18 02:01:03 +08:00
}
2021-07-15 06:21:22 +08:00
}
// Dynamic - Static
// Dynamic - Dynamic
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, C: Dim> Allocator<T, Dynamic, C> for DefaultAllocator {
2021-04-11 17:00:38 +08:00
type Buffer = VecStorage<T, Dynamic, C>;
type BufferUninit = VecStorage<MaybeUninit<T>, Dynamic, C>;
2021-07-15 06:21:22 +08:00
#[inline]
fn allocate_uninit(nrows: Dynamic, ncols: C) -> VecStorage<MaybeUninit<T>, Dynamic, C> {
2021-07-14 17:25:16 +08:00
let mut data = Vec::new();
let length = nrows.value() * ncols.value();
2021-07-14 17:25:16 +08:00
data.reserve_exact(length);
data.resize_with(length, MaybeUninit::uninit);
VecStorage::new(nrows, ncols, data)
}
#[inline]
2021-07-20 07:00:40 +08:00
unsafe fn assume_init(
2021-07-30 01:33:45 +08:00
uninit: VecStorage<MaybeUninit<T>, Dynamic, C>,
) -> VecStorage<T, Dynamic, C> {
2021-07-18 10:43:50 +08:00
// Avoids a double-drop.
let (nrows, ncols) = uninit.shape();
let vec: Vec<_> = uninit.into();
let mut md = ManuallyDrop::new(vec);
2021-07-14 17:25:16 +08:00
2021-07-18 10:43:50 +08:00
// Safety:
// - MaybeUninit<T> has the same alignment and layout as T.
// - The length and capacity come from a valid vector.
let new_data = Vec::from_raw_parts(md.as_mut_ptr() as *mut _, md.len(), md.capacity());
2021-07-14 17:25:16 +08:00
2021-07-18 10:43:50 +08:00
VecStorage::new(nrows, ncols, new_data)
}
2021-07-18 02:01:03 +08:00
#[inline]
2021-04-11 17:00:38 +08:00
fn allocate_from_iterator<I: IntoIterator<Item = T>>(
nrows: Dynamic,
ncols: C,
2018-02-02 19:26:35 +08:00
iter: I,
2021-07-30 01:33:45 +08:00
) -> Self::Buffer {
let it = iter.into_iter();
2021-04-11 17:00:38 +08:00
let res: Vec<T> = it.collect();
assert!(res.len() == nrows.value() * ncols.value(),
"Allocation from iterator error: the iterator did not yield the correct number of elements.");
VecStorage::new(nrows, ncols, res)
}
}
// Static - Dynamic
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, R: DimName> Allocator<T, R, Dynamic> for DefaultAllocator {
type Buffer = VecStorage<T, R, Dynamic>;
type BufferUninit = VecStorage<MaybeUninit<T>, R, Dynamic>;
#[inline]
fn allocate_uninit(nrows: R, ncols: Dynamic) -> VecStorage<MaybeUninit<T>, R, Dynamic> {
2021-07-14 17:25:16 +08:00
let mut data = Vec::new();
let length = nrows.value() * ncols.value();
2021-07-14 17:25:16 +08:00
data.reserve_exact(length);
data.resize_with(length, MaybeUninit::uninit);
VecStorage::new(nrows, ncols, data)
}
#[inline]
2021-07-20 07:00:40 +08:00
unsafe fn assume_init(
2021-07-30 01:33:45 +08:00
uninit: VecStorage<MaybeUninit<T>, R, Dynamic>,
) -> VecStorage<T, R, Dynamic> {
2021-07-18 10:43:50 +08:00
// Avoids a double-drop.
let (nrows, ncols) = uninit.shape();
let vec: Vec<_> = uninit.into();
let mut md = ManuallyDrop::new(vec);
2021-07-18 10:43:50 +08:00
// Safety:
// - MaybeUninit<T> has the same alignment and layout as T.
// - The length and capacity come from a valid vector.
let new_data = Vec::from_raw_parts(md.as_mut_ptr() as *mut _, md.len(), md.capacity());
2021-07-14 17:25:16 +08:00
2021-07-18 10:43:50 +08:00
VecStorage::new(nrows, ncols, new_data)
}
2021-07-18 02:01:03 +08:00
#[inline]
fn allocate_from_iterator<I: IntoIterator<Item = T>>(
nrows: R,
ncols: Dynamic,
iter: I,
) -> Self::Buffer {
let it = iter.into_iter();
let res: Vec<T> = it.collect();
assert!(res.len() == nrows.value() * ncols.value(),
"Allocation from iterator error: the iterator did not yield the correct number of elements.");
2021-07-20 07:00:40 +08:00
VecStorage::new(nrows, ncols, res)
2021-07-20 07:00:40 +08:00
}
}
/*
*
* Reallocator.
*
*/
// Anything -> Static × Static
impl<T: Scalar, RFrom, CFrom, const RTO: usize, const CTO: usize>
2021-04-11 17:00:38 +08:00
Reallocator<T, RFrom, CFrom, Const<RTO>, Const<CTO>> for DefaultAllocator
2018-02-02 19:26:35 +08:00
where
RFrom: Dim,
CFrom: Dim,
2021-04-11 17:00:38 +08:00
Self: Allocator<T, RFrom, CFrom>,
2018-02-02 19:26:35 +08:00
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: Const<RTO>,
cto: Const<CTO>,
2021-09-26 03:05:31 +08:00
buf: <Self as Allocator<T, RFrom, CFrom>>::Buffer,
) -> ArrayStorage<MaybeUninit<T>, RTO, CTO> {
let mut res = <Self as Allocator<T, Const<RTO>, Const<CTO>>>::allocate_uninit(rto, cto);
let (rfrom, cfrom) = buf.shape();
let len_from = rfrom.value() * cfrom.value();
2018-02-02 19:26:35 +08:00
let len_to = rto.value() * cto.value();
let len_copied = cmp::min(len_from, len_to);
ptr::copy_nonoverlapping(buf.ptr(), res.ptr_mut() as *mut T, len_copied);
// Safety:
// - We dont care about dropping elements because the caller is responsible for dropping things.
// - We forget `buf` so that we dont drop the other elements.
std::mem::forget(buf);
res
}
}
// Static × Static -> Dynamic × Any
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, CTo, const RFROM: usize, const CFROM: usize>
2021-04-11 17:00:38 +08:00
Reallocator<T, Const<RFROM>, Const<CFROM>, Dynamic, CTo> for DefaultAllocator
2018-02-02 19:26:35 +08:00
where
CTo: Dim,
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: Dynamic,
cto: CTo,
2021-09-26 03:05:31 +08:00
buf: ArrayStorage<T, RFROM, CFROM>,
) -> VecStorage<MaybeUninit<T>, Dynamic, CTo> {
let mut res = <Self as Allocator<T, Dynamic, CTo>>::allocate_uninit(rto, cto);
let (rfrom, cfrom) = buf.shape();
let len_from = rfrom.value() * cfrom.value();
2018-02-02 19:26:35 +08:00
let len_to = rto.value() * cto.value();
let len_copied = cmp::min(len_from, len_to);
ptr::copy_nonoverlapping(buf.ptr(), res.ptr_mut() as *mut T, len_copied);
// Safety:
// - We dont care about dropping elements because the caller is responsible for dropping things.
// - We forget `buf` so that we dont drop the other elements.
std::mem::forget(buf);
res
}
}
// Static × Static -> Static × Dynamic
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, RTo, const RFROM: usize, const CFROM: usize>
2021-04-11 17:00:38 +08:00
Reallocator<T, Const<RFROM>, Const<CFROM>, RTo, Dynamic> for DefaultAllocator
2018-02-02 19:26:35 +08:00
where
RTo: DimName,
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: RTo,
cto: Dynamic,
2021-09-26 03:05:31 +08:00
buf: ArrayStorage<T, RFROM, CFROM>,
) -> VecStorage<MaybeUninit<T>, RTo, Dynamic> {
let mut res = <Self as Allocator<T, RTo, Dynamic>>::allocate_uninit(rto, cto);
let (rfrom, cfrom) = buf.shape();
let len_from = rfrom.value() * cfrom.value();
2018-02-02 19:26:35 +08:00
let len_to = rto.value() * cto.value();
let len_copied = cmp::min(len_from, len_to);
ptr::copy_nonoverlapping(buf.ptr(), res.ptr_mut() as *mut T, len_copied);
// Safety:
// - We dont care about dropping elements because the caller is responsible for dropping things.
// - We forget `buf` so that we dont drop the other elements.
std::mem::forget(buf);
res
}
}
// All conversion from a dynamic buffer to a dynamic buffer.
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, CFrom: Dim, CTo: Dim> Reallocator<T, Dynamic, CFrom, Dynamic, CTo>
for DefaultAllocator
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: Dynamic,
cto: CTo,
2021-04-11 17:00:38 +08:00
buf: VecStorage<T, Dynamic, CFrom>,
) -> VecStorage<MaybeUninit<T>, Dynamic, CTo> {
let new_buf = buf.resize(rto.value() * cto.value());
VecStorage::new(rto, cto, new_buf)
}
}
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, CFrom: Dim, RTo: DimName> Reallocator<T, Dynamic, CFrom, RTo, Dynamic>
for DefaultAllocator
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: RTo,
cto: Dynamic,
2021-04-11 17:00:38 +08:00
buf: VecStorage<T, Dynamic, CFrom>,
) -> VecStorage<MaybeUninit<T>, RTo, Dynamic> {
let new_buf = buf.resize(rto.value() * cto.value());
VecStorage::new(rto, cto, new_buf)
}
}
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, RFrom: DimName, CTo: Dim> Reallocator<T, RFrom, Dynamic, Dynamic, CTo>
for DefaultAllocator
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: Dynamic,
cto: CTo,
2021-04-11 17:00:38 +08:00
buf: VecStorage<T, RFrom, Dynamic>,
) -> VecStorage<MaybeUninit<T>, Dynamic, CTo> {
let new_buf = buf.resize(rto.value() * cto.value());
VecStorage::new(rto, cto, new_buf)
}
}
#[cfg(any(feature = "std", feature = "alloc"))]
impl<T: Scalar, RFrom: DimName, RTo: DimName> Reallocator<T, RFrom, Dynamic, RTo, Dynamic>
for DefaultAllocator
{
#[inline]
2018-02-02 19:26:35 +08:00
unsafe fn reallocate_copy(
rto: RTo,
cto: Dynamic,
2021-04-11 17:00:38 +08:00
buf: VecStorage<T, RFrom, Dynamic>,
) -> VecStorage<MaybeUninit<T>, RTo, Dynamic> {
let new_buf = buf.resize(rto.value() * cto.value());
VecStorage::new(rto, cto, new_buf)
}
}