Skip to main content

openqmc/
reverse.rs

1//! Port of `oqmc/reverse.h` — bit reversal (radical inversion / Van der
2//! Corput).
3//!
4//! Reverses the order of bits in an integer, so the most significant bit
5//! becomes the least significant and vice versa. The upstream header hand-rolls
6//! the swap with masks and a byte-swap; Rust's `reverse_bits` compiles to the
7//! same `rbit`/`bswap`-style sequence, so we use it directly.
8
9/// Reverse the bits of a 32-bit unsigned integer.
10#[inline]
11pub const fn reverse_bits32(value: u32) -> u32 {
12    value.reverse_bits()
13}
14
15/// Reverse the bits of a 16-bit unsigned integer.
16#[inline]
17pub const fn reverse_bits16(value: u16) -> u16 {
18    value.reverse_bits()
19}
20
21#[cfg(test)]
22mod tests {
23    use super::*;
24
25    // Mirrors src/tests/reverse.cpp — reversing `out` yields `in`.
26    #[test]
27    fn reverse_32bit() {
28        let inputs: [u32; 5] = [
29            0b01010101010101010011001100110011,
30            0b11111111000000001111000011110000,
31            0b11111111111111110000000011111111,
32            0b11111111111111111111111111111111,
33            0b00000000000000000000000000000000,
34        ];
35        let outputs: [u32; 5] = [
36            0b11001100110011001010101010101010,
37            0b00001111000011110000000011111111,
38            0b11111111000000001111111111111111,
39            0b11111111111111111111111111111111,
40            0b00000000000000000000000000000000,
41        ];
42        for i in 0..5 {
43            assert_eq!(inputs[i], reverse_bits32(outputs[i]));
44        }
45    }
46
47    #[test]
48    fn reverse_16bit() {
49        let inputs: [u16; 5] = [
50            0b0101010100110011,
51            0b0000000011110000,
52            0b1111111100000000,
53            0b1111111111111111,
54            0b0000000000000000,
55        ];
56        let outputs: [u16; 5] = [
57            0b1100110010101010,
58            0b0000111100000000,
59            0b0000000011111111,
60            0b1111111111111111,
61            0b0000000000000000,
62        ];
63        for i in 0..5 {
64            assert_eq!(inputs[i], reverse_bits16(outputs[i]));
65        }
66    }
67}