nautilus_indicators/momentum/
macd.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2025 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16use std::fmt::{Display, Formatter};
17
18use nautilus_model::{
19    data::{Bar, QuoteTick, TradeTick},
20    enums::PriceType,
21};
22
23use crate::{
24    average::{MovingAverageFactory, MovingAverageType},
25    indicator::{Indicator, MovingAverage},
26};
27
28#[repr(C)]
29#[derive(Debug)]
30#[cfg_attr(
31    feature = "python",
32    pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.indicators", unsendable)
33)]
34pub struct MovingAverageConvergenceDivergence {
35    pub fast_period: usize,
36    pub slow_period: usize,
37    pub ma_type: MovingAverageType,
38    pub count: usize,
39    pub price_type: PriceType,
40    pub value: f64,
41    pub initialized: bool,
42    has_inputs: bool,
43    fast_ma: Box<dyn MovingAverage + Send + 'static>,
44    slow_ma: Box<dyn MovingAverage + Send + 'static>,
45}
46
47impl Display for MovingAverageConvergenceDivergence {
48    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
49        write!(
50            f,
51            "{}({},{},{},{})",
52            self.name(),
53            self.fast_period,
54            self.slow_period,
55            self.ma_type,
56            self.price_type
57        )
58    }
59}
60
61impl Indicator for MovingAverageConvergenceDivergence {
62    fn name(&self) -> String {
63        stringify!(MovingAverageConvergenceDivergence).to_string()
64    }
65
66    fn has_inputs(&self) -> bool {
67        self.has_inputs
68    }
69
70    fn initialized(&self) -> bool {
71        self.initialized
72    }
73
74    fn handle_quote(&mut self, quote: &QuoteTick) {
75        self.update_raw(quote.extract_price(self.price_type).into());
76    }
77
78    fn handle_trade(&mut self, trade: &TradeTick) {
79        self.update_raw((&trade.price).into());
80    }
81
82    fn handle_bar(&mut self, bar: &Bar) {
83        self.update_raw((&bar.close).into());
84    }
85
86    fn reset(&mut self) {
87        self.value = 0.0;
88        self.fast_ma.reset();
89        self.slow_ma.reset();
90        self.has_inputs = false;
91        self.initialized = false;
92    }
93}
94
95impl MovingAverageConvergenceDivergence {
96    /// Creates a new [`MovingAverageConvergenceDivergence`] instance.
97    #[must_use]
98    pub fn new(
99        fast_period: usize,
100        slow_period: usize,
101        ma_type: Option<MovingAverageType>,
102        price_type: Option<PriceType>,
103    ) -> Self {
104        Self {
105            fast_period,
106            slow_period,
107            ma_type: ma_type.unwrap_or(MovingAverageType::Simple),
108            price_type: price_type.unwrap_or(PriceType::Last),
109            value: 0.0,
110            count: 0,
111            initialized: false,
112            has_inputs: false,
113            fast_ma: MovingAverageFactory::create(
114                ma_type.unwrap_or(MovingAverageType::Simple),
115                fast_period,
116            ),
117            slow_ma: MovingAverageFactory::create(
118                ma_type.unwrap_or(MovingAverageType::Simple),
119                slow_period,
120            ),
121        }
122    }
123}
124
125impl MovingAverage for MovingAverageConvergenceDivergence {
126    fn value(&self) -> f64 {
127        self.value
128    }
129
130    fn count(&self) -> usize {
131        self.count
132    }
133
134    fn update_raw(&mut self, close: f64) {
135        self.fast_ma.update_raw(close);
136        self.slow_ma.update_raw(close);
137        self.value = self.fast_ma.value() - self.slow_ma.value();
138
139        // Initialization logic
140        if !self.initialized {
141            self.has_inputs = true;
142            if self.fast_ma.initialized() && self.slow_ma.initialized() {
143                self.initialized = true;
144            }
145        }
146    }
147}
148
149#[cfg(test)]
150mod tests {
151    use nautilus_model::data::{Bar, QuoteTick, TradeTick};
152    use rstest::rstest;
153
154    use crate::{
155        indicator::{Indicator, MovingAverage},
156        momentum::macd::MovingAverageConvergenceDivergence,
157        stubs::*,
158        testing::approx_equal,
159    };
160
161    #[rstest]
162    fn test_macd_initialized(macd_10: MovingAverageConvergenceDivergence) {
163        let display_st = format!("{macd_10}");
164        assert_eq!(
165            display_st,
166            "MovingAverageConvergenceDivergence(10,8,SIMPLE,BID)"
167        );
168        assert_eq!(macd_10.fast_period, 10);
169        assert_eq!(macd_10.slow_period, 8);
170        assert!(!macd_10.initialized());
171        assert!(!macd_10.has_inputs());
172    }
173
174    #[rstest]
175    fn test_initialized_with_required_input(mut macd_10: MovingAverageConvergenceDivergence) {
176        for i in 1..10 {
177            macd_10.update_raw(f64::from(i));
178        }
179        assert!(!macd_10.initialized);
180        macd_10.update_raw(10.0);
181        assert!(macd_10.initialized);
182    }
183
184    #[rstest]
185    fn test_value_with_one_input(mut macd_10: MovingAverageConvergenceDivergence) {
186        macd_10.update_raw(1.0);
187        assert_eq!(macd_10.value, 0.0);
188    }
189
190    #[rstest]
191    fn test_value_with_three_inputs(mut macd_10: MovingAverageConvergenceDivergence) {
192        macd_10.update_raw(1.0);
193        macd_10.update_raw(2.0);
194        macd_10.update_raw(3.0);
195        assert_eq!(macd_10.value, 0.0);
196    }
197
198    #[rstest]
199    fn test_value_with_ten_inputs(mut macd_10: MovingAverageConvergenceDivergence) {
200        macd_10.update_raw(1.00000);
201        macd_10.update_raw(1.00010);
202        macd_10.update_raw(1.00020);
203        macd_10.update_raw(1.00030);
204        macd_10.update_raw(1.00040);
205        macd_10.update_raw(1.00050);
206        macd_10.update_raw(1.00040);
207        macd_10.update_raw(1.00030);
208        macd_10.update_raw(1.00020);
209        macd_10.update_raw(1.00010);
210        macd_10.update_raw(1.00000);
211        assert!(
212            approx_equal(macd_10.value, -2.5e-5),
213            "MACD value {:.17e} not within tolerance of –2.5e-5",
214            macd_10.value
215        );
216    }
217
218    #[rstest]
219    fn test_handle_quote_tick(
220        mut macd_10: MovingAverageConvergenceDivergence,
221        stub_quote: QuoteTick,
222    ) {
223        macd_10.handle_quote(&stub_quote);
224        assert_eq!(macd_10.value, 0.0);
225    }
226
227    #[rstest]
228    fn test_handle_trade_tick(
229        mut macd_10: MovingAverageConvergenceDivergence,
230        stub_trade: TradeTick,
231    ) {
232        macd_10.handle_trade(&stub_trade);
233        assert_eq!(macd_10.value, 0.0);
234    }
235
236    #[rstest]
237    fn test_handle_bar(
238        mut macd_10: MovingAverageConvergenceDivergence,
239        bar_ethusdt_binance_minute_bid: Bar,
240    ) {
241        macd_10.handle_bar(&bar_ethusdt_binance_minute_bid);
242        assert_eq!(macd_10.value, 0.0);
243        assert!(!macd_10.initialized);
244    }
245
246    #[rstest]
247    fn test_reset(mut macd_10: MovingAverageConvergenceDivergence) {
248        macd_10.update_raw(1.0);
249        macd_10.reset();
250        assert_eq!(macd_10.value, 0.0);
251        assert_eq!(macd_10.fast_ma.value(), 0.0);
252        assert_eq!(macd_10.slow_ma.value(), 0.0);
253        assert!(!macd_10.has_inputs);
254        assert!(!macd_10.initialized);
255    }
256}
nautilus_indicators/momentum/macd.rs

nautilus_indicators/momentum/
macd.rs
