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

use chrono::NaiveDate;
use serde::{Deserialize, Serialize};

use crate::error::Result;
use crate::markets::interestrate::interestrateindex::InterestRateIndex;
use crate::markets::termstructures::yieldcurve::{InterestRateQuote, InterestRateQuoteEnum};
use crate::time::daycounters::DayCounters;
use crate::time::daycounters::actual365fixed::Actual365Fixed;
use crate::time::period::Period;

#[derive(Deserialize, Serialize, Debug)]
pub struct OISRate {
    pub value: f64,
    pub interest_rate_index: InterestRateIndex,
}

impl OISRate {
    pub fn discount(&self, valuation_date: NaiveDate) -> Result<f64> {
        let zero_rate = self.zero_rate(valuation_date)?;
        let maturity_date = self.maturity_date(valuation_date)?;
        let year_fraction =
            Actual365Fixed::default().year_fraction(valuation_date, maturity_date)?;
        Ok((-zero_rate * year_fraction).exp())
    }

    pub fn zero_rate(&self, valuation_date: NaiveDate) -> Result<f64> {
        let settle_date = self.settle_date(valuation_date)?;
        let maturity_date = self.maturity_date(valuation_date)?;
        let year_fraction_index = self
            .interest_rate_index
            .day_counter
            .year_fraction(settle_date, maturity_date)?;
        let year_fraction = Actual365Fixed::default().year_fraction(settle_date, maturity_date)?;
        let discount = 1.0 / (1.0 + year_fraction_index * self.value);

        Ok(-discount.ln() / year_fraction)
    }
}

impl InterestRateQuote for OISRate {
    fn yts_type(&self) -> InterestRateQuoteEnum {
        InterestRateQuoteEnum::OIS
    }
    fn settle_date(&self, valuation_date: NaiveDate) -> Result<NaiveDate> {
        self.interest_rate_index
            .calendar
            .advance(
                valuation_date,
                Period::Days(self.interest_rate_index.settlement_days),
                self.interest_rate_index.convention,
                Some(self.interest_rate_index.end_of_month),
            )
            .map(Option::unwrap) // TODO (DS): what should we do with None dates?
    }
    fn maturity_date(&self, valuation_date: NaiveDate) -> Result<NaiveDate> {
        self.interest_rate_index
            .calendar
            .advance(
                self.settle_date(valuation_date)?,
                self.interest_rate_index.period,
                self.interest_rate_index.convention,
                Some(self.interest_rate_index.end_of_month),
            )
            .map(Option::unwrap) // TODO (DS): what should we do with None dates?
    }
}

#[cfg(test)]
mod tests {
    use super::OISRate;
    use crate::error::Result;
    use crate::markets::interestrate::interestrateindex::{
        InterestRateIndex, InterestRateIndexEnum,
    };
    use crate::markets::termstructures::yieldcurve::InterestRateQuote;
    use crate::time::period::Period;
    use chrono::NaiveDate;

    #[test]
    fn test_settle_maturity_date() -> Result<()> {
        let ois_quote = OISRate {
            value: 0.03938,
            interest_rate_index: InterestRateIndex::from_enum(InterestRateIndexEnum::EUIBOR(
                Period::Months(3),
            ))
            .unwrap(),
        };
        let valuation_date = NaiveDate::from_ymd_opt(2023, 10, 27).unwrap();
        let settle_date = ois_quote.settle_date(valuation_date)?;
        let maturity_date = ois_quote.maturity_date(valuation_date)?;
        assert_eq!(settle_date, NaiveDate::from_ymd_opt(2023, 10, 31).unwrap());
        assert_eq!(maturity_date, NaiveDate::from_ymd_opt(2024, 1, 31).unwrap());

        Ok(())
    }

    #[test]
    fn test_discount() -> Result<()> {
        let ois_quote = OISRate {
            value: 0.03948,
            interest_rate_index: InterestRateIndex::from_enum(InterestRateIndexEnum::EUIBOR(
                Period::Months(3),
            ))
            .unwrap(),
        };
        let valuation_date = NaiveDate::from_ymd_opt(2023, 10, 27).unwrap();
        assert_eq!(
            format!("{:.6}", ois_quote.discount(valuation_date)?),
            "0.989579"
        );
        assert_eq!(
            format!("{:.7}", ois_quote.zero_rate(valuation_date)?),
            "0.0398278"
        );

        Ok(())
    }
}