nalgebra/src/base/array_storage.rs

332 lines
9.1 KiB
Rust
Raw Normal View History

2017-02-13 01:17:09 +08:00
use std::fmt::{self, Debug, Formatter};
// use std::hash::{Hash, Hasher};
2018-07-20 21:25:55 +08:00
#[cfg(feature = "abomonation-serialize")]
use std::io::{Result as IOResult, Write};
use std::ops::Mul;
#[cfg(feature = "serde-serialize-no-std")]
2018-07-20 21:25:55 +08:00
use serde::de::{Error, SeqAccess, Visitor};
#[cfg(feature = "serde-serialize-no-std")]
2017-02-13 01:17:09 +08:00
use serde::ser::SerializeSeq;
#[cfg(feature = "serde-serialize-no-std")]
2018-07-20 21:25:55 +08:00
use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[cfg(feature = "serde-serialize-no-std")]
use std::marker::PhantomData;
#[cfg(feature = "serde-serialize-no-std")]
2018-07-20 21:25:55 +08:00
use std::mem;
#[cfg(feature = "abomonation-serialize")]
use abomonation::Abomonation;
2021-07-15 06:21:22 +08:00
use crate::allocator::InnerAllocator;
2019-03-23 21:29:07 +08:00
use crate::base::default_allocator::DefaultAllocator;
use crate::base::dimension::{Const, ToTypenum};
use crate::base::storage::{
ContiguousStorage, ContiguousStorageMut, Owned, ReshapableStorage, Storage, StorageMut,
};
/*
*
* Static Storage.
*
*/
/// A array-based statically sized matrix data storage.
#[repr(C)]
#[derive(Copy, Clone, PartialEq, Eq, Hash)]
2021-04-11 17:00:38 +08:00
pub struct ArrayStorage<T, const R: usize, const C: usize>(pub [[T; R]; C]);
// TODO: remove this once the stdlib implements Default for arrays.
2021-04-11 17:00:38 +08:00
impl<T: Default, const R: usize, const C: usize> Default for ArrayStorage<T, R, C>
2019-04-16 16:11:27 +08:00
where
2021-04-11 17:00:38 +08:00
[[T; R]; C]: Default,
2019-04-16 16:11:27 +08:00
{
#[inline]
2019-04-16 16:11:27 +08:00
fn default() -> Self {
2021-04-11 17:00:38 +08:00
Self(Default::default())
2019-04-16 16:11:27 +08:00
}
}
2021-04-11 17:00:38 +08:00
impl<T: Debug, const R: usize, const C: usize> Debug for ArrayStorage<T, R, C> {
#[inline]
2017-02-13 01:17:09 +08:00
fn fmt(&self, fmt: &mut Formatter) -> fmt::Result {
2021-04-11 17:00:38 +08:00
self.0.fmt(fmt)
}
}
2021-04-11 17:00:38 +08:00
unsafe impl<T, const R: usize, const C: usize> Storage<T, Const<R>, Const<C>>
for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-15 06:21:22 +08:00
DefaultAllocator: InnerAllocator<T, Const<R>, Const<C>, Buffer = Self>,
2018-02-02 19:26:35 +08:00
{
type RStride = Const<1>;
type CStride = Const<R>;
#[inline]
2021-04-11 17:00:38 +08:00
fn ptr(&self) -> *const T {
self.0.as_ptr() as *const T
}
#[inline]
fn shape(&self) -> (Const<R>, Const<C>) {
(Const, Const)
}
#[inline]
fn strides(&self) -> (Self::RStride, Self::CStride) {
(Const, Const)
}
#[inline]
2021-07-09 00:12:43 +08:00
fn is_contiguous(&self) -> bool {
true
}
#[inline]
2021-04-11 17:00:38 +08:00
fn into_owned(self) -> Owned<T, Const<R>, Const<C>>
2020-04-06 00:49:48 +08:00
where
2021-07-15 06:21:22 +08:00
DefaultAllocator: InnerAllocator<T, Const<R>, Const<C>>,
2020-04-06 00:49:48 +08:00
{
self
}
#[inline]
2021-04-11 17:00:38 +08:00
fn clone_owned(&self) -> Owned<T, Const<R>, Const<C>>
2020-04-06 00:49:48 +08:00
where
2021-07-14 17:25:16 +08:00
T: Clone,
2021-07-15 06:21:22 +08:00
DefaultAllocator: InnerAllocator<T, Const<R>, Const<C>>,
2020-04-06 00:49:48 +08:00
{
let it = self.as_slice().iter().cloned();
DefaultAllocator::allocate_from_iterator(self.shape().0, self.shape().1, it)
}
#[inline]
unsafe fn as_slice_unchecked(&self) -> &[T] {
std::slice::from_raw_parts(self.ptr(), R * C)
}
}
2021-04-11 17:00:38 +08:00
unsafe impl<T, const R: usize, const C: usize> StorageMut<T, Const<R>, Const<C>>
for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-15 06:21:22 +08:00
DefaultAllocator:InnerAllocator<T, Const<R>, Const<C>, Buffer = Self>,
2018-02-02 19:26:35 +08:00
{
#[inline]
2021-04-11 17:00:38 +08:00
fn ptr_mut(&mut self) -> *mut T {
self.0.as_mut_ptr() as *mut T
}
#[inline]
unsafe fn as_mut_slice_unchecked(&mut self) -> &mut [T] {
std::slice::from_raw_parts_mut(self.ptr_mut(), R * C)
}
}
2021-04-11 17:00:38 +08:00
unsafe impl<T, const R: usize, const C: usize> ContiguousStorage<T, Const<R>, Const<C>>
for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-15 06:21:22 +08:00
DefaultAllocator:InnerAllocator<T, Const<R>, Const<C>, Buffer = Self>,
2020-04-06 00:49:48 +08:00
{
}
2021-04-11 17:00:38 +08:00
unsafe impl<T, const R: usize, const C: usize> ContiguousStorageMut<T, Const<R>, Const<C>>
for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-15 06:21:22 +08:00
DefaultAllocator:InnerAllocator<T, Const<R>, Const<C>, Buffer = Self>,
2020-04-06 00:49:48 +08:00
{
}
2017-02-13 01:17:09 +08:00
2021-04-11 17:00:38 +08:00
impl<T, const R1: usize, const C1: usize, const R2: usize, const C2: usize>
ReshapableStorage<T, Const<R1>, Const<C1>, Const<R2>, Const<C2>> for ArrayStorage<T, R1, C1>
where
Const<R1>: ToTypenum,
Const<C1>: ToTypenum,
Const<R2>: ToTypenum,
Const<C2>: ToTypenum,
<Const<R1> as ToTypenum>::Typenum: Mul<<Const<C1> as ToTypenum>::Typenum>,
<Const<R2> as ToTypenum>::Typenum: Mul<
<Const<C2> as ToTypenum>::Typenum,
Output = typenum::Prod<
<Const<R1> as ToTypenum>::Typenum,
<Const<C1> as ToTypenum>::Typenum,
>,
>,
{
2021-04-11 17:00:38 +08:00
type Output = ArrayStorage<T, R2, C2>;
fn reshape_generic(self, _: Const<R2>, _: Const<C2>) -> Self::Output {
unsafe {
2021-04-11 17:00:38 +08:00
let data: [[T; R2]; C2] = std::mem::transmute_copy(&self.0);
std::mem::forget(self.0);
ArrayStorage(data)
}
}
}
2017-02-13 01:17:09 +08:00
/*
*
* Serialization.
2017-02-13 01:17:09 +08:00
*
*/
// XXX: open an issue for serde so that it allows the serialization/deserialization of all arrays?
#[cfg(feature = "serde-serialize-no-std")]
2021-04-11 17:00:38 +08:00
impl<T, const R: usize, const C: usize> Serialize for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-14 17:25:16 +08:00
T: Serialize,
2018-02-02 19:26:35 +08:00
{
2017-02-13 01:17:09 +08:00
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
2020-04-06 00:49:48 +08:00
where
S: Serializer,
{
let mut serializer = serializer.serialize_seq(Some(R * C))?;
2017-02-13 01:17:09 +08:00
for e in self.as_slice().iter() {
2018-02-02 19:26:35 +08:00
serializer.serialize_element(e)?;
2017-02-13 01:17:09 +08:00
}
2018-02-02 19:26:35 +08:00
serializer.end()
}
}
2017-02-13 01:17:09 +08:00
#[cfg(feature = "serde-serialize-no-std")]
2021-04-11 17:00:38 +08:00
impl<'a, T, const R: usize, const C: usize> Deserialize<'a> for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-14 17:25:16 +08:00
T: Deserialize<'a>,
2018-02-02 19:26:35 +08:00
{
2017-02-13 01:17:09 +08:00
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
2020-04-06 00:49:48 +08:00
where
D: Deserializer<'a>,
{
deserializer.deserialize_seq(ArrayStorageVisitor::new())
2018-02-02 19:26:35 +08:00
}
2017-02-13 01:17:09 +08:00
}
#[cfg(feature = "serde-serialize-no-std")]
2017-02-13 01:17:09 +08:00
/// A visitor that produces a matrix array.
2021-04-11 17:00:38 +08:00
struct ArrayStorageVisitor<T, const R: usize, const C: usize> {
marker: PhantomData<T>,
2017-02-13 01:17:09 +08:00
}
#[cfg(feature = "serde-serialize-no-std")]
2021-07-14 17:25:16 +08:00
impl<T, const R: usize, const C: usize> ArrayStorageVisitor<T, R, C> {
2017-02-13 01:17:09 +08:00
/// Construct a new sequence visitor.
pub fn new() -> Self {
ArrayStorageVisitor {
2017-02-13 01:17:09 +08:00
marker: PhantomData,
}
}
}
#[cfg(feature = "serde-serialize-no-std")]
2021-04-11 17:00:38 +08:00
impl<'a, T, const R: usize, const C: usize> Visitor<'a> for ArrayStorageVisitor<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-14 17:25:16 +08:00
T: Deserialize<'a>,
2018-02-02 19:26:35 +08:00
{
2021-04-11 17:00:38 +08:00
type Value = ArrayStorage<T, R, C>;
2017-02-13 01:17:09 +08:00
fn expecting(&self, formatter: &mut Formatter) -> fmt::Result {
formatter.write_str("a matrix array")
}
#[inline]
2021-04-11 17:00:38 +08:00
fn visit_seq<V>(self, mut visitor: V) -> Result<ArrayStorage<T, R, C>, V::Error>
2020-04-06 00:49:48 +08:00
where
V: SeqAccess<'a>,
{
let mut out: Self::Value = unsafe { mem::MaybeUninit::uninit().assume_init() };
2017-02-13 01:17:09 +08:00
let mut curr = 0;
2019-03-23 21:29:07 +08:00
while let Some(value) = visitor.next_element()? {
*out.as_mut_slice()
.get_mut(curr)
2020-04-06 00:49:48 +08:00
.ok_or_else(|| V::Error::invalid_length(curr, &self))? = value;
2017-02-13 01:17:09 +08:00
curr += 1;
}
if curr == R * C {
2017-04-25 02:05:45 +08:00
Ok(out)
2018-02-02 19:26:35 +08:00
} else {
2017-04-25 02:05:45 +08:00
Err(V::Error::invalid_length(curr, &self))
}
2017-02-13 01:17:09 +08:00
}
}
#[cfg(feature = "bytemuck")]
2021-07-14 17:25:16 +08:00
unsafe impl<T: Copy + bytemuck::Zeroable, const R: usize, const C: usize> bytemuck::Zeroable
for ArrayStorage<T, R, C>
{
}
#[cfg(feature = "bytemuck")]
2021-07-14 17:25:16 +08:00
unsafe impl<T: Copy + bytemuck::Pod, const R: usize, const C: usize> bytemuck::Pod
2021-04-11 17:00:38 +08:00
for ArrayStorage<T, R, C>
{
}
#[cfg(feature = "abomonation-serialize")]
2021-04-11 17:00:38 +08:00
impl<T, const R: usize, const C: usize> Abomonation for ArrayStorage<T, R, C>
2018-02-02 19:26:35 +08:00
where
2021-07-14 17:25:16 +08:00
T: Abomonation,
{
2018-07-20 21:25:55 +08:00
unsafe fn entomb<W: Write>(&self, writer: &mut W) -> IOResult<()> {
for element in self.as_slice() {
2018-07-20 21:25:55 +08:00
element.entomb(writer)?;
}
2018-07-20 21:25:55 +08:00
Ok(())
}
unsafe fn exhume<'a, 'b>(&'a mut self, mut bytes: &'b mut [u8]) -> Option<&'b mut [u8]> {
for element in self.as_mut_slice() {
let temp = bytes;
2021-07-04 11:19:07 +08:00
bytes = element.exhume(temp)?
}
Some(bytes)
}
2018-07-20 21:25:55 +08:00
fn extent(&self) -> usize {
self.as_slice().iter().fold(0, |acc, e| acc + e.extent())
2018-07-20 21:25:55 +08:00
}
}
2021-05-07 08:59:02 +08:00
#[cfg(feature = "rkyv-serialize-no-std")]
2021-05-09 23:28:49 +08:00
mod rkyv_impl {
use super::ArrayStorage;
use rkyv::{offset_of, project_struct, Archive, Deserialize, Fallible, Serialize};
impl<T: Archive, const R: usize, const C: usize> Archive for ArrayStorage<T, R, C> {
type Archived = ArrayStorage<T::Archived, R, C>;
type Resolver = <[[T; R]; C] as Archive>::Resolver;
fn resolve(
&self,
pos: usize,
resolver: Self::Resolver,
out: &mut core::mem::MaybeUninit<Self::Archived>,
) {
self.0.resolve(
pos + offset_of!(Self::Archived, 0),
resolver,
project_struct!(out: Self::Archived => 0),
);
}
2021-05-07 08:59:02 +08:00
}
2021-05-09 23:28:49 +08:00
impl<T: Serialize<S>, S: Fallible + ?Sized, const R: usize, const C: usize> Serialize<S>
for ArrayStorage<T, R, C>
{
fn serialize(&self, serializer: &mut S) -> Result<Self::Resolver, S::Error> {
2021-07-04 11:19:07 +08:00
self.0.serialize(serializer)
2021-05-09 23:28:49 +08:00
}
2021-05-07 08:59:02 +08:00
}
2021-05-09 23:28:49 +08:00
impl<T: Archive, D: Fallible + ?Sized, const R: usize, const C: usize>
Deserialize<ArrayStorage<T, R, C>, D> for ArrayStorage<T::Archived, R, C>
where
T::Archived: Deserialize<T, D>,
{
fn deserialize(&self, deserializer: &mut D) -> Result<ArrayStorage<T, R, C>, D::Error> {
Ok(ArrayStorage(self.0.deserialize(deserializer)?))
}
2021-05-07 08:59:02 +08:00
}
}