Struct com_croftsoft_core::math::finance_lib::PresentValue

source · [−]

pub struct PresentValue {
    pub cash_flow: f64,
    pub discount_rate: f64,
    pub time_periods: f64,
}

Expand description

The discounted value of a single cash flow received in the future

Example

use com_croftsoft_core::math::finance_lib::PresentValue;
assert_eq!(
  PresentValue {
    cash_flow:     1.0,  // A dollar in the future
    discount_rate: 0.10, // With inflation at 10% per year
    time_periods:  1.0,  // Received one year from now
  }.calculate(),
  0.9090909090909091);   // Will have the spending power of ~$0.91 today
assert_eq!(
  PresentValue {
    cash_flow:     1.0,  // A dollar in the future
    discount_rate: 0.10, // If it could be invested today at 10% per year
    time_periods:  2.0,  // Received two years from now
  }.calculate(),
  0.8264462809917354);   // Would be worth the same as ~$0.83 invested today

Fields

cash_flow: f64discount_rate: f64

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

time_periods: f64

Number of time periods from today when the cash flow is received

Implementations

impl PresentValue

pub fn calculate(&self) -> f64

Trait Implementations

impl Clone for PresentValue

fn clone(&self) -> PresentValue

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Debug for PresentValue

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

Formats the value using the given formatter. Read more

impl Copy for PresentValue

Auto Trait Implementations

impl RefUnwindSafe for PresentValue

impl Send for PresentValue

impl Sync for PresentValue

impl Unpin for PresentValue

impl UnwindSafe for PresentValue

Blanket Implementations

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

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 Twhere
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 Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.