hilbert_curve_generator 0.1.2

A WIP Hilbert Space-Filling Curve Coordinate Generator
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

// Binary Reflected Gray Code
/* a BRGC is an ordering of the binary numeral system that holds the property that
   sequential numbers differ by exactly 1 bit.

   In a standard binary numeral ordering, moving from 7 to 8 requires 4 bits to change:
        (0111 -> 1000)
   whereas in brgc only a single bit is changed, due to a different ordering of
   decimal -> binary numbers

   BRGC's are stable, meaning once a number has appeared in a smaller order Gray code,
   it will also be in the same position in all higher order Gray codes.

   This means we do not need to know the bit count to generate any BRGC, making it safe
   to implement an iterator over each number in a BRGC without knowing our bit count
   ahead of time
*/
#[derive(Debug)]
pub struct Brgc {
    pub index: u32,
}

impl Iterator for Brgc {
    type Item = u32;

    fn next(&mut self) -> Option<Self::Item> {
        let gray = self.index ^ (self.index >> 1);
        self.index += 1;
        Some(gray)
    }
}