com_croftsoft_core::math::finance_lib

Struct PresentValuePaymentStream

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

Expand description

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 duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for PresentValuePaymentStream

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

Formats the value using the given formatter. Read more

impl Copy for PresentValuePaymentStream

Auto Trait Implementations§

impl Freeze for PresentValuePaymentStream

impl RefUnwindSafe for PresentValuePaymentStream

impl Send for PresentValuePaymentStream

impl Sync for PresentValuePaymentStream

impl Unpin for PresentValuePaymentStream

impl UnwindSafe for PresentValuePaymentStream

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.