API Design Overview¶
This section is the canonical, JavaDoc-style reference for the RegimeFlow API surface. It is organized by package (namespace) and mirrors the header layout under include/regimeflow/**. Each package page documents its files, primary types, responsibilities, and integration points. Diagrams in docs/diagrams are referenced where they provide system-level context.
How To Read This Reference¶
- Package summary: What the namespace is responsible for.
- File index: Every public header in that package and what it provides.
- Type index: Key classes/structs/enums and their roles.
- Lifecycle & data flow: How types collaborate at runtime.
Package Index¶
- Common
- Data
- Engine
- Events
- Execution
- Live
- Metrics
- Plugins
- Regime
- Risk
- Strategy
- Walk-Forward
- Python
- Full File Index
- Public Symbol Index
- Coverage Audit