nyxs_owl 0.4.0

A comprehensive Rust library for trading, forecasting, and financial analysis
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
//! Performance calculation utilities
//!
//! Centralized, optimized performance calculation functions to reduce code duplication
//! and improve accuracy across all strategies.

use chrono::{DateTime, Utc};

#[cfg(feature = "day-trading")]
use crate::day_trade::{DailyOhlcv, Signal as DaySignal, TradeError as DayTradeError};

#[cfg(feature = "minute-trading")]
use crate::minute_trade::{Signal as MinuteSignal, TradeError as MinuteTradeError};

/// Performance metrics for trading strategies
#[derive(Debug, Clone, PartialEq)]
pub struct PerformanceMetrics {
    /// Total return as a percentage
    pub total_return: f64,
    /// Maximum drawdown as a percentage
    pub max_drawdown: f64,
    /// Sharpe ratio
    pub sharpe_ratio: f64,
    /// Number of trades
    pub trade_count: usize,
    /// Win rate as a percentage
    pub win_rate: f64,
    /// Average profit per trade
    pub avg_profit_per_trade: f64,
    /// Volatility (annual)
    pub volatility: f64,
    /// Start date
    pub start_date: DateTime<Utc>,
    /// End date  
    pub end_date: DateTime<Utc>,
}

/// Input validation helper for day trading
#[cfg(feature = "day-trading")]
#[inline]
fn validate_daily_inputs(data_len: usize, signals_len: usize) -> Result<(), DayTradeError> {
    if data_len != signals_len {
        return Err(DayTradeError::InvalidData(
            "Data and signals arrays must be the same length".to_string(),
        ));
    }

    if data_len <= 1 {
        return Err(DayTradeError::InsufficientData(
            "Need at least 2 data points to calculate performance".to_string(),
        ));
    }

    Ok(())
}

/// Optimized basic performance calculation for daily trading
///
/// This replaces the duplicated calculate_performance functions across strategies
/// with a single, optimized implementation.
#[cfg(feature = "day-trading")]
pub fn calculate_daily_performance(
    data: &[DailyOhlcv],
    signals: &[DaySignal],
    initial_cash: f64,
    commission: f64,
) -> Result<f64, DayTradeError> {
    validate_daily_inputs(data.len(), signals.len())?;

    let mut portfolio_value = initial_cash;
    let mut position = 0.0;
    let mut cash = initial_cash;

    // Pre-allocate for better performance
    let mut in_position = false;

    for (i, &signal) in signals.iter().enumerate().skip(1).take(data.len() - 1) {
        let price = data[i].data.open;

        match signal {
            DaySignal::Buy if !in_position => {
                // Buy with all available cash, accounting for commission
                let shares = cash / (price * (1.0 + commission / 100.0));
                position = shares;
                cash = 0.0;
                in_position = true;
            }
            DaySignal::Sell if in_position => {
                // Sell all shares, accounting for commission
                cash = position * price * (1.0 - commission / 100.0);
                position = 0.0;
                in_position = false;
            }
            _ => {} // Hold or invalid signal
        }
    }

    // Calculate final portfolio value
    if let Some(last_data) = data.last() {
        portfolio_value = cash + position * last_data.data.close * (1.0 - commission / 100.0);
    }

    Ok((portfolio_value / initial_cash - 1.0) * 100.0)
}

/// Calculate performance metrics for minute trading strategies
#[cfg(feature = "minute-trading")]
pub fn calculate_minute_performance(
    data: &[crate::minute_trade::MinuteOhlcv],
    signals: &[crate::minute_trade::Signal],
    initial_cash: f64,
    commission_rate: f64,
) -> Result<f64, crate::minute_trade::TradeError> {
    validate_inputs(data.len(), signals.len())?;

    let mut portfolio_value = initial_cash;
    let mut position = 0.0;
    let mut cash = initial_cash;
    let mut in_position = false;

    for (i, &signal) in signals.iter().enumerate().skip(1).take(data.len() - 1) {
        let price = data[i].data.open;

        match signal {
            crate::minute_trade::Signal::Buy if position == 0.0 => {
                let shares = cash / (price * (1.0 + commission_rate / 100.0));
                position = shares;
                cash = 0.0;
                in_position = true;
            }
            crate::minute_trade::Signal::Sell if in_position => {
                cash = position * price * (1.0 - commission_rate / 100.0);
                position = 0.0;
                in_position = false;
            }
            _ => {}
        }
    }

    if let Some(last_data) = data.last() {
        portfolio_value = cash + position * last_data.data.close * (1.0 - commission_rate / 100.0);
    }

    Ok((portfolio_value / initial_cash - 1.0) * 100.0)
}

