Merge pull request #50 from triblespace/codex/proceed-with-next-task-from-inventory

Add runnable examples

Author: somethingelseentirely

CHANGELOG.md

@@ -49,3 +49,5 @@
 - Fixed a typo in `bench/README.md`.
 - Added iterators and `to_vec` helpers for inspecting built vectors.
 - Split inspection tests so each assertion stands alone.
+- Documented `WaveletMatrix` usage in `README.md`.
+- Moved README usage examples to runnable files in `examples/`.

INVENTORY.md

@@ -5,6 +5,7 @@
 
 ## Desired Functionality
 - Provide more usage examples and documentation.
+- Add usage example demonstrating `CompactVector` construction and retrieval.
 - Evaluate additional succinct data structures to include.
 - Investigate alternative dense-select index strategies to replace removed `DArrayIndex`.
 

README.md

@@ -30,25 +30,9 @@ is backed by `anybytes::View`. The data can be serialized with
 allowing zero-copy loading from an mmap or any other source by passing the
 byte region to `Bytes::from_source`.
 
-## Usage example
+## Examples
 
-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::*;
-
-fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let mut builder = BitVectorBuilder::new();
-    builder.extend_bits([true, false, true, false, true]);
-    let bv = builder.freeze::<Rank9SelIndex>();
-
-    assert_eq!(bv.num_bits(), 5);
-    assert_eq!(bv.rank1(4), Some(2));
-    assert_eq!(bv.select1(1), Some(2));
-    Ok(())
-}
-```
+See the [examples](examples/) directory for runnable usage demos.
 
 ## Licensing
 

examples/bit_vector.rs

@@ -0,0 +1,12 @@
+use jerky::bit_vector::*;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let mut builder = BitVectorBuilder::new();
+    builder.extend_bits([true, false, true, false, true]);
+    let bv = builder.freeze::<Rank9SelIndex>();
+
+    assert_eq!(bv.num_bits(), 5);
+    assert_eq!(bv.rank1(4), Some(2));
+    assert_eq!(bv.select1(1), Some(2));
+    Ok(())
+}

examples/wavelet_matrix.rs

@@ -0,0 +1,16 @@
+use jerky::bit_vector::Rank9SelIndex;
+use jerky::char_sequences::WaveletMatrix;
+use jerky::int_vectors::CompactVectorBuilder;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let text = "banana";
+    let mut builder = CompactVectorBuilder::new(8)?;
+    builder.extend(text.chars().map(|c| c as usize))?;
+    let wm = WaveletMatrix::<Rank9SelIndex>::new(builder.freeze())?;
+
+    assert_eq!(wm.len(), text.len());
+    assert_eq!(wm.access(2), Some('n' as usize));
+    assert_eq!(wm.rank(4, 'a' as usize), Some(2));
+    assert_eq!(wm.select(1, 'n' as usize), Some(4));
+    Ok(())
+}