quant-indicators 0.7.0

Pure indicator math library for trading — MA, RSI, Bollinger, MACD, ATR, HRP
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
//! Tests for Kalman filter indicator.

use super::*;
use crate::test_helpers::helpers::{make_candle, ts};
use rust_decimal::Decimal;
use rust_decimal_macros::dec;

fn make_candles_constant(price: Decimal, count: usize) -> Vec<quant_primitives::Candle> {
    (0..count)
        .map(|i| make_candle(price, ts(i as i64)))
        .collect()
}

fn make_candles_linear(
    start: Decimal,
    step: Decimal,
    count: usize,
) -> Vec<quant_primitives::Candle> {
    (0..count)
        .map(|i| {
            let price = start + step * Decimal::from(i as u64);
            make_candle(price, ts(i as i64))
        })
        .collect()
}

fn make_candles_choppy(
    base: Decimal,
    amplitude: Decimal,
    count: usize,
) -> Vec<quant_primitives::Candle> {
    (0..count)
        .map(|i| {
            let sign = if (i * 7 + 3) % 5 < 3 {
                Decimal::ONE
            } else {
                Decimal::NEGATIVE_ONE
            };
            let magnitude = Decimal::from((i * 13 + 7) % 10) / Decimal::TEN;
            let noise = sign * amplitude * magnitude;
            make_candle(base + noise, ts(i as i64))
        })
        .collect()
}

// ============ AC-1: Constructor + Result ============

#[test]
fn test_kalman_warmup_period_matches_config() {
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 42, 20).unwrap();
    assert_eq!(kf.warmup_period(), 42);
}

#[test]
fn test_kalman_invalid_params_zero_q_level() {
    let result = KalmanFilter::new(dec!(0), dec!(0.01), dec!(1), 50, 20);
    assert!(matches!(
        result,
        Err(IndicatorError::InvalidParameter { .. })
    ));
    let msg = result.unwrap_err().to_string();
    assert!(
        msg.contains("q_level"),
        "error should mention q_level: {msg}"
    );
}

#[test]
fn test_kalman_invalid_params_negative_q_slope() {
    let result = KalmanFilter::new(dec!(0.01), dec!(-0.01), dec!(1), 50, 20);
    assert!(matches!(
        result,
        Err(IndicatorError::InvalidParameter { .. })
    ));
}

#[test]
fn test_kalman_invalid_params_zero_r_obs() {
    let result = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(0), 50, 20);
    assert!(matches!(
        result,
        Err(IndicatorError::InvalidParameter { .. })
    ));
    let msg = result.unwrap_err().to_string();
    assert!(msg.contains("r_obs"), "error should mention r_obs: {msg}");
}

#[test]
fn test_kalman_invalid_params_zero_warmup() {
    let result = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 0, 20);
    assert!(matches!(
        result,
        Err(IndicatorError::InvalidParameter { .. })
    ));
}

#[test]
fn test_kalman_output_lengths_match() {
    let candles = make_candles_linear(dec!(100), dec!(1), 100);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    let expected_len = 80; // 100 - 20
    assert_eq!(result.level.len(), expected_len);
    assert_eq!(result.slope.len(), expected_len);
    assert_eq!(result.innovation_variance.len(), expected_len);
    assert_eq!(result.kalman_gain.len(), expected_len);
    assert_eq!(result.normalized_innovation.len(), expected_len);
    assert_eq!(result.len(), expected_len);
}

// ============ AC-2: Warmup behavior ============

#[test]
fn test_kalman_insufficient_data_error() {
    let candles = make_candles_constant(dec!(50), 10);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 50, 20).unwrap();
    let result = kf.compute(&candles);
    assert!(matches!(
        result,
        Err(IndicatorError::InsufficientData { .. })
    ));
}

#[test]
fn test_kalman_exact_warmup_plus_one_produces_one_value() {
    let candles = make_candles_constant(dec!(50), 21);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();
    assert_eq!(result.len(), 1);
}

// ============ AC-3: Mathematical correctness — level tracks price ============

#[test]
fn test_kalman_constant_price_level_converges() {
    let candles = make_candles_constant(dec!(50), 100);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    for (_, val) in result.level.values() {
        let diff = (*val - dec!(50)).abs();
        assert!(
            diff < dec!(0.1),
            "level should converge to 50, got {val} (diff={diff})"
        );
    }
}

#[test]
fn test_kalman_linear_trend_positive_slope() {
    let candles = make_candles_linear(dec!(100), dec!(1), 100);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    for (_, val) in result.slope.values() {
        assert!(
            *val > Decimal::ZERO,
            "slope should be positive on uptrend, got {val}"
        );
    }
}

