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
use std::f64::NAN;
use std::fmt;

use crate::{Close, Next, Reset, Update};
use crate::errors::*;

/// moving average (ma).
///
/// # Formula
///
/// ![ma](https://wikimedia.org/api/rest_v1/media/math/render/svg/e2bf09dc6deaf86b3607040585fac6078f9c7c89)
///
/// Where:
///
/// * _MA<sub>t</sub>_ - value of moving average at a point of time _t_
/// * _n_ - number of periods (length)
/// * _p<sub>t</sub>_ - input value at a point of time _t_
///
/// # Parameters
///
/// * _n_ - number of periods (integer greater than 0)
///
/// # Example
///
/// ```
/// use quantaxis_rs::indicators::MovingAverage;
/// use quantaxis_rs::Next;
///
/// let mut ma = MovingAverage::new(3).unwrap();
/// assert_eq!(ma.next(10.0), 0.0);
/// assert_eq!(ma.next(11.0), 0.0);
/// assert_eq!(ma.next(12.0), 11.0);
/// assert_eq!(ma.next(13.0), 12.0);
/// ```
///
#[derive(Debug, Clone)]
pub struct MovingAverage {
    pub(crate) n: u32,
    index: usize,
    count: u32,
    sum: f64,
    vec: Vec<f64>,
    pub cached: Vec<f64>
}

impl MovingAverage {
    pub fn new(n: u32) -> Result<Self> {
        match n {
            0 => Err(Error::from_kind(ErrorKind::InvalidParameter)),
            _ => {
                let indicator = Self {
                    n,
                    index: 0,
                    count: 1,
                    sum: 0.0,
                    vec: vec![0.0; n as usize],
                    cached: vec![0.0; n as usize],
                };
                Ok(indicator)
            }
        }
    }

    pub fn is_real(&self)->bool{
        self.count-1 >= self.n
    }
}

impl Next<f64> for MovingAverage {
    type Output = f64;

    fn next(&mut self, input: f64) -> Self::Output {
        self.index = (self.index + 1) % (self.n as usize);

        let old_val = self.vec[self.index];
        self.vec[self.index] = input;
        let mut res = 0.0;

        if self.count < self.n {
            self.sum = self.sum - old_val + input;
        } else {
            self.sum = self.sum - old_val + input;
            res = self.sum / (self.n as f64);
        }
        self.count += 1;
        self.cached.push(res);
        self.cached.remove(0);
        res
    }
}


impl<'a, T: Close> Next<&'a T> for MovingAverage {
    type Output = f64;

    fn next(&mut self, input: &'a T) -> Self::Output {
        self.next(input.close())
    }
}

impl Update<f64> for MovingAverage {
    type Output = f64;

    fn update(&mut self, input: f64) -> Self::Output {
        //self.index = (self.index + 1) % (self.n as usize);

        let old_val = self.vec[self.index];
        self.vec[self.index] = input;
        let mut res = 0.0;
        self.count -= 1;
        if self.count < self.n {
            self.sum = self.sum - old_val + input;
        } else {
            self.sum = self.sum - old_val + input;
            res = self.sum / (self.n as f64);
        }
        self.count += 1;
        //println!("VEC {:#?} index {}, count {}", self.vec, self.index, self.count);
        self.cached.remove((self.n - 1) as usize);
        self.cached.push(res);
        res
    }
}


impl<'a, T: Close> Update<&'a T> for MovingAverage {
    type Output = f64;

    fn update(&mut self, input: &'a T) -> Self::Output {
        self.update(input.close())
    }
}


impl Reset for MovingAverage {
    fn reset(&mut self) {
        self.index = 0;
        self.count = 0;
        self.sum = 0.0;
        for i in 0..(self.n as usize) {
            self.vec[i] = 0.0;
            self.cached[i] = 0.0;
        }

    }
}

impl Default for MovingAverage {
    fn default() -> Self {
        Self::new(9).unwrap()
    }
}

