tmval.standardize_rate

tmval.rate.standardize_rate(gr: Union[float, tmval.rate.Rate])tmval.rate.Rate[source]

Given a float or Rate object, standardizes it to be simple or compound effective interest with an interval of one year. If a float is given, returns a Rate object representing a compound effective interest rate with an interval of one year.

If a Rate is given that represents a simple interest or discount rate, returns a simple interest Rate object with an interval of one year.

If a Rate is given that represents a compound rate (effective interest, nominal interest, effective discount, nominal discount, force of interest), returns a compound effective interest Rate object with an interval of one year.

Parameters

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

Returns

A standardized interest rate.

Return type

Rate