libitofin 0.52.1

A ground-up Rust port of QuantLib: quantitative-finance primitives for pricing, risk, and numerical methods.
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
//! Stateless, seeded Monte Carlo building blocks shared across bindings.
//!
//! Draws use the core Mersenne Twister / inverse-normal policy, consumed in
//! path, time, asset order. Nonzero seeds reproduce the native sequence; zero
//! is rejected because the native RNG interprets it as a nondeterministic seed.

use crate::errors::{QlError, QlResult};
use crate::handle::Handle;
use crate::interestrate::Compounding;
use crate::math::array::Array;
use crate::math::matrix::Matrix;
use crate::math::matrixutilities::choleskydecomposition::cholesky_decomposition;
use crate::math::randomnumbers::rngtraits::{McRngTraits, PseudoRandom, SequenceGenerator};
use crate::processes::{HestonDiscretization as Discretization, HestonProcess};
use crate::quotes::make_quote_handle;
use crate::require;
use crate::shared::{Shared, shared};
use crate::stochasticprocess::StochasticProcess;
use crate::termstructures::yields::FlatForward;
use crate::termstructures::yieldtermstructure::YieldTermStructure;
use crate::time::date::{Date, Month};
use crate::time::daycounters::actual365fixed::Actual365Fixed;
use crate::time::frequency::Frequency;
use crate::types::{Natural, Rate, Real, Size, Time, Volatility};

fn error(message: &str) -> QlError {
    QlError::new(message, file!(), line!())
}

fn zeros(count: Size) -> QlResult<Vec<Real>> {
    let mut result = Vec::new();
    result
        .try_reserve_exact(count)
        .map_err(|_| error("allocation failed"))?;
    result.resize(count, 0.0);
    Ok(result)
}

fn product(a: Size, b: Size) -> QlResult<Size> {
    a.checked_mul(b)
        .ok_or_else(|| error("simulation dimensions overflow"))
}

/// Independent standard-normal draws in native sequence order.
///
/// An empty request returns an empty vector, but still requires a nonzero seed.
pub fn gaussian_draws(count: Size, seed: Natural) -> QlResult<Vec<Real>> {
    require!(seed != 0, "seed must be nonzero");
    let mut result = zeros(count)?;
    // A scalar sequence keeps native internal allocations constant-sized.
    let mut rng = PseudoRandom::make_sequence_generator(1, seed)?;
    for value in &mut result {
        *value = rng.next_sequence().value[0];
    }
    Ok(result)
}

/// Parameters for exact-discretization geometric Brownian motion.
///
/// `drift` is the annualized arithmetic drift (risk-neutral callers supply
/// their own rate minus yield); volatility and horizon use matching time units.
/// Correlation is a dense row-major, symmetric, unit-diagonal **positive
/// definite** matrix. Singular positive-semidefinite matrices are rejected;
/// no identity fallback, jitter, or eigenvalue repair is performed.
pub struct GbmRequest<'a> {
    pub initial: &'a [Real],
    pub drift: &'a [Rate],
    pub volatility: &'a [Volatility],
    pub correlation: &'a [Real],
    pub horizon: Time,
    pub steps: Size,
    pub paths: Size,
    pub seed: Natural,
    /// Return only `[path, asset]`, with the same terminal values as full mode.
    pub terminal_only: bool,
}

/// Number of result elements, with overflow checked before allocation.
pub fn output_len(request: &GbmRequest<'_>) -> QlResult<Size> {
    let times = if request.terminal_only {
        1
    } else {
        request
            .steps
            .checked_add(1)
            .ok_or_else(|| error("step count overflows"))?
    };
    product(product(request.paths, times)?, request.initial.len())
}

