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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

use crate::{Iter2, Iter3, Local2i, Local3i, Stride};

use building_blocks_core::prelude::*;

/// Used for both 2D and 3D strided iteration. (Z only used for 3D).
#[derive(Clone)]
pub struct ArrayStrideIter {
    x_stride: usize,
    y_stride: usize,
    z_stride: usize,
    x_start: usize,
    y_start: usize,
    z_start: usize,
    x_i: usize,
    y_i: usize,
    z_i: usize,
}

impl ArrayStrideIter {
    pub fn new_2d(array_shape: Point2i, origin: Local2i, step: Point2i) -> Self {
        debug_assert!(array_shape >= Point2i::ONES);
        debug_assert!(origin.0 >= Point2i::ZERO);
        debug_assert!(step >= Point2i::ONES);

        let mut x_stride = 1usize;
        let mut y_stride = array_shape.x() as usize;

        let x_start = x_stride * origin.0.x() as usize;
        let y_start = y_stride * origin.0.y() as usize;

        x_stride *= step.x() as usize;
        y_stride *= step.y() as usize;

        Self {
            x_stride,
            y_stride,
            z_stride: 0,
            x_start,
            y_start,
            z_start: 0,
            x_i: 0,
            y_i: 0,
            z_i: 0,
        }
    }

    pub fn new_3d(array_shape: Point3i, origin: Local3i, step: Point3i) -> Self {
        debug_assert!(array_shape >= Point3i::ONES);
        debug_assert!(origin.0 >= Point3i::ZERO);
        debug_assert!(step >= Point3i::ONES);

        let mut x_stride = 1usize;
        let mut y_stride = array_shape.x() as usize;
        let mut z_stride = (array_shape.y() * array_shape.x()) as usize;

        let x_start = x_stride * origin.0.x() as usize;
        let y_start = y_stride * origin.0.y() as usize;
        let z_start = z_stride * origin.0.z() as usize;

        x_stride *= step.x() as usize;
        y_stride *= step.y() as usize;
        z_stride *= step.z() as usize;

        Self {
            x_stride,
            y_stride,
            z_stride,
            x_start,
            y_start,
            z_start,
            x_i: 0,
            y_i: 0,
            z_i: 0,
        }
    }
}

impl Iter2 for ArrayStrideIter {
    type Coords = Stride;

    #[inline]
    fn coords(&self) -> Self::Coords {
        Stride(self.x_i)
    }

    #[inline]
    fn start_y(&mut self) {
        self.y_i = self.y_start;
    }
    #[inline]
    fn start_x(&mut self) {
        self.x_i = self.y_i + self.x_start;
    }

    #[inline]
    fn incr_x(&mut self) {
        self.x_i += self.x_stride;
    }
    #[inline]
    fn incr_y(&mut self) {
        self.y_i += self.y_stride;
    }
}

impl Iter3 for ArrayStrideIter {
    type Coords = Stride;

    #[inline]
    fn coords(&self) -> Self::Coords {
        Stride(self.x_i)
    }

    #[inline]
    fn start_z(&mut self) {
        self.z_i = self.z_start;
    }
    #[inline]
    fn start_y(&mut self) {
        self.y_i = self.z_i + self.y_start;
    }
    #[inline]
    fn start_x(&mut self) {
        self.x_i = self.y_i + self.x_start;
    }

    #[inline]
    fn incr_x(&mut self) {
        self.x_i += self.x_stride;
    }
    #[inline]
    fn incr_y(&mut self) {
        self.y_i += self.y_stride;
    }
    #[inline]
    fn incr_z(&mut self) {
        self.z_i += self.z_stride;
    }
}