Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update javadoc on FinanceLib. This closes #162 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1870105 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
PJ Fanning 2019-11-21 18:32:35 +00:00
parent f82a1ffe6a
commit 2d6b1800dc
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/java/org/apache/poi/ss/formula/functions/FinanceLib.java
View File

@ -70,8 +70,8 @@ public final class FinanceLib {
* @param r rate * @param r rate
* @param n num of periods * @param n num of periods
* @param y pmt per period * @param y pmt per period
* @param p future value * @param p present value
* @param t type (true=pmt at end of period, false=pmt at begining of period) * @param t type (true=pmt at beginning of period, false=pmt at end of period)
*/ */
public static double fv(double r, double n, double y, double p, boolean t) { public static double fv(double r, double n, double y, double p, boolean t) {
double retval = 0; double retval = 0;
@ -92,11 +92,11 @@ public final class FinanceLib {
* of individual payment, future value and boolean value indicating whether * of individual payment, future value and boolean value indicating whether
* payments are due at the beginning of period * payments are due at the beginning of period
* (false => payments are due at end of period) * (false => payments are due at end of period)
* @param r * @param r rate
* @param n * @param n num of periods
* @param y * @param y pmt per period
* @param f * @param f future value
* @param t * @param t type (true=pmt at beginning of period, false=pmt at end of period)
*/ */
public static double pv(double r, double n, double y, double f, boolean t) { public static double pv(double r, double n, double y, double f, boolean t) {
double retval = 0; double retval = 0;
@ -118,7 +118,7 @@ public final class FinanceLib {
* (supplied as an array). If the amounts are income the value should * (supplied as an array). If the amounts are income the value should
* be positive, else if they are payments and not income, the * be positive, else if they are payments and not income, the
* value should be negative. * value should be negative.
* @param r * @param r rate
* @param cfs cashflow amounts * @param cfs cashflow amounts
*/ */
public static double npv(double r, double[] cfs) { public static double npv(double r, double[] cfs) {
@ -134,11 +134,11 @@ public final class FinanceLib {
/** /**
* *
* @param r * @param r rate
* @param n * @param n num of periods
* @param p * @param p present value
* @param f * @param f future value
* @param t * @param t type (true=pmt at beginning of period, false=pmt at end of period)
*/ */
public static double pmt(double r, double n, double p, double f, boolean t) { public static double pmt(double r, double n, double p, double f, boolean t) {
double retval = 0; double retval = 0;
@ -156,11 +156,11 @@ public final class FinanceLib {
/** /**
* *
* @param r * @param r rate
* @param y * @param y pmt per period
* @param p * @param p present value
* @param f * @param f future value
* @param t * @param t type (true=pmt at beginning of period, false=pmt at end of period)
*/ */
public static double nper(double r, double y, double p, double f, boolean t) { public static double nper(double r, double y, double p, double f, boolean t) {
double retval = 0; double retval = 0;