nautilus-indicators 0.56.0

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

use std::fmt::Display;

use nautilus_model::{
    data::{Bar, QuoteTick, TradeTick},
    enums::PriceType,
};

use crate::indicator::{Indicator, MovingAverage};

#[repr(C)]
#[derive(Debug)]
#[cfg_attr(
    feature = "python",
    pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.indicators")
)]
#[cfg_attr(
    feature = "python",
    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.indicators")
)]
pub struct WilderMovingAverage {
    pub period: usize,
    pub price_type: PriceType,
    pub alpha: f64,
    pub value: f64,
    pub count: usize,
    pub initialized: bool,
    has_inputs: bool,
}

impl Display for WilderMovingAverage {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}({})", self.name(), self.period)
    }
}

impl Indicator for WilderMovingAverage {
    fn name(&self) -> String {
        stringify!(WilderMovingAverage).to_string()
    }

    fn has_inputs(&self) -> bool {
        self.has_inputs
    }
    fn initialized(&self) -> bool {
        self.initialized
    }

    fn handle_quote(&mut self, quote: &QuoteTick) {
        self.update_raw(quote.extract_price(self.price_type).into());
    }

    fn handle_trade(&mut self, t: &TradeTick) {
        self.update_raw((&t.price).into());
    }

    fn handle_bar(&mut self, b: &Bar) {
        self.update_raw((&b.close).into());
    }

    fn reset(&mut self) {
        self.value = 0.0;
        self.count = 0;
        self.has_inputs = false;
        self.initialized = false;
    }
}

impl WilderMovingAverage {
    /// Creates a new [`WilderMovingAverage`] instance.
    ///
    /// # Panics
    ///
    /// Panics if `period` is not positive (> 0).
    #[must_use]
    pub fn new(period: usize, price_type: Option<PriceType>) -> Self {
        // The Wilder Moving Average is The Wilder's Moving Average is simply
        // an Exponential Moving Average (EMA) with a modified alpha.
        // alpha = 1 / period
        assert!(
            period > 0,
            "WilderMovingAverage: period must be > 0 (received {period})"
        );
        Self {
            period,
            price_type: price_type.unwrap_or(PriceType::Last),
            alpha: 1.0 / period as f64,
            value: 0.0,
            count: 0,
            initialized: false,
            has_inputs: false,
        }
    }
}

impl MovingAverage for WilderMovingAverage {
    fn value(&self) -> f64 {
        self.value
    }
    fn count(&self) -> usize {
        self.count
    }

    fn update_raw(&mut self, price: f64) {
        if !self.has_inputs {
            self.has_inputs = true;
            self.value = price;
            self.count = 1;
            self.initialized = self.count >= self.period;
            return;
        }

        self.value = self.alpha.mul_add(price, (1.0 - self.alpha) * self.value);
        self.count += 1;
        if !self.initialized && self.count >= self.period {
            self.initialized = true;
        }
    }
}

#[cfg(test)]
mod tests {
    use nautilus_model::{
        data::{Bar, QuoteTick, TradeTick},
        enums::PriceType,
    };
    use rstest::rstest;

    use crate::{
        average::rma::WilderMovingAverage,
        indicator::{Indicator, MovingAverage},
        stubs::*,
    };

    #[rstest]
    fn test_rma_initialized(indicator_rma_10: WilderMovingAverage) {
        let rma = indicator_rma_10;
        let display_str = format!("{rma}");
        assert_eq!(display_str, "WilderMovingAverage(10)");
        assert_eq!(rma.period, 10);
        assert_eq!(rma.price_type, PriceType::Mid);
        assert_eq!(rma.alpha, 0.1);
        assert!(!rma.initialized);
    }

    #[rstest]
    #[should_panic(expected = "WilderMovingAverage: period must be > 0")]
    fn test_new_with_zero_period_panics() {
        let _ = WilderMovingAverage::new(0, None);
    }

    #[rstest]
    fn test_one_value_input(indicator_rma_10: WilderMovingAverage) {
        let mut rma = indicator_rma_10;
        rma.update_raw(1.0);
        assert_eq!(rma.count, 1);
        assert_eq!(rma.value, 1.0);
    }

    #[rstest]
    fn test_rma_update_raw(indicator_rma_10: WilderMovingAverage) {
        let mut rma = indicator_rma_10;
        rma.update_raw(1.0);
        rma.update_raw(2.0);
        rma.update_raw(3.0);
        rma.update_raw(4.0);
        rma.update_raw(5.0);
        rma.update_raw(6.0);
        rma.update_raw(7.0);
        rma.update_raw(8.0);
        rma.update_raw(9.0);
        rma.update_raw(10.0);

        assert!(rma.has_inputs());
        assert!(rma.initialized());
        assert_eq!(rma.count, 10);
        assert_eq!(rma.value, 4.486_784_401);
    }

