nautilus_analysis/python/statistics/
sortino_ratio.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::collections::BTreeMap;
17
18use nautilus_model::position::Position;
19use pyo3::prelude::*;
20
21use super::transform_returns;
22use crate::{statistic::PortfolioStatistic, statistics::sortino_ratio::SortinoRatio};
23
24#[pymethods]
25#[pyo3_stub_gen::derive::gen_stub_pymethods]
26impl SortinoRatio {
27    /// Calculates the Sortino ratio for portfolio returns.
28    ///
29    /// The Sortino ratio is a variation of the Sharpe ratio that only penalizes downside
30    /// volatility, making it more appropriate for strategies with asymmetric return distributions.
31    ///
32    /// Formula: `Mean Return / Downside Deviation * sqrt(period)`
33    ///
34    /// Where downside deviation is calculated as:
35    /// `sqrt(sum(negative_returns^2) / total_observations)`
36    ///
37    /// Note: Uses total observations count (not just negative returns) as per Sortino's methodology.
38    ///
39    /// # References
40    ///
41    /// - Sortino, F. A., & van der Meer, R. (1991). "Downside Risk". *Journal of Portfolio Management*, 17(4), 27-31.
42    /// - Sortino, F. A., & Price, L. N. (1994). "Performance Measurement in a Downside Risk Framework".
43    ///   *Journal of Investing*, 3(3), 59-64.
44    #[new]
45    #[pyo3(signature = (period=None))]
46    fn py_new(period: Option<usize>) -> Self {
47        Self::new(period)
48    }
49
50    fn __repr__(&self) -> String {
51        self.to_string()
52    }
53
54    #[getter]
55    #[pyo3(name = "name")]
56    fn py_name(&self) -> String {
57        self.name()
58    }
59
60    #[pyo3(name = "calculate_from_returns")]
61    #[expect(clippy::needless_pass_by_value)]
62    fn py_calculate_from_returns(&mut self, raw_returns: BTreeMap<u64, f64>) -> Option<f64> {
63        self.calculate_from_returns(&transform_returns(&raw_returns))
64    }
65
66    #[pyo3(name = "calculate_from_realized_pnls")]
67    fn py_calculate_from_realized_pnls(&mut self, _realized_pnls: Vec<f64>) -> Option<f64> {
68        None
69    }
70
71    #[pyo3(name = "calculate_from_positions")]
72    fn py_calculate_from_positions(&mut self, _positions: Vec<Position>) -> Option<f64> {
73        None
74    }
75}
nautilus_analysis/python/statistics/sortino_ratio.rs

nautilus_analysis/python/statistics/
sortino_ratio.rs
