pco 0.4.7

Good compression for numerical sequences
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

use crate::constants::Bitlen;
use crate::data_types::Latent;
use crate::read_write_uint::ReadWriteUint;

// doesn't handle the case when n >= U::BITS
#[inline]
pub fn lowest_bits_fast<U: ReadWriteUint>(x: U, n: Bitlen) -> U {
  x & ((U::ONE << n) - U::ONE)
}

#[inline]
pub fn lowest_bits<U: ReadWriteUint>(x: U, n: Bitlen) -> U {
  if n >= U::BITS {
    x
  } else {
    lowest_bits_fast(x, n)
  }
}

pub fn bits_to_encode_offset<L: Latent>(max_offset: L) -> Bitlen {
  L::BITS - max_offset.leading_zeros()
}

pub const fn bits_to_encode_offset_bits<L: Latent>() -> Bitlen {
  (Bitlen::BITS - L::BITS.leading_zeros()) as Bitlen
}

#[cfg(test)]
mod tests {
  use super::*;

  #[test]
  fn test_lowest_bits() {
    assert_eq!(lowest_bits(u32::MAX, 0), 0);
    assert_eq!(lowest_bits_fast(u32::MAX, 0), 0);
    assert_eq!(lowest_bits(u32::MAX, 3), 7);
    assert_eq!(lowest_bits_fast(u32::MAX, 3), 7);
    assert_eq!(lowest_bits(u32::MAX, 32), u32::MAX);
  }

  #[test]
  fn test_bits_to_encode_offset_bits() {
    assert_eq!(bits_to_encode_offset_bits::<u32>(), 6);
    assert_eq!(bits_to_encode_offset_bits::<u64>(), 7);
  }
}