quantlib_rs 0.1.0

A ground-up, idiomatic Rust quantitative finance library inspired by QuantLib.
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
//! Fixed rate bond instrument with cash flows and analytical risk metrics.

use crate::cashflows::coupon::FixedRateCoupon;
use crate::cashflows::leg::Leg;
use crate::cashflows::simple::SimpleCashFlow;
use crate::math::solvers::{NewtonRaphson, SolverError};
use crate::termstructures::yield_term_structure::YieldTermStructure;
use crate::time::calendar::{BusinessDayConvention, Calendar};
use crate::time::date::{Date, Period};
use crate::time::day_counter::DayCounter;
use crate::time::schedule::Schedule;
use std::sync::Arc;
use thiserror::Error;

/// Bond pricing and analysis errors.
#[derive(Debug, Clone, PartialEq, Error)]
pub enum BondError {
    /// Yield to maturity calculation failed to converge.
    #[error("Yield to maturity calculation failed to converge: {0}")]
    YtmConvergence(#[from] SolverError),
    /// Settlement date occurs on or after bond maturity.
    #[error("Bond has already matured at {maturity} on settlement {settlement}")]
    AlreadyMatured {
        /// Maturity date
        maturity: Date,
        /// Settlement date
        settlement: Date,
    },
}

/// Duration convention type.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum DurationType {
    /// Macaulay duration (weighted average time to cash flows in years).
    Macaulay,
    /// Modified duration (percentage price sensitivity to yield changes).
    #[default]
    Modified,
}

/// Fixed rate bond with periodic coupon payments and bullet redemption.
///
/// Supports full clean/dirty price conversion, accrued interest, Yield to Maturity (YTM),
/// Macaulay/Modified duration, convexity, and DV01 analytics.
///
/// # Examples
/// ```
/// use std::sync::Arc;
/// use quantlib_rs::instruments::bonds::fixed_rate_bond::{FixedRateBond, DurationType};
/// use quantlib_rs::termstructures::yield_term_structure::FlatForward;
/// use quantlib_rs::time::calendar::BusinessDayConvention;
/// use quantlib_rs::time::calendars::united_states::{UnitedStates, USMarket};
/// use quantlib_rs::time::date::{Date, Month, Period};
/// use quantlib_rs::time::day_counters::thirty_360::{Thirty360, Thirty360Convention};
/// use quantlib_rs::time::schedule::{DateGenerationRule, Schedule};
///
/// let cal = Arc::new(UnitedStates::new(USMarket::GovernmentBond));
/// let dc = Arc::new(Thirty360::new(Thirty360Convention::BondBasis));
/// let issue = Date::from_ymd(2024, Month::January, 15).unwrap();
/// let maturity = Date::from_ymd(2034, Month::January, 15).unwrap();
///
/// let schedule = Schedule::new(
///     issue,
///     maturity,
///     Period::Months(6),
///     cal.as_ref(),
///     BusinessDayConvention::Following,
///     BusinessDayConvention::Following,
///     DateGenerationRule::Backward,
///     false,
/// ).unwrap();
///
/// let bond = FixedRateBond::new(1, 100.0, schedule, 0.05, dc, cal, issue, 100.0);
/// let today = Date::from_ymd(2024, Month::January, 15).unwrap();
/// let curve = FlatForward::new(0.05, today);
///
/// let clean = bond.clean_price(&curve, today).unwrap();
/// assert!((clean - 100.0).abs() < 1.0);
/// ```
#[derive(Clone)]
pub struct FixedRateBond {
    settlement_days: u32,
    face_amount: f64,
    schedule: Schedule,
    coupon_rate: f64,
    day_counter: Arc<dyn DayCounter>,
    calendar: Arc<dyn Calendar>,
    issue_date: Date,
    redemption: f64,
    leg: Leg,
}

impl FixedRateBond {
    /// Create a new fixed rate bond.
    #[allow(clippy::too_many_arguments)]
    pub fn new(
        settlement_days: u32,
        face_amount: f64,
        schedule: Schedule,
        coupon_rate: f64,
        day_counter: Arc<dyn DayCounter>,
        calendar: Arc<dyn Calendar>,
        issue_date: Date,
        redemption: f64,
    ) -> Self {
        let mut leg = Leg::new();
        let dates = schedule.dates();

        // Build fixed rate coupons
        for i in 1..dates.len() {
            let start = dates[i - 1];
            let end = dates[i];
            let coupon = FixedRateCoupon::new(
                face_amount,
                coupon_rate,
                end,
                start,
                end,
                day_counter.clone(),
            );
            leg.push(Arc::new(coupon));
        }

        // Add principal redemption cash flow at maturity
        if let Some(&maturity) = dates.last() {
            leg.push(Arc::new(SimpleCashFlow::new(redemption, maturity)));
        }

        Self {
            settlement_days,
            face_amount,
            schedule,
            coupon_rate,
            day_counter,
            calendar,
            issue_date,
            redemption,
            leg,
        }
    }

