PHPExcel_Calculation
[ class tree: PHPExcel_Calculation ] [ index: PHPExcel_Calculation ] [ all elements ]

Class: PHPExcel_Calculation_Functions

Source Location: /PHPExcel/Calculation/Functions.php

Class Overview


PHPExcel_Calculation_Functions


Author(s):

Copyright:

  • Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)

Constants

Methods



Class Details

[line 94]
PHPExcel_Calculation_Functions



Tags:

copyright:  Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)


[ Top ]


Class Methods


static method ACCRINT [line 9899]

static float ACCRINT( mixed $issue, mixed $firstinter, mixed $settlement, float $rate, [float $par = 1000], [int $frequency = 1], [ $basis = 0])

ACCRINT

Returns the discount rate for a security.




Tags:

access:  public


Parameters:

mixed   $issue   issue The security's issue date.
mixed   $firstinter   firstinter The security's first interest date.
mixed   $settlement   settlement The security's settlement date.
float   $rate   rate The security's annual coupon rate.
float   $par   par The security's par value.
int   $frequency   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360
   $basis  

[ Top ]

static method ACCRINTM [line 9941]

static float ACCRINTM( mixed $issue, mixed $settlement, float $rate, [float $par = 1000], [int $basis = 0])

ACCRINTM

Returns the discount rate for a security.




Tags:

access:  public


Parameters:

mixed   $issue   issue The security's issue date.
mixed   $settlement   settlement The security's settlement date.
float   $rate   rate The security's annual coupon rate.
float   $par   par The security's par value.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method AMORDEGRC [line 9963]

static void AMORDEGRC( $cost, $purchased, $firstPeriod, $salvage, $period, $rate, [ $basis = 0])



Tags:

access:  public


Parameters:

   $cost  
   $purchased  
   $firstPeriod  
   $salvage  
   $period  
   $rate  
   $basis  

[ Top ]

static method AMORLINC [line 10012]

static void AMORLINC( $cost, $purchased, $firstPeriod, $salvage, $period, $rate, [ $basis = 0])



Tags:

access:  public


Parameters:

   $cost  
   $purchased  
   $firstPeriod  
   $salvage  
   $period  
   $rate  
   $basis  

[ Top ]

static method ASCIICODE [line 5137]

static int ASCIICODE( $characters, string $character)

ASCIICODE



Tags:

access:  public


Parameters:

string   $character   Value
   $characters  

[ Top ]

static method AVEDEV [line 1691]

static float AVEDEV( mixed $arg,...)

AVEDEV

Returns the average of the absolute deviations of data points from their mean. AVEDEV is a measure of the variability in a data set.

