egui-charts 0.2.0

High-performance financial charting engine for egui — candlesticks, 95 drawing tools, 130+ indicators, and a full design-token theme system
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
478
use super::portfolio::Portfolio;
use super::trade::{Trade, TradeStatus};

/// Comprehensive performance metrics
#[derive(Debug, Clone, Default)]
pub struct PerformanceMetrics {
    // Return metrics
    pub total_return: f64,
    pub total_return_pct: f64,
    pub annualized_return: f64,
    pub cagr: f64,

    // Risk metrics
    pub volatility: f64,
    pub annualized_volatility: f64,
    pub max_drawdown: f64,
    pub max_drawdown_duration_days: f64,
    pub avg_drawdown: f64,

    // Risk-adjusted returns
    pub sharpe_ratio: f64,
    pub sortino_ratio: f64,
    pub calmar_ratio: f64,
    pub omega_ratio: f64,

    // Trade statistics
    pub total_trades: usize,
    pub winning_trades: usize,
    pub losing_trades: usize,
    pub win_rate: f64,
    pub avg_win: f64,
    pub avg_loss: f64,
    pub largest_win: f64,
    pub largest_loss: f64,
    pub avg_trade: f64,
    pub profit_factor: f64,
    pub expectancy: f64,
    pub payoff_ratio: f64,

    // Time metrics
    pub avg_trade_duration_bars: f64,
    pub avg_winning_duration_bars: f64,
    pub avg_losing_duration_bars: f64,
    pub percent_time_in_market: f64,

    // Streak metrics
    pub max_consecutive_wins: usize,
    pub max_consecutive_losses: usize,
    pub curr_streak: isize,

    // MAE/MFE
    pub avg_mae: f64,
    pub avg_mfe: f64,
    pub mae_mfe_ratio: f64,

    // Recovery
    pub recovery_factor: f64,
    pub ulcer_idx: f64,

    // Portfolio metrics
    pub final_equity: f64,
    pub peak_equity: f64,
    pub total_commission: f64,
    pub total_slippage: f64,
}

