Skip to content

Commit

Permalink
Merge pull request #23 from designium/patch-1
Browse files Browse the repository at this point in the history
Updated README.md to include the list of functions
  • Loading branch information
wowinter13 authored Oct 26, 2021
2 parents 07d20bd + 8585e00 commit 90e3c3f
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,20 @@ Run `bundle install`.
## Running tests
bundle exec rspec spec/
## Available Functions
** Simple financial functions **
- fv(rate, nper, pmt, pv[, when]) Compute the future value.
- pv(rate, nper, pmt[, fv, when]) Compute the present value.
- npv(rate, values) Returns the NPV (Net Present Value) of a cash flow series.
- pmt(rate, nper, pv[, fv, when]) Compute the payment against loan principal plus interest.
- ppmt(rate, per, nper, pv[, fv, when]) Compute the payment against loan principal.
- ipmt(rate, per, nper, pv[, fv, when]) Compute the interest portion of a payment.
- irr(values) Return the Internal Rate of Return (IRR).
- mirr(values, finance_rate, reinvest_rate) Modified internal rate of return.
- nper(rate, pmt, pv[, fv, when]) Compute the number of periodic payments.
- nrate(nper, pmt, pv, fv[, when, guess, tol, …]) Compute the rate of interest per period.
## Contributing
Expand All @@ -98,4 +112,4 @@ Run `bundle install`.
## License
MIT License. See LICENSE for details.
MIT License. See LICENSE for details.

0 comments on commit 90e3c3f

Please sign in to comment.