mylittleindicators 0.1.8

Multi-stream financial indicators library — 556 bar indicators + 21 event primitives across 35 categories. Consumes 27 stream kinds from digdigdig3 exchange connectors: OHLCV bars, ticks, orderbook (snapshot/delta/L3), funding/predicted funding/funding settlement, mark price, index price, open interest, liquidations, ticker, agg trades, long/short ratio, option greeks, volatility index, historical volatility, basis (derived), composite index, settlement events, block trades, insurance fund, risk limit, market warning, and three kline-family variants. Live-verified on 12 exchanges (89% pass-rate on a 150s BTC slice).
Documentation
// Keltner Distance: distance of price from Keltner center in ATR units

use crate::bar_indicators::average::moving_average::MovingAverageType;
use crate::bar_indicators::channels::keltner_channel::{KeltnerChannel, KeltnerMode};
use crate::bar_indicators::indicator_value::IndicatorValue;

#[derive(Debug, Clone)]
pub struct KeltnerDistance {
    kc: KeltnerChannel,
    value: f64,
}

impl KeltnerDistance {
    pub fn new(period: usize, multiplier: f64) -> Self {
        Self::with_ma_types(period, multiplier, MovingAverageType::SMA, MovingAverageType::RMA)
    }

    /// Create with explicit center MA type and ATR smoothing MA type.
    ///
    /// Defaults used by `new`: center=`SMA`, atr=`RMA` (Wilder).
    pub fn with_ma_types(
        period: usize,
        multiplier: f64,
        center_ma_type: MovingAverageType,
        atr_ma_type: MovingAverageType,
    ) -> Self {
        Self {
            kc: KeltnerChannel::new(
                period.max(2),
                multiplier.max(0.1),
                KeltnerMode::Classic,
                center_ma_type,
                atr_ma_type,
            ),
            value: 0.0,
        }
    }
    #[inline]
    pub fn reset(&mut self) {
        self.kc.reset();
        self.value = 0.0;
    }
    #[inline]
    pub fn is_ready(&self) -> bool {
        self.kc.is_ready()
    }
    #[inline]
    pub fn value(&self) -> IndicatorValue {
        IndicatorValue::Single(self.value)
    }
    pub fn update_bar(&mut self, o: f64, h: f64, l: f64, c: f64, v: f64) -> f64 {
        let _ = self.kc.update_bar(o, h, l, c, v);
        self.value = self.kc.distance_from_center_atr(c);
        self.value
    }
}

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

    #[test]
    fn test_with_ma_types_non_default() {
        let mut kd = KeltnerDistance::with_ma_types(20, 2.0, MovingAverageType::EMA, MovingAverageType::EMA);
        assert!(!kd.is_ready());
        for i in 0..30 {
            let p = 100.0 + (i as f64 * 0.2).sin() * 10.0;
            let v = kd.update_bar(p, p + 1.0, p - 1.0, p, 1000.0);
            assert!(v.is_finite());
        }
        assert!(kd.is_ready());
    }

    #[test]
    fn test_keltner_distance_creation() {
        let kd = KeltnerDistance::new(20, 2.0);
        assert!(!kd.is_ready());
        assert_eq!(kd.value().main(), 0.0);
    }

    #[test]
    fn test_keltner_distance_warmup() {
        let mut kd = KeltnerDistance::new(20, 2.0);
        for i in 0..25 {
            let price = 100.0 + (i as f64 * 0.1).sin() * 5.0;
            kd.update_bar(price, price + 1.0, price - 1.0, price, 1000.0);
        }
        assert!(kd.is_ready());
    }

    #[test]
    fn test_keltner_distance_finite() {
        let mut kd = KeltnerDistance::new(20, 2.0);
        for i in 0..30 {
            let price = 100.0 + (i as f64 * 0.2).sin() * 10.0;
            let value = kd.update_bar(price, price + 1.0, price - 1.0, price, 1000.0);
            assert!(value.is_finite(), "Distance should be finite");
        }
    }

    #[test]
    fn test_keltner_distance_reset() {
        let mut kd = KeltnerDistance::new(20, 2.0);
        for i in 0..25 {
            kd.update_bar(100.0 + i as f64, 101.0, 99.0, 100.0 + i as f64, 1000.0);
        }
        kd.reset();
        assert!(!kd.is_ready());
        assert_eq!(kd.value().main(), 0.0);
    }
}