quantsupport 0.1.0

Rust library for fixed-income, 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

use crate::{ad::adreal::IsReal, time::date::Date, utils::errors::Result};

/// A [`Cashflow`] represents a single payment that occurs at a specific date. It has an amount and a payment date.
pub trait Cashflow<T>
where
    T: IsReal,
{
    /// Returns the amount of the cashflow.
    ///
    /// # Errors
    /// Returns an error if the amount cannot be calculated.
    fn amount(&self) -> Result<T>;

    /// Returns the payment date of the cashflow.
    fn payment_date(&self) -> Date;
}

/// A [`SimpleCashflow`] is the most basic representation of a payable cashflow.
#[derive(Clone)]
pub struct SimpleCashflow<T>
where
    T: IsReal,
{
    amount: T,
    payment_date: Date,
}

impl<T> SimpleCashflow<T>
where
    T: IsReal,
{
    /// Creates a new [`SimpleCashflow`] with the given amount and payment date.
    pub const fn new(amount: T, payment_date: Date) -> Self {
        Self {
            amount,
            payment_date,
        }
    }
}

impl<T> Cashflow<T> for SimpleCashflow<T>
where
    T: IsReal,
{
    fn amount(&self) -> Result<T> {
        Ok(self.amount)
    }

    fn payment_date(&self) -> Date {
        self.payment_date
    }
}