com_croftsoft_core::math::finance_lib

Struct FutureValuePaymentStream

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

Expand description

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 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 FutureValuePaymentStream

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

Formats the value using the given formatter. Read more

impl Copy for FutureValuePaymentStream

Auto Trait Implementations§

impl Freeze for FutureValuePaymentStream

impl RefUnwindSafe for FutureValuePaymentStream

impl Send for FutureValuePaymentStream

impl Sync for FutureValuePaymentStream

impl Unpin for FutureValuePaymentStream

impl UnwindSafe for FutureValuePaymentStream

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.