fn correlation_factor(values: &[Real], assets: Size) -> QlResult<Matrix> {
    require!(
        values.len() == product(assets, assets)?,
        "correlation shape mismatch"
    );
    // Strict input checks prevent the native decomposition's flexible mode
    // from silently interpreting an asymmetric matrix using its upper half.
    for i in 0..assets {
        require!(
            values[i * assets + i] == 1.0,
            "correlation diagonal must equal one"
        );
        for j in 0..assets {
            let value = values[i * assets + j];
            require!(
                value.is_finite() && value.abs() <= 1.0,
                "invalid correlation entry"
            );
            require!(
                value == values[j * assets + i],
                "correlation must be symmetric"
            );
        }
    }
    let mut matrix = Matrix::with_size(assets, assets);
    for i in 0..assets {
        matrix
            .row_mut(i)
            .copy_from_slice(&values[i * assets..(i + 1) * assets]);
    }
    // Flexible mode avoids the core strict-mode panic. Require every pivot
    // positive and verify reconstruction so this remains an SPD-only API.
    let factor = cholesky_decomposition(&matrix, true);
    let tolerance = 64.0 * Real::EPSILON * assets as Real;
    for i in 0..assets {
        require!(
            matches!(
                factor[(i, i)].partial_cmp(&0.0),
                Some(std::cmp::Ordering::Greater)
            ),
            "correlation must be positive definite"
        );
        for j in 0..=i {
            let rebuilt: Real = (0..=j).map(|k| factor[(i, k)] * factor[(j, k)]).sum();
            require!(
                rebuilt.is_finite() && (rebuilt - matrix[(i, j)]).abs() <= tolerance,
                "correlation factorization failed"
            );
        }
    }
    Ok(factor)
}

/// Generate GBM paths, laid out `[path, time, asset]`, including time zero.
///
/// Uses `dt = horizon / steps` and `S *= exp((mu - sigma²/2)dt +
/// sigma*sqrt(dt)*(L*z))`. All paths consume the same number of draws,
/// including zero-volatility assets. Zero horizon returns initial values
/// exactly. Zero volatility follows deterministic `initial*exp(mu*t)`.
///
/// # Errors
/// Rejects nonfinite parameters, nonpositive spots, negative volatilities or
/// horizon, zero steps/paths/seed, inconsistent shapes, non-SPD correlation,
/// and nonfinite or underflowed prices. Supports at most 1,024 assets to bound
/// the core Cholesky routine's infallibly allocated matrix workspace. Output
/// and simulation-owned scratch allocations use `try_reserve_exact`.
pub fn gbm_paths(request: &GbmRequest<'_>) -> QlResult<Vec<Real>> {
    let assets = request.initial.len();
    require!(
        (1..=1024).contains(&assets),
        "asset count must be between 1 and 1024"
    );
    require!(
        request.steps > 0 && request.paths > 0,
        "steps and paths must be positive"
    );
    require!(request.seed != 0, "seed must be nonzero");
    require!(
        request.horizon.is_finite() && request.horizon >= 0.0,
        "invalid horizon"
    );
    require!(
        request.drift.len() == assets && request.volatility.len() == assets,
        "asset shape mismatch"
    );
    for i in 0..assets {
        require!(
            request.initial[i].is_finite() && request.initial[i] > 0.0,
            "invalid initial value"
        );
        require!(request.drift[i].is_finite(), "invalid drift");
        require!(
            request.volatility[i].is_finite() && request.volatility[i] >= 0.0,
            "invalid volatility"
        );
    }
    // Validate dimension products even when terminal mode does not store time.
    product(product(request.paths, request.steps)?, assets)?;
    let count = output_len(request)?;
    let factor = correlation_factor(request.correlation, assets)?;
    let mut output = zeros(count)?;
    let mut current = zeros(assets)?;
    let mut normals = zeros(assets)?;
    let mut rng = PseudoRandom::make_sequence_generator(1, request.seed)?;
    let dt = request.horizon / request.steps as Real;
    let sqrt_dt = dt.sqrt();
    let mut cursor = 0;
    for _ in 0..request.paths {
        current.copy_from_slice(request.initial);
        if !request.terminal_only {
            output[cursor..cursor + assets].copy_from_slice(&current);
            cursor += assets;
        }
        for step in 0..request.steps {
            for z in &mut normals {
                *z = rng.next_sequence().value[0];
            }
            for i in 0..assets {
                let sigma = request.volatility[i];
                let mu = request.drift[i];
                if request.horizon == 0.0 {
                    current[i] = request.initial[i];
                } else if sigma == 0.0 {
                    let time = if step + 1 == request.steps {
                        request.horizon
                    } else {
                        (step + 1) as Real * dt
                    };
                    current[i] = request.initial[i] * (mu * time).exp();
                } else {
                    let z: Real = (0..=i).map(|j| factor[(i, j)] * normals[j]).sum();
                    current[i] *= ((mu - 0.5 * sigma * sigma) * dt + sigma * sqrt_dt * z).exp();
                }
                require!(
                    current[i].is_finite() && current[i] > 0.0,
                    "simulated price overflow or underflow"
                );
            }
            if !request.terminal_only {
                output[cursor..cursor + assets].copy_from_slice(&current);
                cursor += assets;
            }
        }
        if request.terminal_only {
            output[cursor..cursor + assets].copy_from_slice(&current);
            cursor += assets;
        }
    }
    Ok(output)
}

