quantsupport 0.1.5

Rust library for derivative pricing and risk analytics.
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
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
use std::collections::HashMap;

use rand::rngs::StdRng;
use rand::Rng;
use rand::SeedableRng;

use crate::{
    ad::scalar::Scalar,
    core::marketdatahandling::{
        discountrequest::DiscountRequest, forwardraterequest::ForwardRateRequest,
        fxrequest::FxRequest, pathdependentrequest::PathDependentRequest, spotrequest::SpotRequest,
    },
    currencies::currency::Currency,
    indices::marketindex::MarketIndex,
    math::linalg::cholesky,
    math::solvers::solvertraits::Matrix,
    models::lgm::lgmcomponents::{LgmFxModel, LgmRateModel},
    time::{date::Date, daycounter::DayCounter},
    utils::errors::{QSError, Result},
    xva::visitors::{
        preprocessorexecutor::SimulationRequest,
        marketmodel::{MarketModel, PathScenario, SimulationResponse},
    },
};

/// Cached simulation state: Gaussian factors and FX spots keyed by date.
#[derive(Default)]
struct LgmMarketModelState {
    rates: HashMap<MarketIndex, HashMap<Date, f64>>,
    fx: HashMap<Currency, HashMap<Date, f64>>,
}

/// Single- or multi-currency LGM (Linear Gaussian Markov) market model.
///
/// Drives Monte-Carlo path generation for XVA / exposure calculations.
/// Each rate currency is modelled by an [`LgmRateModel`] and each FX pair
/// by an [`LgmFxModel`]; cross-factor correlations are captured via a
/// Cholesky-decomposed correlation matrix.
pub struct LgmMarketModel<'a, T: Scalar> {
    domestic_currency: Currency,
    domestic_index: MarketIndex,
    curve_models: HashMap<MarketIndex, LgmRateModel<'a, T>>,
    fx_models: HashMap<Currency, LgmFxModel<'a, T>>,
    currency_to_index: HashMap<Currency, MarketIndex>,
    fx_spot_indices: HashMap<MarketIndex, Currency>,
    /// Derived curve → driving rate model. Derived curves (e.g. FX-implied
    /// collateral curves) carry no factor of their own: their discount
    /// factors are reconstructed from the driver's simulated factor with the
    /// derived curve's initial term structure (deterministic basis).
    curve_drivers: HashMap<MarketIndex, MarketIndex>,
    dates: Vec<Date>,
    requests: Vec<SimulationRequest>,
    reference_date: Date,
    day_counter: DayCounter,
    n_paths: usize,
    seed: u64,
    correlation_matrix: Option<Matrix<f64>>,
    state: LgmMarketModelState,
}

impl<'a, T: Scalar> LgmMarketModel<'a, T> {
    /// Creates a new LGM market model for the given domestic currency.
    #[must_use]
    pub fn new(
        domestic_currency: Currency,
        domestic_index: MarketIndex,
        reference_date: Date,
        day_counter: DayCounter,
    ) -> Self {
        Self {
            domestic_currency,
            domestic_index,
            curve_models: HashMap::new(),
            fx_models: HashMap::new(),
            currency_to_index: HashMap::new(),
            fx_spot_indices: HashMap::new(),
            curve_drivers: HashMap::new(),
            dates: Vec::new(),
            requests: Vec::new(),
            reference_date,
            day_counter,
            n_paths: 1000,
            seed: 42,
            correlation_matrix: None,
            state: LgmMarketModelState::default(),
        }
    }

    /// Sets the number of Monte Carlo paths.
    #[must_use]
    pub const fn with_n_paths(mut self, n: usize) -> Self {
        self.n_paths = n;
        self
    }

    /// Sets the base RNG seed.
    #[must_use]
    pub const fn with_seed(mut self, seed: u64) -> Self {
        self.seed = seed;
        self
    }

    /// Sets the cross-factor correlation matrix.
    #[must_use]
    pub fn with_correlation_matrix(mut self, corr: Matrix<f64>) -> Self {
        self.correlation_matrix = Some(corr);
        self
    }

    /// Adds a rate curve model for the given market index.
    pub fn add_curve_model(&mut self, market_index: MarketIndex, model: LgmRateModel<'a, T>) {
        if let Ok(details) = market_index.rate_index_details() {
            self.currency_to_index
                .insert(details.currency(), market_index.clone());
        }
        self.curve_models.insert(market_index, model);
    }