impl PerformanceMetrics {
    /// Calculate all metrics from portfolio
    pub fn calculate(portfolio: &Portfolio, risk_free_rate: f64, trading_days: usize) -> Self {
        let closed_trades: Vec<&Trade> = portfolio
            .trades
            .iter()
            .filter(|t| t.status == TradeStatus::Closed)
            .collect();

        let mut metrics = Self::default();

        // Basic portfolio metrics. `max_drawdown` is held as a fraction so it
        // shares units with the fractional returns used by every risk ratio;
        // the portfolio tracks drawdown as a percent, so divide it down here.
        metrics.final_equity = portfolio.equity();
        metrics.peak_equity = portfolio.peak_equity;
        metrics.max_drawdown = portfolio.max_drawdown / 100.0;

        // Return metrics
        metrics.total_return = metrics.final_equity - portfolio.initial_capital;
        metrics.total_return_pct = if portfolio.initial_capital > 0.0 {
            (metrics.total_return / portfolio.initial_capital) * 100.0
        } else {
            0.0
        };

        // Annualized return, kept as a fraction so it shares units with the
        // fractional per-bar returns, the risk-free rate, and the volatility
        // that the Sharpe/Sortino/Calmar ratios divide by. Percent scaling is
        // applied only at the reporting boundary.
        let years = trading_days as f64 / 252.0;
        if years > 0.0 {
            metrics.cagr =
                (metrics.final_equity / portfolio.initial_capital).powf(1.0 / years) - 1.0;
            metrics.annualized_return = metrics.cagr;
        }

        // Trade statistics
        metrics.total_trades = closed_trades.len();
        if metrics.total_trades == 0 {
            return metrics;
        }

        let winners: Vec<&&Trade> = closed_trades.iter().filter(|t| t.pnl > 0.0).collect();
        let losers: Vec<&&Trade> = closed_trades.iter().filter(|t| t.pnl <= 0.0).collect();

        metrics.winning_trades = winners.len();
        metrics.losing_trades = losers.len();
        metrics.win_rate = (metrics.winning_trades as f64 / metrics.total_trades as f64) * 100.0;

        // Win/Loss avgs
        if !winners.is_empty() {
            metrics.avg_win = winners.iter().map(|t| t.pnl).sum::<f64>() / winners.len() as f64;
            metrics.largest_win = winners
                .iter()
                .map(|t| t.pnl)
                .fold(f64::NEG_INFINITY, f64::max);
        }

        if !losers.is_empty() {
            metrics.avg_loss = losers.iter().map(|t| t.pnl).sum::<f64>() / losers.len() as f64;
            metrics.largest_loss = losers.iter().map(|t| t.pnl).fold(f64::INFINITY, f64::min);
        }

        // Avg trade
        metrics.avg_trade =
            closed_trades.iter().map(|t| t.pnl).sum::<f64>() / metrics.total_trades as f64;

        // Profit factor
        let gross_profit: f64 = winners.iter().map(|t| t.pnl).sum();
        let gross_loss: f64 = losers.iter().map(|t| t.pnl.abs()).sum();
        metrics.profit_factor = if gross_loss > 0.0 {
            gross_profit / gross_loss
        } else if gross_profit > 0.0 {
            f64::INFINITY
        } else {
            0.0
        };

        // Payoff ratio
        metrics.payoff_ratio = if metrics.avg_loss.abs() > 0.0 {
            metrics.avg_win / metrics.avg_loss.abs()
        } else {
            f64::INFINITY
        };

        // Expectancy
        let win_rate_decimal = metrics.win_rate / 100.0;
        metrics.expectancy =
            (win_rate_decimal * metrics.avg_win) + ((1.0 - win_rate_decimal) * metrics.avg_loss);

        // Duration metrics
        let durations: Vec<usize> = closed_trades.iter().map(|t| t.bars_held).collect();
        if !durations.is_empty() {
            metrics.avg_trade_duration_bars =
                durations.iter().sum::<usize>() as f64 / durations.len() as f64;
        }

        let winner_durations: Vec<usize> = winners.iter().map(|t| t.bars_held).collect();
        if !winner_durations.is_empty() {
            metrics.avg_winning_duration_bars =
                winner_durations.iter().sum::<usize>() as f64 / winner_durations.len() as f64;
        }

        let loser_durations: Vec<usize> = losers.iter().map(|t| t.bars_held).collect();
        if !loser_durations.is_empty() {
            metrics.avg_losing_duration_bars =
                loser_durations.iter().sum::<usize>() as f64 / loser_durations.len() as f64;
        }

        // Streak metrics
        let (max_wins, max_losses, current) = Self::calculate_streaks(&closed_trades);
        metrics.max_consecutive_wins = max_wins;
        metrics.max_consecutive_losses = max_losses;
        metrics.curr_streak = current;

        // MAE/MFE
        let maes: Vec<f64> = closed_trades.iter().map(|t| t.mae).collect();
        let mfes: Vec<f64> = closed_trades.iter().map(|t| t.mfe).collect();

        if !maes.is_empty() {
            metrics.avg_mae = maes.iter().sum::<f64>() / maes.len() as f64;
        }
        if !mfes.is_empty() {
            metrics.avg_mfe = mfes.iter().sum::<f64>() / mfes.len() as f64;
        }
        if metrics.avg_mfe.abs() > 0.0 {
            metrics.mae_mfe_ratio = metrics.avg_mae.abs() / metrics.avg_mfe;
        }

        // Volatility from equity curve
        if portfolio.equity_curve.len() > 1 {
            let returns = Self::calculate_returns(&portfolio.equity_curve);
            metrics.volatility = Self::std_dev(&returns);
            metrics.annualized_volatility = metrics.volatility * (252.0_f64).sqrt();

            // Sharpe ratio. Every term here is a fraction: the annualized
            // return, the risk-free rate, and the annualized volatility share
            // the same unit, so the ratio is dimensionless and correctly scaled.
            let excess_return = metrics.annualized_return - risk_free_rate;
            if metrics.annualized_volatility > 0.0 {
                metrics.sharpe_ratio = excess_return / metrics.annualized_volatility;
            }

            // Sortino ratio (downside deviation)
            let downside_returns: Vec<f64> =
                returns.iter().filter(|&&r| r < 0.0).copied().collect();
            if !downside_returns.is_empty() {
                let downside_dev = Self::std_dev(&downside_returns);
                if downside_dev > 0.0 {
                    metrics.sortino_ratio = excess_return / (downside_dev * (252.0_f64).sqrt());
                }
            }

            // Ulcer index
            metrics.ulcer_idx = Self::calculate_ulcer_idx(&portfolio.equity_curve);
        }

        // Calmar ratio. Annualized return and max drawdown are both fractions,
        // so the ratio is dimensionless.
        if metrics.max_drawdown > 0.0 {
            metrics.calmar_ratio = metrics.annualized_return / metrics.max_drawdown;
        }

        // Recovery factor. `max_drawdown` is a fraction of peak equity, so the
        // peak-loss dollar amount is the product of the two.
        if metrics.max_drawdown > 0.0 {
            let dd_amount = portfolio.peak_equity * metrics.max_drawdown;
            if dd_amount > 0.0 {
                metrics.recovery_factor = metrics.total_return / dd_amount;
            }
        }

        // Commission and slippage
        metrics.total_commission = closed_trades.iter().map(|t| t.commission).sum();
        metrics.total_slippage = closed_trades.iter().map(|t| t.slippage).sum();

        metrics
    }

