Welcome to Xtructure’s documentation!

Core Concepts:

• Core Concepts: Defining Custom Data Structures
  • @xtructure_dataclass
  • FieldDescriptor
  • In-memory bitpacked fields (memory-optimized runtime state)
  • Aggregate bitpacking across all fields (single byte-stream per instance)
  • base_dataclass and static_fields
  • SoA storage with AoS ergonomics
• Structure Layout Flexibility
  • Backend: SoA arrays for JAX
  • Interface: AoS ergonomics for users
  • Bridging utilities
  • Example
• xtructure_numpy (xnp) Operations
  • Key xnp Operations
  • Import Options
  • Usage Patterns
  • Technical Notes

Data Structures:

• HashTable Usage
  • Key HashTable Details
• Queue Usage
  • Key Queue Details
• Stack Usage
  • Key Stack Details
• BGPQ (Batched GPU Priority Queue) Usage
  • Key BGPQ Details

API Reference:

• xtructure
  • xtructure package

Indices and tables

• Index

• Module Index

• Search Page