lk_math 0.5.0

Collection of reusable mathematical tools.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

pub trait LinearIndex<I> {
    fn index_unchecked(&self, i: I) -> Option<usize>;
    fn unindex(&self, i: usize) -> Option<I>;
    fn is_in_bounds(&self, i: &I) -> bool;

    /// This is unsafe and should not be called as overflows are not checked. Uses [Iterator::product]
    /// # Safety
    /// Don't use this
    #[deprecated]
    unsafe fn cardinality(&self) -> Option<usize>;

    fn index(&self, i: I) -> Option<usize> {
        if self.is_in_bounds(&i) {
            self.index_unchecked(i)
        } else {
            None
        }
    }
}