NumPy

Previous topic

numpy.irr

Next topic

numpy.nper

This is documentation for an old release of NumPy (version 1.18). Read this page in the documentation of the latest stable release (version 2.2).

numpy.mirr

numpy.mirr(values, finance_rate, reinvest_rate)[source]

Modified internal rate of return.

Deprecated since version 1.18: mirr is deprecated; for details, see NEP 32 [1]. Use the corresponding function in the numpy-financial library, https://pypi.org/project/numpy-financial.

Parameters
valuesarray_like

Cash flows (must contain at least one positive and one negative value) or nan is returned. The first value is considered a sunk cost at time zero.

finance_ratescalar

Interest rate paid on the cash flows

reinvest_ratescalar

Interest rate received on the cash flows upon reinvestment

Returns
outfloat

Modified internal rate of return

References

1

NumPy Enhancement Proposal (NEP) 32, https://numpy.org/neps/nep-0032-remove-financial-functions.html