stochastic-rs-quant 2.0.0

Quantitative finance: pricing, calibration, vol surfaces, instruments.
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

use chrono::NaiveDate;

use crate::calendar::DayCountConvention;
use crate::cashflows::CurveProvider;
use crate::curves::Compounding;
use crate::traits::FloatExt;

/// Zero-coupon bond priced directly from the discount curve.
#[derive(Debug, Clone)]
pub struct ZeroCouponBond<T: FloatExt> {
  /// Face amount paid at maturity.
  pub face_value: T,
  /// Maturity date.
  pub maturity_date: NaiveDate,
}

impl<T: FloatExt> ZeroCouponBond<T> {
  /// Create a zero-coupon bond.
  pub fn new(face_value: T, maturity_date: NaiveDate) -> Self {
    Self {
      face_value,
      maturity_date,
    }
  }

  /// Present value from the curve stack.
  pub fn price_from_curve(
    &self,
    valuation_date: NaiveDate,
    discount_day_count: DayCountConvention,
    curves: &(impl CurveProvider<T> + ?Sized),
  ) -> T {
    if self.maturity_date < valuation_date {
      return T::zero();
    }
    let tau = discount_day_count.year_fraction(valuation_date, self.maturity_date);
    self.face_value * curves.discount_curve().discount_factor(tau)
  }

  /// Present value from a quoted yield.
  pub fn price_from_yield(
    &self,
    settlement_date: NaiveDate,
    yield_to_maturity: T,
    yield_day_count: DayCountConvention,
    compounding: Compounding,
  ) -> T {
    if self.maturity_date < settlement_date {
      return T::zero();
    }
    let tau = yield_day_count.year_fraction(settlement_date, self.maturity_date);
    self.face_value * compounding.discount_factor(yield_to_maturity, tau)
  }

  /// Yield-to-maturity implied by a price.
  pub fn yield_to_maturity(
    &self,
    settlement_date: NaiveDate,
    price: T,
    yield_day_count: DayCountConvention,
    compounding: Compounding,
  ) -> T {
    if price <= T::zero() || self.maturity_date <= settlement_date {
      return T::zero();
    }
    let tau = yield_day_count.year_fraction(settlement_date, self.maturity_date);
    let discount_factor = price / self.face_value;
    compounding.zero_rate(discount_factor, tau)
  }
}