    /// Return the settlement date corresponding to evaluation date `as_of`.
    pub fn settlement_date(&self, as_of: Date) -> Date {
        if self.settlement_days == 0 {
            as_of
        } else {
            self.calendar
                .advance(
                    as_of,
                    Period::Days(self.settlement_days as i64),
                    BusinessDayConvention::Following,
                    false,
                )
                .unwrap_or(as_of + self.settlement_days as i64)
        }
    }

    /// Return the maturity date of the bond.
    pub fn maturity_date(&self) -> Date {
        *self
            .schedule
            .dates()
            .last()
            .expect("Bond schedule has dates")
    }

    /// Return the cash flow stream of the bond.
    pub fn leg(&self) -> &Leg {
        &self.leg
    }

    /// Return the face amount (par value) of the bond.
    pub fn face_amount(&self) -> f64 {
        self.face_amount
    }

    /// Return the issue date of the bond.
    pub fn issue_date(&self) -> Date {
        self.issue_date
    }

    /// Return the coupon rate.
    pub fn coupon_rate(&self) -> f64 {
        self.coupon_rate
    }

    /// Calculate the accrued interest amount for settlement on `settlement_date`.
    pub fn accrued_amount(&self, settlement_date: Date) -> f64 {
        let dates = self.schedule.dates();
        if settlement_date <= dates[0] || settlement_date >= *dates.last().unwrap() {
            return 0.0;
        }

        // Find the coupon period [dates[i-1], dates[i]] containing settlement_date
        for i in 1..dates.len() {
            let start = dates[i - 1];
            let end = dates[i];
            if settlement_date >= start && settlement_date <= end {
                if settlement_date == start || settlement_date == end {
                    return 0.0;
                }
                let tau = self.day_counter.year_fraction(start, settlement_date);
                return self.face_amount * self.coupon_rate * tau;
            }
        }
        0.0
    }

    /// Calculate the full (dirty) price of the bond using a discount curve.
    pub fn dirty_price(
        &self,
        curve: &dyn YieldTermStructure,
        as_of: Date,
    ) -> Result<f64, BondError> {
        let settle = self.settlement_date(as_of);
        if settle >= self.maturity_date() {
            return Err(BondError::AlreadyMatured {
                maturity: self.maturity_date(),
                settlement: settle,
            });
        }
        let mut npv = 0.0;
        for cf in self.leg.cash_flows() {
            if cf.date() > settle {
                let tau = self.day_counter.year_fraction(settle, cf.date());
                let df = curve.discount(tau);
                npv += cf.amount() * df;
            }
        }
        Ok(npv)
    }

    /// Calculate the clean price of the bond using a discount curve.
    pub fn clean_price(
        &self,
        curve: &dyn YieldTermStructure,
        as_of: Date,
    ) -> Result<f64, BondError> {
        let dirty = self.dirty_price(curve, as_of)?;
        let settle = self.settlement_date(as_of);
        let accrued = self.accrued_amount(settle);
        Ok(dirty - accrued)
    }

    /// Calculate the dirty price of the bond directly from Yield to Maturity (YTM).
    ///
    /// Evaluates the textbook formula:
    /// $$\text{Dirty Price} = \sum_{d_i > d_{\text{settle}}} \frac{C_i}{(1 + y/m)^{m \tau_i}} + \frac{\text{Redemption}}{(1 + y/m)^{m \tau_N}}$$
    pub fn dirty_price_from_yield(
        &self,
        ytm: f64,
        as_of: Date,
        frequency: u32,
    ) -> Result<f64, BondError> {
        let settle = self.settlement_date(as_of);
        if settle >= self.maturity_date() {
            return Err(BondError::AlreadyMatured {
                maturity: self.maturity_date(),
                settlement: settle,
            });
        }
        let m = frequency as f64;
        let mut dirty = 0.0;
        for cf in self.leg.cash_flows() {
            if cf.date() > settle {
                let tau = self.day_counter.year_fraction(settle, cf.date());
                dirty += cf.amount() / (1.0 + ytm / m).powf(m * tau);
            }
        }
        Ok(dirty)
    }

    /// Calculate the clean price of the bond directly from Yield to Maturity (YTM).
    pub fn clean_price_from_yield(
        &self,
        ytm: f64,
        as_of: Date,
        frequency: u32,
    ) -> Result<f64, BondError> {
        let dirty = self.dirty_price_from_yield(ytm, as_of, frequency)?;
        let settle = self.settlement_date(as_of);
        let accrued = self.accrued_amount(settle);
        Ok(dirty - accrued)
    }