    /// Adds an FX model for the given foreign currency.
    pub fn add_fx_model(&mut self, currency: Currency, model: LgmFxModel<'a, T>) {
        self.fx_models.insert(currency, model);
    }

    /// Declares `index` as a derived curve driven by `driver`'s factor.
    ///
    /// The derived curve's rate model should be built with the driver's
    /// parameters (lambda, sigma schedule) and its own initial term
    /// structure; simulation then reconstructs its discount factors from the
    /// driver's simulated Gaussian factor (deterministic-basis assumption).
    pub fn set_curve_driver(&mut self, index: MarketIndex, driver: MarketIndex) {
        self.curve_drivers.insert(index, driver);
    }

    /// Resolves the index whose simulated factor drives `index`.
    fn factor_index<'b>(&'b self, index: &'b MarketIndex) -> &'b MarketIndex {
        self.curve_drivers.get(index).unwrap_or(index)
    }

    /// Registers a [`MarketIndex`] as an FX spot index so that
    /// [`SpotRequest`]s referencing it are resolved from the FX state.
    pub fn register_fx_spot_index(&mut self, index: MarketIndex, currency: Currency) {
        self.fx_spot_indices.insert(index, currency);
    }

    /// Sets the simulation requests (one per contingent claim).
    pub fn set_requests(&mut self, requests: Vec<SimulationRequest>) {
        self.requests = requests;
    }

    fn time_from_date(&self, date: Date) -> f64 {
        self.day_counter.year_fraction(self.reference_date, date)
    }

    fn rate_index_for_currency(&self, ccy: Currency) -> Option<MarketIndex> {
        self.currency_to_index.get(&ccy).cloned()
    }

    /// Factor ordering:
    ///   [`z_dom` (0), `z_for_1` (1), ..., `z_for_N` (N), `x_1` (N+1), ..., `x_N` (2N)]
    ///
    /// Returns (`rate_indices`, `fx_currencies`) where `rate_indices`[0] = domestic.
    fn build_factor_ordering(&self) -> (Vec<MarketIndex>, Vec<Currency>) {
        let mut rate_indices = vec![self.domestic_index.clone()];
        let mut fx_currencies = Vec::new();

        for ccy in self.fx_models.keys() {
            if let Some(idx) = self.rate_index_for_currency(*ccy) {
                if !rate_indices.contains(&idx) {
                    rate_indices.push(idx);
                }
            }
            fx_currencies.push(*ccy);
        }

        (rate_indices, fx_currencies)
    }
}

/// Box–Muller standard-normal sample.
fn std_normal(rng: &mut impl Rng) -> f64 {
    let u1: f64 = rng.gen_range(f64::EPSILON..1.0);
    let u2: f64 = rng.gen_range(0.0..std::f64::consts::TAU);
    (-2.0 * u1.ln()).sqrt() * u2.cos()
}

/// Read-only pre-computed data shared by all path generators.
struct LgmPathContext<'a, T: Scalar> {
    model: &'a LgmMarketModel<'a, T>,
    times: Vec<f64>,
    rate_indices: Vec<MarketIndex>,
    fx_currencies: Vec<Currency>,
    cholesky_l: Vec<Vec<f64>>,
    n_factors: usize,
}

// SAFETY: `LgmPathContext` is read-only during parallel path generation.
// The `&dyn InterestRatesTermStructure` references inside `LgmRateModel`
// are only used for discount-factor lookups (pure reads).
unsafe impl<T: Scalar> Sync for LgmPathContext<'_, T> {}
unsafe impl<T: Scalar> Send for LgmPathContext<'_, T> {}

impl<'a, T: Scalar> LgmPathContext<'a, T> {
    fn new(model: &'a LgmMarketModel<'a, T>) -> Self {
        let (rate_indices, fx_currencies) = model.build_factor_ordering();
        let n_rates = rate_indices.len();
        let n_fx = fx_currencies.len();
        let n_factors = n_rates + n_fx;

        let cholesky_l = model.correlation_matrix.as_ref().map_or_else(
            || {
                let mut id = vec![vec![0.0; n_factors]; n_factors];
                for (i, row) in id.iter_mut().enumerate() {
                    row[i] = 1.0;
                }
                id
            },
            |corr| cholesky(corr),
        );

        let mut times = Vec::with_capacity(model.dates.len() + 1);
        times.push(0.0);
        for d in &model.dates {
            times.push(model.time_from_date(*d));
        }

        Self {
            model,
            times,
            rate_indices,
            fx_currencies,
            cholesky_l,
            n_factors,
        }
    }

