Struct NpvPeriod

pub struct NpvPeriod { /* private fields */ }

Implementations

impl NpvPeriod

pub fn new( period: u32, rate: f64, present_value: f64, future_value: f64, investment_value: f64, formula: String, formula_symbolic: String, ) -> Self

pub fn period(&self) -> u32

Returns the period number. The first real period is 1 but there’s also a period 0 which which shows the starting conditions.

pub fn rate(&self) -> f64

Returns the periodic rate for the current period. If the containing struct is a TvmSolution every period will have the same rate. If it’s a [TvmSchedule] each period may have a different rate.

pub fn present_value(&self) -> f64

Returns the present value of the cashflow.

pub fn future_value(&self) -> f64

Returns the future value of the cashflow.

pub fn investment_value(&self) -> f64

Returns the investment value of the Npv scenario at the time of the current period.

pub fn formula(&self) -> &str

Returns a text version of the formula used to calculate the value for the current period. The formula includes the actual values rather than variable names. For the formula with variables such as pv for present value call formula_symbolic.

pub fn formula_symbolic(&self) -> &str

Returns a text version of the formula used to calculate the value for the current period. The formula includes variables such as r for the rate. For the formula with actual values rather than variables call formula.

Trait Implementations

impl Clone for NpvPeriod

fn clone(&self) -> NpvPeriod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NpvPeriod

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

Formats the value using the given formatter.