    fn calculate_returns(equity_curve: &[(chrono::DateTime<chrono::Utc>, f64)]) -> Vec<f64> {
        let mut returns = Vec::with_capacity(equity_curve.len() - 1);

        for i in 1..equity_curve.len() {
            let prev = equity_curve[i - 1].1;
            let curr = equity_curve[i].1;
            if prev > 0.0 {
                returns.push((curr - prev) / prev);
            }
        }

        returns
    }

    fn std_dev(values: &[f64]) -> f64 {
        if values.is_empty() {
            return 0.0;
        }

        let mean = values.iter().sum::<f64>() / values.len() as f64;
        let variance = values.iter().map(|v| (v - mean).powi(2)).sum::<f64>() / values.len() as f64;
        variance.sqrt()
    }

    fn calculate_streaks(trades: &[&Trade]) -> (usize, usize, isize) {
        let mut max_wins = 0;
        let mut max_losses = 0;
        let mut curr_wins = 0;
        let mut curr_losses = 0;

        for trade in trades {
            if trade.pnl > 0.0 {
                curr_wins += 1;
                curr_losses = 0;
                max_wins = max_wins.max(curr_wins);
            } else {
                curr_losses += 1;
                curr_wins = 0;
                max_losses = max_losses.max(curr_losses);
            }
        }

        let current = if curr_wins > 0 {
            curr_wins as isize
        } else {
            -(curr_losses as isize)
        };

        (max_wins, max_losses, current)
    }

    fn calculate_ulcer_idx(equity_curve: &[(chrono::DateTime<chrono::Utc>, f64)]) -> f64 {
        if equity_curve.is_empty() {
            return 0.0;
        }

        let mut peak = equity_curve[0].1;
        let mut squared_dd_sum = 0.0;

        for &(_, equity) in equity_curve.iter() {
            peak = peak.max(equity);
            let dd_pct = if peak > 0.0 {
                ((peak - equity) / peak) * 100.0
            } else {
                0.0
            };
            squared_dd_sum += dd_pct.powi(2);
        }

        (squared_dd_sum / equity_curve.len() as f64).sqrt()
    }

