Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added better guess for IRR #61

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions numpy_financial/_financial.py
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,25 @@ def rate(nper, pmt, pv, fv, when='end', guess=None, tol=None, maxiter=100):
rn[~close] = np.nan
return rn

def irr_guess(values, axis=-1):
"""
Return a guess for an Internal Rate of Return (IRR).

A continuously compounded IRR r is defined as a solution to the equation:
log(sum_{k=0}^{n-1} values[k]^+ exp(-r k)) - log(sum_{k=0}^{n-1} values[k]^- exp(-r k)) = 0
Newton's method can be used to find and r to solve this equation.

This function implements the first step of Newton's method, starting from r_0 = 0.
"""
negative_part = -np.minimum(values, 0.)
positive_part = np.maximum(values, 0.)
negative_npv = np.sum(negative_part, axis=axis)
positive_npv = np.sum(positive_part, axis=axis)
times = np.arange(values.shape[axis])
negative_duration = np.sum(negative_part * times, axis=axis)/negative_npv
positive_duration = np.sum(positive_part * times, axis=axis)/positive_npv
delta_t = positive_duration - negative_duration
return (positive_npv/negative_npv)**(1/delta_t) - 1

def irr(values, guess=None, tol=1e-12, maxiter=100):
"""
Expand Down Expand Up @@ -757,10 +776,7 @@ def irr(values, guess=None, tol=1e-12, maxiter=100):

# If no value is passed for `guess`, then make a heuristic estimate
if guess is None:
positive_cashflow = values > 0
inflow = values.sum(where=positive_cashflow)
outflow = -values.sum(where=~positive_cashflow)
guess = inflow / outflow - 1
guess = irr_guess(values)

# We aim to solve eirr such that NPV is exactly zero. This can be framed as
# simply finding the closest root of a polynomial to a given initial guess
Expand Down