finquant 0.0.58

Experimental Rust Quant Library
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
//! Interest-rate cap and floor pricing under a normal (Bachelier) model.
//!
//! A cap is a strip of caplets; a floor is a strip of floorlets. Both are
//! handled by the same `CapFloor` struct via the [`CapFloorKind`] enum. The
//! constituent caplets / floorlets can be forward-looking (Libor-style,
//! fixing at `T_s`) or backward-looking compounded-RFR (fixing at `T_e`) —
//! set the [`CapStyle`] accordingly. Total-variance formulas differ for the
//! two styles; see `basic::caplet_total_variance` and the compounded-RFR
//! volcube note §3.2.
//!
//! Pricing:
//! ```text
//!     PV = direction · Σ_k τ_k · N · DF(T_pay^k) · Bachelier(F_k, K, V_k)
//!     F_k = ( DF(T_s^k) / DF(T_e^k) − 1 ) / τ_k
//!     V_k = σ² · (T_s^k − t)                                      (forward-looking)
//!         = σ² · [ (T_s^k − t) + (T_e^k − T_s^k) / 3 ]            (backward-compounded, t ≤ T_s)
//! ```

use crate::derivatives::basic::BasicInfo;
use crate::derivatives::forex::basic::CurrencyValue;
use crate::derivatives::interestrate::basic::{
    CapFloorKind, CapStyle, IRDerivatives, RateShiftMode, caplet_total_variance,
};
use crate::derivatives::interestrate::swap::InterestRateSchedulePeriod;
use crate::error::Error;
use crate::error::Result;
use crate::markets::interestrate::market_context::IrMarketContext;
use crate::markets::interestrate::volsurface::IRNormalVolSurface;
use crate::markets::termstructures::yieldcurve::{InterpolationMethodEnum, YieldTermStructure};
use crate::models::common::bachelier::{bachelier_call, bachelier_put, bachelier_vega_variance};
use crate::time::daycounters::DayCounters;
use crate::time::daycounters::actual365fixed::Actual365Fixed;
use iso_currency::Currency;
use serde::{Deserialize, Serialize};

/// Cap / floor deal. Notional and strike are fixed; the schedule is a strip
/// of caplets/floorlets (typically from the rate index's standard accrual
/// grid, e.g. quarterly for 3M Libor or SOFR-compounded).
#[derive(Deserialize, Serialize, Debug)]
pub struct CapFloor {
    pub basic_info: BasicInfo,
    pub kind: CapFloorKind,
    pub style: CapStyle,
    pub currency: Currency,
    pub notional: f64,
    pub strike: f64,
    pub valuation_date: chrono::NaiveDate,
    pub schedule: Vec<InterestRateSchedulePeriod>,
    pub accrual_day_counter: Box<dyn DayCounters>,
}

impl CapFloor {
    fn direction_sign(&self) -> f64 {
        self.basic_info.direction as i8 as f64
    }

    /// Per-caplet market inputs under an optional parallel zero-rate shift of
    /// `rate_shift_bp` basis points and an optional parallel normal-vol shift
    /// of `vol_shift_bp` basis points. Both shifts are set to zero for the
    /// base PV; non-zero for DV01 / gamma / vega.
    fn caplet_market(
        &self,
        period: &InterestRateSchedulePeriod,
        yts: &YieldTermStructure,
        vs: &IRNormalVolSurface,
        rate_shift_bp: f64,
        vol_shift_bp: f64,
    ) -> Result<CapletMarket> {
        let method = &InterpolationMethodEnum::StepFunctionForward;
        let tau = self
            .accrual_day_counter
            .year_fraction(period.accrual_start_date, period.accrual_end_date)?;
        let df_start = yts.shifted_discount(period.accrual_start_date, method, rate_shift_bp)?;
        let df_end = yts.shifted_discount(period.accrual_end_date, method, rate_shift_bp)?;
        let df_pay = yts.shifted_discount(period.pay_date, method, rate_shift_bp)?;
        let forward = (df_start / df_end - 1.0) / tau;

        let vol_time = Actual365Fixed::default();
        let yf_start = vol_time.year_fraction(self.valuation_date, period.accrual_start_date)?;
        let yf_end = vol_time.year_fraction(self.valuation_date, period.accrual_end_date)?;
        let sigma_base = vs.caplet_volatility(period.accrual_start_date, self.strike)?;
        let sigma = sigma_base + vol_shift_bp * 1.0e-4;
        let variance = caplet_total_variance(self.style, sigma, yf_start, yf_end);

        Ok(CapletMarket {
            tau,
            df_pay,
            forward,
            variance,
        })
    }