#[test]
fn test_kalman_linear_trend_level_tracks() {
    let candles = make_candles_linear(dec!(100), dec!(1), 100);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    let price_range = dec!(99); // 100 to 199
    let max_lag = price_range * dec!(0.05); // 5%

    for (i, (_, val)) in result.level.values().iter().enumerate() {
        let actual_price = dec!(100) + Decimal::from((i + 20) as u64);
        let diff = (*val - actual_price).abs();
        assert!(
            diff < max_lag,
            "level[{i}] = {val}, expected ~{actual_price}, diff = {diff} exceeds {max_lag}"
        );
    }
}

// ============ AC-4: Innovation variance as regime detector ============

#[test]
fn test_kalman_innovation_variance_trending_low() {
    let candles = make_candles_linear(dec!(100), dec!(1), 200);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 50, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    let values = result.innovation_variance.decimal_values();
    let last_50 = &values[values.len() - 50..];

    // On a perfectly linear series, innovations converge to ~0 after the Kalman
    // filter adapts. The EWMA of innovation² decays toward zero. After 100+ output
    // bars the EWMA transient is negligible.
    for (i, val) in last_50.iter().enumerate() {
        assert!(
            *val < dec!(0.01),
            "innovation_variance[{}] = {} should be < 0.01 on linear series",
            values.len() - 50 + i,
            val
        );
    }
}

#[test]
fn test_kalman_innovation_variance_choppy_high() {
    let trending = make_candles_linear(dec!(100), dec!(1), 200);
    let choppy = make_candles_choppy(dec!(100), dec!(5), 200);

    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 50, 20).unwrap();
    let trend_result = kf.compute(&trending).unwrap();
    let choppy_result = kf.compute(&choppy).unwrap();

    let trend_vars = trend_result.innovation_variance.decimal_values();
    let choppy_vars = choppy_result.innovation_variance.decimal_values();

    let trend_mean = mean_last_n(&trend_vars, 50);
    let choppy_mean = mean_last_n(&choppy_vars, 50);

    assert!(
        choppy_mean > trend_mean * dec!(5),
        "choppy mean ({choppy_mean}) should be > 5x trending mean ({trend_mean})"
    );
}

#[test]
fn test_kalman_normalized_innovation_regime_separation() {
    let trending = make_candles_linear(dec!(100), dec!(1), 200);
    let choppy = make_candles_choppy(dec!(100), dec!(5), 200);

    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 50, 20).unwrap();
    let trend_result = kf.compute(&trending).unwrap();
    let choppy_result = kf.compute(&choppy).unwrap();

    let trend_ni = trend_result.normalized_innovation.decimal_values();
    let choppy_ni = choppy_result.normalized_innovation.decimal_values();

    let trend_abs_mean = mean_abs_last_n(&trend_ni, 50);
    let choppy_abs_mean = mean_abs_last_n(&choppy_ni, 50);

    assert!(
        trend_abs_mean < dec!(1),
        "trending |norm_innov| mean ({trend_abs_mean}) should be < 1.0"
    );
    assert!(
        choppy_abs_mean > trend_abs_mean,
        "choppy |norm_innov| mean ({choppy_abs_mean}) should be > trending ({trend_abs_mean})"
    );
}

// ============ AC-5: Kalman gain adaptation ============

#[test]
fn test_kalman_gain_bounded() {
    let candles = make_candles_choppy(dec!(100), dec!(5), 200);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    for (_, val) in result.kalman_gain.values() {
        assert!(
            *val >= Decimal::ZERO && *val <= Decimal::ONE,
            "kalman_gain should be in [0, 1], got {val}"
        );
    }
}

#[test]
fn test_kalman_gain_stabilizes_in_trend() {
    let candles = make_candles_linear(dec!(100), dec!(1), 200);
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();

    let gains = result.kalman_gain.decimal_values();
    let last_20 = &gains[gains.len() - 20..];
    let mean_gain = mean_last_n(&gains, 20);

    let variance: Decimal = last_20
        .iter()
        .map(|g| {
            let d = *g - mean_gain;
            d * d
        })
        .sum::<Decimal>()
        / Decimal::from(20u64);

    assert!(
        variance < dec!(0.001),
        "gain variance ({variance}) should be very low in stable trend"
    );
}

