tmval.Payments.irr

tmval.value.Payments.irr(self, x0: float = 1.05) → list

Calculates the internal rate of return, also known as the yield rate or dollar-weighted return. If the payment amounts and times result in a polynomial equation of value, the yield is solved by calculating the roots of the polynomial via the NumPy roots function. If the equation of value is not a polynomial, than Newton’s method from the SciPy package is used.

Parameters

x0 (float) – A starting guess when using Newton’s method, defaults to 1.05.

Returns

A list of real roots, if found.

Return type

list