/// Calculate detailed performance metrics for minute trading strategies
#[cfg(feature = "minute-trading")]
pub fn calculate_detailed_minute_performance(
    data: &[crate::minute_trade::MinuteOhlcv],
    signals: &[crate::minute_trade::Signal],
    initial_cash: f64,
    commission_rate: f64,
) -> Result<PerformanceMetrics, crate::minute_trade::TradeError> {
    validate_inputs(data.len(), signals.len())?;

    // Pre-allocate collections for better performance
    let mut trades = Vec::with_capacity(signals.len() / 4); // Estimate: 1 trade per 4 signals
    let mut portfolio_values = Vec::with_capacity(data.len());
    let mut daily_returns = Vec::with_capacity(data.len());

    let mut cash = initial_cash;
    let mut position = 0.0;
    let mut current_trade: Option<crate::minute_trade::Trade> = None;

    portfolio_values.push(initial_cash);

    for (i, &signal) in signals.iter().enumerate().skip(1).take(data.len() - 1) {
        let price = data[i].data.open;
        let timestamp = data[i].timestamp;

        match signal {
            MinuteSignal::Buy if position == 0.0 => {
                let commission_cost = cash * commission_rate / 100.0;
                let shares = (cash - commission_cost) / price;
                position = shares;
                cash = 0.0;

                current_trade = Some(crate::minute_trade::Trade {
                    entry_time: timestamp,
                    entry_price: price,
                    exit_time: None,
                    exit_price: None,
                    size: shares,
                    is_long: true,
                    pnl: None,
                });
            }
            MinuteSignal::Sell if position > 0.0 => {
                let gross_proceeds = position * price;
                let commission_cost = gross_proceeds * commission_rate / 100.0;
                cash = gross_proceeds - commission_cost;

                if let Some(mut trade) = current_trade.take() {
                    trade.exit_time = Some(timestamp);
                    trade.exit_price = Some(price);
                    trade.pnl = Some(cash - initial_cash);
                    trades.push(trade);
                }

                position = 0.0;
            }
            _ => {} // Hold
        }

        // Calculate current portfolio value
        let current_value = cash + position * price;
        portfolio_values.push(current_value);

        // Calculate daily return
        if i > 0 {
            let return_rate = (current_value / portfolio_values[i - 1] - 1.0) * 100.0;
            daily_returns.push(return_rate);
        }
    }

    // Calculate performance metrics efficiently
    let final_value = portfolio_values.last().copied().unwrap_or(initial_cash);
    let total_return = (final_value / initial_cash - 1.0) * 100.0;

    // Calculate additional metrics using optimized algorithms
    let (max_drawdown, sharpe_ratio, volatility) =
        calculate_risk_metrics(&portfolio_values, &daily_returns);

    let (win_rate, profit_factor) = if !trades.is_empty() {
        calculate_trade_metrics(&trades)
    } else {
        (0.0, 0.0)
    };

    let annualized_return = if data.len() > 252 * 24 * 60 {
        // More than a year of minute data
        total_return * (252.0 * 24.0 * 60.0) / data.len() as f64
    } else {
        total_return
    };

    Ok(PerformanceMetrics {
        total_return,
        max_drawdown,
        sharpe_ratio,
        trade_count: trades.len(),
        win_rate,
        avg_profit_per_trade: if !trades.is_empty() {
            final_value / trades.len() as f64
        } else {
            0.0
        },
        volatility,
        start_date: data
            .first()
            .map(|d| d.timestamp)
            .unwrap_or_else(|| Utc::now()),
        end_date: data
            .last()
            .map(|d| d.timestamp)
            .unwrap_or_else(|| Utc::now()),
    })
}

/// Optimized risk metrics calculation
fn calculate_risk_metrics(portfolio_values: &[f64], daily_returns: &[f64]) -> (f64, f64, f64) {
    if portfolio_values.len() < 2 {
        return (0.0, 0.0, 0.0);
    }

    // Calculate maximum drawdown efficiently
    let mut max_value = portfolio_values[0];
    let mut max_drawdown: f64 = 0.0;

    for &value in portfolio_values.iter().skip(1) {
        max_value = max_value.max(value);
        let drawdown = (max_value - value) / max_value;
        max_drawdown = max_drawdown.max(drawdown);
    }

    // Calculate volatility and Sharpe ratio
    let (volatility, sharpe_ratio) = if !daily_returns.is_empty() {
        let mean_return = daily_returns.iter().sum::<f64>() / daily_returns.len() as f64;
        let variance = daily_returns
            .iter()
            .map(|&r| (r - mean_return).powi(2))
            .sum::<f64>()
            / (daily_returns.len() - 1).max(1) as f64;
        let vol = variance.sqrt();
        let sharpe = if vol > 0.0 { mean_return / vol } else { 0.0 };
        (vol, sharpe)
    } else {
        (0.0, 0.0)
    };

    (max_drawdown * 100.0, sharpe_ratio, volatility)
}

