spacecurve 0.2.0

Space-filling curves library and visualization tools.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

//! Core library for working with space‑filling curves.
//!
//! Exposes curve implementations and the [`SpaceCurve`] trait used by the CLI
//! and GUI crates in this workspace.
//!
//! # Supported Curves
//!
//! - Hilbert
//! - Z-order (Morton)
//! - Gray Code
//! - H-curve
//! - Scan (Boustrophedon)
//! - Onion / Hairy Onion (experimental)

/// Implementations of specific space‑filling curves.
pub mod curves;
/// Error types used across the crate.
pub mod error;
/// Internal bit operations shared by curve implementations.
#[doc(hidden)]
pub mod ops;
/// N‑dimensional points and helpers.
pub mod point;
/// The `SpaceCurve` trait and related utilities.
mod spacecurve;
/// Grid specification helpers shared across curves.
pub mod spec;

pub use crate::spacecurve::SpaceCurve;

/// Central registry of curve metadata and constructors.
pub mod registry;

/// Construct a curve by name with the requested dimensionality and size.
///
/// Returns an error if the combination is invalid or the name is unknown.
pub fn curve_from_name(
    name: &str,
    dimension: u32,
    size: u32,
) -> error::Result<Box<dyn SpaceCurve + 'static>> {
    registry::construct(name, dimension, size)
}