FerroWave

API reference (rustdoc)

Rust API reference for FerroWave transforms, analysis, streaming, and finance helpers.

The FerroWave API reference covers every public transform, analysis helper, streaming primitive, and finance-facing utility exposed by the workspace.

API bundles

  • ferro_wave — the core library. Wavelet bases, DWT/CWT transforms, multi-resolution analysis, streaming, and the regime primitives.
  • ferro_wave_finance — finance-specific helpers built on the core: return-series decomposition, scale-energy regime detectors, and the convenience constructors used by production applications.
  • ferro_wave_examples — runnable example workflows and integration sketches built against the core and finance crates.

Conventions

Use the rustdoc search box, item sidebar, and module navigation when moving through the API surface.