Code Monkey home page Code Monkey logo

croovy_finance's Introduction

CroovyFinance

Brought to you by the good folks at Croovy.

This gem provides a handful of functions useful for working with home loans. Specifically provided are functions for calculating Internal Rate of Return (irr) and Net Present Value (npv). Both are implemented as described in Wikipedia, and using the secant method, also as described in Wikipedia.

Also provided is an function for calculating the Annual Percentage Rate (apr). It is basically sugar for the irr function, making it callable like the RATE function found in a Google Docs Spreadsheet or Microsoft Excel.

How CroovyFinance differs from Finance

The Finance gem uses Newton's method (while CroovyFinance uses the secant method), and as a result, CroovyFinance's results are more inline with Excel and Google Docs. In the author's experience, certain reasonable inputs, when used with the Finance gem, produced obviously incorrect results.

Installation

Add this line to your application's Gemfile:

gem 'croovy_finance'

And then execute:

$ bundle

Or install it yourself as:

$ gem install croovy_finance

Usage

irb(main):001:0> require "croovy/finance"
=> true
irb(main):002:0> CroovyFinance::Apr.new(360, 1_044.50, 238_650).calc
=> 0.0027456868896171853

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

croovy_finance's People

Watchers

 avatar  avatar

Forkers

mapdwell

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.