    /// Generate one MC path using the given RNG.
    #[allow(clippy::too_many_lines)]
    fn generate_path(&self, rng: &mut StdRng) -> Result<PathScenario<T>> {
        let n_dates = self.model.dates.len();
        let n_requests = self.model.requests.len();
        let rate_count = self.rate_indices.len();

        // State vectors — AD-typed so gradients flow through.
        let mut z: Vec<T> = vec![T::zero(); rate_count];
        let mut x: HashMap<Currency, T> = self
            .fx_currencies
            .iter()
            .map(|ccy| {
                let spot = self.model.fx_models[ccy].initial_spot();
                (*ccy, spot)
            })
            .collect();

        let mut x_history: Vec<HashMap<Currency, T>> = Vec::with_capacity(n_dates);
        let mut scenario: Vec<Vec<SimulationResponse<T>>> = Vec::with_capacity(n_dates);

        // Pre-allocate scratch buffers for normals and correlated increments
        let mut eps: Vec<f64> = vec![0.0; self.n_factors];
        let mut dw: Vec<f64> = vec![0.0; self.n_factors];

        for step in 0..n_dates {
            let t = self.times[step];
            let t_next = self.times[step + 1];
            let dt = t_next - t;
            let sqrt_dt = dt.sqrt();

            // 1. Generate independent normals (reuse buffer)
            for e in &mut eps {
                *e = std_normal(rng);
            }

            // 2. Apply Cholesky to get correlated increments (dW_i = sum_j L[i][j] * eps[j] * sqrt(dt))
            for (i, dw_i) in dw.iter_mut().enumerate().take(self.n_factors) {
                let mut w = 0.0;
                for (j, eps_j) in eps.iter().enumerate().take(i + 1) {
                    w += self.cholesky_l[i][j] * eps_j;
                }
                *dw_i = w * sqrt_dt;
            }

            // 3. Evolve domestic factor (index 0, drift = 0)
            let dom_model = &self.model.curve_models[&self.rate_indices[0]];
            if dt > 1e-14 {
                z[0] = dom_model.evolve_domestic_factor_euler(t, z[0], dt, dw[0]);
            }

            // 4. Evolve foreign factors and FX spots
            if dt > 1e-14 {
                for (fi, ccy) in self.fx_currencies.iter().enumerate() {
                    let fx_model = &self.model.fx_models[ccy];
                    let for_index = self.model.rate_index_for_currency(*ccy).ok_or_else(|| {
                        QSError::NotFoundErr(format!("Rate index for currency {ccy}"))
                    })?;
                    let rate_pos = self
                        .rate_indices
                        .iter()
                        .position(|idx| *idx == for_index)
                        .ok_or_else(|| {
                            QSError::NotFoundErr(format!("Rate position for {for_index}"))
                        })?;
                    let fx_pos = rate_count + fi; // position in factor array

                    let for_model = &self.model.curve_models[&for_index];

                    // Correlations for the foreign factor drift (from original correlation matrix)
                    let (rho_zz_for_dom, rho_zx_for_fx) = self
                        .model
                        .correlation_matrix
                        .as_ref()
                        .map_or((0.0, 0.0), |c| (c[rate_pos][0], c[rate_pos][fx_pos]));

                    // Evolve foreign Gaussian factor under domestic measure
                    z[rate_pos] = for_model.evolve_foreign_factor_under_domestic_measure_euler(
                        t,
                        z[rate_pos],
                        dt,
                        dw[rate_pos],
                        dom_model,
                        fx_model.fx_vol().value(),
                        rho_zx_for_fx,
                        rho_zz_for_dom,
                    );

                    // Evolve FX spot (log-Euler)
                    let x_curr = x[ccy];
                    let new_x = fx_model.evolve_fx_spot_log_euler(
                        t,
                        x_curr,
                        z[0],
                        z[rate_pos],
                        dt,
                        dw[fx_pos],
                    )?;
                    x.insert(*ccy, new_x);
                }
            }

            x_history.push(x.clone());

            // 5. Build SimulationResponse for each request at this date
            let eval_date = self.model.dates[step];
            let mut date_responses = Vec::with_capacity(n_requests);

            for req in &self.model.requests {
                let mut resp = SimulationResponse::new();

                // Forward rate
                if let Some(fwd_req) = &req.forward_rate_request {
                    let idx = fwd_req.market_index();
                    if let Some(curve_model) = self.model.curve_models.get(&idx) {
                        // Find the z_t for this curve (derived curves are
                        // driven by their driver's factor).
                        let fidx = self.model.factor_index(&idx);
                        let rate_pos = self
                            .rate_indices
                            .iter()
                            .position(|ri| ri == fidx)
                            .unwrap_or(0);
                        let z_t = z[rate_pos];

                        let start = fwd_req
                            .start_date()
                            .unwrap_or_else(|| fwd_req.fixing_date());
                        let end = fwd_req.end_date().unwrap_or_else(|| fwd_req.fixing_date());
                        let t_eval = self.model.time_from_date(eval_date);
                        let t_start = self.model.time_from_date(start);
                        let t_end = self.model.time_from_date(end);

                        if (t_end - t_start).abs() < 1e-14 {
                            // Instantaneous forward rate
                            let rate =
                                curve_model.instantaneous_forward_rate(t_eval, t_start, z_t)?;
                            resp.forward_rates = Some(rate);
                        } else {
                            // Forward rate from discount factors
                            let p_start = curve_model.P_discount(t_eval, t_start, z_t)?;
                            let p_end = curve_model.P_discount(t_eval, t_end, z_t)?;
                            let tau = t_end - t_start;
                            let rate = p_start
                                .div_val(p_end)
                                .sub_val(T::one())
                                .div_val(T::scalar(tau));
                            resp.forward_rates = Some(rate);
                        }
                    }
                }

                // FX rate
                if let Some(fx_req) = &req.fx_request {
                    let base = fx_req.base();
                    if base == self.model.domestic_currency {
                        resp.fx_rates = Some(T::one());
                    } else if let Some(&spot) = x.get(&base) {
                        resp.fx_rates = Some(spot);
                    } else {
                        resp.fx_rates = Some(T::one());
                    }
                }

                // Discounting
                if let Some(disc_req) = &req.discount_request {
                    let idx = disc_req.market_index();
                    if let Some(curve_model) = self.model.curve_models.get(&idx) {
                        let fidx = self.model.factor_index(&idx);
                        let rate_pos = self
                            .rate_indices
                            .iter()
                            .position(|ri| ri == fidx)
                            .unwrap_or(0);
                        let z_t = z[rate_pos];
                        let t_eval = self.model.time_from_date(eval_date);
                        let t_pay = self.model.time_from_date(disc_req.date());
                        if t_pay > t_eval {
                            if let Ok(df) = curve_model.P_discount(t_eval, t_pay, z_t) {
                                resp.discounts = Some(df);
                            }
                        } else {
                            resp.discounts = Some(T::one());
                        }
                    }
                }

                resp.numeraire = None;

                // Spot request — deferred to post-processing pass below
                // so the observation_date's simulated state can be used.

                // Path-dependent request (not modeled in LGM)
                if req.path_dependent_request.is_some() {
                    resp.path_dependent_observations = None;
                }

                date_responses.push(resp);
            }

            scenario.push(date_responses);
        }

        // Post-processing: resolve spot requests using S at the observation date.
        for (step, step_responses) in scenario.iter_mut().enumerate() {
            for (ri, req) in self.model.requests.iter().enumerate() {
                if let Some(spot_req) = &req.spot_request {
                    let idx = spot_req.market_index();
                    let obs_date = spot_req.date();
                    if let Some(ccy) = self.model.fx_spot_indices.get(&idx) {
                        let obs_step = self
                            .model
                            .dates
                            .iter()
                            .rposition(|d| *d <= obs_date)
                            .unwrap_or(step)
                            .min(n_dates - 1);
                        if let Some(&fx_spot) = x_history[obs_step].get(ccy) {
                            step_responses[ri].spots = Some(fx_spot);
                        }
                    }
                }
            }
        }

        Ok(scenario)
    }
}

