Class FinanceLib
- java.lang.Object
-
- org.apache.poi.ss.formula.functions.FinanceLib
-
public final class FinanceLib extends java.lang.Object
This class is a functon library for common fiscal functions. Glossary of terms/abbreviations:
- FV: Future Value
- PV: Present Value
- NPV: Net Present Value
- PMT: (Periodic) Payment
Online References:
- GNU Emacs Calc 2.02 Manual: http://theory.uwinnipeg.ca/gnu/calc/calc_203.html
- Yahoo Financial Glossary: http://biz.yahoo.com/f/g/nn.html#y
- MS Excel function reference: http://office.microsoft.com/en-us/assistance/CH062528251033.aspx
Symbols used in the formulae that follow:
- p: present value
- f: future value
- n: number of periods
- y: payment (in each period)
- r: rate
- ^: the power operator (NOT the java bitwise XOR operator!)
p(1+r)^n + y(1+rt)((1+r)^n-1)/r + f=0 ...{when r!=0} ny + p + f=0 ...{when r=0}
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static double
fv(double r, double n, double y, double p, boolean t)
Future value of an amount given the number of payments, rate, amount of individual payment, present value and boolean value indicating whether payments are due at the beginning of period (false => payments are due at end of period)static double
nper(double r, double y, double p, double f, boolean t)
static double
npv(double r, double[] cfs)
calculates the Net Present Value of a principal amount given the discount rate and a sequence of cash flows (supplied as an array).static double
pmt(double r, double n, double p, double f, boolean t)
static double
pv(double r, double n, double y, double f, boolean t)
Present value of an amount given the number of future payments, rate, amount of individual payment, future value and boolean value indicating whether payments are due at the beginning of period (false => payments are due at end of period)
-
-
-
Method Detail
-
fv
public static double fv(double r, double n, double y, double p, boolean t)
Future value of an amount given the number of payments, rate, amount of individual payment, present value and boolean value indicating whether payments are due at the beginning of period (false => payments are due at end of period)- Parameters:
r
- raten
- num of periodsy
- pmt per periodp
- present valuet
- type (true=pmt at beginning of period, false=pmt at end of period)
-
pv
public static double pv(double r, double n, double y, double f, boolean t)
Present value of an amount given the number of future payments, rate, amount of individual payment, future value and boolean value indicating whether payments are due at the beginning of period (false => payments are due at end of period)- Parameters:
r
- raten
- num of periodsy
- pmt per periodf
- future valuet
- type (true=pmt at beginning of period, false=pmt at end of period)
-
npv
public static double npv(double r, double[] cfs)
calculates the Net Present Value of a principal amount given the discount rate and a sequence of cash flows (supplied as an array). If the amounts are income the value should be positive, else if they are payments and not income, the value should be negative.- Parameters:
r
- ratecfs
- cashflow amounts
-
pmt
public static double pmt(double r, double n, double p, double f, boolean t)
- Parameters:
r
- raten
- num of periodsp
- present valuef
- future valuet
- type (true=pmt at beginning of period, false=pmt at end of period)
-
nper
public static double nper(double r, double y, double p, double f, boolean t)
- Parameters:
r
- ratey
- pmt per periodp
- present valuef
- future valuet
- type (true=pmt at beginning of period, false=pmt at end of period)
-
-