tmval.Annuity.get_r_pmt

Annuity.get_r_pmt(gr: Union[tmval.growth.Accumulation, Callable, float, tmval.rate.Rate]) → float[source]

When inferring the number of payment periods, returns the number of payment periods as if fractional periods were allowed. This fractional value helps calculate the drop or balloon payments, if needed.

Parameters

gr (Accumulation, Callable, float, or Rate) – A growth rate object.

Returns

The number of payment periods.

Return type

float