Struct IntVecFromIterBuilder

pub struct IntVecFromIterBuilder<T: Storable, E: Endianness, I: IntoIterator<Item = T>> { /* private fields */ }

A builder for creating an IntVec from an iterator.

This builder is designed for constructing an IntVec from a data source that is an iterator. It consumes the iterator and compresses its elements on the fly. It is obtained by calling IntVec::from_iter_builder.

Limitations

This builder does not support automatic codec selection (i.e., VariableCodecSpec::Auto) or automatic parameter estimation for codecs like Rice or Golomb. Since the iterator is consumed in a single pass, the data cannot be pre-analyzed to determine its statistical properties. The user must specify a concrete codec.

Implementations

impl<T: Storable, E: Endianness, I: IntoIterator<Item = T>> IntVecFromIterBuilder<T, E, I>

pub fn k(self, k: usize) -> Self

Sets the sampling rate k for random access.

pub fn codec(self, codec_spec: VariableCodecSpec) -> Self

Sets the compression codec to use.

Errors

The build method will return an error if a codec specification that requires data analysis is provided (e.g., VariableCodecSpec::Auto).

pub fn build(self) -> Result<IntVec<T, E, Vec<u64>>, IntVecError>

where BufBitWriter<E, MemWordWriterVec<u64, Vec<u64>>>: BitWrite<E, Error = Infallible> + CodesWrite<E>,

Builds the IntVec by consuming the iterator.

This method iterates through the provided data source, compresses it, and builds the sampling table in a single pass.

Errors

Returns an IntVecError if an automatic codec spec is used or if k is 0.

Examples

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

// Create a vector from a range iterator
let data_iter = 0..1000u32;

let vec: UIntVec<u32> = IntVec::from_iter_builder(data_iter)
    .k(64)
    .codec(VariableCodecSpec::Gamma) // Must be specified
    .build()
    .unwrap();

assert_eq!(vec.len(), 1000);
assert_eq!(vec.get(999), Some(999));

Trait Implementations

impl<T: Debug + Storable, E: Debug + Endianness, I: Debug + IntoIterator<Item = T>> Debug for IntVecFromIterBuilder<T, E, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.