Martingale42/nautilus-dev / skills/nt-signals
nt-signals
UnverifiedUse when working with indicators, signal generation, bar aggregation, custom data types, analysis statistics, or tearsheets in NautilusTrader.
references/rust/analysis/src/statistics/profit_factor.rs
View on GitHub// -------------------------------------------------------------------------------------------------
// 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::position::Position;
use crate::{Returns, statistic::PortfolioStatistic};
/// Calculates the profit factor based on portfolio returns.
///
/// Profit factor is defined as the ratio of gross profits to gross losses:
/// `Sum(Positive Returns) / Abs(Sum(Negative Returns))`
///
/// A profit factor greater than 1.0 indicates a profitable strategy, while
/// a factor less than 1.0 indicates losses exceed gains.
///
/// Generally:
/// - 1.0-1.5: Modest profitability
/// - 1.5-2.0: Good profitability
/// - > 2.0: Excellent profitability
///
/// # References
///
/// - Tharp, V. K. (1998). *Trade Your Way to Financial Freedom*. McGraw-Hill.
/// - Kaufman, P. J. (2013). *Trading Systems and Methods* (5th ed.). Wiley.
#[repr(C)]
#[derive(Debug, Clone)]
#[cfg_attr(
feature = "python",
pyo3::pyclass(module = "nautilus_trader.core.nautilus_pyo3.analysis", from_py_object)
)]
pub struct ProfitFactor {}
impl Display for ProfitFactor {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "Profit Factor")
}
}
impl PortfolioStatistic for ProfitFactor {
type Item = f64;
fn name(&self) -> String {
self.to_string()
}
fn calculate_from_returns(&self, returns: &Returns) -> Option<Self::Item> {
if !self.check_valid_returns(returns) {
return Some(f64::NAN);
}
// Zero returns are excluded from both sums (neither profit nor loss)
let (positive_returns_sum, negative_returns_sum) =
returns
.values()
.fold((0.0, 0.0), |(pos_sum, neg_sum), &pnl| {
if pnl > 0.0 {
(pos_sum + pnl, neg_sum)
} else if pnl < 0.0 {
(pos_sum, neg_sum + pnl)
} else {
(pos_sum, neg_sum)
}
});
if negative_returns_sum == 0.0 {
return Some(f64::NAN);
}
Some((positive_returns_sum / negative_returns_sum).abs())
}
fn calculate_from_realized_pnls(&self, _realized_pnls: &[f64]) -> Option<Self::Item> {
None
}
fn calculate_from_positions(&self, _positions: &[Position]) -> Option<Self::Item> {
None
}
}
#[cfg(test)]
mod profit_factor_tests {
use std::collections::BTreeMap;
use nautilus_core::{UnixNanos, approx_eq};
use rstest::rstest;
use super::*;
fn create_returns(values: Vec<f64>) -> Returns {
let mut new_return = BTreeMap::new();
for (i, value) in values.iter().enumerate() {
new_return.insert(UnixNanos::from(i as u64), *value);
}
new_return
}
#[rstest]
fn test_empty_returns() {
let profit_factor = ProfitFactor {};
let returns = create_returns(vec![]);
let result = profit_factor.calculate_from_returns(&returns);
assert!(result.is_some());
assert!(result.unwrap().is_nan());
}
#[rstest]
fn test_all_positive() {
let profit_factor = ProfitFactor {};
let returns = create_returns(vec![10.0, 20.0, 30.0]);
let result = profit_factor.calculate_from_returns(&returns);
assert!(result.is_some());
assert!(result.unwrap().is_nan());
}
#[rstest]
fn test_all_negative() {
let profit_factor = ProfitFactor {};
let returns = create_returns(vec![-10.0, -20.0, -30.0]);
let result = profit_factor.calculate_from_returns(&returns);
assert!(result.is_some());
assert!(approx_eq!(f64, result.unwrap(), 0.0, epsilon = 1e-9));
}
#[rstest]
fn test_mixed_returns() {
let profit_factor = ProfitFactor {};
let returns = create_returns(vec![10.0, -20.0, 30.0, -40.0]);
let result = profit_factor.calculate_from_returns(&returns);
assert!(result.is_some());
// (10.0 + 30.0) / |-20.0 + -40.0| = 40 / 60 = 0.666...
assert!(approx_eq!(
f64,
result.unwrap(),
0.6666666666666666,
epsilon = 1e-9
));
}
#[rstest]
fn test_with_zero() {
let profit_factor = ProfitFactor {};
let returns = create_returns(vec![10.0, 0.0, -20.0, -30.0]);
let result = profit_factor.calculate_from_returns(&returns);
assert!(result.is_some());
// Zero excluded: 10.0 / |-20.0 + -30.0| = 10 / 50 = 0.2
assert!(approx_eq!(f64, result.unwrap(), 0.2, epsilon = 1e-9));
}
#[rstest]
fn test_equal_positive_negative() {
let profit_factor = ProfitFactor {};
let returns = create_returns(vec![20.0, -20.0]);
let result = profit_factor.calculate_from_returns(&returns);
assert!(result.is_some());
assert!(approx_eq!(f64, result.unwrap(), 1.0, epsilon = 1e-9));
}
#[rstest]
fn test_name() {
let profit_factor = ProfitFactor {};
assert_eq!(profit_factor.name(), "Profit Factor");
}
}
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| slack-gif-creatoranthropics/skillsKnowledge and utilities for creating animated GIFs optimized for Slack. Provides constraints, validation tools, and animation concepts. Use when users request animated GIFs for Slack like "make me a GIF of X doing Y for Slack." | Stars: 198k | Updated | Claude CodeCodex | Verified | Install |
| ponytailDietrichGebert/ponytailLazy senior dev mode for any coding task: the smallest change that fully solves it, and a reply a busy human understands in one read. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailHarvest every shortcut: comment into one debt ledger, so deferrals get tracked instead of forgotten. One-shot report. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-debtDietrichGebert/ponytailList every `shortcut:` comment (and older `ponytail:` ones) as a debt ledger. One-shot report, changes nothing. Use for "ponytail debt", "what did ponytail defer", "list the shortcuts", /ponytail-debt. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |