FerroWave
API reference (rustdoc)
Generated API reference for the ferro-wave workspace — every public type, trait, function, and module.
The complete generated API reference for the ferro-wave workspace lives
here as the authoritative reference for every public type, trait, function,
and module. It is embedded directly into the docs site with the standard
rustdoc navigation, sidebar, and search experience.
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 downstream products consume.ferro_wave_examples— runnable example workflows and integration sketches built against the core and finance crates.
Conventions
The embedded API reference is generated and versioned with this site so the deployed documentation is self-contained. Prefer the search box, item sidebar, and module navigation when moving through the API surface.