485 lines
13 KiB
Rust
485 lines
13 KiB
Rust
#[cfg(feature = "abomonation-serialize")]
|
||
use std::io::{Result as IOResult, Write};
|
||
|
||
#[cfg(all(feature = "alloc", not(feature = "std")))]
|
||
use alloc::vec::Vec;
|
||
|
||
use crate::base::allocator::Allocator;
|
||
use crate::base::constraint::{SameNumberOfRows, ShapeConstraint};
|
||
use crate::base::default_allocator::DefaultAllocator;
|
||
use crate::base::dimension::{Dim, DimName, Dynamic, U1};
|
||
use crate::base::storage::{IsContiguous, Owned, RawStorage, RawStorageMut, ReshapableStorage};
|
||
use crate::base::{Scalar, Vector};
|
||
|
||
#[cfg(feature = "serde-serialize-no-std")]
|
||
use serde::{
|
||
de::{Deserialize, Deserializer, Error},
|
||
ser::{Serialize, Serializer},
|
||
};
|
||
|
||
use crate::Storage;
|
||
#[cfg(feature = "abomonation-serialize")]
|
||
use abomonation::Abomonation;
|
||
use std::mem::MaybeUninit;
|
||
|
||
/*
|
||
*
|
||
* RawStorage.
|
||
*
|
||
*/
|
||
/// A Vec-based matrix data storage. It may be dynamically-sized.
|
||
#[repr(C)]
|
||
#[derive(Eq, Debug, Clone, PartialEq)]
|
||
pub struct VecStorage<T, R: Dim, C: Dim> {
|
||
data: Vec<T>,
|
||
nrows: R,
|
||
ncols: C,
|
||
}
|
||
|
||
#[cfg(feature = "serde-serialize")]
|
||
impl<T, R: Dim, C: Dim> Serialize for VecStorage<T, R, C>
|
||
where
|
||
T: Serialize,
|
||
R: Serialize,
|
||
C: Serialize,
|
||
{
|
||
fn serialize<Ser>(&self, serializer: Ser) -> Result<Ser::Ok, Ser::Error>
|
||
where
|
||
Ser: Serializer,
|
||
{
|
||
(&self.data, &self.nrows, &self.ncols).serialize(serializer)
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "serde-serialize")]
|
||
impl<'a, T, R: Dim, C: Dim> Deserialize<'a> for VecStorage<T, R, C>
|
||
where
|
||
T: Deserialize<'a>,
|
||
R: Deserialize<'a>,
|
||
C: Deserialize<'a>,
|
||
{
|
||
fn deserialize<Des>(deserializer: Des) -> Result<Self, Des::Error>
|
||
where
|
||
Des: Deserializer<'a>,
|
||
{
|
||
let (data, nrows, ncols): (Vec<T>, R, C) = Deserialize::deserialize(deserializer)?;
|
||
|
||
// SAFETY: make sure the data we deserialize have the
|
||
// correct number of elements.
|
||
if nrows.value() * ncols.value() != data.len() {
|
||
return Err(Des::Error::custom(format!(
|
||
"Expected {} components, found {}",
|
||
nrows.value() * ncols.value(),
|
||
data.len()
|
||
)));
|
||
}
|
||
|
||
Ok(Self { data, nrows, ncols })
|
||
}
|
||
}
|
||
|
||
#[deprecated(note = "renamed to `VecStorage`")]
|
||
/// Renamed to [`VecStorage`].
|
||
pub type MatrixVec<T, R, C> = VecStorage<T, R, C>;
|
||
|
||
impl<T, R: Dim, C: Dim> VecStorage<T, R, C> {
|
||
/// Creates a new dynamic matrix data storage from the given vector and shape.
|
||
#[inline]
|
||
pub fn new(nrows: R, ncols: C, data: Vec<T>) -> Self {
|
||
assert!(
|
||
nrows.value() * ncols.value() == data.len(),
|
||
"Data storage buffer dimension mismatch."
|
||
);
|
||
Self { data, nrows, ncols }
|
||
}
|
||
|
||
/// The underlying data storage.
|
||
#[inline]
|
||
#[must_use]
|
||
pub fn as_vec(&self) -> &Vec<T> {
|
||
&self.data
|
||
}
|
||
|
||
/// The underlying mutable data storage.
|
||
///
|
||
/// # Safety
|
||
/// This is unsafe because this may cause UB if the size of the vector is changed
|
||
/// by the user.
|
||
#[inline]
|
||
pub unsafe fn as_vec_mut(&mut self) -> &mut Vec<T> {
|
||
&mut self.data
|
||
}
|
||
|
||
/// Resizes the underlying mutable data storage and unwraps it.
|
||
///
|
||
/// # Safety
|
||
/// - If `sz` is larger than the current size, additional elements are uninitialized.
|
||
/// - If `sz` is smaller than the current size, additional elements are truncated but **not** dropped.
|
||
/// It is the responsibility of the caller of this method to drop these elements.
|
||
#[inline]
|
||
pub unsafe fn resize(mut self, sz: usize) -> Vec<MaybeUninit<T>> {
|
||
let len = self.len();
|
||
|
||
let new_data = if sz < len {
|
||
// Use `set_len` instead of `truncate` because we don’t want to
|
||
// drop the removed elements (it’s the caller’s responsibility).
|
||
self.data.set_len(sz);
|
||
self.data.shrink_to_fit();
|
||
|
||
// Safety:
|
||
// - MaybeUninit<T> has the same alignment and layout as T.
|
||
// - The length and capacity come from a valid vector.
|
||
Vec::from_raw_parts(
|
||
self.data.as_mut_ptr() as *mut MaybeUninit<T>,
|
||
self.data.len(),
|
||
self.data.capacity(),
|
||
)
|
||
} else {
|
||
self.data.reserve_exact(sz - len);
|
||
|
||
// Safety:
|
||
// - MaybeUninit<T> has the same alignment and layout as T.
|
||
// - The length and capacity come from a valid vector.
|
||
let mut new_data = Vec::from_raw_parts(
|
||
self.data.as_mut_ptr() as *mut MaybeUninit<T>,
|
||
self.data.len(),
|
||
self.data.capacity(),
|
||
);
|
||
|
||
// Safety: we can set the length here because MaybeUninit is always assumed
|
||
// to be initialized.
|
||
new_data.set_len(sz);
|
||
new_data
|
||
};
|
||
|
||
// Avoid double-free by forgetting `self` because its data buffer has
|
||
// been transfered to `new_data`.
|
||
std::mem::forget(self);
|
||
new_data
|
||
}
|
||
|
||
/// The number of elements on the underlying vector.
|
||
#[inline]
|
||
#[must_use]
|
||
pub fn len(&self) -> usize {
|
||
self.data.len()
|
||
}
|
||
|
||
/// Returns true if the underlying vector contains no elements.
|
||
#[inline]
|
||
#[must_use]
|
||
pub fn is_empty(&self) -> bool {
|
||
self.len() == 0
|
||
}
|
||
|
||
/// A slice containing all the components stored in this storage in column-major order.
|
||
#[inline]
|
||
pub fn as_slice(&self) -> &[T] {
|
||
&self.data[..]
|
||
}
|
||
|
||
/// A mutable slice containing all the components stored in this storage in column-major order.
|
||
#[inline]
|
||
pub fn as_mut_slice(&mut self) -> &mut [T] {
|
||
&mut self.data[..]
|
||
}
|
||
}
|
||
|
||
impl<T, R: Dim, C: Dim> From<VecStorage<T, R, C>> for Vec<T> {
|
||
fn from(vec: VecStorage<T, R, C>) -> Self {
|
||
vec.data
|
||
}
|
||
}
|
||
|
||
/*
|
||
*
|
||
* Dynamic − Static
|
||
* Dynamic − Dynamic
|
||
*
|
||
*/
|
||
unsafe impl<T, C: Dim> RawStorage<T, Dynamic, C> for VecStorage<T, Dynamic, C> {
|
||
type RStride = U1;
|
||
type CStride = Dynamic;
|
||
|
||
#[inline]
|
||
fn ptr(&self) -> *const T {
|
||
self.data.as_ptr()
|
||
}
|
||
|
||
#[inline]
|
||
fn shape(&self) -> (Dynamic, C) {
|
||
(self.nrows, self.ncols)
|
||
}
|
||
|
||
#[inline]
|
||
fn strides(&self) -> (Self::RStride, Self::CStride) {
|
||
(Self::RStride::name(), self.nrows)
|
||
}
|
||
|
||
#[inline]
|
||
fn is_contiguous(&self) -> bool {
|
||
true
|
||
}
|
||
|
||
#[inline]
|
||
unsafe fn as_slice_unchecked(&self) -> &[T] {
|
||
&self.data
|
||
}
|
||
}
|
||
|
||
unsafe impl<T: Scalar, C: Dim> Storage<T, Dynamic, C> for VecStorage<T, Dynamic, C>
|
||
where
|
||
DefaultAllocator: Allocator<T, Dynamic, C, Buffer = Self>,
|
||
{
|
||
#[inline]
|
||
fn into_owned(self) -> Owned<T, Dynamic, C>
|
||
where
|
||
DefaultAllocator: Allocator<T, Dynamic, C>,
|
||
{
|
||
self
|
||
}
|
||
|
||
#[inline]
|
||
fn clone_owned(&self) -> Owned<T, Dynamic, C>
|
||
where
|
||
DefaultAllocator: Allocator<T, Dynamic, C>,
|
||
{
|
||
self.clone()
|
||
}
|
||
}
|
||
|
||
unsafe impl<T, R: DimName> RawStorage<T, R, Dynamic> for VecStorage<T, R, Dynamic> {
|
||
type RStride = U1;
|
||
type CStride = R;
|
||
|
||
#[inline]
|
||
fn ptr(&self) -> *const T {
|
||
self.data.as_ptr()
|
||
}
|
||
|
||
#[inline]
|
||
fn shape(&self) -> (R, Dynamic) {
|
||
(self.nrows, self.ncols)
|
||
}
|
||
|
||
#[inline]
|
||
fn strides(&self) -> (Self::RStride, Self::CStride) {
|
||
(Self::RStride::name(), self.nrows)
|
||
}
|
||
|
||
#[inline]
|
||
fn is_contiguous(&self) -> bool {
|
||
true
|
||
}
|
||
|
||
#[inline]
|
||
unsafe fn as_slice_unchecked(&self) -> &[T] {
|
||
&self.data
|
||
}
|
||
}
|
||
|
||
unsafe impl<T: Scalar, R: DimName> Storage<T, R, Dynamic> for VecStorage<T, R, Dynamic>
|
||
where
|
||
DefaultAllocator: Allocator<T, R, Dynamic, Buffer = Self>,
|
||
{
|
||
#[inline]
|
||
fn into_owned(self) -> Owned<T, R, Dynamic>
|
||
where
|
||
DefaultAllocator: Allocator<T, R, Dynamic>,
|
||
{
|
||
self
|
||
}
|
||
|
||
#[inline]
|
||
fn clone_owned(&self) -> Owned<T, R, Dynamic>
|
||
where
|
||
DefaultAllocator: Allocator<T, R, Dynamic>,
|
||
{
|
||
self.clone()
|
||
}
|
||
}
|
||
|
||
/*
|
||
*
|
||
* RawStorageMut, ContiguousStorage.
|
||
*
|
||
*/
|
||
unsafe impl<T, C: Dim> RawStorageMut<T, Dynamic, C> for VecStorage<T, Dynamic, C> {
|
||
#[inline]
|
||
fn ptr_mut(&mut self) -> *mut T {
|
||
self.data.as_mut_ptr()
|
||
}
|
||
|
||
#[inline]
|
||
unsafe fn as_mut_slice_unchecked(&mut self) -> &mut [T] {
|
||
&mut self.data[..]
|
||
}
|
||
}
|
||
|
||
unsafe impl<T, R: Dim, C: Dim> IsContiguous for VecStorage<T, R, C> {}
|
||
|
||
impl<T, C1, C2> ReshapableStorage<T, Dynamic, C1, Dynamic, C2> for VecStorage<T, Dynamic, C1>
|
||
where
|
||
T: Scalar,
|
||
C1: Dim,
|
||
C2: Dim,
|
||
{
|
||
type Output = VecStorage<T, Dynamic, C2>;
|
||
|
||
fn reshape_generic(self, nrows: Dynamic, ncols: C2) -> Self::Output {
|
||
assert_eq!(nrows.value() * ncols.value(), self.data.len());
|
||
VecStorage {
|
||
data: self.data,
|
||
nrows,
|
||
ncols,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl<T, C1, R2> ReshapableStorage<T, Dynamic, C1, R2, Dynamic> for VecStorage<T, Dynamic, C1>
|
||
where
|
||
T: Scalar,
|
||
C1: Dim,
|
||
R2: DimName,
|
||
{
|
||
type Output = VecStorage<T, R2, Dynamic>;
|
||
|
||
fn reshape_generic(self, nrows: R2, ncols: Dynamic) -> Self::Output {
|
||
assert_eq!(nrows.value() * ncols.value(), self.data.len());
|
||
VecStorage {
|
||
data: self.data,
|
||
nrows,
|
||
ncols,
|
||
}
|
||
}
|
||
}
|
||
|
||
unsafe impl<T, R: DimName> RawStorageMut<T, R, Dynamic> for VecStorage<T, R, Dynamic> {
|
||
#[inline]
|
||
fn ptr_mut(&mut self) -> *mut T {
|
||
self.data.as_mut_ptr()
|
||
}
|
||
|
||
#[inline]
|
||
unsafe fn as_mut_slice_unchecked(&mut self) -> &mut [T] {
|
||
&mut self.data[..]
|
||
}
|
||
}
|
||
|
||
impl<T, R1, C2> ReshapableStorage<T, R1, Dynamic, Dynamic, C2> for VecStorage<T, R1, Dynamic>
|
||
where
|
||
T: Scalar,
|
||
R1: DimName,
|
||
C2: Dim,
|
||
{
|
||
type Output = VecStorage<T, Dynamic, C2>;
|
||
|
||
fn reshape_generic(self, nrows: Dynamic, ncols: C2) -> Self::Output {
|
||
assert_eq!(nrows.value() * ncols.value(), self.data.len());
|
||
VecStorage {
|
||
data: self.data,
|
||
nrows,
|
||
ncols,
|
||
}
|
||
}
|
||
}
|
||
|
||
impl<T, R1, R2> ReshapableStorage<T, R1, Dynamic, R2, Dynamic> for VecStorage<T, R1, Dynamic>
|
||
where
|
||
T: Scalar,
|
||
R1: DimName,
|
||
R2: DimName,
|
||
{
|
||
type Output = VecStorage<T, R2, Dynamic>;
|
||
|
||
fn reshape_generic(self, nrows: R2, ncols: Dynamic) -> Self::Output {
|
||
assert_eq!(nrows.value() * ncols.value(), self.data.len());
|
||
VecStorage {
|
||
data: self.data,
|
||
nrows,
|
||
ncols,
|
||
}
|
||
}
|
||
}
|
||
|
||
#[cfg(feature = "abomonation-serialize")]
|
||
impl<T: Abomonation, R: Dim, C: Dim> Abomonation for VecStorage<T, R, C> {
|
||
unsafe fn entomb<W: Write>(&self, writer: &mut W) -> IOResult<()> {
|
||
self.data.entomb(writer)
|
||
}
|
||
|
||
unsafe fn exhume<'a, 'b>(&'a mut self, bytes: &'b mut [u8]) -> Option<&'b mut [u8]> {
|
||
self.data.exhume(bytes)
|
||
}
|
||
|
||
fn extent(&self) -> usize {
|
||
self.data.extent()
|
||
}
|
||
}
|
||
|
||
impl<T, R: Dim> Extend<T> for VecStorage<T, R, Dynamic> {
|
||
/// Extends the number of columns of the `VecStorage` 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
|
||
/// `VecStorage`.
|
||
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
|
||
self.data.extend(iter);
|
||
self.ncols = Dynamic::new(self.data.len() / self.nrows.value());
|
||
assert!(self.data.len() % self.nrows.value() == 0,
|
||
"The number of elements produced by the given iterator was not a multiple of the number of rows.");
|
||
}
|
||
}
|
||
|
||
impl<'a, T: 'a + Copy, R: Dim> Extend<&'a T> for VecStorage<T, R, Dynamic> {
|
||
/// Extends the number of columns of the `VecStorage` 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
|
||
/// `VecStorage`.
|
||
fn extend<I: IntoIterator<Item = &'a T>>(&mut self, iter: I) {
|
||
self.extend(iter.into_iter().copied())
|
||
}
|
||
}
|
||
|
||
impl<T, R, RV, SV> Extend<Vector<T, RV, SV>> for VecStorage<T, R, Dynamic>
|
||
where
|
||
T: Scalar,
|
||
R: Dim,
|
||
RV: Dim,
|
||
SV: RawStorage<T, RV>,
|
||
ShapeConstraint: SameNumberOfRows<R, RV>,
|
||
{
|
||
/// Extends the number of columns of the `VecStorage` 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 `VecStorage`.
|
||
fn extend<I: IntoIterator<Item = Vector<T, RV, SV>>>(&mut self, iter: I) {
|
||
let nrows = self.nrows.value();
|
||
let iter = iter.into_iter();
|
||
let (lower, _upper) = iter.size_hint();
|
||
self.data.reserve(nrows * lower);
|
||
for vector in iter {
|
||
assert_eq!(nrows, vector.shape().0);
|
||
self.data.extend(vector.iter().cloned());
|
||
}
|
||
self.ncols = Dynamic::new(self.data.len() / nrows);
|
||
}
|
||
}
|
||
|
||
impl<T> Extend<T> for VecStorage<T, Dynamic, U1> {
|
||
/// Extends the number of rows of the `VecStorage` with elements
|
||
/// from the given iterator.
|
||
fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I) {
|
||
self.data.extend(iter);
|
||
self.nrows = Dynamic::new(self.data.len());
|
||
}
|
||
}
|