Struct TvmPeriod

pub struct TvmPeriod { /* private fields */ }

The value of an investment at the end of a given period, part of a Time Value of Money calculation.

This is either:

• Part of TvmSolution produced by calling rate_solution, periods_solution, present_value_solution, or future_value_solution.
• Part of [TvmSchedule] produced by calling present_value_schedule or future_value_schedule.

Implementations

impl TvmPeriod

pub fn period(&self) -> u32

Returns the period number. The first real period is 1 but there’s also a period 0 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 value(&self) -> f64

Returns the value of the investment at the end 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 symbolic_formula.

pub fn symbolic_formula(&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 TvmPeriod

fn clone(&self) -> TvmPeriod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TvmPeriod

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

Formats the value using the given formatter.