Mercurial > octave-nkf
diff scripts/finance/pv.m @ 3439:3234a698073a
[project @ 2000-01-14 09:51:14 by jwe]
author | jwe |
---|---|
date | Fri, 14 Jan 2000 09:52:35 +0000 |
parents | f8dde1807dee |
children | 434790acb067 |
line wrap: on
line diff
--- a/scripts/finance/pv.m Fri Jan 14 06:34:24 2000 +0000 +++ b/scripts/finance/pv.m Fri Jan 14 09:52:35 2000 +0000 @@ -15,19 +15,19 @@ ## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ## -*- texinfo -*- -## @deftypefn {Function File} {} pv (@var{r}, @var{n}, @var{p} [, @var{l}] [, @var{method}]) +## @deftypefn {Function File} {} pv (@var{r}, @var{n}, @var{p}, @var{l}, @var{method}) ## Returns the present value of an investment that will pay off @var{p} for @var{n} ## consecutive periods, assuming an interest @var{r}. ## -## With the optional scalar argument @var{l}, one can specify an additional +## The optional argument @var{l} may be used to specify an additional ## lump-sum payment made at the end of @var{n} periods. ## -## With the optional string argument `method', one can specify whether -## payments are made at the end ("e", default) or at the beginning ("b") -## of each period. +## The optional argument @var{method} may be used to specify whether +## payments are made at the end (@code{"e"}, default) or at the +## beginning (@code{"b"}) of each period. ## -## Note that the rate r is not specified in percent, i.e., one has to -## write 0.05 rather than 5 %. +## Note that the rate @var{r} is specified as a fraction (i.e., 0.05, +## not 5 percent). ## @end deftypefn ## @seealso{pmt, nper, rate, and npv}