Struct MortonLayout 

#[non_exhaustive]
pub struct MortonLayout {
    pub morton_bits: Vec<u32>,
}

Descriptor for the Morton (Z-order curve) layout.

Elements are stored by interleaving the bits of their dimension indices in round-robin order (LSB of dimension 0 first), producing a linear order with good spatial locality for multi-dimensional access patterns.

For each dimension k, shape[k] MUST satisfy shape[k] <= 2^morton_bits[k]. The buffer must hold exactly 2^(sum(morton_bits)) elements.

Examples

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

// 4×4 tensor: 2 bits per dimension.
let layout = LayoutDescriptor::Morton(MortonLayout::new(vec![2, 2]).unwrap());
assert_eq!(layout.tag(), 0x05);

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.

morton_bits: Vec<u32>

Number of bits used per dimension in the Morton encoding. Every value MUST be > 0.

Implementations

impl MortonLayout

pub fn new(morton_bits: Vec<u32>) -> Result<Self>

Creates a new MortonLayout, validating that every entry in morton_bits is greater than 0.

Errors

Returns Error::InvalidLayout if any morton_bits[k] is 0, or if morton_bits is empty.

Examples

use hurray_core::layout::MortonLayout;

let m = MortonLayout::new(vec![2, 2]).unwrap();
assert_eq!(m.morton_bits, [2, 2]);

// Zero bits is invalid.
assert!(MortonLayout::new(vec![2, 0]).is_err());

Trait Implementations

impl Clone for MortonLayout

fn clone(&self) -> MortonLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MortonLayout

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

Formats the value using the given formatter.

impl ElementAddress for MortonLayout

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 MortonLayout

impl Hash for MortonLayout

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 MortonLayout

fn eq(&self, other: &MortonLayout) -> 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 MortonLayout