This crate provides functions to convert N-dimensional¹ coordinates to Z-order curve indexes and back. Z-order curve, also known as Morton code, is a mapping of N-dimensional coordinates to 1D index which preserves locality. It is cache-efficient way of storing N-dimensional data in 1D array.

use zorder::{index_of, coord_of};

// 2D coordinates
let idx = index_of([1u16, 1u16]);
assert_eq!(idx, 3u32);

let coord = coord_of(idx);
assert_eq!(coord, [1u16, 1u16]);

// 3D coordinates
let idx = index_of([1u16, 1u16, 1u16]);
assert_eq!(idx, 7u64);

let coord = coord_of(idx);
assert_eq!(coord, [1u16, 1u16, 1u16]);

This should be faster but requires x86 specific instruction set support.

use zorder::bmi2::{coord_of, coord_of_unchecked, HardwareSupportToken, index_of, index_of_unchecked};

// Safe interface with hardware support token.
let support_token = HardwareSupportToken::new();
if let Some(support_token) = support_token {
    let idx = index_of([1u16, 1u16], support_token);
    assert_eq!(idx, 3u32);

    let coord = coord_of(idx, support_token);
    assert_eq!(coord, [1u16, 1u16]);
}

// Unsafe interface with hardware support check.
// Only works on x86_64 CPUs.
if zorder::bmi2::has_hardware_support() {
    let idx = unsafe { index_of_unchecked([1u16, 1u16]) };
    assert_eq!(idx, 3u32);

    let coord = unsafe { coord_of_unchecked(idx) };
    assert_eq!(coord, [1u16, 1u16]);
}

You can validate that your CPU supports bmi2 with the provided example:

$ cargo run --example bmi2_support

zorder supports no_std targets but std feature is enabled by default so you need to disable it:

[dependencies]
zorder = { version = "<latest>", default-features = false }

std library is needed for checking BMI2 support.

zorder can be around 500 times slower in dev mode compared to release mode. It is therefore strongly recommended that you enable package level optimizations for zorder. Due to limitations of the Rust compiler described here, you need to increase the dev mode optimization level for your package as well.

Add the following to your Cargo.toml manifest file:

# Small amount of optimization for your package in `dev` mode.
[profile.dev]
opt-level = 1

# Compile `zorder` with high optimization.
[profile.dev.package.zorder]
opt-level = 3

Below are benchmark results using two different systems; PC with AMD Ryzen 9 7950X in Ubuntu WSL2 and Raspberry Pi 5 on Raspberry Pi OS. Standard release profile was used. All results are rounded up to three significant figures.

You can run cargo bench to see the results on your machine.

Raspberry Pi 5 has non-x86_64 architecture and doesn't support BMI2, thus there are no results for those benchmarks.

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

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.