Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / financial-0.4.0 / fvl.m

diff --git a/octave_packages/financial-0.4.0/fvl.m b/octave_packages/financial-0.4.0/fvl.m
new file mode 100644 (file)
index 0000000..115aa48
--- /dev/null
+++ b/octave_packages/financial-0.4.0/fvl.m
@@ -0,0 +1,42 @@
+## Copyright (C) 1995-1998, 2000, 2002, 2005-2007 Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
+##
+## This program is free software; you can redistribute it and/or modify it under
+## the terms of the GNU General Public License as published by the Free Software
+## Foundation; either version 3 of the License, or (at your option) any later
+## version.
+##
+## This program is distributed in the hope that it will be useful, but WITHOUT
+## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+## details.
+##
+## You should have received a copy of the GNU General Public License along with
+## this program; if not, see <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn {Function File} {} fvl (@var{r}, @var{n}, @var{l})
+## Return the future value at the end of @var{n} periods of an initial
+## lump sum investment @var{l}, given a per-period interest rate
+## @var{r}.
+##
+## Note that the rate @var{r} is specified as a fraction (i.e., 0.05,
+## not 5 percent).
+## @end deftypefn
+
+function v = fvl (r, n, l)
+
+  if (nargin != 3)
+    print_usage ();
+  endif
+
+  if (! (isscalar (r) && r > -1))
+    error ("fvl: r has to be a scalar > -1");
+  elseif (! (isscalar (n) && n > 0))
+    error ("fvl: n has to be a positive scalar");
+  elseif (! isscalar (l))
+    error ("fvl: l has to be a scalar");
+  endif
+
+  v = l * (1 + r)^n;
+
+endfunction