/// Optimized trade metrics calculation
fn calculate_trade_metrics(trades: &[crate::minute_trade::Trade]) -> (f64, f64) {
    if trades.is_empty() {
        return (0.0, 0.0);
    }

    let winning_trades = trades.iter().filter(|t| t.pnl.unwrap_or(0.0) > 0.0).count();
    let win_rate = (winning_trades as f64 / trades.len() as f64) * 100.0;

    let gross_profit: f64 = trades
        .iter()
        .filter_map(|t| t.pnl)
        .filter(|&pnl| pnl > 0.0)
        .sum();

    let gross_loss: f64 = trades
        .iter()
        .filter_map(|t| t.pnl)
        .filter(|&pnl| pnl < 0.0)
        .map(|pnl| pnl.abs())
        .sum();

    let profit_factor = if gross_loss > 0.0 {
        gross_profit / gross_loss
    } else if gross_profit > 0.0 {
        f64::INFINITY
    } else {
        0.0
    };

    (win_rate, profit_factor)
}

/// Input validation helper
#[inline]
fn validate_inputs(data_len: usize, signals_len: usize) -> Result<(), MinuteTradeError> {
    if data_len != signals_len {
        return Err(MinuteTradeError::InvalidData(
            "Data and signals arrays must be the same length".to_string(),
        ));
    }

    if data_len <= 1 {
        return Err(MinuteTradeError::InsufficientData(
            "Need at least 2 data points to calculate performance".to_string(),
        ));
    }

    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::day_trade::OhlcvData;
    use crate::minute_trade::OhlcvData as MinuteOhlcvData;
    use chrono::{DateTime, Utc};

    #[test]
    fn test_daily_performance_calculation() {
        let data = create_test_daily_data();
        let signals = vec![
            DaySignal::Buy,
            DaySignal::Hold,
            DaySignal::Sell,
            DaySignal::Hold,
        ];

        let performance = calculate_daily_performance(&data, &signals, 10000.0, 0.1).unwrap();
        assert!(performance.abs() < 100.0); // Reasonable performance range
    }

    #[test]
    fn test_minute_performance_calculation() {
        let data = create_test_minute_data();
        let signals = vec![
            MinuteSignal::Buy,
            MinuteSignal::Hold,
            MinuteSignal::Sell,
            MinuteSignal::Hold,
        ];

        let performance = calculate_minute_performance(&data, &signals, 10000.0, 0.1).unwrap();
        assert!(performance.abs() < 100.0); // Reasonable performance range
    }

    fn create_test_daily_data() -> Vec<DailyOhlcv> {
        vec![
            DailyOhlcv {
                date: chrono::NaiveDate::from_ymd_opt(2023, 1, 1).unwrap(),
                data: OhlcvData {
                    open: 100.0,
                    high: 105.0,
                    low: 99.0,
                    close: 102.0,
                    volume: 1000,
                },
            },
            DailyOhlcv {
                date: chrono::NaiveDate::from_ymd_opt(2023, 1, 2).unwrap(),
                data: OhlcvData {
                    open: 102.0,
                    high: 106.0,
                    low: 101.0,
                    close: 104.0,
                    volume: 1100,
                },
            },
            DailyOhlcv {
                date: chrono::NaiveDate::from_ymd_opt(2023, 1, 3).unwrap(),
                data: OhlcvData {
                    open: 104.0,
                    high: 107.0,
                    low: 103.0,
                    close: 106.0,
                    volume: 1200,
                },
            },
            DailyOhlcv {
                date: chrono::NaiveDate::from_ymd_opt(2023, 1, 4).unwrap(),
                data: OhlcvData {
                    open: 106.0,
                    high: 109.0,
                    low: 105.0,
                    close: 108.0,
                    volume: 1300,
                },
            },
        ]
    }

    fn create_test_minute_data() -> Vec<crate::minute_trade::MinuteOhlcv> {
        vec![
            crate::minute_trade::MinuteOhlcv {
                timestamp: DateTime::parse_from_rfc3339("2023-01-01T09:30:00Z")
                    .unwrap()
                    .with_timezone(&Utc),
                data: MinuteOhlcvData {
                    open: 100.0,
                    high: 105.0,
                    low: 99.0,
                    close: 102.0,
                    volume: 1000.0,
                },
            },
            crate::minute_trade::MinuteOhlcv {
                timestamp: DateTime::parse_from_rfc3339("2023-01-01T09:31:00Z")
                    .unwrap()
                    .with_timezone(&Utc),
                data: MinuteOhlcvData {
                    open: 102.0,
                    high: 106.0,
                    low: 101.0,
                    close: 104.0,
                    volume: 1100.0,
                },
            },
            crate::minute_trade::MinuteOhlcv {
                timestamp: DateTime::parse_from_rfc3339("2023-01-01T09:32:00Z")
                    .unwrap()
                    .with_timezone(&Utc),
                data: MinuteOhlcvData {
                    open: 104.0,
                    high: 107.0,
                    low: 103.0,
                    close: 106.0,
                    volume: 1200.0,
                },
            },
            crate::minute_trade::MinuteOhlcv {
                timestamp: DateTime::parse_from_rfc3339("2023-01-01T09:33:00Z")
                    .unwrap()
                    .with_timezone(&Utc),
                data: MinuteOhlcvData {
                    open: 106.0,
                    high: 109.0,
                    low: 105.0,
                    close: 108.0,
                    volume: 1300.0,
                },
            },
        ]
    }
}