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

use crate::calibration::calibrationpricer::CalibrationInstrumentPricer;
use crate::quotes::calibrationinstrument::CalibrationInstrument;
use crate::quotes::quote::CalibrationInstrumentType;
use crate::utils::errors::{QSError, Result};

/// A calibration process computes residuals (model − market) for a set of
/// calibration instruments.  The default implementation dispatches by
/// instrument type.
pub trait CalibrationProcess: CalibrationInstrumentPricer {
    /// Computes the residual (model − market) for each calibration instrument.
    ///
    /// # Errors
    /// Returns an error if pricing any instrument fails.
    fn residual(&self, instruments: &[CalibrationInstrument]) -> Result<Vec<f64>> {
        let mut residuals = Vec::new();
        for inst in instruments {
            let res = match inst.built() {
                CalibrationInstrumentType::Swap(_)
                | CalibrationInstrumentType::BasisSwap(_)
                | CalibrationInstrumentType::FixFloatCrossCurrencySwap(_)
                | CalibrationInstrumentType::FloatFloatCrossCurrencySwap(_) => self.price(inst)?,
                CalibrationInstrumentType::FixedRateDeposit(_) => {
                    let implied = self.price(inst)?;
                    implied - inst.quote_value()
                }
                CalibrationInstrumentType::RateFutures(rf) => {
                    let implied = self.price(inst)?;
                    implied - rf.implied_rate()
                }
                // an fx forward should have two legs, one per currency.
                CalibrationInstrumentType::FxForward(fxf) => {
                    // Handle both outright forward prices and forward points.
                    let market_fwd = if let Some(price) = fxf.forward_price() {
                        price
                    } else if let Some(points) = fxf.forward_points() {
                        points
                    } else {
                        return Err(QSError::ValueNotSetErr(
                            "FX forward: neither price nor points set".into(),
                        ));
                    };
                    let implied = self.price(inst)?;
                    implied - market_fwd
                }
                // Vol products: quote_value() is a market vol — the default
                // impl cannot convert it to a price.  Implementors must
                // override residual() for vol-quoted instruments.
                CalibrationInstrumentType::CapletFloorlet(_)
                | CalibrationInstrumentType::CapFloor(_)
                | CalibrationInstrumentType::EuropeanSwaption(_) => {
                    return Err(QSError::InvalidValueErr(
                        "Vol-quoted instruments require an overridden residual() implementation"
                            .into(),
                    ))
                }
                _ => {
                    return Err(QSError::InvalidValueErr(
                        "Unsupported instrument type for calibration residual".into(),
                    ))
                }
            };
            residuals.push(res);
        }
        Ok(residuals)
    }
}