mantis-ta 0.6.6

Composable technical analysis and strategy engine for Rust
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

use super::EMA;
use crate::indicators::Indicator;
use crate::types::Candle;

/// Triple Exponential Moving Average over closing prices.
///
/// TEMA = 3 * EMA - 3 * EMA(EMA) + EMA(EMA(EMA)), further reducing lag.
///
/// # Examples
/// ```rust
/// use mantis_ta::indicators::{Indicator, TEMA};
/// use mantis_ta::types::Candle;
///
/// let prices = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0];
/// let candles: Vec<Candle> = prices
///     .iter()
///     .enumerate()
///     .map(|(i, p)| Candle {
///         timestamp: i as i64,
///         open: *p,
///         high: *p,
///         low: *p,
///         close: *p,
///         volume: 0.0,
///     })
///     .collect();
///
/// let out = TEMA::new(3).calculate(&candles);
/// assert!(out.iter().take(6).all(|v| v.is_none()));
/// assert!(out[6].is_some());
/// ```
#[derive(Debug, Clone)]
pub struct TEMA {
    period: usize,
    ema1: EMA,
    ema2: EMA,
    ema3: EMA,
}

impl TEMA {
    pub fn new(period: usize) -> Self {
        assert!(period > 0, "period must be > 0");
        Self {
            period,
            ema1: EMA::new(period),
            ema2: EMA::new(period),
            ema3: EMA::new(period),
        }
    }

    #[inline]
    fn update(&mut self, value: f64) -> Option<f64> {
        let ema1_val = self.ema1.next(&Candle {
            timestamp: 0,
            open: value,
            high: value,
            low: value,
            close: value,
            volume: 0.0,
        });

        if let Some(ema1) = ema1_val {
            let ema2_val = self.ema2.next(&Candle {
                timestamp: 0,
                open: ema1,
                high: ema1,
                low: ema1,
                close: ema1,
                volume: 0.0,
            });

            if let Some(ema2) = ema2_val {
                let ema3_val = self.ema3.next(&Candle {
                    timestamp: 0,
                    open: ema2,
                    high: ema2,
                    low: ema2,
                    close: ema2,
                    volume: 0.0,
                });

                if let Some(ema3) = ema3_val {
                    return Some(3.0 * ema1 - 3.0 * ema2 + ema3);
                }
            }
        }

        None
    }
}

impl Indicator for TEMA {
    type Output = f64;

    fn next(&mut self, candle: &Candle) -> Option<Self::Output> {
        self.update(candle.close)
    }

    fn reset(&mut self) {
        self.ema1.reset();
        self.ema2.reset();
        self.ema3.reset();
    }

    fn warmup_period(&self) -> usize {
        self.period * 3 - 2
    }

    fn clone_boxed(&self) -> Box<dyn Indicator<Output = Self::Output>> {
        Box::new(self.clone())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn tema_emits_after_warmup() {
        let prices = [1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0];
        let candles: Vec<Candle> = prices
            .iter()
            .enumerate()
            .map(|(i, p)| Candle {
                timestamp: i as i64,
                open: *p,
                high: *p,
                low: *p,
                close: *p,
                volume: 0.0,
            })
            .collect();

        let out = TEMA::new(3).calculate(&candles);
        assert!(out.iter().take(6).all(|v| v.is_none()));
        assert!(out.iter().skip(6).any(|v| v.is_some()));
    }
}