#[test]
fn test_kalman_gain_increases_after_regime_shift() {
    // Issue spec: Given 100 bars linear trend, then 100 bars random noise
    let mut candles = make_candles_linear(dec!(100), dec!(1), 100);
    let choppy = make_candles_choppy(dec!(200), dec!(5), 100);
    for (i, c) in choppy.iter().enumerate() {
        candles.push(make_candle(c.close(), ts((100 + i) as i64)));
    }

    // Issue spec: compute, warmup=20
    let kf = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 20).unwrap();
    let result = kf.compute(&candles).unwrap();
    let gains = result.kalman_gain.decimal_values();

    // Issue spec: mean(kalman_gain[105..110]) > mean(kalman_gain[80..100])
    // Output indices: bar N → index N - warmup = N - 20
    // bars 80..100 → indices 60..80, bars 105..110 → indices 85..90
    let stable_mean = mean_slice(&gains, 60, 80);
    let post_shift_mean = mean_slice(&gains, 85, 90);

    assert!(
        post_shift_mean > stable_mean,
        "mean(gain[105..110])={post_shift_mean} should be > mean(gain[80..100])={stable_mean}"
    );
}

// ============ AC-6: eiv_window parameter ============

#[test]
fn test_eiv_window_below_2_rejected() {
    let result = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 1);
    assert!(matches!(
        result,
        Err(IndicatorError::InvalidParameter { .. })
    ));
    let msg = result.unwrap_err().to_string();
    assert!(
        msg.contains("eiv_window"),
        "error should mention eiv_window: {msg}"
    );
}

#[test]
fn test_eiv_window_changes_output() {
    // Two KalmanFilters with different eiv_window must produce different innovation_variance.
    let candles = make_candles_choppy(dec!(100), dec!(5), 200);

    let kf_short = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 10).unwrap();
    let kf_long = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 50).unwrap();

    let result_short = kf_short.compute(&candles).unwrap();
    let result_long = kf_long.compute(&candles).unwrap();

    let vars_short = result_short.innovation_variance.decimal_values();
    let vars_long = result_long.innovation_variance.decimal_values();

    // At least some values must differ between the two windows.
    let differs = vars_short.iter().zip(vars_long.iter()).any(|(a, b)| a != b);
    assert!(
        differs,
        "different eiv_window values must produce different innovation_variance series"
    );
}

#[test]
fn test_eiv_window_shorter_detects_regime_shift_faster() {
    // Linear candles then choppy candles — regime shift at bar 100.
    let mut candles = make_candles_linear(dec!(100), dec!(1), 100);
    let choppy = make_candles_choppy(dec!(200), dec!(5), 100);
    for (i, c) in choppy.iter().enumerate() {
        candles.push(make_candle(c.close(), ts((100 + i) as i64)));
    }

    let kf_short = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 10).unwrap();
    let kf_long = KalmanFilter::new(dec!(0.01), dec!(0.001), dec!(1), 20, 50).unwrap();

    let result_short = kf_short.compute(&candles).unwrap();
    let result_long = kf_long.compute(&candles).unwrap();

    let vars_short = result_short.innovation_variance.decimal_values();
    let vars_long = result_long.innovation_variance.decimal_values();

    // Near the regime shift (output index ~85-90 = bars 105-110),
    // the shorter window should show higher EIV because it reacts faster.
    let short_near_shift = mean_slice(&vars_short, 85, 95);
    let long_near_shift = mean_slice(&vars_long, 85, 95);

    assert!(
        short_near_shift > long_near_shift,
        "eiv_window=10 near shift ({short_near_shift}) should be > eiv_window=50 ({long_near_shift})"
    );
}

// ============ Helpers ============

fn mean_last_n(values: &[Decimal], n: usize) -> Decimal {
    let start = values.len().saturating_sub(n);
    let slice = &values[start..];
    let sum: Decimal = slice.iter().copied().sum();
    sum / Decimal::from(slice.len() as u64)
}

fn mean_abs_last_n(values: &[Decimal], n: usize) -> Decimal {
    let start = values.len().saturating_sub(n);
    let slice = &values[start..];
    let sum: Decimal = slice.iter().map(|v| v.abs()).sum();
    sum / Decimal::from(slice.len() as u64)
}

fn mean_slice(values: &[Decimal], from: usize, to: usize) -> Decimal {
    let to = to.min(values.len());
    let from = from.min(to);
    let slice = &values[from..to];
    if slice.is_empty() {
        return Decimal::ZERO;
    }
    let sum: Decimal = slice.iter().copied().sum();
    sum / Decimal::from(slice.len() as u64)
}