FutureValue

Struct FutureValue 

Source
pub struct FutureValue { /* private fields */ }
Expand description

§Compute the future value

§Parameters

  • rate : an interest rate compounded once per period
  • nper : number of compounding periods
  • pmt : payment in each period
  • pv : present value
  • when : when payments are due WhenType. Defaults to When::End

§Return:

  • fv: the value at the end of the nper periods, which is used in other modules as parameter

§Example

use rfinancial::*;
let fv = FutureValue::from_tuple((0.075, 20, -2000.0, 0.0, WhenType::End));
println!("{:#?}'s fv is {:?}", fv, fv.get());

Implementations§

Source§

impl FutureValue

Source

pub fn from_tuple(tup: (f64, u32, f64, f64, WhenType)) -> Self

Instantiate a FutureValue instance from a tuple of (rate, nper, pmt, pv and when) in said order

Source

pub fn from_map(map: ParaMap) -> Result<Self>

Instantiate a FutureValue instance from a hash map with keys of (rate, nper, pmt, pv and when) in said order Since [HashMap] requires values of same type, we need to wrap into a variant of enum

Source

pub fn get(&self) -> Result<f64>

Get the future value from an instance of FutureValue

Trait Implementations§

Source§

impl Debug for FutureValue

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

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.

Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.