/// Parameters for stateless Heston paths under flat risk-free and dividend rates.
///
/// The two independent normals at each step are consumed in path, time,
/// spot-factor, variance-factor order. Correlation is applied by the process.
pub struct HestonRequest {
    pub spot: Real,
    pub variance: Real,
    pub risk_free_rate: Rate,
    pub dividend_yield: Rate,
    pub kappa: Real,
    pub theta: Real,
    pub sigma: Real,
    pub rho: Real,
    pub horizon: Time,
    pub steps: Size,
    pub paths: Size,
    pub seed: Natural,
    pub discretization: Discretization,
    pub terminal_only: bool,
}

/// Number of spot/variance result elements, checked before allocation.
pub fn heston_output_len(request: &HestonRequest) -> QlResult<Size> {
    let times = if request.terminal_only {
        1
    } else {
        request
            .steps
            .checked_add(1)
            .ok_or_else(|| error("step count overflows"))?
    };
    product(product(request.paths, times)?, 2)
}

fn flat_curve(rate: Rate) -> Handle<dyn YieldTermStructure> {
    Handle::new(shared(FlatForward::with_rate(
        Date::new(1, Month::January, 2026),
        rate,
        Actual365Fixed::new(),
        Compounding::Continuous,
        Frequency::Annual,
    )) as Shared<dyn YieldTermStructure>)
}

