octave_packages/financial-0.4.0/effrr.m

   1 ## Copyright (C) 2008 Bill Denney <bill@denney.ws>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{return} =} effrr (@var{rate}, @var{numperiods})
  18 ## Compute the effective rate of return based on a nominal @var{rate}
  19 ## over a number of periods, @var{numperiods}.
  20 ## @seealso{irr, nomrr}
  21 ## @end deftypefn
  22
  23 function rate = effrr (rate, numperiods)
  24
  25   if (nargin != 2)
  26     print_usage ();
  27   endif
  28
  29   rate = (1+rate./numperiods).^numperiods - 1;
  30
  31 endfunction
  32
  33 ## Tests
  34 %!assert (effrr (0.09, 12), 0.0938, 0.00005)