    /// Present value under an optional (rate, vol) parallel shift. The
    /// building block for mtm, DV01, gamma-1bp and vega-1bp.
    fn pv_under_shift(
        &self,
        yts: &YieldTermStructure,
        vs: &IRNormalVolSurface,
        rate_shift_bp: f64,
        vol_shift_bp: f64,
    ) -> Result<f64> {
        let mut pv = 0.0_f64;
        for period in &self.schedule {
            let m = self.caplet_market(period, yts, vs, rate_shift_bp, vol_shift_bp)?;
            let opt = match self.kind {
                CapFloorKind::Cap => bachelier_call(m.forward, self.strike, m.variance),
                CapFloorKind::Floor => bachelier_put(m.forward, self.strike, m.variance),
            };
            pv += self.direction_sign() * self.notional * m.tau * m.df_pay * opt;
        }
        Ok(pv)
    }
}

struct CapletMarket {
    tau: f64,
    df_pay: f64,
    forward: f64,
    variance: f64,
}

/// Unpack the IR context into (curve, vol surface), erroring cleanly
/// if vol surface is missing (which is required for any cap pricing).
fn unpack(market: &IrMarketContext) -> Result<(&YieldTermStructure, &IRNormalVolSurface)> {
    let vs = market.cap_surface.as_ref().ok_or_else(|| {
        Error::InvalidData("CapFloor: IrMarketContext.cap_surface must be present".to_string())
    })?;
    Ok((&market.curve, vs))
}

impl IRDerivatives for CapFloor {
    fn mtm(&self, market: &IrMarketContext) -> Result<CurrencyValue> {
        let (yts, vs) = unpack(market)?;
        let pv = self.pv_under_shift(yts, vs, 0.0, 0.0)?;
        Ok(CurrencyValue {
            currency: self.currency,
            value: pv,
        })
    }

    /// DV01 = PV(y + 1bp) − PV(y). Parallel zero-rate shift across all
    /// pillars, vol held fixed (sticky-vol). Long-cap DV01 is positive:
    /// higher rates lift the call payoff even though the discount term pulls
    /// the other way.
    fn dv01(&self, market: &IrMarketContext) -> Result<f64> {
        let (yts, vs) = unpack(market)?;
        let base = self.pv_under_shift(yts, vs, 0.0, 0.0)?;
        let up = self.pv_under_shift(yts, vs, 1.0, 0.0)?;
        Ok(up - base)
    }

    /// Central second difference with bump `δ = rate_shift_bp` basis points:
    /// `PV(y + δ) + PV(y − δ) − 2·PV(y)`. Scales with δ² for small δ.
    fn gamma(
        &self,
        market: &IrMarketContext,
        rate_shift_bp: f64,
        mode: RateShiftMode,
    ) -> Result<f64> {
        ensure_supported_mode(mode)?;
        let (yts, vs) = unpack(market)?;
        let base = self.pv_under_shift(yts, vs, 0.0, 0.0)?;
        let up = self.pv_under_shift(yts, vs, rate_shift_bp, 0.0)?;
        let down = self.pv_under_shift(yts, vs, -rate_shift_bp, 0.0)?;
        Ok(up + down - 2.0 * base)
    }

    /// Vega: `PV(σ + δ) − PV(σ)` with `δ = vol_shift_bp` basis points of
    /// normal vol. Curve held fixed.
    ///
    /// The closed-form alternative `Σ τ · DF · (∂C/∂V) · (2σ · T_var) · δ·1e−4`
    /// agrees to O(1e-8) for typical vols; the finite-difference form is kept
    /// for symmetry with DV01 and to stay honest about sticky-vol.
    fn vega(&self, market: &IrMarketContext, vol_shift_bp: f64) -> Result<f64> {
        let (yts, vs) = unpack(market)?;
        let base = self.pv_under_shift(yts, vs, 0.0, 0.0)?;
        let up = self.pv_under_shift(yts, vs, 0.0, vol_shift_bp)?;
        Ok(up - base)
    }
}

fn ensure_supported_mode(mode: RateShiftMode) -> Result<()> {
    match mode {
        RateShiftMode::Zeros => Ok(()),
        other => Err(Error::InvalidData(format!(
            "rate shift mode {:?} is not yet implemented; only Zeros is supported",
            other
        ))),
    }
}

// Keep the closed-form vega primitive referenceable from this module even
// though the trait implementation uses bump-and-reprice — some callers want
// the analytic vega for sanity checks.
#[allow(dead_code)]
fn analytic_vega_1bp(
    cap: &CapFloor,
    yts: &YieldTermStructure,
    vs: &IRNormalVolSurface,
) -> Result<f64> {
    let vol_time = Actual365Fixed::default();
    let mut vega = 0.0_f64;
    for period in &cap.schedule {
        let m = cap.caplet_market(period, yts, vs, 0.0, 0.0)?;
        if m.variance <= 0.0 {
            continue;
        }
        let yf_start = vol_time.year_fraction(cap.valuation_date, period.accrual_start_date)?;
        let yf_end = vol_time.year_fraction(cap.valuation_date, period.accrual_end_date)?;
        let sigma = vs.caplet_volatility(period.accrual_start_date, cap.strike)?;
        if sigma <= 0.0 {
            continue;
        }
        let t_var = match cap.style {
            CapStyle::ForwardLooking => yf_start.max(0.0),
            CapStyle::BackwardCompounded => {
                let te_minus_ts = yf_end - yf_start;
                if yf_start >= 0.0 {
                    yf_start + te_minus_ts / 3.0
                } else {
                    yf_end.powi(3) / (3.0 * te_minus_ts * te_minus_ts)
                }
            }
        };
        let dv_dsigma = 2.0 * sigma * t_var;
        let vega_per_v = bachelier_vega_variance(m.forward, cap.strike, m.variance);
        vega += cap.direction_sign()
            * cap.notional
            * m.tau
            * m.df_pay
            * vega_per_v
            * dv_dsigma
            * 1.0e-4;
    }
    Ok(vega)
}

