wickra-embed-core 0.1.2

Allocation-free, no_std streaming technical indicators, byte-for-byte identical to wickra-core
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

//! Lifecycle-contract parity: `warmup_period`, `is_ready` and `reset` behave the
//! same as the std `wickra-core`, indicator by indicator.
//!
//! Value parity lives in `parity.rs` / `golden.rs`; this file pins the *state
//! machine*: how long each indicator warms up, when `is_ready` flips, and that
//! `reset` returns it to the freshly-constructed state.

use wickra_embed_core::{Atr, Candle, Ema, Indicator, Roc, Rsi, Sma};
// Bring the std reference's trait methods (`warmup_period`) into scope for
// resolution without shadowing `wickra_embed_core::Indicator` — receivers are distinct
// types so there is no ambiguity.
use wickra_core::Indicator as _;

fn feed_scalar<I: Indicator<Input = f64>>(ind: &mut I, n: usize) {
    for i in 0..n {
        ind.update(1.0 + (i as f64) * 0.5);
    }
}

/// `warmup_period` matches `wickra-core`, `is_ready` is false before that many
/// inputs and true after, and `reset` returns to not-ready.
#[test]
fn sma_lifecycle_matches_wickra_core() {
    let mut e = Sma::<20>::new();
    let w = wickra_core::Sma::new(20).unwrap();
    assert_eq!(e.warmup_period(), w.warmup_period(), "sma warmup");
    assert!(!e.is_ready());
    let warmup = e.warmup_period();
    feed_scalar(&mut e, warmup - 1);
    assert!(!e.is_ready(), "not ready one short of warmup");
    feed_scalar(&mut e, 1);
    assert!(e.is_ready(), "ready at warmup");
    e.reset();
    assert!(!e.is_ready(), "reset clears readiness");
    assert_eq!(e.name(), "sma");
}

#[test]
fn ema_lifecycle_matches_wickra_core() {
    let mut e = Ema::new(20);
    let w = wickra_core::Ema::new(20).unwrap();
    assert_eq!(e.warmup_period(), w.warmup_period(), "ema warmup");
    let warmup = e.warmup_period();
    feed_scalar(&mut e, warmup - 1);
    assert!(!e.is_ready());
    feed_scalar(&mut e, 1);
    assert!(e.is_ready());
    e.reset();
    assert!(!e.is_ready());
}

#[test]
fn rsi_lifecycle_matches_wickra_core() {
    let mut e = Rsi::<14>::new();
    let w = wickra_core::Rsi::new(14).unwrap();
    assert_eq!(e.warmup_period(), w.warmup_period(), "rsi warmup");
    let warmup = e.warmup_period();
    feed_scalar(&mut e, warmup - 1);
    assert!(!e.is_ready());
    feed_scalar(&mut e, 1);
    assert!(e.is_ready());
    e.reset();
    assert!(!e.is_ready());
}

#[test]
fn roc_lifecycle_matches_wickra_core() {
    let mut e = Roc::<10>::new();
    let w = wickra_core::Roc::new(10).unwrap();
    assert_eq!(e.warmup_period(), w.warmup_period(), "roc warmup");
    let warmup = e.warmup_period();
    feed_scalar(&mut e, warmup - 1);
    assert!(!e.is_ready());
    feed_scalar(&mut e, 1);
    assert!(e.is_ready());
    e.reset();
    assert!(!e.is_ready());
}

#[test]
fn atr_lifecycle_matches_wickra_core() {
    let mut e = Atr::<14>::new();
    let w = wickra_core::Atr::new(14).unwrap();
    assert_eq!(e.warmup_period(), w.warmup_period(), "atr warmup");
    let warmup = e.warmup_period();
    for i in 0..warmup - 1 {
        let base = 100.0 + i as f64;
        let t = i64::try_from(i).unwrap();
        e.update(Candle::new(
            base,
            base + 2.0,
            base - 2.0,
            base + 1.0,
            10.0,
            t,
        ));
    }
    assert!(!e.is_ready(), "not ready one short of warmup");
    e.update(Candle::new(200.0, 202.0, 198.0, 201.0, 10.0, 99));
    assert!(e.is_ready(), "ready at warmup");
    e.reset();
    assert!(!e.is_ready(), "reset clears readiness");
    assert_eq!(e.name(), "atr");
}