API reference

This section provides the complete Doxygen-generated C++ API for eagle, rendered through Breathe and split by module. For the Python package (eagle, imported from pip install -e ./python), see Python API reference.

Note

The API reference is generated from Doxygen XML. Run make doxygen in the docs/ directory before building the Sphinx docs, or use make doxygen html to build both in one step.

Module	Contents
API reference — cuda	Graph, Launcher, StreamCapturer, CapturedGraph (see Module: cuda); Stream, Event (RAII wrappers, see CUDA graphs); HostCallback (a CPU function run as a graph node, see Library structure); three free functions used internally for launch-geometry tuning — currentSMCount (the current GPU’s streaming-multiprocessor count), currentFp64PerfRatio (its FP32:FP64 throughput ratio, used to pick between native and emulated double-precision kernels), and computeBlocks (derives a block-size/block-count pair for an N-sample launch from those two numbers).
API reference — filtering	Scanner, FilteringSlice, RefScanner, RefSlice, cuda::Scan, cpu::Scan.
API reference — reduce	cuda::Reduction, cpu::Reduction.
API reference — host	eagle::cpu::Host — OpenMP + SIMD host dispatcher.
API reference — util	Global typedefs, logging, error handling, Observable / Observer, Slice, and thread management.