mdarray 0.7.2

Multidimensional array for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

use std::alloc::{AllocError, Allocator, Global, Layout};
use std::cmp;
use std::ptr::NonNull;

/// Aligned memory allocator, using the global allocator as default.
#[derive(Clone, Copy, Debug, Default)]
pub struct AlignedAlloc<const N: usize, A: Allocator = Global> {
    alloc: A,
}

impl<const N: usize, A: Allocator> AlignedAlloc<N, A> {
    /// Creates a new aligned allocator based on the specified allocator.
    pub fn new(alloc: A) -> Self {
        assert!(N.is_power_of_two(), "alignment must be power of two");

        Self { alloc }
    }
}

unsafe impl<const N: usize, A: Allocator> Allocator for AlignedAlloc<N, A> {
    fn allocate(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError> {
        self.alloc.allocate(aligned_layout::<N>(layout))
    }

    unsafe fn deallocate(&self, ptr: NonNull<u8>, layout: Layout) {
        unsafe {
            self.alloc.deallocate(ptr, aligned_layout::<N>(layout));
        }
    }

    fn allocate_zeroed(&self, layout: Layout) -> Result<NonNull<[u8]>, AllocError> {
        self.alloc.allocate_zeroed(aligned_layout::<N>(layout))
    }

    unsafe fn grow(
        &self,
        ptr: NonNull<u8>,
        old_layout: Layout,
        new_layout: Layout,
    ) -> Result<NonNull<[u8]>, AllocError> {
        unsafe {
            self.alloc.grow(ptr, aligned_layout::<N>(old_layout), aligned_layout::<N>(new_layout))
        }
    }

    unsafe fn grow_zeroed(
        &self,
        ptr: NonNull<u8>,
        old_layout: Layout,
        new_layout: Layout,
    ) -> Result<NonNull<[u8]>, AllocError> {
        unsafe {
            self.alloc.grow_zeroed(
                ptr,
                aligned_layout::<N>(old_layout),
                aligned_layout::<N>(new_layout),
            )
        }
    }

    unsafe fn shrink(
        &self,
        ptr: NonNull<u8>,
        old_layout: Layout,
        new_layout: Layout,
    ) -> Result<NonNull<[u8]>, AllocError> {
        unsafe {
            self.alloc.shrink(ptr, aligned_layout::<N>(old_layout), aligned_layout::<N>(new_layout))
        }
    }
}

fn aligned_layout<const N: usize>(layout: Layout) -> Layout {
    // Align to the specified value, but not larger than the layout size rounded
    // to the next power of two and not smaller than the layout alignment.
    let align = cmp::min(N, layout.size().next_power_of_two());

    unsafe { Layout::from_size_align_unchecked(layout.size(), cmp::max(layout.align(), align)) }
}