zdex

Z-indexes bit-collections into a packed Vob


Keywords
library, morton-encoding-library, rust, z-index, z-order-index
Licenses
MIT/Apache-2.0

Documentation

Zdex   Latest version License Docs badge

Evaluate Z-order indexing for types, iterators, and tuples of BitCollections.

See also morton_encoding.

Example

Here's a basic example using the built-in FromU8 BitCollection - see more examples in the docs.

use zdex::*;

fn main() -> Result<(), std::io::Error> {
  let v1: FromU8 = 0b0011.into();
  let v2: FromU8 = 0b1111.into();

  // Prints "Vob[01011111]".
  println!("{:?}", (v1, v2).z_index()?);

  Ok(())
}

Todo

  • docs example: custom BitCollections
  • docs example: practical example with z-order index ranges
  • docs example: manipulating result vob
  • docs quality: rustdoc + docs.rs link
  • key feature: z-indexes over heterogeneous BitCollections
  • key feature: is_relevant and next_jump_in
  • feature: iterator over sub-ranges (Page Jump Querying heuristic)
  • docs metadata: crates.io tags
  • code quality: rustfmt + clippy