Skip to main content

openqmc/
rotate.rs

1//! Port of `oqmc/rotate.h` — bit/byte rotation, used to extract fresh random
2//! values from an existing hash or RNG number.
3
4/// Rotate the bits of a 32-bit integer right by `distance` (wrapping every 32).
5///
6/// Upstream computes `value >> (distance & 31) | value << ((-distance) & 31)`,
7/// which is exactly a right-rotation; `u32::rotate_right` reduces the distance
8/// modulo 32 identically.
9#[inline]
10pub const fn rotate_bits(value: u32, distance: u32) -> u32 {
11    value.rotate_right(distance)
12}
13
14/// Rotate the bytes of a 4-byte integer by `distance` (wrapping every 4).
15#[inline]
16pub const fn rotate_bytes(value: u32, distance: i32) -> u32 {
17    rotate_bits(value, (distance * 8) as u32)
18}
19
20#[cfg(test)]
21mod tests {
22    use super::*;
23
24    #[test]
25    fn rotate_bits_matches_the_upstream_formula() {
26        for v in [0u32, 1, 0x8000_0000, 0x1234_5678, u32::MAX] {
27            for d in 0..70u32 {
28                let expected = (v >> (d & 31)) | v.wrapping_shl(d.wrapping_neg() & 31);
29                assert_eq!(rotate_bits(v, d), expected, "{v:#x} by {d}");
30            }
31        }
32    }
33
34    #[test]
35    fn rotate_bytes_moves_whole_bytes() {
36        assert_eq!(rotate_bytes(0x1234_5678, 0), 0x1234_5678);
37        assert_eq!(rotate_bytes(0x1234_5678, 1), 0x7812_3456);
38        assert_eq!(rotate_bytes(0x1234_5678, 2), 0x5678_1234);
39        assert_eq!(rotate_bytes(0x1234_5678, 3), 0x3456_7812);
40        assert_eq!(rotate_bytes(0x1234_5678, 4), 0x1234_5678);
41        assert_eq!(rotate_bytes(0x1234_5678, -1), 0x3456_7812);
42    }
43
44    #[test]
45    fn four_byte_rotations_of_a_generic_seed_are_distinct() {
46        let seed = 0x0102_0304u32;
47        let r = [
48            rotate_bytes(seed, 0),
49            rotate_bytes(seed, 1),
50            rotate_bytes(seed, 2),
51            rotate_bytes(seed, 3),
52        ];
53        for a in 0..4 {
54            for b in (a + 1)..4 {
55                assert_ne!(r[a], r[b]);
56            }
57        }
58    }
59
60    #[test]
61    fn functions_are_const() {
62        const A: u32 = rotate_bits(2, 1);
63        const B: u32 = rotate_bytes(0x100, 1);
64        assert_eq!(A, 1);
65        assert_eq!(B, 1);
66    }
67}