garray2d 0.5.1

Game development focused 2d array with signed index and offset support.
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

use mint::Vector2;

use crate::Zip;
use crate::traits::{Array2dStorageMut, Array2dStorageOwned};

use crate::{Array2d, GenericArray2d, traits::Array2dStorage, zip::GenericArray2dRef};

impl<T: Array2dStorage> GenericArray2d<T> {
    /// Copy the array or slice into an owned array.
    pub fn copied(&self) -> Array2d<T::Item>
    where
        T::Item: Copy,
    {
        let mut data = Vec::with_capacity(self.len());
        data.extend(self.values().copied());
        Array2d {
            data,
            boundary: self.boundary,
            pitch: self.pitch,
        }
    }

    /// Clone the array or slice into an owned array.
    pub fn cloned(&self) -> Array2d<T::Item>
    where
        T::Item: Clone,
    {
        let mut data = Vec::with_capacity(self.len());
        data.extend(self.values().cloned());
        Array2d {
            data,
            boundary: self.boundary,
            pitch: self.pitch,
        }
    }

    /// Map the array or slice into an owned array.
    pub fn mapped<U>(&self, f: impl FnMut(&T::Item) -> U) -> Array2d<U> {
        let mut data = Vec::with_capacity(self.len());
        data.extend(self.values().map(f));
        Array2d {
            data,
            boundary: self.boundary,
            pitch: self.pitch,
        }
    }

    /// Combine with another array, must have the same dimension.
    ///
    /// Supports both mutable and immutable references.
    pub fn zip<U: GenericArray2dRef>(&self, rhs: U) -> Zip<&Self, U> {
        Zip(self, rhs)
    }

    /// Combine with another array, must have the same dimension.
    ///
    /// Supports both mutable and immutable references.
    pub fn zip_mut<U: GenericArray2dRef>(&mut self, rhs: U) -> Zip<&mut Self, U>
    where
        T: Array2dStorageMut,
    {
        Zip(self, rhs)
    }
}

/// Indicates a point has a truth value or signifies being occupied.
pub trait Truthy {
    fn is_true(&self) -> bool;
}

impl Truthy for bool {
    fn is_true(&self) -> bool {
        *self
    }
}

impl<T> Truthy for Option<T> {
    fn is_true(&self) -> bool {
        self.is_some()
    }
}

impl<T: Array2dStorage<Item: Truthy>> GenericArray2d<T> {
    /// For a boolean 2d array, iterate through points with `true` values.
    pub fn iter_points<U: From<Vector2<i32>>>(&self) -> impl Iterator<Item = U> {
        self.iter::<U>()
            .filter_map(|(pos, val)| val.is_true().then_some(pos))
    }

    /// For a boolean 2d array, iterate through points with `true` values.
    pub fn iter_points_owned<U: From<Vector2<i32>>>(self) -> impl Iterator<Item = U>
    where
        T: Array2dStorageOwned,
    {
        self.iter_owned::<U>()
            .filter_map(|(pos, val)| val.is_true().then_some(pos))
    }

    /// For a boolean 2d array, iterate through points with `true` values that have at least one `false` or out of bounds neighbors.
    pub fn border_detection<U: From<Vector2<i32>>>(&self) -> impl Iterator<Item = U> {
        let pitch = self.pitch;
        let slice = self.data.slice();
        self.boundary()
            .trim_border()
            .iter()
            .filter(move |p| {
                let i = self.index_internal(*p).unwrap();
                slice[i].is_true()
                    && (!slice[i - 1].is_true()
                        || !slice[i + 1].is_true()
                        || !slice[i - pitch].is_true()
                        || !slice[i + pitch].is_true())
            })
            .chain(
                self.boundary()
                    .iter_border()
                    .filter(move |p| self.get(*p).is_some_and(|x| x.is_true())),
            )
            .map(Into::into)
    }
}

impl<T: Array2dStorage<Item = Option<A>>, A> GenericArray2d<T> {
    /// For a option 2d array, iterate through points with `Some` values.
    pub fn iter_some<'t, U: From<Vector2<i32>>>(&'t self) -> impl Iterator<Item = (U, &'t A)>
    where
        A: 't,
    {
        self.iter::<U>()
            .filter_map(|(pos, value)| value.as_ref().map(|v| (pos, v)))
    }

    /// For a option 2d array, iterate through points with `Some` values.
    pub fn iter_some_mut<'t, U: From<Vector2<i32>>>(
        &'t mut self,
    ) -> impl Iterator<Item = (U, &'t mut A)>
    where
        T: Array2dStorageMut,
        A: 't,
    {
        self.iter_mut::<U>()
            .filter_map(|(pos, value)| value.as_mut().map(|v| (pos, v)))
    }

    /// For a option 2d array, iterate through points with `Some` values.
    pub fn iter_some_owned<U: From<Vector2<i32>>>(self) -> impl Iterator<Item = (U, A)>
    where
        T: Array2dStorageOwned,
    {
        self.iter_owned::<U>()
            .filter_map(|(pos, value)| value.map(|v| (pos, v)))
    }
}