Struct com_croftsoft_core::math::finance_lib::FutureValuePaymentStream

pub struct FutureValuePaymentStream {
    pub cash_income: f64,
    pub interest_rate: f64,
    pub time_periods: f64,
}

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

Example

use com_croftsoft_core::math::finance_lib::FutureValuePaymentStream;
assert_eq!(
  FutureValuePaymentStream {
    cash_income:   10_000.0, // Future payments of $10k per year
    interest_rate: 0.10,     // With 10% interest annually on the payments
    time_periods:  10.0,     // Paying each year for ten years
  }.calculate(),
  159_374.246_010_000_2);    // Will be worth ~$159k in the future

Fields

cash_income: f64

Periodic cash income payment starting one period from today

interest_rate: f64

Periodic interest earned on income (use 0.01 for 1%)

time_periods: f64

Number of periods of cash income

Implementations

impl FutureValuePaymentStream

pub fn calculate(&self) -> f64

Trait Implementations

impl Clone for FutureValuePaymentStream

fn clone(&self) -> FutureValuePaymentStream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FutureValuePaymentStream

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

Formats the value using the given formatter.

impl Copy for FutureValuePaymentStream