// ---------------------------------------------------------------------------
// Tests: expected-screen reference — USD 5Y SOFR cap, ATM, $10MM notional
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::{CapFloor, CapFloorKind, CapStyle, IRDerivatives};
    use crate::derivatives::basic::{BasicInfo, Direction, Style};
    use crate::derivatives::interestrate::basic::{
        DEFAULT_RATE_SHIFT_BP, DEFAULT_VOL_SHIFT_BP, RateShiftMode,
    };
    use crate::derivatives::interestrate::swap::InterestRateSchedulePeriod;
    use crate::error::Result;
    use crate::markets::interestrate::market_context::IrMarketContext;
    use crate::markets::interestrate::volsurface::{
        CapQuote, CapletVolPillar, IRCapMarketData, IRNormalVolSurface,
    };
    use crate::markets::termstructures::yieldcurve::{
        InterestRateQuoteEnum, StrippedCurve, YieldTermStructure,
    };
    use crate::time::calendars::UnitedStates;
    use crate::time::daycounters::actual360::Actual360;
    use crate::time::daycounters::actual365fixed::Actual365Fixed;
    use chrono::NaiveDate;
    use iso_currency::Currency;

    /// Rebuild a fresh `YieldTermStructure` from an existing one's
    /// stripped curves — used inside closures where we need multiple
    /// `IrMarketContext` instances without `yts` being `Clone`.
    fn clone_yts(yts: &YieldTermStructure) -> YieldTermStructure {
        YieldTermStructure::new(
            Box::new(UnitedStates::default()),
            Box::new(Actual365Fixed::default()),
            yts.valuation_date,
            yts.stripped_curves.clone(),
        )
    }

    /// expected cap-pricing reference (curve date 04/22/2026, valuation 04/24/2026):
    ///   Index:       1D SOFRRATE (backward-looking daily-compounded)
    ///   Effective:   04/24/2026
    ///   Maturity:    04/24/2031 (5Y)
    ///   Notional:    $10,000,000
    ///   Strike:      3.543236 % (ATM)
    ///   Schedule:    Quarterly, ACT/360, Mod Foll, pay-delay 2BD
    ///   Model:       HW1F, Normal vol
    ///   Premium:     2.37665 (% of notional)
    ///   **NPV:       $237,665.49**
    ///   Vega(1bp):   $2,656.12
    ///
    /// The vol surface is stripped from the single market quote (one cap ⇒ one
    /// pillar ⇒ a flat σ across all 20 caplets), so after rebuild the surface
    /// trivially reprices the same quote. The value of that flat σ falls out
    /// of the Brent solve; we also verify it sits in the 70–120 bp range
    /// consistent with the USD SOFR swaption vol cube at 5Y.
    #[test]
    fn usd_sofr_5y_cap_matches_expected_reference() -> Result<()> {
        // Curve date = 04/22/2026. The deal effective is 04/24 (T+2); the
        // expected screen shows a valuation of 04/24, but the stripping and
        // discounting use the 04/22 curve. We run everything from the curve
        // date, matching the reference.
        let curve_date = NaiveDate::from_ymd_opt(2026, 4, 22).unwrap();
        let valuation_date = curve_date;

        let yts = build_expected_usd_sofr_curve(curve_date, valuation_date);
        let d = |y, m, dd| NaiveDate::from_ymd_opt(y, m, dd).unwrap();

        // --- Build the expected cap schedule ------------------------------------
        let notional = 10_000_000.0_f64;
        let strike = 0.03543236;
        let schedule = expected_sofr_5y_schedule();

        // Single ATM 5Y market quote. expected reference NPV = 237,665.49.
        let quote = CapQuote {
            strike,
            notional,
            direction: Direction::Buy,
            kind: CapFloorKind::Cap,
            style: CapStyle::BackwardCompounded,
            currency: Currency::USD,
            schedule: schedule.clone(),
            accrual_day_counter: Box::new(Actual360),
            market_npv: 237_665.49,
        };
        let md = IRCapMarketData::new(valuation_date, vec![quote]);

        // --- Strip the surface and reprice ------------------------------------
        let mut vs = IRNormalVolSurface::new(valuation_date);
        vs.rebuild(&yts, &md)?;

        // One cap ⇒ one pillar with one (strike, σ) node.
        assert_eq!(vs.pillars.len(), 1);
        assert_eq!(vs.pillars[0].nodes.len(), 1);
        let (node_strike, sigma) = vs.pillars[0].nodes[0];
        assert!((node_strike - strike).abs() < 1e-12);
        // σ comes out in the 50–200 bp band for USD SOFR 5Y ATM.
        assert!(
            (0.005..0.020).contains(&sigma),
            "stripped σ {} (= {:.1} bp) outside plausible SOFR 5Y band",
            sigma,
            sigma * 10_000.0
        );

        let cap = CapFloor {
            basic_info: BasicInfo {
                trade_date: valuation_date,
                style: Style::IRSwap, // no dedicated Cap Style variant yet
                direction: Direction::Buy,
                expiry_date: d(2031, 4, 24),
                delivery_date: d(2031, 4, 28),
            },
            kind: CapFloorKind::Cap,
            style: CapStyle::BackwardCompounded,
            currency: Currency::USD,
            notional,
            strike,
            valuation_date,
            schedule,
            accrual_day_counter: Box::new(Actual360),
        };

        let ctx = IrMarketContext::new(valuation_date, Currency::USD, yts, Some(vs));
        let mtm = cap.mtm(&ctx)?;
        // After stripping, the repriced NPV must match the quote to solver tolerance.
        assert!(
            (mtm.value - 237_665.49).abs() < 1.0,
            "repriced NPV {} vs expected reference 237,665.49",
            mtm.value
        );
        assert_eq!(mtm.currency, Currency::USD);

        // Vega(1bp) ≈ $2,656 on the expected screen. Check within ~10% — the curve
        // is a coarsely-digitised version of the expected's so there's some
        // tolerance. Pass DEFAULT_VOL_SHIFT_BP (= 1bp) to match the reference.
        let vega = cap.vega(&ctx, DEFAULT_VOL_SHIFT_BP)?;
        let ref_vega = 2_656.12_f64;
        let err_pct = (vega - ref_vega).abs() / ref_vega;
        assert!(
            err_pct < 0.10,
            "Vega(1bp) {} vs expected reference {} — {:.2}% off",
            vega,
            ref_vega,
            err_pct * 100.0
        );

        // A long cap's PV rises with rates: DV01 > 0. Long optionality means
        // gamma > 0 (at any bump size). Modified duration is then negative.
        let dv01 = cap.dv01(&ctx)?;
        let gamma_10bp = cap.gamma(&ctx, DEFAULT_RATE_SHIFT_BP, RateShiftMode::default())?;
        let gamma_1bp = cap.gamma(&ctx, 1.0, RateShiftMode::default())?;
        let mod_dur = cap.modified_duration(&ctx)?;
        assert!(dv01 > 0.0, "long cap DV01 should be positive, got {}", dv01);
        assert!(
            gamma_10bp > 0.0,
            "long cap gamma(10bp) should be positive, got {}",
            gamma_10bp
        );
        // Central-difference gamma scales ≈ δ² for small δ. Confirm the 10bp
        // reading is roughly 100× the 1bp reading (loose ±30% band — small
        // gammas are noisy).
        let ratio = gamma_10bp / gamma_1bp.max(1e-12);
        assert!(
            (70.0..130.0).contains(&ratio),
            "gamma(10bp)/gamma(1bp) = {:.1}, expected ≈ 100",
            ratio
        );
        assert!(vega > 0.0);
        assert!(
            mod_dur < 0.0,
            "long cap modified duration should be negative (PV rises with rates), got {}",
            mod_dur
        );
        Ok(())
    }

    /// Unsupported shift modes must return an error rather than silently
    /// falling back to `Zeros`.
    #[test]
    fn unsupported_rate_shift_mode_errors() -> Result<()> {
        let curve_date = NaiveDate::from_ymd_opt(2026, 4, 22).unwrap();
        let valuation_date = curve_date;
        let yts = build_expected_usd_sofr_curve(curve_date, valuation_date);
        let d = |y, m, dd| NaiveDate::from_ymd_opt(y, m, dd).unwrap();

        let notional = 10_000_000.0_f64;
        let strike = 0.03543236;
        let schedule = expected_sofr_5y_schedule();
        let quote = CapQuote {
            strike,
            notional,
            direction: Direction::Buy,
            kind: CapFloorKind::Cap,
            style: CapStyle::BackwardCompounded,
            currency: Currency::USD,
            schedule: schedule.clone(),
            accrual_day_counter: Box::new(Actual360),
            market_npv: 237_665.49,
        };
        let md = IRCapMarketData::new(valuation_date, vec![quote]);
        let mut vs = IRNormalVolSurface::new(valuation_date);
        vs.rebuild(&yts, &md)?;
        let cap = CapFloor {
            basic_info: BasicInfo {
                trade_date: valuation_date,
                style: Style::IRSwap,
                direction: Direction::Buy,
                expiry_date: d(2031, 4, 24),
                delivery_date: d(2031, 4, 28),
            },
            kind: CapFloorKind::Cap,
            style: CapStyle::BackwardCompounded,
            currency: Currency::USD,
            notional,
            strike,
            valuation_date,
            schedule,
            accrual_day_counter: Box::new(Actual360),
        };

        let ctx = IrMarketContext::new(valuation_date, Currency::USD, yts, Some(vs));
        for unsupported in [
            RateShiftMode::Instruments,
            RateShiftMode::Forwards,
            RateShiftMode::Swaps,
        ] {
            let err = cap.gamma(&ctx, DEFAULT_RATE_SHIFT_BP, unsupported);
            assert!(
                err.is_err(),
                "expected error for unsupported mode {:?}",
                unsupported
            );
        }
        Ok(())
    }

    /// Strike-smile round-trip: feed three caps at ATM±50bp with known σ's,
    /// and verify the stripper recovers those σ's to solver tolerance and
    /// that in-strike linear interpolation is consistent.
    ///
    /// Not a expected-anchored test — the three NPVs are produced in-test by
    /// pricing each cap at its own (strike, σ) via a single-node surface.
    /// Purpose is to exercise the column-per-strike bootstrap and the bilinear
    /// query path.
    #[test]
    fn smile_strike_bootstrap_roundtrip() -> Result<()> {
        let curve_date = NaiveDate::from_ymd_opt(2026, 4, 22).unwrap();
        let valuation_date = curve_date;
        let yts = build_expected_usd_sofr_curve(curve_date, valuation_date);
        let d = |y, m, dd| NaiveDate::from_ymd_opt(y, m, dd).unwrap();

        let notional = 10_000_000.0_f64;
        let atm = 0.03543236;
        // (strike, σ_normal). Mild inverted smile: lower vol at low strike,
        // rising at higher strike — consistent with a SOFR 5Y curve that's
        // slightly upward-sloped and recent put-skew compression.
        let inputs: [(f64, f64); 3] = [
            (atm - 0.0050, 0.0078),
            (atm, 0.0085),
            (atm + 0.0050, 0.0092),
        ];
        let schedule = expected_sofr_5y_schedule();
        let last_accrual_start = schedule.last().unwrap().accrual_start_date;

        // For each (K, σ), price a cap under a one-node surface at that (K, σ)
        // so the resulting NPV is consistent with σ at every caplet.
        let quotes: Vec<CapQuote> = inputs
            .iter()
            .map(|(k, sigma)| {
                let cap = CapFloor {
                    basic_info: BasicInfo {
                        trade_date: valuation_date,
                        style: Style::IRSwap,
                        direction: Direction::Buy,
                        expiry_date: d(2031, 4, 24),
                        delivery_date: d(2031, 4, 28),
                    },
                    kind: CapFloorKind::Cap,
                    style: CapStyle::BackwardCompounded,
                    currency: Currency::USD,
                    notional,
                    strike: *k,
                    valuation_date,
                    schedule: schedule.clone(),
                    accrual_day_counter: Box::new(Actual360),
                };
                let mut vs = IRNormalVolSurface::new(valuation_date);
                vs.pillars = vec![CapletVolPillar {
                    expiry: last_accrual_start,
                    nodes: vec![(*k, *sigma)],
                }];
                // Build an ad-hoc per-iteration context (yts rebuilt
                // from stripped curves to stay Clone-free).
                let ctx =
                    IrMarketContext::new(valuation_date, Currency::USD, clone_yts(&yts), Some(vs));
                let npv = cap.mtm(&ctx).unwrap().value;
                CapQuote {
                    strike: *k,
                    notional,
                    direction: Direction::Buy,
                    kind: CapFloorKind::Cap,
                    style: CapStyle::BackwardCompounded,
                    currency: Currency::USD,
                    schedule: schedule.clone(),
                    accrual_day_counter: Box::new(Actual360),
                    market_npv: npv,
                }
            })
            .collect();

        // --- Strip from all three quotes ---
        let md = IRCapMarketData::new(valuation_date, quotes);
        let mut vs = IRNormalVolSurface::new(valuation_date);
        vs.rebuild(&yts, &md)?;

        assert_eq!(vs.pillars.len(), 1, "all three quotes share one expiry");
        let pillar = &vs.pillars[0];
        assert_eq!(pillar.expiry, last_accrual_start);
        assert_eq!(pillar.nodes.len(), 3, "three strikes ⇒ three nodes");

        // Nodes are sorted by strike ascending; `inputs` is already ascending.
        for (i, (expected_k, expected_sigma)) in inputs.iter().enumerate() {
            let (k, sigma) = pillar.nodes[i];
            assert!((k - expected_k).abs() < 1.0e-12);
            assert!(
                (sigma - expected_sigma).abs() < 1.0e-6,
                "round-trip σ at K={}: got {}, expected {}",
                k,
                sigma,
                expected_sigma
            );
        }

        // Linear-in-strike interpolation midway between ATM and ATM+50bp.
        let mid_strike = atm + 0.0025;
        let expected_mid = 0.5 * (inputs[1].1 + inputs[2].1);
        let sigma_mid = vs.caplet_volatility(last_accrual_start, mid_strike)?;
        assert!(
            (sigma_mid - expected_mid).abs() < 1.0e-6,
            "mid-strike σ: got {}, expected {}",
            sigma_mid,
            expected_mid
        );

        // Flat extrapolation well beyond the wings.
        let sigma_far_put = vs.caplet_volatility(last_accrual_start, 0.010)?;
        assert!((sigma_far_put - inputs[0].1).abs() < 1.0e-6);
        let sigma_far_call = vs.caplet_volatility(last_accrual_start, 0.080)?;
        assert!((sigma_far_call - inputs[2].1).abs() < 1.0e-6);

        Ok(())
    }

    /// Helper: a StrippedCurve pillar from (first_settle, date, market, zero, discount).
    fn pillar(
        first_settle: NaiveDate,
        date: NaiveDate,
        market_rate: f64,
        zero_rate: f64,
        discount: f64,
    ) -> StrippedCurve {
        StrippedCurve {
            first_settle_date: first_settle,
            date,
            market_rate,
            zero_rate,
            discount,
            source: InterestRateQuoteEnum::Swap,
            hidden_pillar: false,
        }
    }

    /// USD SOFR stripped curve (expected OIS-curve screen, mid). Minimal pillar
    /// set: one non-hidden pillar at each caplet pay date plus a terminal one
    /// beyond 2031-04-28 so `step_forward_zero_rate` never degenerates. Values
    /// read off the expected curve screen at each tenor.
    fn build_expected_usd_sofr_curve(
        curve_date: NaiveDate,
        valuation_date: NaiveDate,
    ) -> YieldTermStructure {
        let d = |y, m, dd| NaiveDate::from_ymd_opt(y, m, dd).unwrap();
        let stripped_curves = vec![
            pillar(curve_date, d(2026, 7, 28), 0.0366740, 0.0370115, 0.990614),
            pillar(curve_date, d(2026, 10, 28), 0.0367845, 0.0369477, 0.981249),
            pillar(curve_date, d(2027, 1, 27), 0.0368130, 0.0366428, 0.963633),
            pillar(curve_date, d(2027, 4, 28), 0.0363006, 0.0362530, 0.946743),
            pillar(curve_date, d(2027, 7, 27), 0.0359295, 0.0357673, 0.930690),
            pillar(curve_date, d(2027, 10, 27), 0.0357000, 0.0355700, 0.915000),
            pillar(curve_date, d(2028, 1, 26), 0.0355274, 0.0353648, 0.899078),
            pillar(curve_date, d(2028, 4, 26), 0.0355985, 0.0354437, 0.883300),
            pillar(curve_date, d(2028, 7, 26), 0.0356600, 0.0354800, 0.867564),
            pillar(curve_date, d(2028, 10, 26), 0.0357300, 0.0355400, 0.851900),
            pillar(curve_date, d(2029, 1, 26), 0.0358000, 0.0356000, 0.836300),
            pillar(curve_date, d(2029, 4, 26), 0.0358700, 0.0356600, 0.820800),
            pillar(curve_date, d(2029, 7, 26), 0.0359125, 0.0357764, 0.835959),
            pillar(curve_date, d(2029, 10, 26), 0.0360000, 0.0358200, 0.790000),
            pillar(curve_date, d(2030, 1, 28), 0.0360800, 0.0359000, 0.774500),
            pillar(curve_date, d(2030, 4, 26), 0.0361500, 0.0359700, 0.759500),
            pillar(curve_date, d(2030, 7, 26), 0.0362200, 0.0360400, 0.744600),
            pillar(curve_date, d(2030, 10, 28), 0.0362900, 0.0361100, 0.729500),
            pillar(curve_date, d(2031, 1, 27), 0.0363600, 0.0361800, 0.714500),
            pillar(curve_date, d(2031, 4, 28), 0.0363860, 0.0362811, 0.803898),
            pillar(curve_date, d(2032, 4, 28), 0.0369019, 0.0368388, 0.772305),
        ];
        YieldTermStructure::new(
            Box::new(UnitedStates::default()),
            Box::new(Actual365Fixed::default()),
            valuation_date,
            stripped_curves,
        )
    }

    /// Hand-coded accrual schedule lifted from the expected cap-details tab —
    /// quarterly, pay-delay 2BD, effective 04/24/2026, maturity 04/24/2031.
    fn expected_sofr_5y_schedule() -> Vec<InterestRateSchedulePeriod> {
        let notional = 10_000_000.0_f64;
        let d = |y, m, dd| NaiveDate::from_ymd_opt(y, m, dd).unwrap();
        let rows: &[(NaiveDate, NaiveDate, NaiveDate)] = &[
            (d(2026, 4, 24), d(2026, 7, 24), d(2026, 7, 28)),
            (d(2026, 7, 24), d(2026, 10, 26), d(2026, 10, 28)),
            (d(2026, 10, 26), d(2027, 1, 25), d(2027, 1, 27)),
            (d(2027, 1, 25), d(2027, 4, 26), d(2027, 4, 28)),
            (d(2027, 4, 26), d(2027, 7, 26), d(2027, 7, 28)),
            (d(2027, 7, 26), d(2027, 10, 25), d(2027, 10, 27)),
            (d(2027, 10, 25), d(2028, 1, 24), d(2028, 1, 26)),
            (d(2028, 1, 24), d(2028, 4, 24), d(2028, 4, 26)),
            (d(2028, 4, 24), d(2028, 7, 24), d(2028, 7, 26)),
            (d(2028, 7, 24), d(2028, 10, 24), d(2028, 10, 26)),
            (d(2028, 10, 24), d(2029, 1, 24), d(2029, 1, 26)),
            (d(2029, 1, 24), d(2029, 4, 24), d(2029, 4, 26)),
            (d(2029, 4, 24), d(2029, 7, 24), d(2029, 7, 26)),
            (d(2029, 7, 24), d(2029, 10, 24), d(2029, 10, 26)),
            (d(2029, 10, 24), d(2030, 1, 24), d(2030, 1, 28)),
            (d(2030, 1, 24), d(2030, 4, 24), d(2030, 4, 26)),
            (d(2030, 4, 24), d(2030, 7, 24), d(2030, 7, 26)),
            (d(2030, 7, 24), d(2030, 10, 24), d(2030, 10, 28)),
            (d(2030, 10, 24), d(2031, 1, 24), d(2031, 1, 27)),
            (d(2031, 1, 24), d(2031, 4, 24), d(2031, 4, 28)),
        ];
        rows.iter()
            .map(|(start, end, pay)| InterestRateSchedulePeriod {
                accrual_start_date: *start,
                accrual_end_date: *end,
                pay_date: *pay,
                reset_date: *start,
                amortisation_amounts: 0.0,
                balance: notional,
            })
            .collect()
    }
}