nautilus_analysis/statistics/
winner_min.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 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;
17
18use nautilus_model::position::Position;
19
20use crate::{Returns, statistic::PortfolioStatistic};
21
22/// Calculates the smallest winning trade from realized PnLs.
23///
24/// Only positive PnLs count as winners. Returns `NaN` for an empty series or
25/// when there are no winning trades.
26#[repr(C)]
27#[derive(Debug, Clone)]
28#[cfg_attr(
29    feature = "python",
30    pyo3::pyclass(module = "nautilus_trader.analysis", from_py_object)
31)]
32#[cfg_attr(
33    feature = "python",
34    pyo3_stub_gen::derive::gen_stub_pyclass(module = "nautilus_trader.analysis")
35)]
36pub struct MinWinner {}
37
38impl Display for MinWinner {
39    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
40        write!(f, "Min Winner")
41    }
42}
43
44impl PortfolioStatistic for MinWinner {
45    type Item = f64;
46
47    fn name(&self) -> String {
48        self.to_string()
49    }
50
51    fn calculate_from_realized_pnls(&self, realized_pnls: &[f64]) -> Option<Self::Item> {
52        if realized_pnls.is_empty() {
53            return Some(f64::NAN);
54        }
55
56        let winners: Vec<f64> = realized_pnls
57            .iter()
58            .filter(|&&pnl| pnl > 0.0)
59            .copied()
60            .collect();
61
62        if winners.is_empty() {
63            return Some(f64::NAN);
64        }
65
66        winners
67            .iter()
68            .min_by(|a, b| a.partial_cmp(b).unwrap_or(std::cmp::Ordering::Equal))
69            .copied()
70    }
71
72    fn calculate_from_returns(&self, _returns: &Returns) -> Option<Self::Item> {
73        None
74    }
75
76    fn calculate_from_positions(&self, _positions: &[Position]) -> Option<Self::Item> {
77        None
78    }
79}
80
81#[cfg(test)]
82mod tests {
83    use nautilus_core::approx_eq;
84    use rstest::rstest;
85
86    use super::*;
87
88    #[rstest]
89    fn test_empty_pnls() {
90        let min_winner = MinWinner {};
91        let result = min_winner.calculate_from_realized_pnls(&[]);
92        assert!(result.is_some());
93        assert!(result.unwrap().is_nan());
94    }
95
96    #[rstest]
97    fn test_no_winning_trades() {
98        let min_winner = MinWinner {};
99        let realized_pnls = vec![-100.0, -50.0, -200.0];
100        let result = min_winner.calculate_from_realized_pnls(&realized_pnls);
101        assert!(result.is_some());
102        assert!(result.unwrap().is_nan());
103    }
104
105    #[rstest]
106    fn test_all_winning_trades() {
107        let min_winner = MinWinner {};
108        let realized_pnls = vec![100.0, 50.0, 200.0];
109        let result = min_winner.calculate_from_realized_pnls(&realized_pnls);
110        assert!(result.is_some());
111        assert!(approx_eq!(f64, result.unwrap(), 50.0, epsilon = 1e-9)); // Minimum of 100.0, 50.0, and 200.0 is 50.0
112    }
113
114    #[rstest]
115    fn test_mixed_trades() {
116        let min_winner = MinWinner {};
117        let realized_pnls = vec![100.0, -50.0, 200.0, -100.0];
118        let result = min_winner.calculate_from_realized_pnls(&realized_pnls);
119        assert!(result.is_some());
120        assert!(approx_eq!(f64, result.unwrap(), 100.0, epsilon = 1e-9)); // Minimum of 100.0 and 200.0 is 100.0
121    }
122
123    #[rstest]
124    fn test_single_winning_trade() {
125        let min_winner = MinWinner {};
126        let realized_pnls = vec![50.0];
127        let result = min_winner.calculate_from_realized_pnls(&realized_pnls);
128        assert!(result.is_some());
129        assert!(approx_eq!(f64, result.unwrap(), 50.0, epsilon = 1e-9));
130    }
131
132    #[rstest]
133    fn test_name() {
134        let min_winner = MinWinner {};
135        assert_eq!(min_winner.name(), "Min Winner");
136    }
137}
nautilus_analysis/statistics/winner_min.rs

nautilus_analysis/statistics/
winner_min.rs
