sark_grids 0.7.0

A set of grids for storing and accessing data in a grid-like way.
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

//! A simple data structure for storing values in a sparse 2d grid.

use std::{
    collections::BTreeMap,
    ops::{Index, IndexMut},
};

use glam::{IVec2, UVec2};

use crate::{GridPoint, SizedGrid};

/// A simple data structure for storing values in a sparse 2d grid.
pub struct SparseGrid<T> {
    data: BTreeMap<Cell, T>,
    size: UVec2,
}

impl<T> SparseGrid<T> {
    pub fn new(size: UVec2) -> Self {
        Self {
            data: BTreeMap::new(),
            size,
        }
    }

    pub fn insert(&mut self, pos: impl GridPoint, value: T) {
        self.data.insert(Cell(pos.to_ivec2()), value);
    }

    pub fn get(&self, pos: impl GridPoint) -> Option<&T> {
        self.data.get(&Cell(pos.to_ivec2()))
    }

    pub fn get_mut(&mut self, pos: impl GridPoint) -> Option<&mut T> {
        self.data.get_mut(&Cell(pos.to_ivec2()))
    }

    pub fn remove(&mut self, pos: impl GridPoint) -> Option<T> {
        self.data.remove(&Cell(pos.to_ivec2()))
    }

    pub fn iter(&self) -> impl Iterator<Item = (&IVec2, &T)> {
        self.data.iter().map(|(cell, value)| (&cell.0, value))
    }

    pub fn iter_mut(&mut self) -> impl Iterator<Item = (&IVec2, &mut T)> {
        self.data.iter_mut().map(|(cell, value)| (&cell.0, value))
    }
}

impl<T> SizedGrid for SparseGrid<T> {
    fn size(&self) -> UVec2 {
        self.size
    }
}

#[derive(Debug, Clone, Copy, Eq, PartialEq)]
struct Cell(IVec2);

impl Ord for Cell {
    // Order by y then x
    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
        self.0.y.cmp(&other.0.y).then(self.0.x.cmp(&other.0.x))
    }
}

impl PartialOrd for Cell {
    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
        Some(self.cmp(other))
    }
}

impl<T, P: GridPoint> Index<P> for SparseGrid<T> {
    type Output = T;

    fn index(&self, index: P) -> &Self::Output {
        self.get(index).unwrap()
    }
}

impl<T, P: GridPoint> IndexMut<P> for SparseGrid<T>
where
    T: Default,
{
    fn index_mut(&mut self, index: P) -> &mut Self::Output {
        self.data.entry(Cell(index.to_ivec2())).or_default()
    }
}