// SAFETY: LgmMarketModel is immutable during simulation — all &dyn
// InterestRatesTermStructure references are used for read-only discount-factor
// lookups.  No interior mutability is involved.
unsafe impl<T: Scalar> Sync for LgmMarketModel<'_, T> {}
#[allow(clippy::non_send_fields_in_send_ty)]
unsafe impl<T: Scalar> Send for LgmMarketModel<'_, T> {}

// ---------------------------------------------------------------------------
// MarketModel implementation
// ---------------------------------------------------------------------------
impl<T: Scalar + 'static> MarketModel<T> for LgmMarketModel<'_, T> {
    fn n_paths(&self) -> usize {
        self.n_paths
    }

    fn generate_path(&self, index: usize) -> Option<PathScenario<T>> {
        let ctx = LgmPathContext::new(self);
        let mut rng = StdRng::seed_from_u64(self.seed.wrapping_add(index as u64));
        ctx.generate_path(&mut rng).ok()
    }

    fn set_evaluation_dates(&mut self, dates: Vec<Date>) {
        self.dates = dates;
    }

    fn resolve_discount_request(&self, eval_date: Date, request: &DiscountRequest) -> Result<T> {
        let idx = request.market_index();
        let curve_model = self
            .curve_models
            .get(&idx)
            .ok_or_else(|| QSError::NotFoundErr(format!("Curve model for {idx}")))?;
        let t_eval = self.time_from_date(eval_date);
        let t_pay = self.time_from_date(request.date());
        let z_t = T::scalar(self.state_z(&idx, eval_date).unwrap_or(0.0));
        curve_model.P_discount(t_eval, t_pay, z_t)
    }

