Struct com_croftsoft_core::math::finance_lib::PresentValuePaymentStream

pub struct PresentValuePaymentStream {
    pub cash_flow: f64,
    pub inflation_rate: f64,
    pub time_periods: f64,
}

Calculates the present value of a payment stream such as an annuity

Example

use com_croftsoft_core::math::finance_lib::PresentValuePaymentStream;
assert_eq!(
  PresentValuePaymentStream {
    cash_flow :     1.0,  // A dollar every year starting a year from today
    inflation_rate: 0.10, // With inflation at 10% per year
    time_periods:   10.0, // For ten years
  }.calculate(),
  6.144567105704685);     // Is the same as receiving ~$6.14 today

Fields

cash_flow: f64

inflation_rate: f64

The inflation rate or interest rate per time period (use 0.01 for 1%)

time_periods: f64

Number of time periods of cash income

Implementations

impl PresentValuePaymentStream

pub fn calculate(&self) -> f64

Trait Implementations

impl Clone for PresentValuePaymentStream

fn clone(&self) -> PresentValuePaymentStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PresentValuePaymentStream

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Copy for PresentValuePaymentStream