Class: PHPExcel_Calculation_Financial
Source Location: /PHPExcel/Calculation/Financial.php
PHPExcel_Calculation_Financial
Author(s):
Copyright:
- Copyright (c) 2006 - 2012 PHPExcel (http://www.codeplex.com/PHPExcel)
|
|
Class Details
Class Methods
static method ACCRINT [line 201]
static float ACCRINT(
mixed
$issue, mixed
$firstinterest, mixed
$settlement, float
$rate, [float
$par = 1000], [integer
$frequency = 1], [integer
$basis = 0])
|
|
ACCRINT Returns the accrued interest for a security that pays periodic interest. Excel Function: ACCRINT(issue,firstinterest,settlement,rate,par,frequency[,basis])
Tags:
Parameters:
static method ACCRINTM [line 253]
static float ACCRINTM(
mixed
$issue, mixed
$settlement, float
$rate, [float
$par = 1000], [integer
$basis = 0])
|
|
ACCRINTM Returns the accrued interest for a security that pays interest at maturity. Excel Function: ACCRINTM(issue,settlement,rate[,par[,basis]])
Tags:
Parameters:
static method AMORDEGRC [line 309]
static float AMORDEGRC(
float
$cost, mixed
$purchased, mixed
$firstPeriod, mixed
$salvage, float
$period, float
$rate, [integer
$basis = 0])
|
|
AMORDEGRC Returns the depreciation for each accounting period. This function is provided for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is taken into account. The function is similar to AMORLINC, except that a depreciation coefficient is applied in the calculation depending on the life of the assets. This function will return the depreciation until the last period of the life of the assets or until the cumulated value of depreciation is greater than the cost of the assets minus the salvage value. Excel Function: AMORDEGRC(cost,purchased,firstPeriod,salvage,period,rate[,basis])
Tags:
Parameters:
static method AMORLINC [line 385]
static float AMORLINC(
float
$cost, mixed
$purchased, mixed
$firstPeriod, mixed
$salvage, float
$period, float
$rate, [integer
$basis = 0])
|
|
AMORLINC Returns the depreciation for each accounting period. This function is provided for the French accounting system. If an asset is purchased in the middle of the accounting period, the prorated depreciation is taken into account. Excel Function: AMORLINC(cost,purchased,firstPeriod,salvage,period,rate[,basis])
Tags:
Parameters:
static method COUPDAYBS [line 451]
static float COUPDAYBS(
mixed
$settlement, mixed
$maturity, mixed
$frequency, [integer
$basis = 0])
|
|
COUPDAYBS Returns the number of days from the beginning of the coupon period to the settlement date. Excel Function: COUPDAYBS(settlement,maturity,frequency[,basis])
Tags:
Parameters:
static method COUPDAYS [line 509]
static float COUPDAYS(
mixed
$settlement, mixed
$maturity, mixed
$frequency, [integer
$basis = 0])
|
|
COUPDAYS Returns the number of days in the coupon period that contains the settlement date. Excel Function: COUPDAYS(settlement,maturity,frequency[,basis])
Tags:
Parameters:
static method COUPDAYSNC [line 579]
static float COUPDAYSNC(
mixed
$settlement, mixed
$maturity, mixed
$frequency, [integer
$basis = 0])
|
|
COUPDAYSNC Returns the number of days from the settlement date to the next coupon date. Excel Function: COUPDAYSNC(settlement,maturity,frequency[,basis])
Tags:
Parameters:
static method COUPNCD [line 638]
static mixed COUPNCD(
mixed
$settlement, mixed
$maturity, mixed
$frequency, [integer
$basis = 0])
|
|
COUPNCD Returns the next coupon date after the settlement date. Excel Function: COUPNCD(settlement,maturity,frequency[,basis])
Tags:
Parameters:
static method COUPNUM [line 694]
static integer COUPNUM(
mixed
$settlement, mixed
$maturity, mixed
$frequency, [integer
$basis = 0])
|
|
COUPNUM Returns the number of coupons payable between the settlement date and maturity date, rounded up to the nearest whole coupon. Excel Function: COUPNUM(settlement,maturity,frequency[,basis])
Tags:
Parameters:
static method COUPPCD [line 765]
static mixed COUPPCD(
mixed
$settlement, mixed
$maturity, mixed
$frequency, [integer
$basis = 0])
|
|
COUPPCD Returns the previous coupon date before the settlement date. Excel Function: COUPPCD(settlement,maturity,frequency[,basis])
Tags:
Parameters:
static method CUMIPMT [line 809]
static float CUMIPMT(
float
$rate, integer
$nper, float
$pv, integer
$start, integer
$end, [integer
$type = 0])
|
|
CUMIPMT Returns the cumulative interest paid on a loan between the start and end periods. Excel Function: CUMIPMT(rate,nper,pv,start,end[,type])
Tags:
Parameters:
static method CUMPRINC [line 856]
static float CUMPRINC(
float
$rate, integer
$nper, float
$pv, integer
$start, integer
$end, [integer
$type = 0])
|
|
CUMPRINC Returns the cumulative principal paid on a loan between the start and end periods. Excel Function: CUMPRINC(rate,nper,pv,start,end[,type])
Tags:
Parameters:
static method DB [line 908]
static float DB(
float
$cost, float
$salvage, integer
$life, integer
$period, [integer
$month = 12])
|
|
DB Returns the depreciation of an asset for a specified period using the fixed-declining balance method. This form of depreciation is used if you want to get a higher depreciation value at the beginning of the depreciation (as opposed to linear depreciation). The depreciation value is reduced with every depreciation period by the depreciation already deducted from the initial cost. Excel Function: DB(cost,salvage,life,period[,month])
Tags:
Parameters:
static method DDB [line 975]
static float DDB(
float
$cost, float
$salvage, integer
$life, integer
$period, [float
$factor = 2.0])
|
|
DDB Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify. Excel Function: DDB(cost,salvage,life,period[,factor])
Tags:
Parameters:
static method DISC [line 1036]
static float DISC(
mixed
$settlement, mixed
$maturity, integer
$price, integer
$redemption, [integer
$basis = 0])
|
|
DISC Returns the discount rate for a security. Excel Function: DISC(settlement,maturity,price,redemption[,basis])
Tags:
Parameters:
static method DOLLARDE [line 1079]
static float DOLLARDE(
[float
$fractional_dollar = Null], [integer
$fraction = 0])
|
|
DOLLARDE Converts a dollar price expressed as an integer part and a fraction part into a dollar price expressed as a decimal number. Fractional dollar numbers are sometimes used for security prices. Excel Function: DOLLARDE(fractional_dollar,fraction)
Tags:
Parameters:
static method DOLLARFR [line 1115]
static float DOLLARFR(
[float
$decimal_dollar = Null], [integer
$fraction = 0])
|
|
DOLLARFR Converts a dollar price expressed as a decimal number into a dollar price expressed as a fraction. Fractional dollar numbers are sometimes used for security prices. Excel Function: DOLLARFR(decimal_dollar,fraction)
Tags:
Parameters:
static method EFFECT [line 1150]
static float EFFECT(
[float
$nominal_rate = 0], [integer
$npery = 0])
|
|
EFFECT Returns the effective interest rate given the nominal rate and the number of compounding payments per year. Excel Function: EFFECT(nominal_rate,npery)
Tags:
Parameters:
static method FV [line 1185]
static float FV(
[float
$rate = 0], [int
$nper = 0], [float
$pmt = 0], [float
$pv = 0], [integer
$type = 0])
|
|
FV Returns the Future Value of a cash flow with constant payments and interest rate (annuities). Excel Function: FV(rate,nper,pmt[,pv[,type]])
Tags:
Parameters:
static method FVSCHEDULE [line 1210]
static void FVSCHEDULE(
$principal,
$schedule)
|
|
FVSCHEDULE
Tags:
Parameters:
static method INTRATE [line 1244]
static float INTRATE(
mixed
$settlement, mixed
$maturity, integer
$investment, integer
$redemption, [integer
$basis = 0])
|
|
INTRATE Returns the interest rate for a fully invested security. Excel Function: INTRATE(settlement,maturity,investment,redemption[,basis])
Tags:
Parameters:
static method IPMT [line 1284]
static float IPMT(
float
$rate, int
$per, int
$nper, float
$pv, [float
$fv = 0], [int
$type = 0])
|
|
IPMT Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate.
Tags:
Parameters:
static method IRR [line 1306]
static void IRR(
$values, [
$guess = 0.1])
|
|
Tags:
Parameters:
static method ISPMT [line 1362]
ISPMT Returns the interest payment for an investment based on an interest rate and a constant payment schedule. Excel Function: =ISPMT(interest_rate, period, number_payments, PV) interest_rate is the interest rate for the investment period is the period to calculate the interest rate. It must be betweeen 1 and number_payments. number_payments is the number of payments for the annuity PV is the loan amount or present value of the payments
Tags:
static method MIRR [line 1387]
static void MIRR(
$values,
$finance_rate,
$reinvestment_rate)
|
|
Tags:
Parameters:
static method NOMINAL [line 1426]
static float NOMINAL(
[float
$effect_rate = 0], [int
$npery = 0])
|
|
NOMINAL Returns the nominal interest rate given the effective rate and the number of compounding payments per year.
Tags:
Parameters:
static method NPER [line 1452]
static float NPER(
[float
$rate = 0], [int
$pmt = 0], [float
$pv = 0], [float
$fv = 0], [int
$type = 0])
|
|
NPER Returns the number of periods for a cash flow with constant periodic payments (annuities), and interest rate.
Tags:
Parameters:
static method NPV [line 1488]
static float NPV(
float
0, array
1)
|
|
NPV Returns the Net Present Value of a cash flow series given a discount rate.
Tags:
Parameters:
static method PMT [line 1521]
static float PMT(
[float
$rate = 0], [int
$nper = 0], [float
$pv = 0], [float
$fv = 0], [int
$type = 0])
|
|
PMT Returns the constant payment (annuity) for a cash flow with a constant interest rate.
Tags:
Parameters:
static method PPMT [line 1555]
static float PPMT(
float
$rate, int
$per, int
$nper, float
$pv, [float
$fv = 0], [int
$type = 0])
|
|
PPMT Returns the interest payment for a given period for an investment based on periodic, constant payments and a constant interest rate.
Tags:
Parameters:
static method PRICE [line 1577]
static void PRICE(
$settlement,
$maturity,
$rate,
$yield,
$redemption,
$frequency, [
$basis = 0])
|
|
Tags:
Parameters:
static method PRICEDISC [line 1637]
static float PRICEDISC(
mixed
$settlement, mixed
$maturity, int
$discount, int
$redemption, [int
$basis = 0])
|
|
PRICEDISC Returns the price per $100 face value of a discounted security.
Tags:
Parameters:
static method PRICEMAT [line 1681]
static float PRICEMAT(
mixed
$settlement, mixed
$maturity, mixed
$issue, int
$rate, int
$yield, [int
$basis = 0])
|
|
PRICEMAT Returns the price per $100 face value of a security that pays interest at maturity.
Tags:
Parameters:
static method PV [line 1737]
static float PV(
[float
$rate = 0], [int
$nper = 0], [float
$pmt = 0], [float
$fv = 0], [int
$type = 0])
|
|
PV Returns the Present Value of a cash flow with constant payments and interest rate (annuities).
Tags:
Parameters:
static method RATE [line 1788]
static float RATE(
float
$nper, float
$pmt, float
$pv, [float
$fv = 0.0], [integer
$type = 0], [float
$guess = 0.1])
|
|
RATE Returns the interest rate per period of an annuity. RATE is calculated by iteration and can have zero or more solutions. If the successive results of RATE do not converge to within 0.0000001 after 20 iterations, RATE returns the #NUM! error value. Excel Function: RATE(nper,pmt,pv[,fv[,type[,guess]]])
Tags:
Parameters:
static method RECEIVED [line 1850]
static float RECEIVED(
mixed
$settlement, mixed
$maturity, int
$investment, int
$discount, [int
$basis = 0])
|
|
RECEIVED Returns the price per $100 face value of a discounted security.
Tags:
Parameters:
static method SLN [line 1884]
static float SLN(
cost
$cost, salvage
$salvage, life
$life)
|
|
SLN Returns the straight-line depreciation of an asset for one period
Tags:
Parameters:
static method SYD [line 1911]
static float SYD(
cost
$cost, salvage
$salvage, life
$life, period
$period)
|
|
SYD Returns the sum-of-years' digits depreciation of an asset for a specified period.
Tags:
Parameters:
static method TBILLEQ [line 1940]
static float TBILLEQ(
mixed
$settlement, mixed
$maturity, int
$discount)
|
|
TBILLEQ Returns the bond-equivalent yield for a Treasury bill.
Tags:
Parameters:
static method TBILLPRICE [line 1978]
static float TBILLPRICE(
mixed
$settlement, mixed
$maturity, int
$discount)
|
|
TBILLPRICE Returns the yield for a Treasury bill.
Tags:
Parameters:
static method TBILLYIELD [line 2030]
static float TBILLYIELD(
mixed
$settlement, mixed
$maturity, int
$price)
|
|
TBILLYIELD Returns the yield for a Treasury bill.
Tags:
Parameters:
static method XIRR [line 2062]
static void XIRR(
$values,
$dates, [
$guess = 0.1])
|
|
Tags:
Parameters:
static method XNPV [line 2118]
static float XNPV(
float
$rate, array
$values, array
$dates)
|
|
XNPV Returns the net present value for a schedule of cash flows that is not necessarily periodic. To calculate the net present value for a series of cash flows that is periodic, use the NPV function. Excel Function: =XNPV(rate,values,dates)
Tags:
Parameters:
static method YIELDDISC [line 2156]
static float YIELDDISC(
mixed
$settlement, mixed
$maturity, int
$price, int
$redemption, [int
$basis = 0])
|
|
YIELDDISC Returns the annual yield of a security that pays interest at maturity.
Tags:
Parameters:
static method YIELDMAT [line 2205]
static float YIELDMAT(
mixed
$settlement, mixed
$maturity, mixed
$issue, int
$rate, int
$price, [int
$basis = 0])
|
|
YIELDMAT Returns the annual yield of a security that pays interest at maturity.
Tags:
Parameters:
|
|