octave_packages/financial-0.4.0/taxedrr.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} =} taxedrr (@var{pretaxreturn}, @var{taxrate})
  18 ## Compute the taxed rate of @var{return} based on a @var{pretaxreturn}
  19 ## rate and a @var{taxrate}.
  20 ## @seealso{irr, effrr, nomrr, pvvar, xirr}
  21 ## @end deftypefn
  22
  23 function rate = taxedrr (pretax, taxrate)
  24
  25   if (nargin != 2)
  26     print_usage ();
  27   elseif (taxrate < 0 || taxrate > 1)
  28     error ("taxedrr: taxrate must be between 0 and 1")
  29   endif
  30
  31   rate = pretax.*(1-taxrate);
  32
  33 endfunction
  34
  35 ## Tests
  36 %!assert (taxedrr (0.12, 0.30), 0.084, 10*eps)
  37 %!assert (taxedrr (0.12, 0), 0.12, 10*eps)
  38 %!assert (taxedrr (0.12, 1), 0, 10*eps)