Apache POI - Common 5.3.0 · org.apache.poi.ss.formula.functions.Finance

Access	Constructor and Description
public	Finance()

Method Summary

Modifier and Type	Method and Description
public static double	Returns: `double` representing future principal value. fv(double - periodic interest rate represented as a decimal. r, int - number of total payments / periods. nper, double - periodic payment amount. pmt, double - present value -- borrowed or invested principal. pv, int - when payment is made: beginning of period is 1; end, 0. type) Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV, Type) function, which calculates future value or principal at period N.
public static double	fv(double r, int nper, double c, double pv) Overloaded fv() call omitting type, which defaults to 0.
public static double	Returns: `double` representing interest portion of payment. ipmt(double - periodic interest rate represented as a decimal. r, int - period (payment number) to check value at. per, int - number of total payments / periods. nper, double - present value -- borrowed or invested principal. pv, double - future value of loan or annuity. fv, int - when payment is made: beginning of period is 1; end, 0. type) Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV, FV, Type) function, which calculates the portion of the payment at a given period that is the interest on previous balance.
public static double	ipmt(double r, int per, int nper, double pv, double fv)
public static double	ipmt(double r, int per, int nper, double pv)
public static double	Returns: `double` representing periodic payment amount. pmt(double - periodic interest rate represented as a decimal. r, int - number of total payments / periods. nper, double - present value -- borrowed or invested principal. pv, double - future value of loan or annuity. fv, int - when payment is made: beginning of period is 1; end, 0. type) Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type) function, which calculates the payments for a loan or the future value of an investment
public static double	pmt(double r, int nper, double pv, double fv) Overloaded pmt() call omitting type, which defaults to 0.
public static double	pmt(double r, int nper, double pv) Overloaded pmt() call omitting fv and type, which both default to 0.
public static double	Returns: `double` representing principal portion of payment. ppmt(double - periodic interest rate represented as a decimal. r, int - period (payment number) to check value at. per, int - number of total payments / periods. nper, double - present value -- borrowed or invested principal. pv, double - future value of loan or annuity. fv, int - when payment is made: beginning of period is 1; end, 0. type) Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV, FV, Type) function, which calculates the portion of the payment at a given period that will apply to principal.
public static double	ppmt(double r, int per, int nper, double pv, double fv)
public static double	ppmt(double r, int per, int nper, double pv)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Finance	back to summary
public Finance()

Method Detail

fv back to summary

fv	back to summary
public static double fv(double r, int nper, double pmt, double pv, int type) Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV, Type) function, which calculates future value or principal at period N. Parameters r:double - periodic interest rate represented as a decimal. nper:int - number of total payments / periods. pmt:double - periodic payment amount. pv:double - present value -- borrowed or invested principal. type:int - when payment is made: beginning of period is 1; end, 0. Returns:double `double` representing future principal value.

public static double fv(double r, int nper, double pmt, double pv, int type)

Emulates Excel/Calc's FV(interest_rate, number_payments, payment, PV, Type) function, which calculates future value or principal at period N.

Parameters

r:double: - periodic interest rate represented as a decimal.
nper:int: - number of total payments / periods.
pmt:double: - periodic payment amount.
pv:double: - present value -- borrowed or invested principal.
type:int: - when payment is made: beginning of period is 1; end, 0.

Returns:double

double representing future principal value.

fv back to summary

fv	back to summary
public static double fv(double r, int nper, double c, double pv) Overloaded fv() call omitting type, which defaults to 0. See Also `fv(double, int, double, double, int)`

public static double fv(double r, int nper, double c, double pv)

Overloaded fv() call omitting type, which defaults to 0.

See Also: fv(double, int, double, double, int)

ipmt back to summary

ipmt	back to summary
public static double ipmt(double r, int per, int nper, double pv, double fv, int type) Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV, FV, Type) function, which calculates the portion of the payment at a given period that is the interest on previous balance. Parameters r:double - periodic interest rate represented as a decimal. per:int - period (payment number) to check value at. nper:int - number of total payments / periods. pv:double - present value -- borrowed or invested principal. fv:double - future value of loan or annuity. type:int - when payment is made: beginning of period is 1; end, 0. Returns:double `double` representing interest portion of payment. See Also `pmt(double, int, double, double, int)`, `fv(double, int, double, double, int)`

