grixy 0.5.0

2-dimensional grids
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

//! Testing fixtures internal to the crate.

extern crate alloc;

use alloc::{vec, vec::Vec};

use crate::{
    core::{GridError, RowMajor},
    ops::{GridRead, GridWrite},
};

/// A grid implementation that does not optimize any operations.
pub struct NaiveGrid<T> {
    cells: Vec<T>,
    width: usize,
    height: usize,
}

impl<T> NaiveGrid<T> {
    #[must_use]
    pub fn new(width: usize, height: usize) -> Self
    where
        T: Default + Copy,
    {
        let cells = vec![T::default(); width * height];
        Self {
            cells,
            width,
            height,
        }
    }

    #[must_use]
    #[allow(clippy::missing_panics_doc)]
    pub fn with_cells(width: usize, height: usize, cells: impl IntoIterator<Item = T>) -> Self {
        let cells: Vec<T> = cells.into_iter().collect();
        assert_eq!(
            cells.len(),
            width * height,
            "Cells length does not match grid size"
        );
        Self {
            cells,
            width,
            height,
        }
    }
}

impl<T> GridRead for NaiveGrid<T> {
    type Element<'a>
        = &'a T
    where
        Self: 'a;

    type Layout = RowMajor;

    fn get(&self, pos: crate::core::Pos) -> Option<Self::Element<'_>> {
        if pos.x < self.width && pos.y < self.height {
            Some(&self.cells[pos.y * self.width + pos.x])
        } else {
            None
        }
    }
}

impl<T> GridWrite for NaiveGrid<T> {
    type Element = T;
    type Layout = RowMajor;

    fn set(&mut self, pos: crate::core::Pos, value: Self::Element) -> Result<(), GridError> {
        if pos.x < self.width && pos.y < self.height {
            self.cells[pos.y * self.width + pos.x] = value;
            Ok(())
        } else {
            Err(GridError)
        }
    }
}

impl<T> IntoIterator for NaiveGrid<T> {
    type Item = T;
    type IntoIter = alloc::vec::IntoIter<T>;

    fn into_iter(self) -> Self::IntoIter {
        self.cells.into_iter()
    }
}

#[cfg(test)]
mod tests {
    use crate::core::Pos;

    use super::*;

    #[test]
    #[should_panic(expected = "Cells length does not match grid size")]
    fn test_with_cells_panics_on_invalid_length() {
        let _grid = NaiveGrid::<u8>::with_cells(2, 2, vec![1, 2, 3]);
    }

    #[test]
    fn get_none() {
        let grid = NaiveGrid::<u8>::new(3, 3);
        assert_eq!(grid.get(Pos::new(3, 3)), None);
    }
}