    fn resolve_forward_rate_request(
        &self,
        eval_date: Date,
        request: &ForwardRateRequest,
    ) -> Result<T> {
        let idx = request.market_index();
        let curve_model = self
            .curve_models
            .get(&idx)
            .ok_or_else(|| QSError::NotFoundErr(format!("Curve model for {idx}")))?;
        let t_eval = self.time_from_date(eval_date);
        let z_t = T::scalar(self.state_z(&idx, eval_date).unwrap_or(0.0));

        let start = request
            .start_date()
            .unwrap_or_else(|| request.fixing_date());
        let end = request.end_date().unwrap_or_else(|| request.fixing_date());
        let t_start = self.time_from_date(start);
        let t_end = self.time_from_date(end);

        if (t_end - t_start).abs() < 1e-14 {
            curve_model.instantaneous_forward_rate(t_eval, t_start, z_t)
        } else {
            let p_s = curve_model.P_discount(t_eval, t_start, z_t)?;
            let p_e = curve_model.P_discount(t_eval, t_end, z_t)?;
            let tau = t_end - t_start;
            Ok(p_s.div_val(p_e).sub_val(T::one()).div_val(T::scalar(tau)))
        }
    }

    fn resolve_fx_request(&self, eval_date: Date, request: &FxRequest) -> Result<T> {
        let base = request.base();
        if base == self.domestic_currency {
            return Ok(T::one());
        }
        self.state_fx(base, eval_date)
            .map(|v| T::scalar(v))
            .ok_or_else(|| QSError::NotFoundErr(format!("FX state for {base} at {eval_date}")))
    }

    fn resolve_spot_request(&self, eval_date: Date, request: &SpotRequest) -> Result<T> {
        let idx = request.market_index();
        self.fx_spot_indices.get(&idx).map_or_else(
            || {
                Err(QSError::NotImplementedErr(
                    "Spot request not supported in LGM rate model".into(),
                ))
            },
            |ccy| {
                self.state_fx(*ccy, eval_date)
                    .map(|v| T::scalar(v))
                    .ok_or_else(|| {
                        QSError::NotFoundErr(format!("FX state for {ccy} at {eval_date}"))
                    })
            },
        )
    }

    fn resolve_path_dependent_request(
        &self,
        _eval_date: Date,
        _request: &PathDependentRequest,
    ) -> Result<T> {
        Err(QSError::NotImplementedErr(
            "Path-dependent request not supported in LGM rate model".into(),
        ))
    }
}

// ---------------------------------------------------------------------------
// State accessors (used by resolve methods when state is populated externally)
// ---------------------------------------------------------------------------
impl<T: Scalar> LgmMarketModel<'_, T> {
    fn state_z(&self, index: &MarketIndex, date: Date) -> Option<f64> {
        self.state.rates.get(self.factor_index(index))?.get(&date).copied()
    }

    fn state_fx(&self, currency: Currency, date: Date) -> Option<f64> {
        self.state.fx.get(&currency)?.get(&date).copied()
    }
}