Struct HilbertLayout 

#[non_exhaustive]
pub struct HilbertLayout {
    pub hilbert_order: u32,
    pub hilbert_rank: u32,
}

Descriptor for the Hilbert space-filling curve layout.

Elements are ordered according to a Hilbert curve, which provides better spatial locality than Morton (Z-order): consecutive Hilbert indices always differ by exactly 1 in exactly one coordinate (L∞ distance = 1).

Constraints (enforced by HilbertLayout::new):

• hilbert_order > 0
• hilbert_rank >= 2
• Every tensor dimension must equal 2^hilbert_order (validated at shape-binding time via [LayoutDescriptor::validate_against_shape])

The normative index mapping is the Skilling (2004) algorithm; see docs/spec/layouts/hilbert.md § Normative Index Mapping.

Examples

use hurray_core::layout::{LayoutDescriptor, HilbertLayout};

// 2-D Hilbert curve, order 2 (4×4 tensor).
let layout = LayoutDescriptor::Hilbert(HilbertLayout::new(2, 2).unwrap());
assert_eq!(layout.tag(), 0x40);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hilbert_order: u32

Order of the Hilbert curve. MUST be > 0. Each tensor dimension must equal 2^hilbert_order.

hilbert_rank: u32

Number of curve dimensions. MUST equal the tensor rank. MUST be >= 2.

Implementations

impl HilbertLayout

pub fn new(hilbert_order: u32, hilbert_rank: u32) -> Result<Self>

Creates a new HilbertLayout, validating that hilbert_order > 0 and hilbert_rank >= 2.

Shape consistency (shape[k] == 2^hilbert_order for all k) is deferred to [LayoutDescriptor::validate_against_shape] because the layout descriptor does not carry the shape.

Errors

Returns Error::InvalidLayout if hilbert_order == 0 or hilbert_rank < 2.

Examples

use hurray_core::layout::HilbertLayout;

let h = HilbertLayout::new(3, 2).unwrap(); // 8×8 tensor
assert_eq!(h.hilbert_order, 3);
assert_eq!(h.hilbert_rank, 2);

assert!(HilbertLayout::new(0, 2).is_err()); // order must be > 0
assert!(HilbertLayout::new(2, 1).is_err()); // rank must be >= 2

Trait Implementations

impl Clone for HilbertLayout

fn clone(&self) -> HilbertLayout

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HilbertLayout

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ElementAddress for HilbertLayout

fn element_offset(&self, index: &[u64], shape: &Shape) -> Result<u64>

Returns the linear element offset (in logical elements) for the given index.

impl Eq for HilbertLayout

impl Hash for HilbertLayout

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for HilbertLayout

fn eq(&self, other: &HilbertLayout) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HilbertLayout