public static double ipmt(double r, int per, int nper, double pv, double fv, int type)

Emulates Excel/Calc's IPMT(interest_rate, period, number_payments, PV, FV, Type) function, which calculates the portion of the payment at a given period that is the interest on previous balance.

Parameters

r:double: - periodic interest rate represented as a decimal.
per:int: - period (payment number) to check value at.
nper:int: - number of total payments / periods.
pv:double: - present value -- borrowed or invested principal.
fv:double: - future value of loan or annuity.
type:int: - when payment is made: beginning of period is 1; end, 0.

Returns:double

double representing interest portion of payment.

ipmt	back to summary
public static double ipmt(double r, int per, int nper, double pv, double fv)

ipmt	back to summary
public static double ipmt(double r, int per, int nper, double pv)

pmt back to summary

pmt	back to summary
public static double pmt(double r, int nper, double pv, double fv, int type) Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type) function, which calculates the payments for a loan or the future value of an investment Parameters r:double - periodic interest rate represented as a decimal. nper:int - number of total payments / periods. pv:double - present value -- borrowed or invested principal. fv:double - future value of loan or annuity. type:int - when payment is made: beginning of period is 1; end, 0. Returns:double `double` representing periodic payment amount.

public static double pmt(double r, int nper, double pv, double fv, int type)

Emulates Excel/Calc's PMT(interest_rate, number_payments, PV, FV, Type) function, which calculates the payments for a loan or the future value of an investment

Parameters

r:double: - periodic interest rate represented as a decimal.
nper:int: - number of total payments / periods.
pv:double: - present value -- borrowed or invested principal.
fv:double: - future value of loan or annuity.
type:int: - when payment is made: beginning of period is 1; end, 0.

Returns:double

double representing periodic payment amount.

pmt back to summary

pmt	back to summary
public static double pmt(double r, int nper, double pv, double fv) Overloaded pmt() call omitting type, which defaults to 0. See Also `pmt(double, int, double, double, int)`

public static double pmt(double r, int nper, double pv, double fv)

Overloaded pmt() call omitting type, which defaults to 0.

See Also: pmt(double, int, double, double, int)

pmt back to summary

pmt	back to summary
public static double pmt(double r, int nper, double pv) Overloaded pmt() call omitting fv and type, which both default to 0. See Also `pmt(double, int, double, double, int)`

public static double pmt(double r, int nper, double pv)

Overloaded pmt() call omitting fv and type, which both default to 0.

See Also: pmt(double, int, double, double, int)

ppmt back to summary

ppmt	back to summary
public static double ppmt(double r, int per, int nper, double pv, double fv, int type) Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV, FV, Type) function, which calculates the portion of the payment at a given period that will apply to principal. Parameters r:double - periodic interest rate represented as a decimal. per:int - period (payment number) to check value at. nper:int - number of total payments / periods. pv:double - present value -- borrowed or invested principal. fv:double - future value of loan or annuity. type:int - when payment is made: beginning of period is 1; end, 0. Returns:double `double` representing principal portion of payment. See Also `pmt(double, int, double, double, int)`, `ipmt(double, int, int, double, double, int)`

public static double ppmt(double r, int per, int nper, double pv, double fv, int type)

Emulates Excel/Calc's PPMT(interest_rate, period, number_payments, PV, FV, Type) function, which calculates the portion of the payment at a given period that will apply to principal.

Parameters

r:double: - periodic interest rate represented as a decimal.
per:int: - period (payment number) to check value at.
nper:int: - number of total payments / periods.
pv:double: - present value -- borrowed or invested principal.
fv:double: - future value of loan or annuity.
type:int: - when payment is made: beginning of period is 1; end, 0.

Returns:double

double representing principal portion of payment.

ppmt	back to summary
public static double ppmt(double r, int per, int nper, double pv, double fv)

ppmt	back to summary
public static double ppmt(double r, int per, int nper, double pv)

public Class Finance

Constructor Summary

Method Summary

Constructor Detail

Method Detail