    #[rstest]
    fn test_reset(indicator_rma_10: WilderMovingAverage) {
        let mut rma = indicator_rma_10;
        rma.update_raw(1.0);
        assert_eq!(rma.count, 1);
        rma.reset();
        assert_eq!(rma.count, 0);
        assert_eq!(rma.value, 0.0);
        assert!(!rma.initialized);
    }

    #[rstest]
    fn test_handle_quote_tick_single(indicator_rma_10: WilderMovingAverage, stub_quote: QuoteTick) {
        let mut rma = indicator_rma_10;
        rma.handle_quote(&stub_quote);
        assert!(rma.has_inputs());
        assert_eq!(rma.value, 1501.0);
    }

    #[rstest]
    fn test_handle_quote_tick_multi(mut indicator_rma_10: WilderMovingAverage) {
        let tick1 = stub_quote("1500.0", "1502.0");
        let tick2 = stub_quote("1502.0", "1504.0");

        indicator_rma_10.handle_quote(&tick1);
        indicator_rma_10.handle_quote(&tick2);
        assert_eq!(indicator_rma_10.count, 2);
        assert_eq!(indicator_rma_10.value, 1_501.2);
    }

    #[rstest]
    fn test_handle_trade_tick(indicator_rma_10: WilderMovingAverage, stub_trade: TradeTick) {
        let mut rma = indicator_rma_10;
        rma.handle_trade(&stub_trade);
        assert!(rma.has_inputs());
        assert_eq!(rma.value, 1500.0);
    }

    #[rstest]
    fn handle_handle_bar(
        mut indicator_rma_10: WilderMovingAverage,
        bar_ethusdt_binance_minute_bid: Bar,
    ) {
        indicator_rma_10.handle_bar(&bar_ethusdt_binance_minute_bid);
        assert!(indicator_rma_10.has_inputs);
        assert!(!indicator_rma_10.initialized);
        assert_eq!(indicator_rma_10.value, 1522.0);
    }

    #[rstest]
    #[should_panic(expected = "WilderMovingAverage: period must be > 0")]
    fn invalid_period_panics() {
        let _ = WilderMovingAverage::new(0, None);
    }

    #[rstest]
    #[case(1.0)]
    #[case(123.456)]
    #[case(9_876.543_21)]
    fn first_tick_seeding_parity(#[case] seed_price: f64) {
        let mut rma = WilderMovingAverage::new(10, None);

        rma.update_raw(seed_price);

        assert_eq!(rma.count(), 1);
        assert_eq!(rma.value(), seed_price);
        assert!(!rma.initialized());
    }

    #[rstest]
    fn numeric_parity_with_reference_series() {
        let mut rma = WilderMovingAverage::new(10, None);

        for price in 1_u32..=10 {
            rma.update_raw(f64::from(price));
        }

        assert!(rma.initialized());
        assert_eq!(rma.count(), 10);
        let expected = 4.486_784_401_f64;
        assert!((rma.value() - expected).abs() < 1e-12);
    }

    /// Period = 1 should act as a pure 1-tick MA (α = 1) and be initialized immediately.
    #[rstest]
    fn test_rma_period_one_behaviour() {
        let mut rma = WilderMovingAverage::new(1, None);

        // First tick seeds and immediately initializes
        rma.update_raw(42.0);
        assert!(rma.initialized());
        assert_eq!(rma.count(), 1);
        assert!((rma.value() - 42.0).abs() < 1e-12);

        // With α = 1 the next tick fully replaces the previous value
        rma.update_raw(100.0);
        assert_eq!(rma.count(), 2);
        assert!((rma.value() - 100.0).abs() < 1e-12);
    }

    /// Very large period: `initialized()` must remain `false` until enough samples arrive.
    #[rstest]
    fn test_rma_large_period_not_initialized() {
        let mut rma = WilderMovingAverage::new(1_000, None);

        for p in 1_u32..=999 {
            rma.update_raw(f64::from(p));
        }

        assert_eq!(rma.count(), 999);
        assert!(!rma.initialized());
    }

    #[rstest]
    fn test_reset_reseeds_properly() {
        let mut rma = WilderMovingAverage::new(10, None);

        rma.update_raw(10.0);
        assert!(rma.has_inputs());
        assert_eq!(rma.count(), 1);

        rma.reset();
        assert_eq!(rma.count(), 0);
        assert!(!rma.has_inputs());
        assert!(!rma.initialized());

        rma.update_raw(20.0);
        assert_eq!(rma.count(), 1);
        assert!((rma.value() - 20.0).abs() < 1e-12);
    }

    #[rstest]
    fn test_default_price_type_is_last() {
        let rma = WilderMovingAverage::new(5, None);
        assert_eq!(rma.price_type, PriceType::Last);
    }

    #[rstest]
    fn test_update_with_nan_propagates() {
        let mut rma = WilderMovingAverage::new(10, None);
        rma.update_raw(f64::NAN);

        assert!(rma.value().is_nan());
        assert!(rma.has_inputs());
        assert_eq!(rma.count(), 1);
    }
}