/// Generate Heston spot/variance paths in `[path, time, component]` order.
///
/// Component zero is spot and component one is variance. Full output includes
/// time zero; terminal output is `[path, component]` and equals the last full
/// time row for the same seed. Zero horizon repeats the initial state exactly.
///
/// # Errors
/// Rejects invalid dimensions, zero seed, nonfinite values, spot <= 0,
/// variance < 0, kappa/theta/sigma <= 0, rho outside [-1,1], negative
/// horizon, unsupported schemes, allocation failures, and nonfinite states.
pub fn heston_paths(request: &HestonRequest) -> QlResult<Vec<Real>> {
    require!(
        request.steps > 0 && request.paths > 0,
        "steps and paths must be positive"
    );
    require!(request.seed != 0, "seed must be nonzero");
    require!(
        request.spot.is_finite() && request.spot > 0.0,
        "invalid initial spot"
    );
    require!(
        request.variance.is_finite() && request.variance >= 0.0,
        "invalid initial variance"
    );
    require!(
        request.risk_free_rate.is_finite() && request.dividend_yield.is_finite(),
        "invalid rate"
    );
    require!(
        request.kappa.is_finite() && request.kappa > 0.0,
        "invalid kappa"
    );
    require!(
        request.theta.is_finite() && request.theta > 0.0,
        "invalid theta"
    );
    require!(
        request.sigma.is_finite() && request.sigma > 0.0,
        "invalid sigma"
    );
    require!(
        request.rho.is_finite() && request.rho.abs() <= 1.0,
        "invalid rho"
    );
    require!(
        request.horizon.is_finite() && request.horizon >= 0.0,
        "invalid horizon"
    );
    require!(
        matches!(
            request.discretization,
            Discretization::QuadraticExponential | Discretization::QuadraticExponentialMartingale
        ),
        "unsupported Heston discretization"
    );
    product(product(request.paths, request.steps)?, 2)?;
    let count = heston_output_len(request)?;
    let dt = request.horizon / request.steps as Real;
    require!(request.horizon == 0.0 || dt > 0.0, "time step underflow");
    let process = HestonProcess::with_discretization(
        flat_curve(request.risk_free_rate),
        flat_curve(request.dividend_yield),
        make_quote_handle(request.spot).handle(),
        request.variance,
        request.kappa,
        request.theta,
        request.sigma,
        request.rho,
        request.discretization,
    );
    let mut output = zeros(count)?;
    let mut rng = PseudoRandom::make_sequence_generator(1, request.seed)?;
    let initial = [request.spot, request.variance];
    let mut cursor = 0;
    for _ in 0..request.paths {
        let mut state = Array::from(initial);
        if !request.terminal_only {
            output[cursor..cursor + 2].copy_from_slice(&initial);
            cursor += 2;
        }
        for step in 0..request.steps {
            let z_spot = rng.next_sequence().value[0];
            let z_variance = rng.next_sequence().value[0];
            if request.horizon > 0.0 {
                state = process.evolve(
                    step as Real * dt,
                    &state,
                    dt,
                    &Array::from([z_spot, z_variance]),
                )?;
                require!(
                    state[0].is_finite() && state[0] > 0.0,
                    "simulated spot overflow or underflow"
                );
                require!(
                    state[1].is_finite() && state[1] >= 0.0,
                    "invalid simulated variance"
                );
            }
            if !request.terminal_only {
                output[cursor..cursor + 2].copy_from_slice(&[state[0], state[1]]);
                cursor += 2;
            }
        }
        if request.terminal_only {
            output[cursor..cursor + 2].copy_from_slice(&[state[0], state[1]]);
            cursor += 2;
        }
    }
    Ok(output)
}

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

    fn heston_request() -> HestonRequest {
        HestonRequest {
            spot: 100.0,
            variance: 0.04,
            risk_free_rate: 0.05,
            dividend_yield: 0.02,
            kappa: 1.2,
            theta: 0.06,
            sigma: 0.3,
            rho: -0.5,
            horizon: 1.0,
            steps: 4,
            paths: 3,
            seed: 42,
            discretization: Discretization::QuadraticExponentialMartingale,
            terminal_only: false,
        }
    }

    #[test]
    fn heston_draw_order_layout_and_terminal_match_process() {
        let request = heston_request();
        let full = heston_paths(&request).unwrap();
        assert_eq!(full.len(), 30);
        assert_eq!(&full[..2], &[100.0, 0.04]);
        let process = HestonProcess::with_discretization(
            flat_curve(request.risk_free_rate),
            flat_curve(request.dividend_yield),
            make_quote_handle(request.spot).handle(),
            request.variance,
            request.kappa,
            request.theta,
            request.sigma,
            request.rho,
            request.discretization,
        );
        let mut draws = PseudoRandom::make_sequence_generator(1, request.seed).unwrap();
        let z0 = draws.next_sequence().value[0];
        let z1 = draws.next_sequence().value[0];
        let first = process
            .evolve(
                0.0,
                &Array::from([100.0, 0.04]),
                0.25,
                &Array::from([z0, z1]),
            )
            .unwrap();
        assert_eq!(&full[2..4], &[first[0], first[1]]);
        assert!((full[2] - 93.218_736_641_315_03).abs() < 1e-11);
        assert!((full[3] - 0.065_675_158_526_020_28).abs() < 1e-13);
        let terminal = heston_paths(&HestonRequest {
            terminal_only: true,
            ..request
        })
        .unwrap();
        for (path, row) in terminal.chunks_exact(2).enumerate() {
            assert_eq!(row, &full[path * 10 + 8..path * 10 + 10]);
        }
        assert_eq!(full, heston_paths(&heston_request()).unwrap());
        assert_ne!(
            full,
            heston_paths(&HestonRequest {
                seed: 43,
                ..heston_request()
            })
            .unwrap()
        );
    }

    #[test]
    fn heston_qe_high_psi_fixed_fixture() {
        let request = HestonRequest {
            variance: 0.01,
            kappa: 0.5,
            theta: 0.01,
            sigma: 0.2,
            horizon: 1.0,
            steps: 1,
            paths: 1,
            discretization: Discretization::QuadraticExponential,
            terminal_only: true,
            ..heston_request()
        };
        let result = heston_paths(&request).unwrap();
        assert!((result[0] - 96.553_174_001_572_44).abs() < 1e-11);
        assert!((result[1] - 0.018_076_059_597_846_472).abs() < 1e-13);
    }

    #[test]
    fn heston_zero_horizon_and_invalid_inputs() {
        let zero = HestonRequest {
            horizon: 0.0,
            ..heston_request()
        };
        for state in heston_paths(&zero).unwrap().chunks_exact(2) {
            assert_eq!(state, &[100.0, 0.04]);
        }
        let cases = [
            HestonRequest {
                steps: 0,
                ..heston_request()
            },
            HestonRequest {
                paths: 0,
                ..heston_request()
            },
            HestonRequest {
                seed: 0,
                ..heston_request()
            },
            HestonRequest {
                spot: 0.0,
                ..heston_request()
            },
            HestonRequest {
                variance: -0.1,
                ..heston_request()
            },
            HestonRequest {
                risk_free_rate: Real::NAN,
                ..heston_request()
            },
            HestonRequest {
                dividend_yield: Real::INFINITY,
                ..heston_request()
            },
            HestonRequest {
                kappa: 0.0,
                ..heston_request()
            },
            HestonRequest {
                theta: 0.0,
                ..heston_request()
            },
            HestonRequest {
                sigma: 0.0,
                ..heston_request()
            },
            HestonRequest {
                rho: 1.1,
                ..heston_request()
            },
            HestonRequest {
                horizon: -1.0,
                ..heston_request()
            },
            HestonRequest {
                steps: Size::MAX,
                ..heston_request()
            },
            HestonRequest {
                paths: Size::MAX,
                ..heston_request()
            },
            HestonRequest {
                discretization: Discretization::FullTruncation,
                ..heston_request()
            },
        ];
        for request in cases {
            assert!(heston_paths(&request).is_err());
        }
    }

    #[test]
    fn heston_variance_moment_and_discounted_spot() {
        let request = HestonRequest {
            variance: 0.09,
            theta: 0.09,
            kappa: 1.0,
            sigma: 0.3,
            rho: -0.8,
            horizon: 0.1,
            steps: 1,
            paths: 30_000,
            terminal_only: true,
            ..heston_request()
        };
        let result = heston_paths(&request).unwrap();
        let n = request.paths as Real;
        let mean_v = result.chunks_exact(2).map(|v| v[1]).sum::<Real>() / n;
        let var_v = result
            .chunks_exact(2)
            .map(|v| (v[1] - mean_v).powi(2))
            .sum::<Real>()
            / n;
        let ex = (-request.kappa * request.horizon).exp();
        let target_v = request.theta + (request.variance - request.theta) * ex;
        let target_var = request.variance * request.sigma.powi(2) * ex / request.kappa * (1.0 - ex)
            + request.theta * request.sigma.powi(2) / (2.0 * request.kappa) * (1.0 - ex).powi(2);
        assert!((mean_v - target_v).abs() < 6.0 * (target_var / n).sqrt());
        assert!((var_v - target_var).abs() < 0.05 * target_var);
        let mean_spot = result.chunks_exact(2).map(|v| v[0]).sum::<Real>() / n;
        let spot_var = result
            .chunks_exact(2)
            .map(|v| (v[0] - mean_spot).powi(2))
            .sum::<Real>()
            / n;
        let target_spot = request.spot
            * ((request.risk_free_rate - request.dividend_yield) * request.horizon).exp();
        assert!((mean_spot - target_spot).abs() < 6.0 * (spot_var / n).sqrt());
    }

    fn request() -> GbmRequest<'static> {
        GbmRequest {
            initial: &[100.0, 80.0],
            drift: &[0.05, -0.02],
            volatility: &[0.2, 0.3],
            correlation: &[1.0, 0.4, 0.4, 1.0],
            horizon: 1.0,
            steps: 4,
            paths: 3,
            seed: 42,
            terminal_only: false,
        }
    }

    #[test]
    fn gaussian_matches_native_sequence_across_batch_boundaries() {
        let draws = gaussian_draws(35, 42).unwrap();
        let mut native = PseudoRandom::make_sequence_generator(7, 42).unwrap();
        for chunk in draws.chunks_exact(7) {
            assert_eq!(chunk, native.next_sequence().value);
        }
        assert_eq!(draws, gaussian_draws(35, 42).unwrap());
        assert_ne!(draws, gaussian_draws(35, 43).unwrap());
        assert!(gaussian_draws(0, 42).unwrap().is_empty());
        assert!(gaussian_draws(1, 0).is_err());
        assert!(gaussian_draws(Size::MAX, 42).is_err());
    }

    #[test]
    fn correlated_paths_match_native_rng_and_analytic_two_asset_factor() {
        let r = request();
        let paths = gbm_paths(&r).unwrap();
        let mut native = PseudoRandom::make_sequence_generator(8, 42).unwrap();
        for path in paths.chunks_exact(10) {
            assert_eq!(&path[..2], r.initial);
            let z = &native.next_sequence().value;
            let mut expected = [100.0, 80.0];
            for step in 0..4 {
                let correlated = [
                    z[2 * step],
                    0.4 * z[2 * step] + (1.0_f64 - 0.16).sqrt() * z[2 * step + 1],
                ];
                for i in 0..2 {
                    let sigma = r.volatility[i];
                    expected[i] *= ((r.drift[i] - 0.5 * sigma * sigma) * 0.25
                        + sigma * 0.5 * correlated[i])
                        .exp();
                    assert_eq!(path[(step + 1) * 2 + i], expected[i]);
                }
            }
        }
        let terminal = gbm_paths(&GbmRequest {
            terminal_only: true,
            ..r
        })
        .unwrap();
        for (i, chunk) in terminal.chunks_exact(2).enumerate() {
            assert_eq!(chunk, &paths[i * 10 + 8..i * 10 + 10]);
        }
    }

    #[test]
    fn zero_horizon_and_volatility_are_exact() {
        let r = GbmRequest {
            horizon: 0.0,
            ..request()
        };
        for pair in gbm_paths(&r).unwrap().chunks_exact(2) {
            assert_eq!(pair, r.initial);
        }
        let r = GbmRequest {
            volatility: &[0.0, 0.0],
            ..request()
        };
        let result = gbm_paths(&r).unwrap();
        for path in result.chunks_exact(10) {
            for time in 0..=4 {
                for asset in 0..2 {
                    assert_eq!(
                        path[2 * time + asset],
                        r.initial[asset] * (r.drift[asset] * time as Real / 4.0).exp()
                    );
                }
            }
        }
        let changed_seed = gbm_paths(&GbmRequest { seed: 91, ..r }).unwrap();
        assert_eq!(result, changed_seed);
    }

    #[test]
    fn scalar_terminal_log_returns_have_theoretical_moments() {
        let r = GbmRequest {
            initial: &[100.0],
            drift: &[0.07],
            volatility: &[0.2],
            correlation: &[1.0],
            horizon: 2.0,
            steps: 4,
            paths: 50_000,
            seed: 1234,
            terminal_only: true,
        };
        let values = gbm_paths(&r).unwrap();
        let n = values.len() as Real;
        let mean = values.iter().map(|s| (s / 100.0).ln()).sum::<Real>() / n;
        let variance = values
            .iter()
            .map(|s| ((s / 100.0).ln() - mean).powi(2))
            .sum::<Real>()
            / n;
        // Six standard errors for the mean and variance of normal log returns.
        assert!((mean - 0.1).abs() < 6.0 * (0.08 / n).sqrt());
        assert!((variance - 0.08).abs() < 6.0 * 0.08 * (2.0 / n).sqrt());
    }

    #[test]
    fn correlated_log_returns_reproduce_requested_correlation() {
        let r = GbmRequest {
            paths: 50_000,
            steps: 1,
            terminal_only: true,
            ..request()
        };
        let values = gbm_paths(&r).unwrap();
        let n = r.paths as Real;
        let mut sum = [0.0; 2];
        let mut square = [0.0; 2];
        let mut cross = 0.0;
        for pair in values.chunks_exact(2) {
            let x = (pair[0] / 100.0).ln();
            let y = (pair[1] / 80.0).ln();
            sum[0] += x;
            sum[1] += y;
            square[0] += x * x;
            square[1] += y * y;
            cross += x * y;
        }
        let covariance = cross / n - sum[0] * sum[1] / (n * n);
        let variance = [
            square[0] / n - (sum[0] / n).powi(2),
            square[1] / n - (sum[1] / n).powi(2),
        ];
        let correlation = covariance / (variance[0] * variance[1]).sqrt();
        assert!((correlation - 0.4).abs() < 6.0 * (1.0 - 0.16) / n.sqrt());
    }

    #[test]
    fn rejects_invalid_parameters_and_dimensions() {
        let cases = [
            GbmRequest {
                steps: 0,
                ..request()
            },
            GbmRequest {
                paths: 0,
                ..request()
            },
            GbmRequest {
                seed: 0,
                ..request()
            },
            GbmRequest {
                horizon: -1.0,
                ..request()
            },
            GbmRequest {
                horizon: Real::NAN,
                ..request()
            },
            GbmRequest {
                initial: &[],
                ..request()
            },
            GbmRequest {
                initial: &[0.0, 1.0],
                ..request()
            },
            GbmRequest {
                initial: &[Real::INFINITY, 1.0],
                ..request()
            },
            GbmRequest {
                drift: &[0.0],
                ..request()
            },
            GbmRequest {
                drift: &[Real::NAN, 0.0],
                ..request()
            },
            GbmRequest {
                volatility: &[-0.1, 0.2],
                ..request()
            },
            GbmRequest {
                volatility: &[Real::INFINITY, 0.2],
                ..request()
            },
            GbmRequest {
                correlation: &[1.0],
                ..request()
            },
            GbmRequest {
                correlation: &[1.0, 0.1, 0.2, 1.0],
                ..request()
            },
            GbmRequest {
                correlation: &[1.0, Real::NAN, Real::NAN, 1.0],
                ..request()
            },
            GbmRequest {
                correlation: &[0.9, 0.0, 0.0, 1.0],
                ..request()
            },
            GbmRequest {
                correlation: &[1.0, 1.0, 1.0, 1.0],
                ..request()
            },
            GbmRequest {
                correlation: &[1.0, -1.0, -1.0, 1.0],
                ..request()
            },
            GbmRequest {
                correlation: &[1.0, 1.1, 1.1, 1.0],
                ..request()
            },
            GbmRequest {
                paths: Size::MAX,
                ..request()
            },
            GbmRequest {
                steps: Size::MAX,
                ..request()
            },
            GbmRequest {
                volatility: &[0.0, 0.0],
                drift: &[1e308, 0.0],
                ..request()
            },
        ];
        for r in cases {
            assert!(gbm_paths(&r).is_err());
        }
        // All entries are valid correlations, but this matrix is indefinite.
        assert!(correlation_factor(&[1.0, 0.9, 0.9, 0.9, 1.0, -0.9, 0.9, -0.9, 1.0], 3).is_err());
    }
}