    /// Solve for the Yield to Maturity (IRR) given a target clean price.
    ///
    /// Solves:
    /// $$\text{Dirty Price} = \sum_{d_i > d_{\text{settle}}} \frac{C_i}{(1 + y/m)^{m \tau_i}} + \frac{\text{Redemption}}{(1 + y/m)^{m \tau_N}}$$
    pub fn yield_to_maturity(
        &self,
        clean_price: f64,
        as_of: Date,
        frequency: u32,
        tolerance: f64,
        max_iter: usize,
    ) -> Result<f64, BondError> {
        let settle = self.settlement_date(as_of);
        let target_dirty = clean_price + self.accrued_amount(settle);
        let m = frequency as f64;

        // Cash flows strictly after settlement
        let mut future_cfs = Vec::new();
        for cf in self.leg.cash_flows() {
            if cf.date() > settle {
                let tau = self.day_counter.year_fraction(settle, cf.date());
                future_cfs.push((cf.amount(), tau));
            }
        }

        let pv_fn = |y: f64| -> f64 {
            let mut sum = 0.0;
            for &(amount, tau) in &future_cfs {
                sum += amount / (1.0 + y / m).powf(m * tau);
            }
            sum - target_dirty
        };

        let dpv_fn = |y: f64| -> f64 {
            let mut sum = 0.0;
            for &(amount, tau) in &future_cfs {
                sum += -tau * amount / (1.0 + y / m).powf(m * tau + 1.0);
            }
            sum
        };

        let initial_guess = (self.coupon_rate
            + (self.redemption - clean_price) / future_cfs.last().unwrap().1)
            / (0.5 * (self.redemption + clean_price));

        let ytm = NewtonRaphson::solve(
            pv_fn,
            dpv_fn,
            -0.20,
            1.0,
            initial_guess.clamp(-0.10, 0.50),
            tolerance,
            max_iter,
        )?;

        Ok(ytm)
    }

    /// Calculate Macaulay or Modified duration of the bond.
    pub fn duration(
        &self,
        ytm: f64,
        as_of: Date,
        frequency: u32,
        duration_type: DurationType,
    ) -> Result<f64, BondError> {
        let settle = self.settlement_date(as_of);
        let m = frequency as f64;

        let mut pv_sum = 0.0;
        let mut weighted_time_sum = 0.0;

        for cf in self.leg.cash_flows() {
            if cf.date() > settle {
                let tau = self.day_counter.year_fraction(settle, cf.date());
                let df = (1.0 + ytm / m).powf(-m * tau);
                let pv = cf.amount() * df;
                pv_sum += pv;
                weighted_time_sum += tau * pv;
            }
        }

        let macaulay = weighted_time_sum / pv_sum;
        match duration_type {
            DurationType::Macaulay => Ok(macaulay),
            DurationType::Modified => Ok(macaulay / (1.0 + ytm / m)),
        }
    }

    /// Calculate the convexity of the bond.
    ///
    /// $$\text{Convexity} = \frac{1}{\text{Dirty Price} \cdot (1 + y/m)^2} \sum \tau_i \left(\tau_i + \frac{1}{m}\right) \text{PV}_i$$
    pub fn convexity(&self, ytm: f64, as_of: Date, frequency: u32) -> Result<f64, BondError> {
        let settle = self.settlement_date(as_of);
        let m = frequency as f64;

        let mut pv_sum = 0.0;
        let mut weighted_convexity_sum = 0.0;

        for cf in self.leg.cash_flows() {
            if cf.date() > settle {
                let tau = self.day_counter.year_fraction(settle, cf.date());
                let df = (1.0 + ytm / m).powf(-m * tau);
                let pv = cf.amount() * df;
                pv_sum += pv;
                weighted_convexity_sum += tau * (tau + 1.0 / m) * pv;
            }
        }

        let factor = (1.0 + ytm / m).powi(2);
        Ok(weighted_convexity_sum / (pv_sum * factor))
    }

    /// Calculate Dollar Value of a Basis Point (DV01 / PV01).
    pub fn dv01(&self, ytm: f64, as_of: Date, frequency: u32) -> Result<f64, BondError> {
        let mod_dur = self.duration(ytm, as_of, frequency, DurationType::Modified)?;
        let settle = self.settlement_date(as_of);
        let dirty = {
            let m = frequency as f64;
            let mut sum = 0.0;
            for cf in self.leg.cash_flows() {
                if cf.date() > settle {
                    let tau = self.day_counter.year_fraction(settle, cf.date());
                    sum += cf.amount() * (1.0 + ytm / m).powf(-m * tau);
                }
            }
            sum
        };
        Ok(dirty * mod_dur * 0.0001)
    }
}