    /// Format metrics as a report string
    pub fn report(&self) -> String {
        format!(
            r#"=== Performance Report ===

Returns:
  Total Return: ${:.2} ({:.2}%)
  CAGR: {:.2}%

Risk:
  Max Drawdown: {:.2}%
  Volatility (Ann.): {:.2}%

Risk-Adjusted:
  Sharpe Ratio: {:.2}
  Sortino Ratio: {:.2}
  Calmar Ratio: {:.2}

Trade Statistics:
  Total Trades: {}
  Win Rate: {:.2}%
  Profit Factor: {:.2}
  Avg Trade: ${:.2}
  Expectancy: ${:.2}

  Avg Win: ${:.2}
  Avg Loss: ${:.2}
  Largest Win: ${:.2}
  Largest Loss: ${:.2}

Streaks:
  Max Consecutive Wins: {}
  Max Consecutive Losses: {}

Costs:
  Total Commission: ${:.2}
  Total Slippage: ${:.2}

Final Equity: ${:.2}
"#,
            self.total_return,
            self.total_return_pct,
            self.cagr * 100.0,
            self.max_drawdown * 100.0,
            self.annualized_volatility * 100.0,
            self.sharpe_ratio,
            self.sortino_ratio,
            self.calmar_ratio,
            self.total_trades,
            self.win_rate,
            self.profit_factor,
            self.avg_trade,
            self.expectancy,
            self.avg_win,
            self.avg_loss,
            self.largest_win,
            self.largest_loss,
            self.max_consecutive_wins,
            self.max_consecutive_losses,
            self.total_commission,
            self.total_slippage,
            self.final_equity,
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_std_dev() {
        let values = vec![2.0, 4.0, 4.0, 4.0, 5.0, 5.0, 7.0, 9.0];
        let std = PerformanceMetrics::std_dev(&values);
        assert!((std - 2.0).abs() < 0.1);
    }

    #[test]
    fn test_streaks() {
        use super::super::trade::{TradeSide, TradeStatus};
        use chrono::Utc;

        let mut trades = Vec::new();

        // WWWLLWW pattern
        let pnls = [100.0, 50.0, 75.0, -30.0, -20.0, 80.0, 90.0];
        for (i, &pnl) in pnls.iter().enumerate() {
            let mut trade = Trade::new(i, "TEST".into(), TradeSide::Long, 100.0, 10.0, Utc::now());
            trade.pnl = pnl;
            trade.status = TradeStatus::Closed;
            trades.push(trade);
        }

        let trade_refs: Vec<&Trade> = trades.iter().collect();
        let (max_wins, max_losses, current) = PerformanceMetrics::calculate_streaks(&trade_refs);

        assert_eq!(max_wins, 3);
        assert_eq!(max_losses, 2);
        assert_eq!(current, 2); // Current winning streak
    }

    #[test]
    fn test_metrics_calculation() {
        let portfolio = Portfolio::new(100_000.0);
        let metrics = PerformanceMetrics::calculate(&portfolio, 0.0, 252);

        assert!((metrics.final_equity - 100_000.0).abs() < 0.01);
        assert_eq!(metrics.total_trades, 0);
    }

    #[test]
    fn test_sharpe_against_hand_computed_value() {
        use super::super::trade::{TradeSide, TradeStatus};
        use chrono::Utc;

        // Drive the metric with a fully known series so the Sharpe ratio can be
        // checked against a hand calculation. With one year of data the
        // annualized return collapses to the simple total return: ending equity
        // 110_000 on 100_000 of capital is a 0.10 fraction.
        let mut portfolio = Portfolio::new(100_000.0);
        portfolio.cash = 110_000.0;

        // Equity-curve returns of [+1%, -1%, +1%, -1%] have a zero mean and a
        // population standard deviation of exactly 0.01 per bar.
        let curve = [100_000.0, 101_000.0, 99_990.0, 100_989.9, 99_980.001];
        let now = Utc::now();
        for &equity in curve.iter() {
            portfolio.equity_curve.push((now, equity));
        }

        // At least one closed trade is required for the full metric pass to run.
        let mut trade = Trade::new(0, "TEST".into(), TradeSide::Long, 100.0, 10.0, now);
        trade.pnl = 100.0;
        trade.status = TradeStatus::Closed;
        portfolio.trades.push(trade);

        let metrics = PerformanceMetrics::calculate(&portfolio, 0.0, 252);

        // Internal units are fractions: 10% annualized return, 1% per-bar vol.
        assert!((metrics.annualized_return - 0.10).abs() < 1e-9);
        assert!((metrics.volatility - 0.01).abs() < 1e-9);

        let expected_ann_vol = 0.01 * (252.0_f64).sqrt();
        assert!((metrics.annualized_volatility - expected_ann_vol).abs() < 1e-9);

        // Sharpe = (0.10 - 0.0) / (0.01 * sqrt(252)) ≈ 0.6299605.
        let expected_sharpe = 0.10 / expected_ann_vol;
        assert!(
            (metrics.sharpe_ratio - expected_sharpe).abs() < 1e-9,
            "sharpe was {}, expected {}",
            metrics.sharpe_ratio,
            expected_sharpe
        );
        assert!((metrics.sharpe_ratio - 0.629960_5).abs() < 1e-4);

        // A correctly scaled Sharpe stays near unity; the unit mismatch would
        // have inflated it by roughly 100x.
        assert!(metrics.sharpe_ratio < 2.0);
    }
}