trade_aggregation 13.0.1

Aggregate trades into user defined candles using information driven rules
Documentation
use crate::{CandleComponent, CandleComponentUpdate, TakerTrade};

/// This 'CandleComponent' keeps track of the cumulative volume of trades.
#[derive(Debug, Default, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Volume {
    volume: f64,
}

impl CandleComponent<f64> for Volume {
    #[inline(always)]
    fn value(&self) -> f64 {
        self.volume
    }

    #[inline(always)]
    fn reset(&mut self) {
        self.volume = 0.0;
    }
}

impl<T: TakerTrade> CandleComponentUpdate<T> for Volume {
    #[inline(always)]
    fn update(&mut self, trade: &T) {
        self.volume += trade.size().abs()
    }
}

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

    #[test]
    fn volume() {
        let mut m = Volume::default();
        let mut sum: f64 = 0.0;
        for t in &crate::candle_components::tests::TRADES {
            sum += t.size.abs();
            m.update(t);
            assert_eq!(m.value(), sum);
        }
    }
}