Merge pull request #49 from triblespace/codex/perform-inventory-cleanup-tasks

Flatten bit vector module

Author: somethingelseentirely

CHANGELOG.md

@@ -18,7 +18,10 @@
 - Replaced `DArrayFullIndex` with new `DArrayIndex` that uses const generics
   to optionally include `select1` and `select0` support.
 - Introduced `CompactVectorBuilder` mutable APIs `push_int`, `set_int`, and `extend`.
+- Simplified bit vector imports by re-exporting `BitVectorBuilder` and `Rank9SelIndex` and updating examples.
+- Moved the `bit_vector::bit_vector` module contents directly into `bit_vector` for cleaner paths.
 - Added README usage example demonstrating basic bit vector operations.
+- Removed `bit_vector::prelude`; import traits directly with `use jerky::bit_vector::*`.
 - Added `freeze()` on `CompactVectorBuilder` yielding an immutable `CompactVector` backed by `BitVector<NoIndex>`.
 - `CompactVector::new` and `with_capacity` now return builders; other constructors build via the builder pattern.
 - Wavelet matrix and DACs builders now use `BitVectorBuilder` for temporary bit

INVENTORY.md

@@ -10,8 +10,3 @@
 
 ## Discovered Issues
 - `katex.html` performs manual string replacements; consider DOM-based manipulation.
-- bit_vector prelude lacks common types like `BitVectorBuilder` and `Rank9SelIndex`,
-  forcing verbose imports in examples.
-- Import paths for `BitVectorBuilder` include a redundant `bit_vector` module
-  segment, e.g. `jerky::bit_vector::bit_vector::BitVectorBuilder`.
-  Cleanup the module layout so examples only need `jerky::bit_vector`.

README.md

@@ -36,7 +36,7 @@ The snippet below shows how to build a bit vector with a rank/select index and
 perform a few basic queries:
 
 ```rust
-use jerky::bit_vector::{bit_vector::BitVectorBuilder, rank9sel::inner::Rank9SelIndex, prelude::*};
+use jerky::bit_vector::*;
 
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     let mut builder = BitVectorBuilder::new();

bench/benches/timing_bitvec_rank.rs

@@ -7,9 +7,7 @@ use criterion::{
     criterion_group, criterion_main, measurement::WallTime, BenchmarkGroup, Criterion, SamplingMode,
 };
 
-use jerky::bit_vector::bit_vector::BitVectorBuilder;
-use jerky::bit_vector::rank9sel::inner::Rank9SelIndex;
-use jerky::bit_vector::{BitVector, NoIndex, Rank};
+use jerky::bit_vector::{BitVector, BitVectorBuilder, NoIndex, Rank, Rank9SelIndex};
 
 const SAMPLE_SIZE: usize = 30;
 const WARM_UP_TIME: Duration = Duration::from_secs(5);

bench/benches/timing_bitvec_select.rs

@@ -6,9 +6,7 @@ use rand_chacha::ChaChaRng;
 use criterion::{
     criterion_group, criterion_main, measurement::WallTime, BenchmarkGroup, Criterion, SamplingMode,
 };
-use jerky::bit_vector::bit_vector::BitVectorBuilder;
-use jerky::bit_vector::rank9sel::inner::Rank9SelIndex;
-use jerky::bit_vector::{BitVector, NoIndex, Select};
+use jerky::bit_vector::{BitVector, BitVectorBuilder, NoIndex, Rank9SelIndex, Select};
 
 const SAMPLE_SIZE: usize = 30;
 const WARM_UP_TIME: Duration = Duration::from_secs(5);

bench/benches/timing_chrseq_access.rs

@@ -3,10 +3,7 @@ use std::time::Duration;
 use rand::{Rng, SeedableRng};
 use rand_chacha::ChaChaRng;
 
-use jerky::bit_vector::bit_vector::BitVectorBuilder;
-use jerky::bit_vector::prelude::*;
-use jerky::bit_vector::rank9sel::inner::Rank9SelIndex;
-use jerky::bit_vector::{BitVector, NoIndex};
+use jerky::bit_vector::*;
 use jerky::char_sequences::WaveletMatrix;
 use jerky::int_vectors::CompactVector;
 

bench/src/mem_bitvec.rs

@@ -1,6 +1,4 @@
-use jerky::bit_vector::bit_vector::BitVectorBuilder;
-use jerky::bit_vector::rank9sel::inner::Rank9SelIndex;
-use jerky::bit_vector::BitVector;
+use jerky::bit_vector::{BitVector, BitVectorBuilder, Rank9SelIndex};
 use rand::{Rng, SeedableRng};
 use rand_chacha::ChaChaRng;
 

bench/src/mem_chrseq.rs

@@ -1,6 +1,4 @@
-use jerky::bit_vector::bit_vector::BitVectorBuilder;
-use jerky::bit_vector::rank9sel::inner::Rank9SelIndex;
-use jerky::bit_vector::{BitVector, NoIndex, Rank};
+use jerky::bit_vector::{BitVector, BitVectorBuilder, NoIndex, Rank, Rank9SelIndex};
 use jerky::char_sequences::WaveletMatrix;
 use jerky::int_vectors::CompactVector;