financial

Crates.iofinancial
lib.rsfinancial
version1.1.5
sourcesrc
created_at2020-07-11 16:34:16.322295
updated_at2023-02-17 23:29:11.133764
descriptionA collection of finance calculations mimicking some of Excel Financial Functions interface
homepagehttps://github.com/raymon1/financial
repositoryhttps://github.com/raymon1/financial
max_upload_size
id264067
size198,867
Raymon Mina (raymon1)

documentation

https://docs.rs/financial/

README

Financial

GitHub CircleCI crates.io docs.rs

Financial is a Rust crate that contains collection of finance calculations mimicking some of Excel Financial Functions interface. you can find the crate here

Usage

use financial;

let npv = financial::npv(0.1, &[-1000., 500., 500., 500.]);
assert_eq!(npv, 221.29635953828267);

What makes this crate different

It supports both periodic and scheduled computation for IRR and NPV.

IRR and NPV functions are faster since powers are pre-computed iteratively instead of using power function multiple times. Take this with a grain of salt since no benches tests are offered at the moment.

Supported Functions

  • FV(Rate, Nper, Pmt, Pv, Pmt_is_due)
  • PV(Rate, Nper, Pmt, Fv, Pmt_is_due)
  • NPV(Rate, values)
  • XNPV(Rate, values, dates)
  • IRR(values)
  • XIRR(values, dates)
  • MIRR(values, finance_rate, reinvest_rate)

NaiveDate Interface

  • financial::naive_date::xirr() and financial::naive_date::xnpv() provide same functionalities as financial::xirr() and financial::xnpv(), except that the former supports NaiveDate as the input date type while the latter uses DateTime<T>.

Future Work

  • Add bench tests
  • Add More Functions (NPER, PMT, Rate, effect)

Testing

  • This crate has over 180 test case, most of them are compared to Excel outputs.
  • XIRR is not compared against Excel, since Excel XIRR doesn't always converge to the correct answer and often produce the wrong answer of 0.000000002980. Instead XIRR are tested by using the XIRR to produce a zero XNPV value.
  • Note that the precision used for equality of floating points is 1e-7

Contribution

  • Using the crate and providing feedback or pointing out any issues.
  • Adding more test cases is encouraged.
  • Any contribution that serves the crate is welcome.

Buy Me A Coffee

Commit count: 41

cargo fmt