valib 0.2.6

valflrt's utility crate
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

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

/// A struct that represents a 2D array.
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Array2<T> {
    pub width: usize,
    pub height: usize,
    pub vec: Vec<T>,
}

impl<T> Array2<T> {
    /// Creates a 2D array filled with the given value.
    pub fn filled_with(value: T, width: usize, height: usize) -> Self
    where
        T: Clone,
    {
        Self {
            width,
            height,
            vec: vec![value; height * width],
        }
    }

    /// Returns a reference to an element.
    pub fn get(&self, index: (usize, usize)) -> Option<&T> {
        let index = self.map_index(index);
        self.vec.get(index)
    }

    /// Returns a mutable reference to an element.
    pub fn get_mut(&mut self, index: (usize, usize)) -> Option<&mut T> {
        let index = self.map_index(index);
        self.vec.get_mut(index)
    }

    #[inline]
    fn map_index(&self, index: (usize, usize)) -> usize {
        index.0 + index.1 * self.width
    }
}

impl<T> Index<(usize, usize)> for Array2<T> {
    type Output = T;

    fn index(&self, index: (usize, usize)) -> &Self::Output {
        self.get(index)
            .unwrap_or_else(|| panic!("index {:?} out of bounds", index))
    }
}
impl<T> IndexMut<(usize, usize)> for Array2<T> {
    fn index_mut(&mut self, index: (usize, usize)) -> &mut Self::Output {
        self.get_mut(index)
            .unwrap_or_else(|| panic!("index {:?} out of bounds", index))
    }
}

/// A struct that represents a 3D array.
#[derive(Clone, PartialEq, Eq, Debug)]
pub struct Array3<T> {
    pub width: usize,
    pub height: usize,
    pub depth: usize,
    pub vec: Vec<T>,
}

impl<T> Array3<T> {
    /// Creates a 2D array filled with the given value.
    pub fn filled_with(value: T, width: usize, height: usize, depth: usize) -> Self
    where
        T: Clone,
    {
        Self {
            width,
            height,
            depth,
            vec: vec![value; height * width * depth],
        }
    }

    /// Returns a reference to an element.
    pub fn get(&self, index: (usize, usize, usize)) -> Option<&T> {
        let index = self.map_index(index);
        self.vec.get(index)
    }

    /// Returns a mutable reference to an element.
    pub fn get_mut(&mut self, index: (usize, usize, usize)) -> Option<&mut T> {
        let index = self.map_index(index);
        self.vec.get_mut(index)
    }

    #[inline]
    fn map_index(&self, index: (usize, usize, usize)) -> usize {
        index.0 + index.1 * self.width + index.2 * self.width * self.height
    }
}

impl<T> Index<(usize, usize, usize)> for Array3<T> {
    type Output = T;

    fn index(&self, index: (usize, usize, usize)) -> &Self::Output {
        self.get(index)
            .unwrap_or_else(|| panic!("index {:?} out of bounds", index))
    }
}
impl<T> IndexMut<(usize, usize, usize)> for Array3<T> {
    fn index_mut(&mut self, index: (usize, usize, usize)) -> &mut Self::Output {
        self.get_mut(index)
            .unwrap_or_else(|| panic!("index {:?} out of bounds", index))
    }
}