API Reference

The API reference is organized into the following sections. Each section links to detailed, auto-generated documentation derived from the source code docstrings.

Linops

The core linear operator classes. Start with NamedLinop for the base class, then explore specific operators:

• Core: Dense, Diagonal & Scalar, Identity, FFT
• Composition: Chain, Add, Concat & Stack
• Transforms: NUFFT, Interpolation, Sampling
• Structural: Einops, Padding & Truncation, ArrayToBlocks
• Device & Batching: Device Transfer, Splitting

Functional

Low-level functional interfaces that operate directly on tensors:

• Interpolation -- grid/ungrid operations
• NUFFT -- non-uniform FFT
• Padding -- centered padding and cropping
• Unfold/Fold -- block extraction and reassembly

Named Dimensions

The dimension-naming abstraction that underpins the library:

• NamedDimension & Dim -- the core dimension type
• NamedShape -- paired input/output shape specs
• Matching -- shape comparison and partitioning

Algorithms

Iterative solvers and related tools:

• Conjugate Gradient
• Power Method
• Polynomial Preconditioner

Utilities

Helper functions for math, memory management, and benchmarking:

• Math & FFT -- centered FFT, adjoint testing
• Memory & Device -- device transfer, memory reporting
• Benchmarking -- GPU/CPU benchmarking