Summary
CorrelationRegimeDetector is RTTA's streaming implementation of: Stateful rolling correlation regime detector with upper/lower hysteresis bands.
Update API
result = rtta.CorrelationRegimeDetector().update(real0, real1)
The update(...) call consumes one observation using real0, real1. advance(...)
uses the same inputs when the caller wants to update state without materializing
a Python return value.
Theory Of Operation
CorrelationRegimeDetector first constructs a scalar market-state metric from the current observation and compact streaming state, then passes that metric through explicit entry/exit hysteresis. The metric is named in the recurrence below; the hysteresis keeps the output stable until the metric crosses the opposite exit band.
Recurrence
Let \(z_t = (real0_t, real1_t)\) denote the observation consumed by one
update(...) call and let \(\theta\) denote constructor parameters such as
window lengths, thresholds, and smoothing constants.
The sums are maintained over the configured rolling window.
The entry/exit constants satisfy \(\ell_e < \ell_x \le u_x < u_e\).
The return value is the current scalar indicator value.
Implementation Notes
The recurrence is implemented in src/rtta/indicator.cpp in class CorrelationRegimeDetector.
