building_blocks_storage 0.7.1

Efficient storage for maps on sparse or dense, 2D and 3D integer lattices.
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

pub mod channel;
pub mod compression;
pub mod multichannel;

pub use channel::*;
pub use compression::*;
pub use multichannel::*;

use crate::MultiMutPtr;

/// Implemented by any tuple of `Channel`s to indicate the types of data being stored.
pub trait Channels {
    type Data;
    type Ptr: MultiMutPtr<Data = Self::Data>;
    type UninitSelf: UninitChannels;
}

/// Converts a tuple of channels into a tuple of slices.
pub trait Slices<'a> {
    type Target;

    fn slices(&'a self) -> Self::Target;
}

/// Converts a tuple of channels into a tuple of mutable slices.
pub trait SlicesMut<'a> {
    type Target;

    fn slices_mut(&'a mut self) -> Self::Target;
}

pub trait CopySlices<'a> {
    type Src;

    fn copy_slices(&mut self, src: Self::Src);
}

/// Converts a tuple of channels that own their data into a tuple of channels that borrow their data.
pub trait BorrowChannels<'a> {
    type Borrowed;

    fn borrow(&'a self) -> Self::Borrowed;
}

/// Converts a tuple of channels that own their data into a tuple of channels that mutably borrow their data.
pub trait BorrowChannelsMut<'a> {
    type Borrowed;

    fn borrow_mut(&'a mut self) -> Self::Borrowed;
}

pub trait ResetChannels: Channels {
    fn reset_values(&mut self, value: Self::Data);
}

pub trait FillChannels: Channels {
    fn fill(value: Self::Data, length: usize) -> Self;
}

pub trait UninitChannels: Channels {
    type InitSelf;

    /// # Safety
    /// Elements should not be read until they are initialized.
    unsafe fn maybe_uninit(size: usize) -> Self;

    /// # Safety
    /// All elements of the channel must be initialized.
    unsafe fn assume_init(self) -> Self::InitSelf;
}