Payments

class tmval.value.Payments(amounts: Union[list, Iterable, Callable], times: Union[list, Iterable, Callable], gr: Union[float, tmval.rate.Rate, tmval.growth.Accumulation, tmval.growth.TieredBal, tmval.growth.TieredTime] = None)[source]

A collection of payments, and corresponding growth object. If no growth object (an interest rate, Rate object, Accumulation object) is provided, the payments are assumed to be undiscounted. The payments class serves as the backbone for major types of financial instruments, such as annuities and bonds. It provides methods for calculating net present value, internal rate of return (dollar weighted yield), equated time, equated value, and time-weighted yield.

Parameters
  • amounts (list, Iterable, Callable) – a list of payment amounts.

  • times (list, Iterable, Callable) – a list of payment times.

  • gr (float, Rate, or Accumulation) – a growth rate object, can be supplied as a float, a Rate object, or an Accumulation object.