finance_rb 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fa908552e787182999bb782ed6c7f7f624307f0acd77ff969c0171e07dd0179
-  data.tar.gz: e0492ef3dd7baa271a4d7893ff32c5c94de852d2328d1c49321bb1d78147f08e
+  metadata.gz: 3a0dc37279e3b577acb13a90c61ad4f232573a4d8c0eccdf19a267d42001a9ea
+  data.tar.gz: ca6db2175dd770056d7539d555b239127bcc5836ae79826edc6807a4f5bd4311
 SHA512:
-  metadata.gz: ccc866a27aecf49b0f869f9ddf590ac58d7682bc35c30a5abfda526251b800960b143fa19b05063411e30061a96f950963c4f8c38d867da763b1654ec77bfb52
-  data.tar.gz: 5ca7d064faf5bb38ad5cd70ddb1595d8983833e4ad9b46290f17b9f5ca8eee2abd4e4c99eedf852bbf79790c28d54e4aa4743beeffbf72921ff0dccc95f1cc94
+  metadata.gz: 395383e7e7c9b2b564a738aae13bc6f95d7180652b951a2fa4cf90118e551cb0cba6e87badb4ca23c7b5ab790be2de0ff5bef0e3736c50c18a7246262b2ae496
+  data.tar.gz: 5c9a8d1e5b8726234fafa45ed747dcf881f7ae92a9157abf34e9186594775a4e651fc8c09395cdd9fd30e21426e217c4216f2b13644ee15f324a967325d4bf6a

data/CHANGELOG.md

@@ -1,4 +1,7 @@
-## [Unreleased]
+## [0.0.3] - 2021-03-23
+
+### Added
+* Implement Finance::Calculations#irr using Newton's method
 
 ## [0.0.2] - 2021-03-22
 

data/README.md

@@ -9,13 +9,13 @@ which are as follows:
 
 | numpy-financial function     | ruby native function ported?   | info|
 |:------------------------:    |:------------------:  | :------------------|
-| fv                           |    |   Computes the  future value|
-| ipmt                         |    |   Computes interest payment for a loan|
-| pmt                          |    |   Computes the fixed periodic payment(principal + interest) made against a loan amount|
-| ppmt                         |    |   Computes principal payment for a loan|
-| nper                         |    |    Computes the number of periodic payments|
-| pv                           |      |   Computes the present value of a payment|
-| rate                         |      |    Computes the rate of interest per period|
+| fv                           |       |   Computes the  future value|
+| ipmt                         |       |   Computes interest payment for a loan|
+| pmt                          |       |   Computes the fixed periodic payment(principal + interest) made against a loan amount|
+| ppmt                         |       |   Computes principal payment for a loan|
+| nper                         |       |    Computes the number of periodic payments|
+| pv                           |       |   Computes the present value of a payment|
+| rate                         |   ✅  |    Computes the rate of interest per period|
 | irr                          |       |    Computes the internal rate of return|
 | npv                          |  ✅   |   Computes the net present value of a series of cash flow|
 | mirr                         |       |    Computes the modified internal rate of return|

data/lib/finance/calculations.rb

@@ -1,9 +1,15 @@
 # frozen_string_literal: true
 
+require 'bigdecimal'
+require 'bigdecimal/newton'
+
+include Newton
+
 module Finance
   class Calculations
     class << self
       # Npv computes the Net Present Value of a cash flow series.
+      #
       # @return [Numeric] The NPV of the input cash flow series `values` at the discount `rate`.
       #
       # @param [Numeric] :rate A discount rate applied once per period.
@@ -24,7 +30,58 @@ module Finance
         npv_value
       end
 
+      # IRR computes the Rate of Interest per period.
+      #
+      # @return [Float] Internal Rate of Return for periodic input values.
+      #
+      # @param [Array<Numeric>] :values Input cash flows per time period.
+      #
+      # @example
+      #   require 'finance_rb'
+      #   Finance::Calculations.irr([-100, 0, 0, 74]) #=> 0.14299344106053188
+      #
+      # @see http://en.wikipedia.org/wiki/Internal_rate_of_return
+      # @see L. J. Gitman, "Principles of Managerial Finance, Brief," 3rd ed.,
+      #   Addison-Wesley, 2003, pg. 348.
+      def irr(values)
+        inflows, outflows = values.partition{ |i| i >= 0 }
+        if inflows.empty? || outflows.empty?
+          return 0.0
+        end
+
+        func = BigDecimal.limit(100)
+        func = Function.new(values)
+        rate = [ func.one ]
+        nlsolve(func, rate)
+        rate[0].to_f
+      end
+
       alias net_present_value npv
+      alias internal_return_rate irr
+
+      private
+
+      # Base class for working with Newton's Method.
+      # For more details, see Bigdecimal::Newton.
+      # @api private
+      class Function
+        def initialize(values)
+          @zero   = BigDecimal("0.0")
+          @one    = BigDecimal("1.0")
+          @two    = BigDecimal("2.0")
+          @ten    = BigDecimal("10.0")
+          @eps    = BigDecimal("1.0e-16")
+          @values = values
+        end
+        
+        def zero; @zero; end
+        def one ; @one;  end
+        def two ; @two;  end
+        def ten ; @ten;  end
+        def eps ; @eps;  end
+
+        def values(x); [Finance::Calculations.npv(x[0], @values)]; end
+      end
     end
   end
 end

data/lib/finance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Finance
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/finance/calculations_spec.rb

@@ -12,10 +12,30 @@ RSpec.describe Finance::Calculations do
       ).to eq(-85.07888805409468)
     end
 
-    it 'returns correct npv for zero rates' do
+    it 'calculates correct npv for zero rates' do
       expect(
         Finance::Calculations.net_present_value(0.0, [-2000, 55, 55, 55])
       ).to eq(-1835.0)
     end
   end
+
+  describe '#irr' do
+    it 'calculates correct irr value' do
+      expect(
+        Finance::Calculations.irr([-4000,1200,1410,1875,1050])
+      ).to eq(0.14299344106053188)
+    end
+
+    it 'calculates zero value for cashflows w/o any inflows' do
+      expect(
+        Finance::Calculations.irr([100,500,200,50])
+      ).to eq(0.0)
+    end
+
+    it 'is available through alias name' do
+      expect(
+        Finance::Calculations.internal_return_rate([-100, 0, 0, 74])
+      ).to eq(-0.09549583035161031)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: finance_rb
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Vlad Dyachenko
@@ -33,9 +33,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/wowinter13/finance_rb/issues
-  changelog_uri: https://github.com/wowinter13/finance_rb/blob/v0.0.2/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/wowinter13/finance_rb/0.0.2
-  source_code_uri: https://github.com/wowinter13/finance_rb/tree/v0.0.2
+  changelog_uri: https://github.com/wowinter13/finance_rb/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/github/wowinter13/finance_rb
+  source_code_uri: https://github.com/wowinter13/finance_rb
 post_install_message: 
 rdoc_options: []
 require_paths: