Struct IntVecReader

pub struct IntVecReader<'a, T: Storable, E: Endianness, B: AsRef<[u64]>>
where
    for<'b> BufBitReader<E, MemWordReader<u64, &'b [u64]>, DefaultReadParams>: BitRead<E, Error = Infallible> + CodesRead<E> + BitSeek<Error = Infallible>,
{ /* private fields */ }

A stateful reader for an IntVec that provides fast random access.

This reader is created by the IntVec::reader method. It maintains an internal, reusable bitstream reader, making it highly efficient for performing multiple random lookups where the access pattern is not known ahead of time.

Examples

use compressed_intvec::variable::{IntVec, UIntVec};

let data: Vec<u32> = (0..100).rev().collect(); // Data is not sequential
let vec: UIntVec<u32> = IntVec::from_slice(&data).unwrap();

// Create a reusable reader
let mut reader = vec.reader();

// Perform multiple random reads efficiently
assert_eq!(reader.get(99).unwrap(), Some(0));
assert_eq!(reader.get(0).unwrap(), Some(99));
assert_eq!(reader.get(50).unwrap(), Some(49));

Implementations

impl<'a, T: Storable, E: Endianness, B: AsRef<[u64]>> IntVecReader<'a, T, E, B>

where for<'b> BufBitReader<E, MemWordReader<u64, &'b [u64]>, DefaultReadParams>: BitRead<E, Error = Infallible> + CodesRead<E> + BitSeek<Error = Infallible>,

pub fn get(&mut self, index: usize) -> Result<Option<T>, IntVecError>

Retrieves the element at index, or None if out of bounds.

This method leverages the stateful nature of the reader to perform efficient random access by seeking to the nearest preceding sample point and decoding sequentially from there.

pub unsafe fn get_unchecked(&mut self, index: usize) -> T

Retrieves the element at index without bounds checking.

Safety

Calling this method with an out-of-bounds index is undefined behavior. The caller must ensure that index < self.intvec.len().