mantis-ta 0.6.7

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

use crate::indicators::Indicator;
use crate::types::{Candle, PivotOutput};

/// Classic floor-trader pivot points calculated from a single candle's OHLC.
///
/// # Examples
/// ```rust
/// use mantis_ta::indicators::{Indicator, PivotPoints};
/// use mantis_ta::types::Candle;
///
/// let candles: Vec<Candle> = vec![
///     (1.0, 0.5, 0.8),
///     (2.0, 0.5, 1.5),
///     (3.0, 1.0, 2.5),
/// ]
/// .into_iter()
/// .enumerate()
/// .map(|(i, (h, l, c))| Candle {
///     timestamp: i as i64,
///     open: c,
///     high: h,
///     low: l,
///     close: c,
///     volume: 0.0,
/// })
/// .collect();
///
/// let out = PivotPoints::new().calculate(&candles);
/// assert!(out.iter().all(|v| v.is_some()));
/// ```
#[derive(Debug, Clone)]
pub struct PivotPoints;

impl PivotPoints {
    pub fn new() -> Self {
        Self
    }
}

impl Default for PivotPoints {
    fn default() -> Self {
        Self::new()
    }
}

impl Indicator for PivotPoints {
    type Output = PivotOutput;

    fn next(&mut self, candle: &Candle) -> Option<Self::Output> {
        let pp = (candle.high + candle.low + candle.close) / 3.0;
        let r1 = 2.0 * pp - candle.low;
        let s1 = 2.0 * pp - candle.high;
        let r2 = pp + (candle.high - candle.low);
        let s2 = pp - (candle.high - candle.low);
        let r3 = candle.high + 2.0 * (pp - candle.low);
        let s3 = candle.low - 2.0 * (candle.high - pp);

        Some(PivotOutput {
            pp,
            r1,
            r2,
            r3,
            s1,
            s2,
            s3,
        })
    }

    fn reset(&mut self) {}

    fn warmup_period(&self) -> usize {
        0
    }

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

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

    #[test]
    fn computes_pivots() {
        let mut pivots = PivotPoints::new();
        let candle = Candle {
            timestamp: 0,
            open: 0.0,
            high: 12.0,
            low: 8.0,
            close: 10.0,
            volume: 0.0,
        };
        let out = pivots.next(&candle).unwrap();
        assert_eq!(out.pp, 10.0);
        assert_eq!(out.r1, 12.0);
        assert_eq!(out.s1, 8.0);
    }
}