Excel Function: AVEDEV(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method AVERAGE [line 1388]

static float AVERAGE( mixed $arg,...)

AVERAGE

Returns the average (arithmetic mean) of the arguments

Excel Function: AVERAGE(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method AVERAGEA [line 1431]

static float AVERAGEA( mixed $arg,...)

AVERAGEA

Returns the average of its arguments, including numbers, text, and logical values

Excel Function: AVERAGEA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method AVERAGEIF [line 1481]

static float AVERAGEIF( $aArgs, string $condition, [ $averageArgs = array()], mixed $arg,...)

AVERAGEIF

Returns the average value from a range of cells that contain numbers within the list of arguments

Excel Function: AVERAGEIF(value1[,value2[, ...]],condition)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
string   $condition   The criteria that defines which cells will be checked.
   $aArgs  
   $averageArgs  

[ Top ]

static method BESSELI [line 8605]

static int BESSELI( float $x, float $n)

BESSELI

Returns the modified Bessel function, which is equivalent to the Bessel function evaluated for purely imaginary arguments




Tags:

access:  public


Parameters:

float   $x  
float   $n  

[ Top ]

static method BESSELJ [line 8648]

static int BESSELJ( float $x, float $n)

BESSELJ

Returns the Bessel function




Tags:

access:  public


Parameters:

float   $x  
float   $n  

[ Top ]

static method BESSELK [line 8727]

static float BESSELK( float $x, float $ord)

BESSELK

Returns the modified Bessel function, which is equivalent to the Bessel functions evaluated for purely imaginary arguments.




Tags:

access:  public


Parameters:

float   $x  
float   $ord  

[ Top ]

static method BESSELY [line 8805]

static int BESSELY( float $x, $ord, float $n)

BESSELY

Returns the Bessel function, which is also called the Weber function or the Neumann function.




Tags:

access:  public


Parameters:

float   $x  
float   $n  
   $ord  

[ Top ]

static method BETADIST [line 4092]

static float BETADIST( float $value, float $alpha, float $beta, [ $rMin = 0], [ $rMax = 1], boolean $cumulative)

BETADIST

Returns the beta distribution.




Tags:

access:  public


Parameters:

float   $value   Value at which you want to evaluate the distribution
float   $alpha   Parameter to the distribution
float   $beta   Parameter to the distribution
boolean   $cumulative  
   $rMin  
   $rMax  

[ Top ]

static method BETAINV [line 4128]

static float BETAINV( float $probability, float $alpha, float $beta, [ $rMin = 0], [ $rMax = 1], boolean $cumulative)

BETAINV

Returns the inverse of the beta distribution.




Tags:

access:  public


Parameters:

float   $probability   Probability at which you want to evaluate the distribution
float   $alpha   Parameter to the distribution
float   $beta   Parameter to the distribution
boolean   $cumulative  
   $rMin  
   $rMax  

[ Top ]

static method BINOMDIST [line 3412]

static float BINOMDIST( float $value, float $trials, float $probability, boolean $cumulative)

BINOMDIST

Returns the individual term binomial distribution probability. Use BINOMDIST in problems with a fixed number of tests or trials, when the outcomes of any trial are only success or failure, when trials are independent, and when the probability of success is constant throughout the experiment. For example, BINOMDIST can calculate the probability that two of the next three babies born are male.




Tags:

todo:  Cumulative distribution function
access:  public


Parameters:

float   $value   Number of successes in trials
float   $trials   Number of trials
float   $probability   Probability of success on each trial
boolean   $cumulative  

[ Top ]

static method BINTODEC [line 6877]

static string BINTODEC( string $x)

BINTODEC

Return a binary value as Decimal.




Tags:

access:  public


Parameters:

string   $x  

[ Top ]

static method BINTOHEX [line 6913]

static string BINTOHEX( string $x, [ $places = null])

BINTOHEX

Return a binary value as Hex.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method BINTOOCT [line 6951]

static string BINTOOCT( string $x, [ $places = null])

BINTOOCT

Return a binary value as Octal.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method CEILING [line 2928]

static float CEILING( float $number, [float $significance = null])

CEILING

Returns number rounded up, away from zero, to the nearest multiple of significance.




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round
float   $significance   Significance

[ Top ]

static method CELL_ADDRESS [line 10815]

static string CELL_ADDRESS( row $row, column $column, [relativity $relativity = 1], [referenceStyle $referenceStyle = True], [sheetText $sheetText = ''])

CELL_ADDRESS

Creates a cell address as text, given specified row and column numbers.




Tags:

access:  public


Parameters:

row   $row   Row number to use in the cell reference
column   $column   Column number to use in the cell reference
relativity   $relativity   Flag indicating the type of reference to return
  1. or omitted Absolute
  2. Absolute row; relative column
  3. Relative row; absolute column
  4. Relative
referenceStyle   $referenceStyle   A logical value that specifies the A1 or R1C1 reference style. TRUE or omitted CELL_ADDRESS returns an A1-style reference FALSE CELL_ADDRESS returns an R1C1-style reference
sheetText   $sheetText   Optional Name of worksheet to use

[ Top ]

static method CHARACTER [line 5098]

static int CHARACTER( string $character)

CHARACTER



Tags:

access:  public


Parameters:

string   $character   Value

[ Top ]

static method CHIDIST [line 3597]

static float CHIDIST( float $value, float $degrees)

CHIDIST

Returns the one-tailed probability of the chi-squared distribution.




Tags:

access:  public


Parameters:

float   $value   Value for the function
float   $degrees   degrees of freedom

[ Top ]

static method CHIINV [line 3626]

static float CHIINV( float $probability, float $degrees)

CHIINV

Returns the one-tailed probability of the chi-squared distribution.




Tags:

access:  public


Parameters:

float   $probability   Probability for the function
float   $degrees   degrees of freedom

[ Top ]

static method CHOOSE [line 11105]

static void CHOOSE( )



Tags:

access:  public


[ Top ]

static method COLUMN [line 10854]

static integer COLUMN( [cellAddress $cellAddress = Null])

COLUMN

Returns the column number of the given cell reference If the cell reference is a range of cells, COLUMN returns the column numbers of each column in the reference as a horizontal array. If cell reference is omitted, and the function is being called through the calculation engine, then it is assumed to be the reference of the cell in which the COLUMN function appears; otherwise this function returns 0.




Tags:

return:  or array of integer
access:  public


Parameters:

cellAddress   $cellAddress   A reference to a range of cells for which you want the column numbers

[ Top ]

static method COLUMNS [line 10891]

static integer COLUMNS( [cellAddress $cellAddress = Null])

COLUMNS

Returns the number of columns in an array or reference.




Tags:

access:  public


Parameters:

cellAddress   $cellAddress   An array or array formula, or a reference to a range of cells for which you want the number of columns

[ Top ]

static method COMBIN [line 3181]

static int COMBIN( int $numObjs, int $numInSet)

COMBIN

Returns the number of combinations for a given number of items. Use COMBIN to determine the total possible number of groups for a given number of items.




Tags:

return:  Number of combinations
access:  public


Parameters:

int   $numObjs   Number of different objects
int   $numInSet   Number of objects in each combination

[ Top ]

static method COMPLEX [line 7297]

static string COMPLEX( [float $realNumber = 0.0], [float $imaginary = 0.0], [string $suffix = 'i'])

COMPLEX

returns a complex number of the form x + yi or x + yj.




Tags:

access:  public


Parameters:

float   $realNumber  
float   $imaginary  
string   $suffix  

[ Top ]

static method CONCATENATE [line 5167]

static string CONCATENATE( )

CONCATENATE



Tags:

access:  public


[ Top ]

static method CONFIDENCE [line 4856]

static float CONFIDENCE( float $alpha, float $stdDev, float $size)

CONFIDENCE

Returns the confidence interval for a population mean




Tags:

access:  public


Parameters:

float   $alpha  
float   $stdDev   Standard Deviation
float   $size  

[ Top ]

static method CONVERTUOM [line 8513]

static float CONVERTUOM( float $value, string $fromUOM, string $toUOM)

CONVERTUOM



Tags:

access:  public


Parameters:

float   $value  
string   $fromUOM  
string   $toUOM  

[ Top ]

static method CORREL [line 2487]

static float CORREL( array $yValues, [array $xValues = null])

CORREL

Returns covariance, the average of the products of deviations for each data point pair.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method COUNT [line 1217]

static int COUNT( mixed $arg,...)

COUNT

Counts the number of cells that contain numbers within the list of arguments

Excel Function: COUNT(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method COUNTA [line 1283]

static int COUNTA( mixed $arg,...)

COUNTA

Counts the number of cells that are not empty within the list of arguments

Excel Function: COUNTA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method COUNTBLANK [line 1252]

static int COUNTBLANK( mixed $arg,...)

COUNTBLANK

Counts the number of empty cells within the list of arguments

Excel Function: COUNTBLANK(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method COUNTIF [line 1315]

static int COUNTIF( $aArgs, string $condition, mixed $arg,...)

COUNTIF

Counts the number of cells that contain numbers within the list of arguments

Excel Function: COUNTIF(value1[,value2[, ...]],condition)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
string   $condition   The criteria that defines which cells will be counted.
   $aArgs  

[ Top ]

static method COUPDAYBS [line 10125]

static void COUPDAYBS( $settlement, $maturity, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $frequency  
   $basis  

[ Top ]

static method COUPDAYS [line 10087]

static void COUPDAYS( $settlement, $maturity, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $frequency  
   $basis  

[ Top ]

static method COUPDAYSNC [line 10151]

static void COUPDAYSNC( $settlement, $maturity, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $frequency  
   $basis  

[ Top ]

static method COUPNCD [line 10177]

static void COUPNCD( $settlement, $maturity, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $frequency  
   $basis  

[ Top ]

static method COUPNUM [line 10223]

static void COUPNUM( $settlement, $maturity, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $frequency  
   $basis  

[ Top ]

static method COUPPCD [line 10200]

static void COUPPCD( $settlement, $maturity, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $frequency  
   $basis  

[ Top ]

static method COVAR [line 2460]

static float COVAR( array $yValues, array $xValues)

COVAR

Returns covariance, the average of the products of deviations for each data point pair.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method CRITBINOM [line 3497]

static int CRITBINOM( float $trials, float $probability, float $alpha)

CRITBINOM

Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value

See http://support.microsoft.com/kb/828117/ for details of the algorithm used




Tags:

todo:  Warning. This implementation differs from the algorithm detailed on the MS web site in that $CumPGuessMinus1 = $CumPGuess - 1 rather than $CumPGuess - $PGuess This eliminates a potential endless loop error, but may have an adverse affect on the accuracy of the function (although all my tests have so far returned correct results).
access:  public


Parameters:

float   $trials   number of Bernoulli trials
float   $probability   probability of a success on each trial
float   $alpha   criterion value

[ Top ]

static method CUMIPMT [line 9405]

static float CUMIPMT( float $rate, int $nper, float $pv, int $start, int $end, [int $type = 0])

CUMIPMT

Returns the cumulative interest paid on a loan between start_period and end_period.




Tags:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $nper   Number of periods
float   $pv   Present Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period
int   $start   start The first period in the calculation. Payment periods are numbered beginning with 1.
int   $end   end The last period in the calculation.

[ Top ]

static method CUMPRINC [line 9480]

static float CUMPRINC( float $rate, int $nper, float $pv, int $start, int $end, [int $type = 0])

CUMPRINC

Returns the cumulative principal paid on a loan between start_period and end_period.




Tags:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $nper   Number of periods
float   $pv   Present Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period
int   $start   start The first period in the calculation. Payment periods are numbered beginning with 1.
int   $end   end The last period in the calculation.

[ Top ]

static method DATE [line 5707]

static mixed DATE( [long $year = 0], [long $month = 1], [long $day = 1])

DATE



Tags:

return:  Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag
access:  public


Parameters:

long   $year  
long   $month  
long   $day  

[ Top ]

static method DATEDIF [line 6108]

static long DATEDIF( [long $startDate = 0], [long $endDate = 0], [string $unit = 'D'])

DATEDIF



Tags:

return:  Interval between the dates
access:  public


Parameters:

long   $startDate   Excel date serial value or a standard date string
long   $endDate   Excel date serial value or a standard date string
string   $unit  

[ Top ]

static method DATENOW [line 6018]

static mixed DATENOW( )

DATENOW



Tags:

return:  Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag
access:  public


[ Top ]

static method DATETIMENOW [line 5994]

static mixed DATETIMENOW( )

DATETIMENOW



Tags:

return:  Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag
access:  public


[ Top ]

static method DATEVALUE [line 5839]

static mixed DATEVALUE( [string $dateValue = 1])

DATEVALUE



Tags:

return:  Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag
access:  public


Parameters:

string   $dateValue  

[ Top ]

static method DAYOFMONTH [line 6457]

static int DAYOFMONTH( [long $dateValue = 1])

DAYOFMONTH



Tags:

return:  Day
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string

[ Top ]

static method DAYOFWEEK [line 6481]

static int DAYOFWEEK( [long $dateValue = 1], [ $style = 1])

DAYOFWEEK



Tags:

return:  Day
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string
   $style  

[ Top ]

static method DAYS360 [line 6074]

static long DAYS360( [long $startDate = 0], [long $endDate = 0], [boolean $method = false])

DAYS360



Tags:

return:  PHP date/time serial
access:  public


Parameters:

long   $startDate   Excel date serial value or a standard date string
long   $endDate   Excel date serial value or a standard date string
boolean   $method   US or European Method

[ Top ]

static method DB [line 9774]

static float DB( float $cost, float $salvage, int $life, int $period, [float $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.




Tags:

access:  public


Parameters:

float   $cost   cost Initial cost of the asset.
float   $salvage   salvage Value at the end of the depreciation. (Sometimes called the salvage value of the asset)
int   $life   life Number of periods over which the asset is depreciated. (Sometimes called the useful life of the asset)
int   $period   period The period for which you want to calculate the depreciation. Period must use the same units as life.
float   $month   month Number of months in the first year. If month is omitted, it defaults to 12.

[ Top ]

static method DDB [line 9826]

static float DDB( float $cost, float $salvage, int $life, int $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.




Tags:

access:  public


Parameters:

float   $cost   cost Initial cost of the asset.
float   $salvage   salvage Value at the end of the depreciation. (Sometimes called the salvage value of the asset)
int   $life   life Number of periods over which the asset is depreciated. (Sometimes called the useful life of the asset)
int   $period   period The period for which you want to calculate the depreciation. Period must use the same units as life.
float   $factor   factor The rate at which the balance declines. If factor is omitted, it is assumed to be 2 (the double-declining balance method).

[ Top ]

static method DECTOBIN [line 6989]

static string DECTOBIN( string $x, [ $places = null])

DECTOBIN

Return an octal value as binary.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method DECTOHEX [line 7059]

static string DECTOHEX( string $x, [ $places = null])

DECTOHEX

Return an octal value as binary.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method DECTOOCT [line 7025]

static string DECTOOCT( string $x, [ $places = null])

DECTOOCT

Return an octal value as binary.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method DELTA [line 8843]

static int DELTA( float $a, [float $b = 0])

DELTA

Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.




Tags:

access:  public


Parameters:

float   $a  
float   $b  

[ Top ]

static method DEVSQ [line 1641]

static float DEVSQ( mixed $arg,...)

DEVSQ

Returns the sum of squares of deviations of data points from their sample mean.

Excel Function: DEVSQ(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method DISC [line 10321]

static float DISC( mixed $settlement, mixed $maturity, int $price, int $redemption, [int $basis = 0])

DISC

Returns the discount rate for a security.




Tags:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
int   $price   price The security's price per $100 face value.
int   $redemption   redemption the security's redemption value per $100 face value.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method DOLLAR [line 9061]

static string DOLLAR( [float $value = 0], [int $decimals = 2])

DOLLAR

This function converts a number to text using currency format, with the decimals rounded to the specified place. The format used is $#,##0.00_);($#,##0.00)..




Tags:

access:  public


Parameters:

float   $value   The value to format
int   $decimals   The number of digits to display to the right of the decimal point. If decimals is negative, number is rounded to the left of the decimal point. If you omit decimals, it is assumed to be 2

[ Top ]

static method DOLLARDE [line 9094]

static float DOLLARDE( [float $fractional_dollar = Null], [int $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.




Tags:

access:  public


Parameters:

float   $fractional_dollar   Fractional Dollar
int   $fraction   Fraction

[ Top ]

static method DOLLARFR [line 9124]

static float DOLLARFR( [float $decimal_dollar = Null], [int $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.




Tags:

access:  public


Parameters:

float   $decimal_dollar   Decimal Dollar
int   $fraction   Fraction

[ Top ]

static method DUMMY [line 224]

static string DUMMY( )

DUMMY



Tags:

return:  #Not Yet Implemented
access:  public


[ Top ]

static method EDATE [line 6737]

static long EDATE( [long $dateValue = 1], [int $adjustmentMonths = 0])

EDATE

Returns the serial number that represents the date that is the indicated number of months before or after a specified date (the start_date). Use EDATE to calculate maturity dates or due dates that fall on the same day of the month as the date of issue.




Tags:

return:  Excel date serial value
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string
int   $adjustmentMonths   Number of months to adjust by

[ Top ]

static method EFFECT [line 9153]

static float EFFECT( [float $nominal_rate = 0], [int $npery = 0])

EFFECT

Returns the effective interest rate given the nominal rate and the number of compounding payments per year.




Tags:

access:  public


Parameters:

float   $nominal_rate   Nominal interest rate
int   $npery   Number of compounding payments per year

[ Top ]

static method EOMONTH [line 6773]

static long EOMONTH( [long $dateValue = 1], [int $adjustmentMonths = 0])

EOMONTH

Returns the serial number for the last day of the month that is the indicated number of months before or after start_date. Use EOMONTH to calculate maturity dates or due dates that fall on the last day of the month.




Tags:

return:  Excel date serial value
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string
int   $adjustmentMonths   Number of months to adjust by

[ Top ]

static method ERF [line 8905]

static int ERF( float $lower, [float $upper = null])

ERF

Returns the error function integrated between lower_limit and upper_limit




Tags:

access:  public


Parameters:

float   $lower   lower bound for integrating ERF
float   $upper   upper bound for integrating ERF. If omitted, ERF integrates between zero and lower_limit

[ Top ]

static method ERFC [line 8967]

static int ERFC( float $x)

ERFC

Returns the complementary ERF function integrated between x and infinity




Tags:

access:  public


Parameters:

float   $x   The lower bound for integrating ERF

[ Top ]

static method ERROR_TYPE [line 5535]

static boolean ERROR_TYPE( [mixed $value = ''])

ERROR_TYPE



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method EVEN [line 2958]

static int EVEN( float $number)

EVEN

Returns number rounded up to the nearest even integer.




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round

[ Top ]

static method EXPONDIST [line 3685]

static float EXPONDIST( float $value, float $lambda, boolean $cumulative)

EXPONDIST

Returns the exponential distribution. Use EXPONDIST to model the time between events, such as how long an automated bank teller takes to deliver cash. For example, you can use EXPONDIST to determine the probability that the process takes at most 1 minute.




Tags:

access:  public


Parameters:

float   $value   Value of the function
float   $lambda   The parameter value
boolean   $cumulative  

[ Top ]

static method FACT [line 2834]

static int FACT( float $factVal)

FACT

Returns the factorial of a number.




Tags:

return:  Factorial
access:  public


Parameters:

float   $factVal   Factorial Value

[ Top ]

static method FACTDOUBLE [line 2866]

static int FACTDOUBLE( float $factVal)

FACTDOUBLE

Returns the double factorial of a number.




Tags:

return:  Double Factorial
access:  public


Parameters:

float   $factVal   Factorial Value

[ Top ]

static method FISHER [line 3716]

static float FISHER( float $value)

FISHER

Returns the Fisher transformation at x. This transformation produces a function that is normally distributed rather than skewed. Use this function to perform hypothesis testing on the correlation coefficient.




Tags:

access:  public


Parameters:

float   $value  

[ Top ]

static method FISHERINV [line 3739]

static float FISHERINV( float $value)

FISHERINV

Returns the inverse of the Fisher transformation. Use this transformation when analyzing correlations between ranges or arrays of data. If y = FISHER(x), then FISHERINV(y) = x.




Tags:

access:  public


Parameters:

float   $value  

[ Top ]

static method FIXEDFORMAT [line 5454]

static boolean FIXEDFORMAT( mixed $value, [ $decimals = 2], [ $no_commas = false])

FIXEDFORMAT



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $decimals  
   $no_commas  

[ Top ]

static method flattenArray [line 11823]

static array flattenArray( array $array)

Convert a multi-dimensional array to a simple 1-dimensional array



Tags:

return:  Flattened array
access:  public


Parameters:

array   $array   Array to be flattened

[ Top ]

static method flattenArrayIndexed [line 11855]

static array flattenArrayIndexed( array $array)

Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing



Tags:

return:  Flattened array
access:  public


Parameters:

array   $array   Array to be flattened

[ Top ]

static method flattenSingleValue [line 11887]

static mixed flattenSingleValue( [mixed $value = ''])

Convert an array to a single scalar value by extracting the first element



Tags:

access:  public


Parameters:

mixed   $value   Array or scalar value

[ Top ]

static method FLOOR [line 3121]

static float FLOOR( float $number, [float $significance = null])

FLOOR

Rounds number down, toward zero, to the nearest multiple of significance.




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round
float   $significance   Significance

[ Top ]

static method FORECAST [line 2630]

static float FORECAST( float $xValue, array $yValues, array $xValues)

FORECAST

Calculates, or predicts, a future value by using existing values. The predicted value is a y-value for a given x-value.




Tags:

access:  public


Parameters:

float   $xValue   Value of X for which we want to find Y
array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method FV [line 9234]

static float FV( [float $rate = 0], [int $nper = 0], [float $pmt = 0], [float $pv = 0], [int $type = 0])

FV

Returns the Future Value of a cash flow with constant payments and interest rate (annuities).




Tags:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $nper   Number of periods
float   $pmt   Periodic payment (annuity)
float   $pv   Present Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period

[ Top ]

static method FVSCHEDULE [line 9259]

static void FVSCHEDULE( $principal, $schedule)

FVSCHEDULE



Tags:

access:  public


Parameters:

   $principal  
   $schedule  

[ Top ]

static method GAMMADIST [line 4224]

static float GAMMADIST( float $value, float $a, float $b, boolean $cumulative)

GAMMADIST

Returns the gamma distribution.




Tags:

access:  public


Parameters:

float   $value   Value at which you want to evaluate the distribution
float   $a   Parameter to the distribution
float   $b   Parameter to the distribution
boolean   $cumulative  

[ Top ]

static method GAMMAINV [line 4256]

static float GAMMAINV( float $probability, float $alpha, float $beta)

GAMMAINV

Returns the inverse of the beta distribution.




Tags:

access:  public


Parameters:

float   $probability   Probability at which you want to evaluate the distribution
float   $alpha   Parameter to the distribution
float   $beta   Parameter to the distribution

[ Top ]

static method GAMMALN [line 4314]

static float GAMMALN( float $value)

GAMMALN

Returns the natural logarithm of the gamma function.




Tags:

access:  public


Parameters:

float   $value  

[ Top ]

static method GCD [line 3340]

static int GCD( $array 0)

GCD

Returns the greatest common divisor of a series of numbers




Tags:

return:  Greatest Common Divisor
access:  public


Parameters:

$array   0   Values to calculate the Greatest Common Divisor

[ Top ]

static method GEOMEAN [line 1741]

static float GEOMEAN( mixed $arg,...)

GEOMEAN

Returns the geometric mean of an array or range of positive data. For example, you can use GEOMEAN to calculate average growth rate given compound interest with variable rates.

Excel Function: GEOMEAN(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method GESTEP [line 8860]

static int GESTEP( float $number, [float $step = 0])

GESTEP

Returns 1 if number = step; returns 0 (zero) otherwise




Tags:

access:  public


Parameters:

float   $number  
float   $step  

[ Top ]

static method getCompatibilityMode [line 173]

static string getCompatibilityMode( )

Return the current Compatibility Mode



Tags:

return:  Compatibility Mode Possible Return values are: PHPExcel_Calculation_Functions::COMPATIBILITY_EXCEL 'Excel' PHPExcel_Calculation_Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' PHPExcel_Calculation_Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'
access:  public


[ Top ]

static method getConversionGroups [line 8452]

static array getConversionGroups( )

getConversionGroups



Tags:

access:  public


[ Top ]

static method getConversionGroupUnitDetails [line 8482]

static array getConversionGroupUnitDetails( [ $group = NULL])

getConversionGroupUnitDetails



Tags:

access:  public


Parameters:

   $group  

[ Top ]

static method getConversionGroupUnits [line 8466]

static array getConversionGroupUnits( [ $group = NULL])

getConversionGroupUnits



Tags:

access:  public


Parameters:

   $group  

[ Top ]

static method getConversionMultipliers [line 8500]

static array getConversionMultipliers( )

getConversionGroups



Tags:

access:  public


[ Top ]

static method getReturnDateType [line 212]

static string getReturnDateType( )

Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object)



Tags:

return:  Return Date Format Possible Return values are: PHPExcel_Calculation_Functions::RETURNDATE_PHP_NUMERIC 'P' PHPExcel_Calculation_Functions::RETURNDATE_PHP_OBJECT 'O' PHPExcel_Calculation_Functions::RETURNDATE_EXCEL 'E'
access:  public


[ Top ]

static method GROWTH [line 2695]

static array GROWTH( array $yValues, [array $xValues = array()], [array $newValues = array()], [boolean $const = True])

GROWTH

Returns values along a predicted emponential trend




Tags:

return:  of float
access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X
array   $newValues   of mixed Values of X for which we want to find Y
boolean   $const   A logical value specifying whether to force the intersect to equal 0.

[ Top ]

static method HARMEAN [line 1769]

static float HARMEAN( mixed $arg,...)

HARMEAN

Returns the harmonic mean of a data set. The harmonic mean is the reciprocal of the arithmetic mean of reciprocals.

Excel Function: HARMEAN(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method HEXTOBIN [line 7093]

static string HEXTOBIN( string $x, [ $places = null])

HEXTOBIN

Return a hex value as binary.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method HEXTODEC [line 7143]

static string HEXTODEC( string $x)

HEXTODEC

Return a hex value as octal.




Tags:

access:  public


Parameters:

string   $x  

[ Top ]

static method HEXTOOCT [line 7118]

static string HEXTOOCT( string $x, [ $places = null])

HEXTOOCT

Return a hex value as octal.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method HOUROFDAY [line 6608]

static int HOUROFDAY( [mixed $timeValue = 0])

HOUROFDAY



Tags:

return:  Hour
access:  public


Parameters:

mixed   $timeValue   Excel time serial value or a standard time string

[ Top ]

static method HYPERLINK [line 574]

static mixed HYPERLINK( [string $linkURL = ''], [string $displayName = null], [ $pCell = null])

HYPERLINK

Excel Function: =HYPERLINK(linkURL,displayName)




Tags:

return:  The value of errorpart or testValue determined by error condition
access:  public


Parameters:

string   $linkURL   Value to check, is also the value returned when no error
string   $displayName   Value to return when testValue is an error condition
PHPExcel_Cell   $pCell  

[ Top ]

static method HYPGEOMDIST [line 4705]

static float HYPGEOMDIST( float $sampleSuccesses, float $sampleNumber, float $populationSuccesses, float $populationNumber)

HYPGEOMDIST

Returns the hypergeometric distribution. HYPGEOMDIST returns the probability of a given number of sample successes, given the sample size, population successes, and population size.




Tags:

access:  public


Parameters:

float   $sampleSuccesses   Number of successes in the sample
float   $sampleNumber   Size of the sample
float   $populationSuccesses   Number of successes in the population
float   $populationNumber   Population size

[ Top ]

static method IMABS [line 7374]

static real IMABS( string $complexNumber)

IMABS

Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMAGINARY [line 7336]

static real IMAGINARY( string $complexNumber)

IMAGINARY

Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMARGUMENT [line 7393]

static string IMARGUMENT( string $complexNumber)

IMARGUMENT

Returns the argument theta of a complex number, i.e. the angle in radians from the real axis to the representation of the number in polar coordinates.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMCONJUGATE [line 7427]

static string IMCONJUGATE( string $complexNumber)

IMCONJUGATE

Returns the complex conjugate of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMCOS [line 7452]

static string IMCOS( string $complexNumber)

IMCOS

Returns the cosine of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMDIV [line 7679]

static real IMDIV( string $complexDividend, string $complexDivisor)

IMDIV

Returns the quotient of two complex numbers in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexDividend  
string   $complexDivisor  

[ Top ]

static method IMEXP [line 7612]

static string IMEXP( string $complexNumber)

IMEXP

Returns the exponential of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMLN [line 7529]

static string IMLN( string $complexNumber)

IMLN

Returns the natural logarithm of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMLOG2 [line 7586]

static string IMLOG2( string $complexNumber)

IMLOG2

Returns the common logarithm (base 10) of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMLOG10 [line 7560]

static string IMLOG10( string $complexNumber)

IMLOG10

Returns the common logarithm (base 10) of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMPOWER [line 7644]

static string IMPOWER( string $complexNumber, $realNumber)

IMPOWER

Returns a complex number in x + yi or x + yj text format raised to a power.




Tags:

access:  public


Parameters:

string   $complexNumber  
   $realNumber  

[ Top ]

static method IMPRODUCT [line 7799]

static real IMPRODUCT( array 0)

IMPRODUCT

Returns the product of two or more complex numbers in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

array   0   of mixed Data Series

[ Top ]

static method IMREAL [line 7355]

static real IMREAL( string $complexNumber)

IMREAL

Returns the real coefficient of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMSIN [line 7476]

static string IMSIN( string $complexNumber)

IMSIN

Returns the sine of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMSQRT [line 7500]

static string IMSQRT( string $complexNumber)

IMSQRT

Returns the square root of a complex number in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber  

[ Top ]

static method IMSUB [line 7727]

static real IMSUB( string $complexNumber1, string $complexNumber2)

IMSUB

Returns the difference of two complex numbers in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

string   $complexNumber1  
string   $complexNumber2  

[ Top ]

static method IMSUM [line 7763]

static real IMSUM( array 0)

IMSUM

Returns the sum of two or more complex numbers in x + yi or x + yj text format.




Tags:

access:  public


Parameters:

array   0   of mixed Data Series

[ Top ]

static method INDEX [line 11252]

static void INDEX( range_array $arrayValues, [row_num $rowNum = 0], [column_num $columnNum = 0])

INDEX

Uses an index to choose a value from a reference or array implemented: Return the value of a specified cell or array of cells Array form not implemented: Return a reference to specified cells Reference form




Tags:

access:  public


Parameters:

range_array   $arrayValues   a range of cells or an array constant
row_num   $rowNum   selects the row in array from which to return a value. If row_num is omitted, column_num is required.
column_num   $columnNum   selects the column in array from which to return a value. If column_num is omitted, row_num is required.

[ Top ]

static method INDIRECT [line 10987]

static integer INDIRECT( [cellAddress $cellAddress = Null], [ $pCell = null])

INDIRECT

Returns the number of rows in an array or reference.




Tags:

access:  public


Parameters:

cellAddress   $cellAddress   An array or array formula, or a reference to a range of cells for which you want the number of rows
PHPExcel_Cell   $pCell  

[ Top ]

static method INTERCEPT [line 2352]

static float INTERCEPT( array $yValues, array $xValues)

INTERCEPT

Calculates the point at which a line will intersect the y-axis by using existing x-values and y-values.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method INTRATE [line 10508]

static float INTRATE( mixed $settlement, mixed $maturity, int $investment, int $redemption, [int $basis = 0])

INTRATE

Returns the interest rate for a fully invested security.




Tags:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
int   $investment   investment The amount invested in the security.
int   $redemption   redemption The amount to be received at maturity.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method INTVALUE [line 3003]

static integer INTVALUE( float $number)

INTVALUE

Casts a floating point value to an integer




Tags:

return:  Integer value
access:  public


Parameters:

float   $number   Number to cast to an integer

[ Top ]

static method IPMT [line 9369]

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:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $per   Period for which we want to find the interest
int   $nper   Number of periods
float   $pv   Present Value
float   $fv   Future Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period

[ Top ]

static method IRR [line 9602]

static void IRR( $values, [ $guess = 0.1])



Tags:

access:  public


Parameters:

   $values  
   $guess  

[ Top ]

static method ISPMT [line 9522]

static void ISPMT( )

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:

access:  public


[ Top ]

static method IS_BLANK [line 5555]

static boolean IS_BLANK( [mixed $value = null])

IS_BLANK



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_ERR [line 5570]

static boolean IS_ERR( [mixed $value = ''])

IS_ERR



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_ERROR [line 5583]

static boolean IS_ERROR( [mixed $value = ''])

IS_ERROR



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_EVEN [line 5609]

static boolean IS_EVEN( [mixed $value = 0])

IS_EVEN



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_LOGICAL [line 5657]

static boolean IS_LOGICAL( [mixed $value = true])

IS_LOGICAL



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_NA [line 5596]

static boolean IS_NA( [mixed $value = ''])

IS_NA



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_NONTEXT [line 5683]

static boolean IS_NONTEXT( [mixed $value = ''])

IS_NONTEXT



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_NUMBER [line 5641]

static boolean IS_NUMBER( [mixed $value = 0])

IS_NUMBER



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_ODD [line 5625]

static boolean IS_ODD( [mixed $value = null])

IS_ODD



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method IS_TEXT [line 5670]

static boolean IS_TEXT( [mixed $value = ''])

IS_TEXT



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method KURT [line 5021]

static float KURT( array 0)

KURT

Returns the kurtosis of a data set. Kurtosis characterizes the relative peakedness or flatness of a distribution compared with the normal distribution. Positive kurtosis indicates a relatively peaked distribution. Negative kurtosis indicates a relatively flat distribution.




Tags:

access:  public


Parameters:

array   0   Data Series

[ Top ]

static method LARGE [line 1097]

static float LARGE( mixed $arg,..., int $entry)

LARGE

Returns the nth largest value in a data set. You can use this function to select a value based on its relative standing.

Excel Function: LARGE(value1[,value2[, ...]],entry)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
int   $entry   Position (ordered from the largest) in the array or range of data to return

[ Top ]

static method LCM [line 3295]

static int LCM( $array 0)

LCM

Returns the lowest common multiplier of a series of numbers




Tags:

return:  Lowest Common Multiplier
access:  public


Parameters:

$array   0   Values to calculate the Lowest Common Multiplier

[ Top ]

static method LEFT [line 5288]

static string LEFT( [string $value = ''], [int $chars = 1])

LEFT



Tags:

access:  public


Parameters:

string   $value   Value
int   $chars   Number of characters

[ Top ]

static method LINEST [line 2520]

static array LINEST( array $yValues, [array $xValues = null], [boolean $const = True], [boolean $stats = False])

LINEST

Calculates the statistics for a line by using the "least squares" method to calculate a straight line that best fits your data, and then returns an array that describes the line.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X
boolean   $const   A logical value specifying whether to force the intersect to equal 0.
boolean   $stats   A logical value specifying whether to return additional regression statistics.

[ Top ]

static method LOGEST [line 2573]

static array LOGEST( array $yValues, [array $xValues = null], [boolean $const = True], [boolean $stats = False])

LOGEST

Calculates an exponential curve that best fits the X and Y data series, and then returns an array that describes the line.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X
boolean   $const   A logical value specifying whether to force the intersect to equal 0.
boolean   $stats   A logical value specifying whether to return additional regression statistics.

[ Top ]

static method LOGICAL_AND [line 339]

static boolean LOGICAL_AND( mixed $arg,...)

LOGICAL_AND

Returns boolean TRUE if all its arguments are TRUE; returns FALSE if one or more argument is FALSE.

Excel Function: =AND(logical1[,logical2[, ...]])

The arguments must evaluate to logical values such as TRUE or FALSE, or the arguments must be arrays or references that contain logical values.

Boolean arguments are treated as True or False as appropriate Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value




Tags:

return:  The logical AND of the arguments.
access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method LOGICAL_FALSE [line 442]

static boolean LOGICAL_FALSE( )

LOGICAL_FALSE

Returns the boolean FALSE.

Excel Function: =FALSE()




Tags:

return:  False
access:  public


[ Top ]

static method LOGICAL_NOT [line 484]

static boolean LOGICAL_NOT( mixed $logical)

LOGICAL_NOT

Returns the boolean inverse of the argument.

Excel Function: =NOT(logical)

The argument must evaluate to a logical value such as TRUE or FALSE

Boolean arguments are treated as True or False as appropriate Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value




Tags:

return:  The boolean inverse of the argument.
access:  public


Parameters:

mixed   $logical   A value or expression that can be evaluated to TRUE or FALSE

[ Top ]

static method LOGICAL_OR [line 395]

static boolean LOGICAL_OR( mixed $arg,...)

LOGICAL_OR

Returns boolean TRUE if any argument is TRUE; returns FALSE if all arguments are FALSE.

Excel Function: =OR(logical1[,logical2[, ...]])

The arguments must evaluate to logical values such as TRUE or FALSE, or the arguments must be arrays or references that contain logical values.

Boolean arguments are treated as True or False as appropriate Integer or floating point arguments are treated as True, except for 0 or 0.0 which are False If any argument value is a string, or a Null, the function returns a #VALUE! error, unless the string holds the value TRUE or FALSE, in which case it is evaluated as the corresponding boolean value




Tags:

return:  The logical OR of the arguments.
access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method LOGICAL_TRUE [line 459]

static boolean LOGICAL_TRUE( )

LOGICAL_TRUE

Returns the boolean TRUE.

Excel Function: =TRUE()




Tags:

return:  True
access:  public


[ Top ]

static method LOGINV [line 4677]

static float LOGINV( $probability, $mean, $stdDev, float $value)

LOGINV

Returns the inverse of the normal cumulative distribution




Tags:

todo:  Try implementing P J Acklam's refinement algorithm for greater accuracy if I can get my head round the mathematics (as described at) http://home.online.no/~pjacklam/notes/invnorm/
access:  public


Parameters:

float   $value  
   $probability  
   $mean  
   $stdDev  

[ Top ]

static method LOGNORMDIST [line 4388]

static float LOGNORMDIST( float $value, $mean, $stdDev)

LOGNORMDIST

Returns the cumulative lognormal distribution of x, where ln(x) is normally distributed with parameters mean and standard_dev.




Tags:

access:  public


Parameters:

float   $value  
   $mean  
   $stdDev  

[ Top ]

static method LOG_BASE [line 643]

static float LOG_BASE( $number, [float $base = 10], float $value)

LOG_BASE

Returns the logarithm of a number to a specified base. The default base is 10.

Excel Function: LOG(number[,base])




Tags:

access:  public


Parameters:

float   $value   The positive real number for which you want the logarithm
float   $base   The base of the logarithm. If base is omitted, it is assumed to be 10.
   $number  

[ Top ]

static method LOOKUP [line 11757]

static mixed LOOKUP( lookup_value $lookup_value, lookup_vector $lookup_vector, [result_vector $result_vector = null])

LOOKUP The LOOKUP function searches for value either from a one-row or one-column range or from an array.



Tags:

return:  The value of the found cell
access:  public


Parameters:

lookup_value   $lookup_value   The value that you want to match in lookup_array
lookup_vector   $lookup_vector   The range of cells being searched
result_vector   $result_vector   The column from which the matching value must be returned

[ Top ]

static method LOWERCASE [line 8988]

static string LOWERCASE( string $mixedCaseString)

LOWERCASE

Converts a string value to upper case.




Tags:

access:  public


Parameters:

string   $mixedCaseString  

[ Top ]

static method MATCH [line 11141]

static integer MATCH( lookup_value $lookup_value, lookup_array $lookup_array, [match_type $match_type = 1])

MATCH

The MATCH function searches for a specified item in a range of cells




Tags:

return:  The relative position of the found item
access:  public


Parameters:

lookup_value   $lookup_value   The value that you want to match in lookup_array
lookup_array   $lookup_array   The range of cells being searched
match_type   $match_type   The number -1, 0, or 1. -1 means above, 0 means exact match, 1 means below. If match_type is 1 or -1, the list has to be ordered.

[ Top ]

static method MAX [line 964]

static float MAX( mixed $arg,...)

MAX

MAX returns the value of the element of the values passed that has the highest value, with negative numbers considered smaller than positive numbers.

Excel Function: MAX(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method MAXA [line 1000]

static float MAXA( mixed $arg,...)

MAXA

Returns the greatest value in a list of arguments, including numbers, text, and logical values

Excel Function: MAXA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method MAXIF [line 1055]

static float MAXIF( $aArgs, string $condition, [ $sumArgs = array()], mixed $arg,...)

MAXIF

Counts the maximum value within a range of cells that contain numbers within the list of arguments

Excel Function: MAXIF(value1[,value2[, ...]],condition)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
string   $condition   The criteria that defines which cells will be checked.
   $aArgs  
   $sumArgs  

[ Top ]

static method MDETERM [line 11532]

static float MDETERM( array $matrixValues)

MDETERM



Tags:

access:  public


Parameters:

array   $matrixValues   A matrix of values

[ Top ]

static method MEDIAN [line 1526]

static float MEDIAN( mixed $arg,...)

MEDIAN

Returns the median of the given numbers. The median is the number in the middle of a set of numbers.

Excel Function: MEDIAN(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method MID [line 5343]

static string MID( [string $value = ''], [int $start = 1], [int $chars = null])

MID



Tags:

access:  public


Parameters:

string   $value   Value
int   $start   Start character
int   $chars   Number of characters

[ Top ]

static method MIN [line 805]

static float MIN( mixed $arg,...)

MIN

MIN returns the value of the element of the values passed that has the smallest value, with negative numbers considered smaller than positive numbers.

Excel Function: MIN(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method MINA [line 841]

static float MINA( mixed $arg,...)

MINA

Returns the smallest value in a list of arguments, including numbers, text, and logical values

Excel Function: MINA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method MINIF [line 883]

static float MINIF( $aArgs, string $condition, [ $sumArgs = array()], mixed $arg,...)

MINIF

Returns the minimum value within a range of cells that contain numbers within the list of arguments

Excel Function: MINIF(value1[,value2[, ...]],condition)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
string   $condition   The criteria that defines which cells will be checked.
   $aArgs  
   $sumArgs  

[ Top ]

static method MINUTEOFHOUR [line 6641]

static int MINUTEOFHOUR( [long $timeValue = 0])

MINUTEOFHOUR



Tags:

return:  Minute
access:  public


Parameters:

long   $timeValue   Excel time serial value or a standard time string

[ Top ]

static method MINVERSE [line 11498]

static array MINVERSE( array $matrixValues)

MINVERSE



Tags:

access:  public


Parameters:

array   $matrixValues   A matrix of values

[ Top ]

static method MIRR [line 9642]

static void MIRR( $values, $finance_rate, $reinvestment_rate)



Tags:

access:  public


Parameters:

   $values  
   $finance_rate  
   $reinvestment_rate  

[ Top ]

static method MMULT [line 11448]

static array MMULT( array $matrixData1, array $matrixData2)

MMULT



Tags:

access:  public


Parameters:

array   $matrixData1   A matrix of values
array   $matrixData2   A matrix of values

[ Top ]

static method MOD [line 5076]

static int MOD( [int $a = 1], [int $b = 1])

MOD



Tags:

return:  Remainder
access:  public


Parameters:

int   $a   Dividend
int   $b   Divisor

[ Top ]

static method MODE [line 1604]

static float MODE( mixed $arg,...)

MODE

Returns the most frequently occurring, or repetitive, value in an array or range of data

Excel Function: MODE(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method MONTHOFYEAR [line 6564]

static int MONTHOFYEAR( [long $dateValue = 1])

MONTHOFYEAR



Tags:

return:  Month
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string

[ Top ]

static method MROUND [line 3072]

static float MROUND( float $number, int $multiple)

MROUND

Rounds a number to the nearest multiple of a specified value




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round
int   $multiple   Multiple to which you want to round $number

[ Top ]

static method MULTINOMIAL [line 2892]

static float MULTINOMIAL( array 0)

MULTINOMIAL

Returns the ratio of the factorial of a sum of values to the product of factorials.




Tags:

access:  public


Parameters:

array   0   of mixed Data Series

[ Top ]

static method N [line 11313]

static number N( value $value)

N

Returns a value converted to a number




Tags:

return:  N converts values listed in the following table If value is or refers to N returns A number That number A date The serial number of that date TRUE 1 FALSE 0 An error value The error value Anything else 0
access:  public


Parameters:

value   $value   The value you want converted

[ Top ]

static method NA [line 242]

static string NA( )

NA

Excel Function: =NA()

Returns the error value #N/A #N/A is the error value that means "no value is available."




Tags:

return:  #N/A!
access:  public


[ Top ]

static method NAME [line 270]

static string NAME( )

NAME

Returns the error value #NAME?




Tags:

return:  #NAME?
access:  public


[ Top ]

static method NaN [line 256]

static string NaN( )

NAN

Returns the error value #NUM!




Tags:

return:  #NUM!
access:  public


[ Top ]

static method NEGBINOMDIST [line 3455]

static float NEGBINOMDIST( float $failures, float $successes, float $probability)

NEGBINOMDIST

Returns the negative binomial distribution. NEGBINOMDIST returns the probability that there will be number_f failures before the number_s-th success, when the constant probability of a success is probability_s. This function is similar to the binomial distribution, except that the number of successes is fixed, and the number of trials is variable. Like the binomial, trials are assumed to be independent.




Tags:

access:  public


Parameters:

float   $failures   Number of Failures
float   $successes   Threshold number of Successes
float   $probability   Probability of success on each trial

[ Top ]

static method NETWORKDAYS [line 6297]

static long NETWORKDAYS( mixed $startDate, mixed $endDate, array 2)

NETWORKDAYS



Tags:

return:  Interval between the dates
access:  public


Parameters:

array   2   of mixed Optional Date Series
mixed   $startDate   Start date
mixed   $endDate   End date

[ Top ]

static method NOMINAL [line 9175]

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:

access:  public


Parameters:

float   $effect_rate   Effective interest rate
int   $npery   Number of compounding payments per year

[ Top ]

static method NORMDIST [line 4341]

static float NORMDIST( float $value, float $mean, float $stdDev, boolean $cumulative)

NORMDIST

Returns the normal distribution for the specified mean and standard deviation. This function has a very wide range of applications in statistics, including hypothesis testing.




Tags:

access:  public


Parameters:

float   $value  
float   $mean   Mean Value
float   $stdDev   Standard Deviation
boolean   $cumulative  

[ Top ]

static method NORMINV [line 4634]

static float NORMINV( $probability, float $mean, float $stdDev, float $value)

NORMINV

Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.




Tags:

access:  public


Parameters:

float   $value  
float   $mean   Mean Value
float   $stdDev   Standard Deviation
   $probability  

[ Top ]

static method NORMSDIST [line 4372]

static float NORMSDIST( float $value)

NORMSDIST

Returns the standard normal cumulative distribution function. The distribution has a mean of 0 (zero) and a standard deviation of one. Use this function in place of a table of standard normal curve areas.




Tags:

access:  public


Parameters:

float   $value  

[ Top ]

static method NORMSINV [line 4660]

static float NORMSINV( float $value)

NORMSINV

Returns the inverse of the standard normal cumulative distribution




Tags:

access:  public


Parameters:

float   $value  

[ Top ]

static method NPER [line 9316]

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:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $pmt   Periodic payment (annuity)
float   $pv   Present Value
float   $fv   Future Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period

[ Top ]

static method NPV [line 9556]

static float NPV( float 0, array 1)

NPV

Returns the Net Present Value of a cash flow series given a discount rate.




Tags:

access:  public


Parameters:

float   0   Discount interest rate
array   1   Cash flow series

[ Top ]

static method OCTTOBIN [line 7165]

static string OCTTOBIN( string $x, [ $places = null])

OCTTOBIN

Return an octal value as binary.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method OCTTODEC [line 7190]

static string OCTTODEC( string $x)

OCTTODEC

Return an octal value as binary.




Tags:

access:  public


Parameters:

string   $x  

[ Top ]

static method OCTTOHEX [line 7212]

static string OCTTOHEX( string $x, [ $places = null])

OCTTOHEX

Return an octal value as hex.




Tags:

access:  public


Parameters:

string   $x  
   $places  

[ Top ]

static method ODD [line 2977]

static int ODD( float $number)

ODD

Returns number rounded up to the nearest odd integer.




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round

[ Top ]

static method OFFSET [line 11037]

static string OFFSET( [cellAddress $cellAddress = Null], [rows $rows = 0], [cols $columns = 0], [height $height = null], [width $width = null])

OFFSET

Returns a reference to a range that is a specified number of rows and columns from a cell or range of cells. The reference that is returned can be a single cell or a range of cells. You can specify the number of rows and the number of columns to be returned.




Tags:

return:  A reference to a cell or range of cells
access:  public


Parameters:

cellAddress   $cellAddress   The reference from which you want to base the offset. Reference must refer to a cell or range of adjacent cells; otherwise, OFFSET returns the #VALUE! error value.
rows   $rows   The number of rows, up or down, that you want the upper-left cell to refer to. Using 5 as the rows argument specifies that the upper-left cell in the reference is five rows below reference. Rows can be positive (which means below the starting reference) or negative (which means above the starting reference).
cols   $columns   The number of columns, to the left or right, that you want the upper-left cell of the result to refer to. Using 5 as the cols argument specifies that the upper-left cell in the reference is five columns to the right of reference. Cols can be positive (which means to the right of the starting reference) or negative (which means to the left of the starting reference).
height   $height   The height, in number of rows, that you want the returned reference to be. Height must be a positive number.
width   $width   The width, in number of columns, that you want the returned reference to be. Width must be a positive number.

[ Top ]

static method PERCENTILE [line 1137]

static float PERCENTILE( mixed $arg,..., float $entry)

PERCENTILE

Returns the nth percentile of values in a range..

Excel Function: PERCENTILE(value1[,value2[, ...]],entry)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
float   $entry   Percentile value in the range 0..1, inclusive.

[ Top ]

static method PERCENTRANK [line 2282]

static float PERCENTRANK( array $valueSet, number $value, [number $significance = 3])

PERCENTRANK

Returns the rank of a value in a data set as a percentage of the data set.




Tags:

access:  public


Parameters:

array   $valueSet   of number An array of, or a reference to, a list of numbers.
number   $value   The number whose rank you want to find.
number   $significance   The number of significant digits for the returned percentage value.

[ Top ]

static method PERMUT [line 3156]

static int PERMUT( int $numObjs, int $numInSet)

PERMUT

Returns the number of permutations for a given number of objects that can be selected from number objects. A permutation is any set or subset of objects or events where internal order is significant. Permutations are different from combinations, for which the internal order is not significant. Use this function for lottery-style probability calculations.




Tags:

return:  Number of permutations
access:  public


Parameters:

int   $numObjs   Number of different objects
int   $numInSet   Number of objects in each permutation

[ Top ]

static method PMT [line 9283]

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:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $nper   Number of periods
float   $pv   Present Value
float   $fv   Future Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period

[ Top ]

static method POISSON [line 4887]

static float POISSON( float $value, float $mean, boolean $cumulative)

POISSON

Returns the Poisson distribution. A common application of the Poisson distribution is predicting the number of events over a specific time, such as the number of cars arriving at a toll plaza in 1 minute.




Tags:

access:  public


Parameters:

float   $value  
float   $mean   Mean Value
boolean   $cumulative  

[ Top ]

static method POWER [line 6842]

static float POWER( [float $x = 0], [float $y = 2])

POWER

Computes x raised to the power y.




Tags:

access:  public


Parameters:

float   $x  
float   $y  

[ Top ]

static method PPMT [line 9444]

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:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $per   Period for which we want to find the interest
int   $nper   Number of periods
float   $pv   Present Value
float   $fv   Future Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period

[ Top ]

static method PRICE [line 10261]

static void PRICE( $settlement, $maturity, $rate, $yield, $redemption, $frequency, [ $basis = 0])



Tags:

access:  public


Parameters:

   $settlement  
   $maturity  
   $rate  
   $yield  
   $redemption  
   $frequency  
   $basis  

[ Top ]

static method PRICEDISC [line 10363]

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:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
int   $discount   discount The security's discount rate.
int   $redemption   redemption The security's redemption value per $100 face value.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method PRICEMAT [line 10406]

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:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security's settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
mixed   $issue   issue The security's issue date.
int   $rate   rate The security's interest rate at date of issue.
int   $yield   yield The security's annual yield.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method PRODUCT [line 726]

static float PRODUCT( mixed $arg,...)

PRODUCT

PRODUCT returns the product of all the values and cells referenced in the argument list.

Excel Function: PRODUCT(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method PROPERCASE [line 9034]

static string PROPERCASE( string $mixedCaseString)

PROPERCASE

Converts a string value to upper case.




Tags:

access:  public


Parameters:

string   $mixedCaseString  

[ Top ]

static method PV [line 9201]

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:

access:  public


Parameters:

float   $rate   Interest rate per period
int   $nper   Number of periods
float   $pmt   Periodic payment (annuity)
float   $fv   Future Value
int   $type   Payment type: 0 = at the end of each period, 1 = at the beginning of each period

[ Top ]

static method QUARTILE [line 1187]

static float QUARTILE( mixed $arg,..., int $entry)

QUARTILE

Returns the quartile of a data set.

Excel Function: QUARTILE(value1[,value2[, ...]],entry)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
int   $entry   Quartile value in the range 1..3, inclusive.

[ Top ]

static method QUOTIENT [line 765]

static float QUOTIENT( mixed $arg,...)

QUOTIENT

QUOTIENT function returns the integer portion of a division. Numerator is the divided number and denominator is the divisor.

Excel Function: QUOTIENT(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method RAND [line 5057]

static int RAND( [int $min = 0], [int $max = 0])

RAND



Tags:

return:  Random number
access:  public


Parameters:

int   $min   Minimal value
int   $max   Maximal value

[ Top ]

static method RANK [line 2247]

static float RANK( number $value, array $valueSet, [mixed $order = 0])

RANK

Returns the rank of a number in a list of numbers.




Tags:

access:  public


Parameters:

number   $value   The number whose rank you want to find.
array   $valueSet   of number An array of, or a reference to, a list of numbers.
mixed   $order   Order to sort the values in the value set

[ Top ]

static method RATE [line 9718]

static void RATE( $nper, $pmt, $pv, [ $fv = 0.0], [ $type = 0], [ $guess = 0.1])

RATE



Tags:

access:  public


Parameters:

   $nper  
   $pmt  
   $pv  
   $fv  
   $type  
   $guess  

[ Top ]

static method RECEIVED [line 10466]

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:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
int   $investment   investment The amount invested in the security.
int   $discount   discount The security's discount rate.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method REF [line 284]

static string REF( )

REF

Returns the error value #REF!




Tags:

return:  #REF!
access:  public


[ Top ]

static method REPLACE [line 5372]

static string REPLACE( [ $oldText = ''], [int $start = 1], [int $chars = null], $newText, string $value)

REPLACE



Tags:

access:  public


Parameters:

string   $value   Value
int   $start   Start character
int   $chars   Number of characters
   $oldText  
   $newText  

[ Top ]

static method RETURNSTRING [line 5438]

static boolean RETURNSTRING( [ $testValue = ''], mixed $value)

RETURNSTRING



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $testValue  

[ Top ]

static method REVERSE_ATAN2 [line 617]

static float REVERSE_ATAN2( float $xCoordinate, float $yCoordinate)

ATAN2

This function calculates the arc tangent of the two variables x and y. It is similar to calculating the arc tangent of y x, except that the signs of both arguments are used to determine the quadrant of the result. The arctangent is the angle from the x-axis to a line containing the origin (0, 0) and a point with coordinates (xCoordinate, yCoordinate). The angle is given in radians between -pi and pi, excluding -pi.

Note that the Excel ATAN2() function accepts its arguments in the reverse order to the standard PHP atan2() function, so we need to reverse them here before calling the PHP atan() function.

Excel Function: ATAN2(xCoordinate,yCoordinate)




Tags:

return:  The inverse tangent of the specified x- and y-coordinates.
access:  public


Parameters:

float   $xCoordinate   The x-coordinate of the point.
float   $yCoordinate   The y-coordinate of the point.

[ Top ]

static method RIGHT [line 5315]

static string RIGHT( [string $value = ''], [int $chars = 1])

RIGHT



Tags:

access:  public


Parameters:

string   $value   Value
int   $chars   Number of characters

[ Top ]

static method ROMAN [line 2720]

static void ROMAN( $aValue, [ $style = 0])



Tags:

access:  public


Parameters:

   $aValue  
   $style  

[ Top ]

static method ROUNDDOWN [line 3047]

static float ROUNDDOWN( float $number, int $digits)

ROUNDDOWN

Rounds a number down to a specified number of decimal places




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round
int   $digits   Number of digits to which you want to round $number

[ Top ]

static method ROUNDUP [line 3022]

static float ROUNDUP( float $number, int $digits)

ROUNDUP

Rounds a number up to a specified number of decimal places




Tags:

return:  Rounded Number
access:  public


Parameters:

float   $number   Number to round
int   $digits   Number of digits to which you want to round $number

[ Top ]

static method ROW [line 10922]

static integer ROW( [cellAddress $cellAddress = Null])

ROW

Returns the row number of the given cell reference If the cell reference is a range of cells, ROW returns the row numbers of each row in the reference as a vertical array. If cell reference is omitted, and the function is being called through the calculation engine, then it is assumed to be the reference of the cell in which the ROW function appears; otherwise this function returns 0.




Tags:

return:  or array of integer
access:  public


Parameters:

cellAddress   $cellAddress   A reference to a range of cells for which you want the row numbers

[ Top ]

static method ROWS [line 10960]

static integer ROWS( [cellAddress $cellAddress = Null])

ROWS

Returns the number of rows in an array or reference.




Tags:

access:  public


Parameters:

cellAddress   $cellAddress   An array or array formula, or a reference to a range of cells for which you want the number of rows

[ Top ]

static method RSQ [line 2379]

static float RSQ( array $yValues, array $xValues)

RSQ

Returns the square of the Pearson product moment correlation coefficient through data points in known_y's and known_x's.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method SEARCHINSENSITIVE [line 5256]

static string SEARCHINSENSITIVE( string $needle, string $haystack, [int $offset = 1])

SEARCHINSENSITIVE



Tags:

access:  public


Parameters:

string   $needle   The string to look for
string   $haystack   The string in which to look
int   $offset   Offset within $haystack

[ Top ]

static method SEARCHSENSITIVE [line 5223]

static string SEARCHSENSITIVE( string $needle, string $haystack, [int $offset = 1])

SEARCHSENSITIVE



Tags:

access:  public


Parameters:

string   $needle   The string to look for
string   $haystack   The string in which to look
int   $offset   Offset within $haystack

[ Top ]

static method SECONDOFMINUTE [line 6674]

static int SECONDOFMINUTE( [long $timeValue = 0])

SECONDOFMINUTE



Tags:

return:  Second
access:  public


Parameters:

long   $timeValue   Excel time serial value or a standard time string

[ Top ]

static method SERIESSUM [line 3208]

static float SERIESSUM( float $x, float $n, float $m, array 3)

SERIESSUM

Returns the sum of a power series




Tags:

access:  public


Parameters:

float   $x   Input value to the power series
float   $n   Initial power to which you want to raise $x
float   $m   Step by which to increase $n for each term in the series
array   3   of mixed Data Series

[ Top ]

static method setCompatibilityMode [line 151]

static boolean setCompatibilityMode( string $compatibilityMode)

Set the Compatibility Mode



Tags:

return:  (Success or Failure)
access:  public


Parameters:

string   $compatibilityMode   Compatibility Mode Permitted values are: PHPExcel_Calculation_Functions::COMPATIBILITY_EXCEL 'Excel' PHPExcel_Calculation_Functions::COMPATIBILITY_GNUMERIC 'Gnumeric' PHPExcel_Calculation_Functions::COMPATIBILITY_OPENOFFICE 'OpenOfficeCalc'

[ Top ]

static method setReturnDateType [line 190]

static boolean setReturnDateType( string $returnDateType)

Set the Return Date Format used by functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object)



Tags:

return:  Success or failure
access:  public


Parameters:

string   $returnDateType   Return Date Format Permitted values are: PHPExcel_Calculation_Functions::RETURNDATE_PHP_NUMERIC 'P' PHPExcel_Calculation_Functions::RETURNDATE_PHP_OBJECT 'O' PHPExcel_Calculation_Functions::RETURNDATE_EXCEL 'E'

[ Top ]

static method SIGN [line 3099]

static int SIGN( float $number)

SIGN

Determines the sign of a number. Returns 1 if the number is positive, zero (0) if the number is 0, and -1 if the number is negative.




Tags:

return:  sign value
access:  public


Parameters:

float   $number   Number to round

[ Top ]

static method SKEW [line 4983]

static float SKEW( array 0)

SKEW

Returns the skewness of a distribution. Skewness characterizes the degree of asymmetry of a distribution around its mean. Positive skewness indicates a distribution with an asymmetric tail extending toward more positive values. Negative skewness indicates a distribution with an asymmetric tail extending toward more negative values.




Tags:

access:  public


Parameters:

array   0   Data Series

[ Top ]

static method SLN [line 10673]

static float SLN( cost $cost, salvage $salvage, life $life)

SLN

Returns the straight-line depreciation of an asset for one period




Tags:

access:  public


Parameters:

cost   $cost   Initial cost of the asset
salvage   $salvage   Value at the end of the depreciation
life   $life   Number of periods over which the asset is depreciated

[ Top ]

static method SLOPE [line 2406]

static float SLOPE( array $yValues, array $xValues)

SLOPE

Returns the slope of the linear regression line through data points in known_y's and known_x's.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method SMALL [line 924]

static float SMALL( mixed $arg,..., int $entry)

SMALL

Returns the nth smallest value in a data set. You can use this function to select a value based on its relative standing.

Excel Function: SMALL(value1[,value2[, ...]],entry)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
int   $entry   Position (ordered from the smallest) in the array or range of data to return

[ Top ]

static method SQRTPI [line 2813]

static float SQRTPI( float $number)

SQRTPI

Returns the square root of (number * pi).




Tags:

return:  Square Root of Number * Pi
access:  public


Parameters:

float   $number   Number

[ Top ]

static method STANDARDIZE [line 3247]

static float STANDARDIZE( float $value, float $mean, float $stdDev)

STANDARDIZE

Returns a normalized value from a distribution characterized by mean and standard_dev.




Tags:

return:  Standardized value
access:  public


Parameters:

float   $value   Value to normalize
float   $mean   Mean Value
float   $stdDev   Standard Deviation

[ Top ]

static method STATEMENT_IF [line 533]

static mixed STATEMENT_IF( [mixed $condition = true], [mixed $returnIfTrue = 0], [mixed $returnIfFalse = False])

STATEMENT_IF

Returns one value if a condition you specify evaluates to TRUE and another value if it evaluates to FALSE.

Excel Function: =IF(condition[,returnIfTrue[,returnIfFalse]])

Condition is any value or expression that can be evaluated to TRUE or FALSE. For example, A10=100 is a logical expression; if the value in cell A10 is equal to 100, the expression evaluates to TRUE. Otherwise, the expression evaluates to FALSE. This argument can use any comparison calculation operator. ReturnIfTrue is the value that is returned if condition evaluates to TRUE. For example, if this argument is the text string "Within budget" and the condition argument evaluates to TRUE, then the IF function returns the text "Within budget" If condition is TRUE and ReturnIfTrue is blank, this argument returns 0 (zero). To display the word TRUE, use the logical value TRUE for this argument. ReturnIfTrue can be another formula. ReturnIfFalse is the value that is returned if condition evaluates to FALSE. For example, if this argument is the text string "Over budget" and the condition argument evaluates to FALSE, then the IF function returns the text "Over budget". If condition is FALSE and ReturnIfFalse is omitted, then the logical value FALSE is returned. If condition is FALSE and ReturnIfFalse is blank, then the value 0 (zero) is returned. ReturnIfFalse can be another formula.




Tags:

return:  The value of returnIfTrue or returnIfFalse determined by condition
access:  public


Parameters:

mixed   $condition   Condition to evaluate
mixed   $returnIfTrue   Value to return when condition is true
mixed   $returnIfFalse   Optional value to return when condition is false

[ Top ]

static method STATEMENT_IFERROR [line 554]

static mixed STATEMENT_IFERROR( [mixed $testValue = ''], [mixed $errorpart = ''])

STATEMENT_IFERROR

Excel Function: =IFERROR(testValue,errorpart)




Tags:

return:  The value of errorpart or testValue determined by error condition
access:  public


Parameters:

mixed   $testValue   Value to check, is also the value returned when no error
mixed   $errorpart   Value to return when testValue is an error condition

[ Top ]

static method STDEV [line 1862]

static float STDEV( mixed $arg,...)

STDEV

Estimates standard deviation based on a sample. The standard deviation is a measure of how widely values are dispersed from the average value (the mean).

Excel Function: STDEV(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method STDEVA [line 1909]

static float STDEVA( mixed $arg,...)

STDEVA

Estimates standard deviation based on a sample, including numbers, text, and logical values

Excel Function: STDEVA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method STDEVP [line 1961]

static float STDEVP( mixed $arg,...)

STDEVP

Calculates standard deviation based on the entire population

Excel Function: STDEVP(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method STDEVPA [line 2008]

static float STDEVPA( mixed $arg,...)

STDEVPA

Calculates standard deviation based on the entire population, including numbers, text, and logical values

Excel Function: STDEVPA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method STEYX [line 2433]

static float STEYX( array $yValues, array $xValues)

STEYX

Returns the standard error of the predicted y-value for each x in the regression.




Tags:

access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X

[ Top ]

static method STRINGLENGTH [line 5200]

static string STRINGLENGTH( [string $value = ''], int $chars)

STRINGLENGTH



Tags:

access:  public


Parameters:

string   $value   Value
int   $chars   Number of characters

[ Top ]

static method SUBSTITUTE [line 5394]

static string SUBSTITUTE( [string $text = ''], [string $fromText = ''], [string $toText = ''], [integer $instance = 0])

SUBSTITUTE



Tags:

access:  public


Parameters:

string   $text   Value
string   $fromText   From Value
string   $toText   To Value
integer   $instance   Instance Number

[ Top ]

static method SUBTOTAL [line 2758]

static float SUBTOTAL( int 0, array 1)

SUBTOTAL

Returns a subtotal in a list or database.




Tags:

access:  public


Parameters:

int   0   the number 1 to 11 that specifies which function to use in calculating subtotals within a list.
array   1   of mixed Data Series

[ Top ]

static method SUM [line 664]

static float SUM( mixed $arg,...)

SUM

SUM computes the sum of all the values and cells referenced in the argument list.

Excel Function: SUM(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method SUMIF [line 1350]

static float SUMIF( $aArgs, string $condition, [ $sumArgs = array()], mixed $arg,...)

SUMIF

Counts the number of cells that contain numbers within the list of arguments

Excel Function: SUMIF(value1[,value2[, ...]],condition)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
string   $condition   The criteria that defines which cells will be summed.
   $aArgs  
   $sumArgs  

[ Top ]

static method SUMPRODUCT [line 11566]

static float SUMPRODUCT( mixed $value)

SUMPRODUCT



Tags:

access:  public


Parameters:

mixed   $value   Value to check

[ Top ]

static method SUMSQ [line 695]

static float SUMSQ( mixed $arg,...)

SUMSQ

SUMSQ returns the sum of the squares of the arguments

Excel Function: SUMSQ(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method SUMX2MY2 [line 11597]

static float SUMX2MY2( $matrixData1, $matrixData2, mixed $value)

SUMX2MY2



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $matrixData1  
   $matrixData2  

[ Top ]

static method SUMX2PY2 [line 11626]

static float SUMX2PY2( $matrixData1, $matrixData2, mixed $value)

SUMX2PY2



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $matrixData1  
   $matrixData2  

[ Top ]

static method SUMXMY2 [line 11655]

static float SUMXMY2( $matrixData1, $matrixData2, mixed $value)

SUMXMY2



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $matrixData1  
   $matrixData2  

[ Top ]

static method SYD [line 11399]

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:

access:  public


Parameters:

cost   $cost   Initial cost of the asset
salvage   $salvage   Value at the end of the depreciation
life   $life   Number of periods over which the asset is depreciated
period   $period   Period

[ Top ]

static method TBILLEQ [line 10543]

static float TBILLEQ( mixed $settlement, mixed $maturity, int $discount)

TBILLEQ

Returns the bond-equivalent yield for a Treasury bill.




Tags:

access:  public


Parameters:

mixed   $settlement   settlement The Treasury bill's settlement date. The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
mixed   $maturity   maturity The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
int   $discount   discount The Treasury bill's discount rate.

[ Top ]

static method TBILLPRICE [line 10581]

static float TBILLPRICE( mixed $settlement, mixed $maturity, int $discount)

TBILLPRICE

Returns the yield for a Treasury bill.




Tags:

access:  public


Parameters:

mixed   $settlement   settlement The Treasury bill's settlement date. The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
mixed   $maturity   maturity The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
int   $discount   discount The Treasury bill's discount rate.

[ Top ]

static method TBILLYIELD [line 10632]

static float TBILLYIELD( mixed $settlement, mixed $maturity, int $price)

TBILLYIELD

Returns the yield for a Treasury bill.




Tags:

access:  public


Parameters:

mixed   $settlement   settlement The Treasury bill's settlement date. The Treasury bill's settlement date is the date after the issue date when the Treasury bill is traded to the buyer.
mixed   $maturity   maturity The Treasury bill's maturity date. The maturity date is the date when the Treasury bill expires.
int   $price   price The Treasury bill's price per $100 face value.

[ Top ]

static method TDIST [line 4739]

static float TDIST( float $value, float $degrees, float $tails)

TDIST

Returns the probability of Student's T distribution.




Tags:

access:  public


Parameters:

float   $value   Value for the function
float   $degrees   degrees of freedom
float   $tails   number of tails (1 or 2)

[ Top ]

static method TEXTFORMAT [line 5475]

static boolean TEXTFORMAT( mixed $value, $format)

TEXTFORMAT



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $format  

[ Top ]

static method TIME [line 5763]

static mixed TIME( [long $hour = 0], [long $minute = 0], [long $second = 0])

TIME



Tags:

return:  Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag
access:  public


Parameters:

long   $hour  
long   $minute  
long   $second  

[ Top ]

static method TIMEVALUE [line 5948]

static mixed TIMEVALUE( string $timeValue)

TIMEVALUE



Tags:

return:  Excel date/time serial value, PHP date/time serial value or PHP date/time object, depending on the value of the ReturnDateType flag
access:  public


Parameters:

string   $timeValue  

[ Top ]

static method TINV [line 4799]

static float TINV( float $probability, float $degrees)

TINV

Returns the one-tailed probability of the chi-squared distribution.




Tags:

access:  public


Parameters:

float   $probability   Probability for the function
float   $degrees   degrees of freedom

[ Top ]

static method TRANSPOSE [line 11424]

static array TRANSPOSE( array $matrixData)

TRANSPOSE



Tags:

return:  Unlike the Excel TRANSPOSE function, which will only work on a single row or column, this function will transpose a full matrix.
access:  public


Parameters:

array   $matrixData   A matrix of values

[ Top ]

static method TREND [line 2664]

static array TREND( array $yValues, [array $xValues = array()], [array $newValues = array()], [boolean $const = True])

TREND

Returns values along a linear trend




Tags:

return:  of float
access:  public


Parameters:

array   $yValues   of mixed Data Series Y
array   $xValues   of mixed Data Series X
array   $newValues   of mixed Values of X for which we want to find Y
boolean   $const   A logical value specifying whether to force the intersect to equal 0.

[ Top ]

static method TRIMMEAN [line 1819]

static float TRIMMEAN( mixed $arg,..., float $discard)

TRIMMEAN

Returns the mean of the interior of a data set. TRIMMEAN calculates the mean taken by excluding a percentage of data points from the top and bottom tails of a data set.

Excel Function: TRIMEAN(value1[,value2[, ...]],$discard)




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values
float   $discard   Percentage to discard

[ Top ]

static method TRIMNONPRINTABLE [line 5511]

static string TRIMNONPRINTABLE( [ $stringValue = ''], mixed $value)

TRIMNONPRINTABLE



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $stringValue  

[ Top ]

static method TRIMSPACES [line 5493]

static string TRIMSPACES( [ $stringValue = ''], mixed $value)

TRIMSPACES



Tags:

access:  public


Parameters:

mixed   $value   Value to check
   $stringValue  

[ Top ]

static method TRUNC [line 6811]

static float TRUNC( [float $value = 0], [int $number_digits = 0])

TRUNC

Truncates value to the number of fractional digits by number_digits.




Tags:

return:  Truncated value
access:  public


Parameters:

float   $value  
int   $number_digits  

[ Top ]

static method TYPE [line 11352]

static number TYPE( value $value)

TYPE

Returns a number that identifies the type of a value




Tags:

return:  N converts values listed in the following table If value is or refers to N returns A number 1 Text 2 Logical Value 4 An error value 16 Array or Matrix 64
access:  public


Parameters:

value   $value   The value you want tested

[ Top ]

static method UPPERCASE [line 9011]

static string UPPERCASE( string $mixedCaseString)

UPPERCASE

Converts a string value to upper case.




Tags:

access:  public


Parameters:

string   $mixedCaseString  

[ Top ]

static method VALUE [line 298]

static string VALUE( )

VALUE

Returns the error value #VALUE!




Tags:

return:  #VALUE!
access:  public


[ Top ]

static method VARA [line 2102]

static float VARA( mixed $arg,...)

VARA

Estimates variance based on a sample, including numbers, text, and logical values

Excel Function: VARA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method VARFunc [line 2060]

static float VARFunc( mixed $arg,...)

VARFunc

Estimates variance based on a sample.

Excel Function: VAR(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method VARP [line 2155]

static float VARP( mixed $arg,...)

VARP

Calculates variance based on the entire population

Excel Function: VARP(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method VARPA [line 2197]

static float VARPA( mixed $arg,...)

VARPA

Calculates variance based on the entire population, including numbers, text, and logical values

Excel Function: VARPA(value1[,value2[, ...]])




Tags:

access:  public


Parameters:

mixed   $arg,...   Data values

[ Top ]

static method VERSION [line 5693]

static string VERSION( )

VERSION



Tags:

return:  Version information
access:  public


[ Top ]

static method VLOOKUP [line 11697]

static mixed VLOOKUP( lookup_value $lookup_value, lookup_array $lookup_array, index_number $index_number, [not_exact_match $not_exact_match = true])

VLOOKUP The VLOOKUP function searches for value in the left-most column of lookup_array and returns the value in the same row based on the index_number.



Tags:

return:  The value of the found cell
access:  public


Parameters:

lookup_value   $lookup_value   The value that you want to match in lookup_array
lookup_array   $lookup_array   The range of cells being searched
index_number   $index_number   The column number in table_array from which the matching value must be returned. The first column is 1.
not_exact_match   $not_exact_match   Determines if you are looking for an exact match based on lookup_value.

[ Top ]

static method WEEKOFYEAR [line 6528]

static int WEEKOFYEAR( [long $dateValue = 1], [boolean $method = 1])

WEEKOFYEAR



Tags:

return:  Week Number
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string
boolean   $method   Week begins on Sunday or Monday

[ Top ]

static method WEIBULL [line 4924]

static float WEIBULL( float $value, float $alpha, float $beta, boolean $cumulative)

WEIBULL

Returns the Weibull distribution. Use this distribution in reliability analysis, such as calculating a device's mean time to failure.




Tags:

access:  public


Parameters:

float   $value  
float   $alpha   Alpha Parameter
float   $beta   Beta Parameter
boolean   $cumulative  

[ Top ]

static method WORKDAY [line 6362]

static long WORKDAY( mixed $startDate, mixed $endDays, array 2)

WORKDAY



Tags:

return:  Interval between the dates
access:  public


Parameters:

array   2   of mixed Optional Date Series
mixed   $startDate   Start date
mixed   $endDays   number of days for adjustment

[ Top ]

static method XIRR [line 9672]

static void XIRR( $values, $dates, [ $guess = 0.1])



Tags:

access:  public


Parameters:

   $values  
   $dates  
   $guess  

[ Top ]

static method XNPV [line 9587]

static float XNPV( float $rate, array $values, $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.




Tags:

access:  public


Parameters:

float   $rate   Discount interest rate
array   $values   Cash flow series
   $dates  

[ Top ]

static method YEAR [line 6586]

static int YEAR( [long $dateValue = 1])

YEAR



Tags:

return:  Year
access:  public


Parameters:

long   $dateValue   Excel date serial value or a standard date string

[ Top ]

static method YEARFRAC [line 6212]

static float YEARFRAC( [mixed $startDate = 0], [mixed $endDate = 0], [integer $method = 0])

YEARFRAC

Calculates the fraction of the year represented by the number of whole days between two dates (the start_date and the end_date). Use the YEARFRAC worksheet function to identify the proportion of a whole year's benefits or obligations to assign to a specific term.




Tags:

return:  fraction of the year
access:  public


Parameters:

mixed   $startDate   Excel date serial value (float), PHP date timestamp (integer) or date object, or a standard date string
mixed   $endDate   Excel date serial value (float), PHP date timestamp (integer) or date object, or a standard date string
integer   $method   Method used for the calculation
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method YIELDDISC [line 10769]

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:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security's settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
int   $price   price The security's price per $100 face value.
int   $redemption   redemption The security's redemption value per $100 face value.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method YIELDMAT [line 10709]

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:

access:  public


Parameters:

mixed   $settlement   settlement The security's settlement date. The security's settlement date is the date after the issue date when the security is traded to the buyer.
mixed   $maturity   maturity The security's maturity date. The maturity date is the date when the security expires.
mixed   $issue   issue The security's issue date.
int   $rate   rate The security's interest rate at date of issue.
int   $price   price The security's price per $100 face value.
int   $basis   basis The type of day count to use.
  1. or omitted US (NASD) 30/360
  2. Actual/actual
  3. Actual/360
  4. Actual/365
  5. European 30/360

[ Top ]

static method ZTEST [line 4958]

static float ZTEST( $dataSet, $m0, [ $sigma = null], float $value, float $alpha, float $beta, boolean $cumulative)

ZTEST

Returns the Weibull distribution. Use this distribution in reliability analysis, such as calculating a device's mean time to failure.




Tags:

access:  public


Parameters:

float   $value  
float   $alpha   Alpha Parameter
float   $beta   Beta Parameter
boolean   $cumulative  
   $dataSet  
   $m0  
   $sigma  

[ Top ]

static method _parseComplex [line 7229]

static void _parseComplex( $complexNumber)



Tags:

access:  public


Parameters:

   $complexNumber  

[ Top ]


Class Constants

COMPATIBILITY_EXCEL =  'Excel'

[line 97]

constants


[ Top ]

COMPATIBILITY_GNUMERIC =  'Gnumeric'

[line 98]


[ Top ]

COMPATIBILITY_OPENOFFICE =  'OpenOfficeCalc'

[line 99]


[ Top ]

RETURNDATE_EXCEL =  'E'

[line 103]


[ Top ]

RETURNDATE_PHP_NUMERIC =  'P'

[line 101]


[ Top ]

RETURNDATE_PHP_OBJECT =  'O'

[line 102]


[ Top ]



Documentation generated on Thu, 26 Aug 2010 17:43:09 +0200 by phpDocumentor 1.4.3