impl fmt::Display for MovingAverage {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "ma({})", self.n)
    }
}

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

    use super::*;

    macro_rules! test_indicator {
        ($i:tt) => {
            #[test]
            fn test_indicator() {
                let bar = Bar::new();

                // ensure Default trait is implemented
                let mut indicator = $i::default();

                // ensure Next<f64> is implemented
                let first_output = indicator.next(12.3);

                // ensure next accepts &DataItem as well
                indicator.next(&bar);

                // ensure Reset is implemented and works correctly
                indicator.reset();
                assert_eq!(indicator.next(12.3), first_output);

                // ensure Display is implemented
                format!("{}", indicator);
            }
        };
    }
    test_indicator!(MovingAverage);

    #[test]
    fn test_new() {
        assert!(MovingAverage::new(0).is_err());
        assert!(MovingAverage::new(1).is_ok());
    }

    #[test]
    fn test_next() {
        let mut ma = MovingAverage::new(4).unwrap();
        assert_eq!(ma.next(4.0), 0.0);
        assert_eq!(ma.next(5.0), 0.0);
        assert_eq!(ma.next(6.0), 0.0);
        assert_eq!(ma.next(6.0), 5.25);
        assert_eq!(ma.next(6.0), 5.75);
        assert_eq!(ma.next(6.0), 6.0);
        assert_eq!(ma.next(2.0), 5.0);
    }

    #[test]
    fn test_real() {
        let mut ma = MovingAverage::new(4).unwrap();
        ma.next(1.0);
        assert_eq!(ma.is_real(), false);
        ma.next(2.0);
        assert_eq!(ma.is_real(), false);
        ma.next(3.0);
        assert_eq!(ma.is_real(), false);
        ma.next(4.0);
        assert_eq!(ma.is_real(), true);


    }

    #[test]
    fn test_update() {
        let mut ma = MovingAverage::new(2).unwrap();
        assert_eq!(ma.next(5.0), 0.0);
        assert_eq!(ma.update(6.0), 0.0);
        assert_eq!(ma.next(7.0), 6.5);
        assert_eq!(ma.update(8.0), 7.0);
        assert_eq!(ma.next(9.0), 8.5);
    }


    #[test]
    fn test_cached() {
        let mut ma = MovingAverage::new(2).unwrap();
        assert_eq!(ma.next(4.0), 0.0);
        assert_eq!(ma.next(5.0), 4.5);
        assert_eq!(ma.next(6.0), 5.5);
        println!("{:#?}", ma.cached);
        assert_eq!(ma.next(6.0), 6.0);
        println!("{:#?}", ma.cached);
        assert_eq!(ma.next(6.0), 6.0);
        println!("{:#?}", ma.cached);
        assert_eq!(ma.next(6.0), 6.0);
        println!("{:#?}", ma.cached);
        assert_eq!(ma.next(2.0), 4.0);
        println!("{:#?}", ma.cached);
    }

    #[test]
    fn test_next_with_bars() {
        fn bar(close: f64) -> Bar {
            Bar::new().close(close)
        }

        let mut ma = MovingAverage::new(3).unwrap();
        assert_eq!(ma.next(&bar(4.0)), 0.0);
        assert_eq!(ma.next(&bar(4.0)), 0.0);
        assert_eq!(ma.next(&bar(7.0)), 5.0);
        assert_eq!(ma.next(&bar(1.0)), 4.0);
    }

    #[test]
    fn test_reset() {
        let mut ma = MovingAverage::new(4).unwrap();
        assert_eq!(ma.next(4.0), 0.0);
        assert_eq!(ma.next(5.0), 0.0);
        assert_eq!(ma.next(6.0), 0.0);
        assert_eq!(ma.next(5.0), 5.0);
        ma.reset();
        assert_eq!(ma.next(99.0), 0.0);
    }

    #[test]
    fn test_default() {
        MovingAverage::default();
    }

    #[test]
    fn test_display() {
        let ma = MovingAverage::new(5).unwrap();
        assert_eq!(format!("{}", ma), "ma(5)");
    }
}