hilbert_2d

Crates.iohilbert_2d
lib.rshilbert_2d
version1.1.0
sourcesrc
created_at2020-09-01 18:03:33.202133
updated_at2023-01-06 12:20:08.871714
descriptionFunctions for mapping between 1D and 2D space using the Hilbert curve, and its approximations.
homepage
repositoryhttps://github.com/hbertoduarte/hilbert_2d/
max_upload_size
id283489
size167,163
Humberto Duarte (hbertoduarte)

documentation

README

Hilbert 2D

Latest Version API Documentation rustc 1.46+

Rust functions for mapping between 1D and 2D space using the Hilbert curve, and its approximations.

Examples

Usage

Add this to your Cargo.toml:

[dependencies]
hilbert_2d = "1.1.0"

When working with images and matrices, use the h2xy_discrete and xy2h_discrete functions:

use hilbert_2d::{h2xy_discrete, xy2h_discrete, Variant};

let (x, y) = h2xy_discrete(7, 2, Variant::Hilbert); // (1, 2)
let h = xy2h_discrete(2, 1, 2, Variant::Hilbert); // 13

When performing real-valued calculations, use the continuous functions instead:

use hilbert_2d::{h2xy_continuous_f64, Variant};

// Approaches the bottom-left corner
let (x1, y1) = h2xy_continuous_f64(0.0, Variant::Hilbert); 
// Approaches the bottom-right corner
let (x2, y2) = h2xy_continuous_f64(1.0, Variant::Hilbert); 

Some of the pattern variants of the Hilbert curve have also been implemented:

use hilbert_2d::{h2xy_continuous_f64, Variant};

// In the Liu L1 variant, both ends of the curve approach the center of the square
let (x1, y1) = h2xy_continuous_f64(0.0, Variant::Liu1); // (~0.5, ~0.5)
let (x2, y2) = h2xy_continuous_f64(1.0, Variant::Liu1); // (~0.5, ~0.5)

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 3

cargo fmt