PHPExcel_Calculation

# 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) | ### Variables $compatibilityMode $ReturnDateType $_conversionMultipliers $_conversionUnits $_errorCodes $_invalidChars $_logBetaCache_p $_logBetaCache_q $_logBetaCache_result $_logGammaCache_result $_logGammaCache_x $_one_sqrtpi $_two_sqrtpi $_unitConversions | ### Constants COMPATIBILITY_EXCEL COMPATIBILITY_GNUMERIC COMPATIBILITY_OPENOFFICE RETURNDATE_EXCEL RETURNDATE_PHP_NUMERIC RETURNDATE_PHP_OBJECT | ### Methods ACCRINT ACCRINTM AMORDEGRC AMORLINC ASCIICODE AVEDEV AVERAGE AVERAGEA BESSELI BESSELJ BESSELK BESSELY BETADIST BETAINV BINOMDIST BINTODEC BINTOHEX BINTOOCT CEILING CELL_ADDRESS CHARACTER CHIDIST CHIINV CHOOSE COLUMN COLUMNS COMBIN COMPLEX CONCATENATE CONFIDENCE CONVERTUOM CORREL COUNT COUNTA COUNTBLANK COUNTIF COUPDAYBS COUPNUM COVAR CRITBINOM CUMIPMT CUMPRINC DATE DATEDIF DATENOW DATETIMENOW DATEVALUE DAYOFMONTH DAYOFWEEK DAYS360 DB DDB DECTOBIN DECTOHEX DECTOOCT DELTA DEVSQ DISC DOLLAR DOLLARDE DOLLARFR DUMMY EDATE EFFECT EOMONTH ERF ERFC ERROR_TYPE EVEN EXPONDIST FACT FACTDOUBLE FISHER FISHERINV FIXEDFORMAT flattenArray flattenArrayIndexed flattenSingleValue FLOOR FORECAST FV FVSCHEDULE GAMMADIST GAMMAINV GAMMALN GCD GEOMEAN GESTEP getCompatibilityMode getConversionGroups getConversionGroupUnitDetails getConversionGroupUnits getConversionMultipliers getReturnDateType GROWTH HARMEAN HEXTOBIN HEXTODEC HEXTOOCT HOUROFDAY HYPGEOMDIST IMABS IMAGINARY IMARGUMENT IMCONJUGATE IMCOS IMDIV IMEXP IMLN IMLOG2 IMLOG10 IMPOWER IMPRODUCT IMREAL IMSIN IMSQRT IMSUB IMSUM INDEX INDIRECT INTERCEPT INTRATE INTVALUE IPMT IRR isCellValue isMatrixValue ISPMT isValue IS_BLANK IS_ERR IS_ERROR IS_EVEN IS_LOGICAL IS_NA IS_NONTEXT IS_NUMBER IS_ODD IS_TEXT KURT LARGE LCM LEFT LINEST LOGEST LOGICAL_AND LOGICAL_FALSE LOGICAL_NOT LOGICAL_OR LOGICAL_TRUE LOGINV LOGNORMDIST LOG_BASE LOOKUP LOWERCASE MATCH MAX MAXA MDETERM MEDIAN MID MIN MINA MINUTEOFHOUR MINVERSE MIRR MMULT MOD MODE MONTHOFYEAR MROUND MULTINOMIAL NA NAME NaN NEGBINOMDIST NETWORKDAYS NOMINAL NORMDIST NORMINV NORMSDIST NORMSINV NPER NPV OCTTOBIN OCTTODEC OCTTOHEX ODD OFFSET PERCENTILE PERCENTRANK PERMUT PMT POISSON POWER PPMT PRICEDISC PRICEMAT PRODUCT PROPERCASE PV QUARTILE QUOTIENT RAND RANK RATE RECEIVED REF REPLACE RETURNSTRING REVERSE_ATAN2 RIGHT ROMAN ROUNDDOWN ROUNDUP ROW ROWS RSQ SEARCHINSENSITIVE SEARCHSENSITIVE SECONDOFMINUTE SERIESSUM setCompatibilityMode setReturnDateType SIGN SKEW SLN SLOPE SMALL SQRTPI STANDARDIZE STATEMENT_IF STATEMENT_IFERROR STDEV STDEVA STDEVP STDEVPA STEYX STRINGLENGTH SUBSTITUTE SUBTOTAL SUM SUMIF SUMPRODUCT SUMSQ SUMX2MY2 SUMX2PY2 SUMXMY2 SYD TBILLEQ TBILLPRICE TBILLYIELD TDIST TEXTFORMAT TIME TIMEVALUE TINV TRANSPOSE TREND TRIMMEAN TRIMNONPRINTABLE TRIMSPACES TRUNC UPPERCASE VALUE VARA VARFunc VARP VARPA VERSION VLOOKUP WEEKOFYEAR WEIBULL WORKDAY XIRR XNPV YEAR YEARFRAC YIELDDISC YIELDMAT ZTEST _adjustDateByMonths _Besselk0 _Besselk1 _Bessely0 _Bessely1 _beta _betaFraction _checkTrendArrays _cleanComplex _dateDiff360 _daysPerYear _erfcVal _erfVal _factors _gamma _getDateValue _getTimeValue _incompleteBeta _incompleteGamma _interestAndPrincipal _inverse_ncdf _inverse_ncdf2 _inverse_ncdf3 _isLeapYear _logBeta _logGamma _modeCalc _nbrConversionFormat _parseComplex _romanCut _uniord _vlookupSort
### Class Details [line 101] PHPExcel_Calculation_Functions PHPExcel_Calculation_Functions #### Tags:
copyright: | Copyright (c) 2006 - 2010 PHPExcel (http://www.codeplex.com/PHPExcel)
[ Top ] ### Class Variables #### static $compatibilityMode = self::COMPATIBILITY_EXCEL [line 119] Compatibility mode to use for error checking and responses Compatibility mode to use for error checking and responses #### Tags:
access: | private
Type: | string
[ Top ] #### static $ReturnDateType = self::RETURNDATE_EXCEL [line 127] Data Type to use when returning date values Data Type to use when returning date values #### Tags:
access: | private
Type: | integer
[ Top ] #### static $_conversionMultipliers = array( 'Y' => array( 'multiplier' => 1E24, 'name' => 'yotta' ),'Z'=>array('multiplier'=>1E21,'name'=>'zetta'),'E'=>array('multiplier'=>1E18,'name'=>'exa'),'P'=>array('multiplier'=>1E15,'name'=>'peta'),'T'=>array('multiplier'=>1E12,'name'=>'tera'),'G'=>array('multiplier'=>1E9,'name'=>'giga'),'M'=>array('multiplier'=>1E6,'name'=>'mega'),'k'=>array('multiplier'=>1E3,'name'=>'kilo'),'h'=>array('multiplier'=>1E2,'name'=>'hecto'),'e'=>array('multiplier'=>1E1,'name'=>'deka'),'d'=>array('multiplier'=>1E-1,'name'=>'deci'),'c'=>array('multiplier'=>1E-2,'name'=>'centi'),'m'=>array('multiplier'=>1E-3,'name'=>'milli'),'u'=>array('multiplier'=>1E-6,'name'=>'micro'),'n'=>array('multiplier'=>1E-9,'name'=>'nano'),'p'=>array('multiplier'=>1E-12,'name'=>'pico'),'f'=>array('multiplier'=>1E-15,'name'=>'femto'),'a'=>array('multiplier'=>1E-18,'name'=>'atto'),'z'=>array('multiplier'=>1E-21,'name'=>'zepto'),'y'=>array('multiplier'=>1E-24,'name'=>'yocto')) [line 7659] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_conversionUnits = array( 'g' => array( 'Group' => 'Mass', 'Unit Name' => 'Gram', 'AllowPrefix' => True ),'sg'=>array('Group'=>'Mass','Unit Name'=>'Slug','AllowPrefix'=>False),'lbm'=>array('Group'=>'Mass','Unit Name'=>'Pound mass (avoirdupois)','AllowPrefix'=>False),'u'=>array('Group'=>'Mass','Unit Name'=>'U (atomic mass unit)','AllowPrefix'=>True),'ozm'=>array('Group'=>'Mass','Unit Name'=>'Ounce mass (avoirdupois)','AllowPrefix'=>False),'m'=>array('Group'=>'Distance','Unit Name'=>'Meter','AllowPrefix'=>True),'mi'=>array('Group'=>'Distance','Unit Name'=>'Statute mile','AllowPrefix'=>False),'Nmi'=>array('Group'=>'Distance','Unit Name'=>'Nautical mile','AllowPrefix'=>False),'in'=>array('Group'=>'Distance','Unit Name'=>'Inch','AllowPrefix'=>False),'ft'=>array('Group'=>'Distance','Unit Name'=>'Foot','AllowPrefix'=>False),'yd'=>array('Group'=>'Distance','Unit Name'=>'Yard','AllowPrefix'=>False),'ang'=>array('Group'=>'Distance','Unit Name'=>'Angstrom','AllowPrefix'=>True),'Pica'=>array('Group'=>'Distance','Unit Name'=>'Pica (1/72 in)','AllowPrefix'=>False),'yr'=>array('Group'=>'Time','Unit Name'=>'Year','AllowPrefix'=>False),'day'=>array('Group'=>'Time','Unit Name'=>'Day','AllowPrefix'=>False),'hr'=>array('Group'=>'Time','Unit Name'=>'Hour','AllowPrefix'=>False),'mn'=>array('Group'=>'Time','Unit Name'=>'Minute','AllowPrefix'=>False),'sec'=>array('Group'=>'Time','Unit Name'=>'Second','AllowPrefix'=>True),'Pa'=>array('Group'=>'Pressure','Unit Name'=>'Pascal','AllowPrefix'=>True),'p'=>array('Group'=>'Pressure','Unit Name'=>'Pascal','AllowPrefix'=>True),'atm'=>array('Group'=>'Pressure','Unit Name'=>'Atmosphere','AllowPrefix'=>True),'at'=>array('Group'=>'Pressure','Unit Name'=>'Atmosphere','AllowPrefix'=>True),'mmHg'=>array('Group'=>'Pressure','Unit Name'=>'mm of Mercury','AllowPrefix'=>True),'N'=>array('Group'=>'Force','Unit Name'=>'Newton','AllowPrefix'=>True),'dyn'=>array('Group'=>'Force','Unit Name'=>'Dyne','AllowPrefix'=>True),'dy'=>array('Group'=>'Force','Unit Name'=>'Dyne','AllowPrefix'=>True),'lbf'=>array('Group'=>'Force','Unit Name'=>'Pound force','AllowPrefix'=>False),'J'=>array('Group'=>'Energy','Unit Name'=>'Joule','AllowPrefix'=>True),'e'=>array('Group'=>'Energy','Unit Name'=>'Erg','AllowPrefix'=>True),'c'=>array('Group'=>'Energy','Unit Name'=>'Thermodynamic calorie','AllowPrefix'=>True),'cal'=>array('Group'=>'Energy','Unit Name'=>'IT calorie','AllowPrefix'=>True),'eV'=>array('Group'=>'Energy','Unit Name'=>'Electron volt','AllowPrefix'=>True),'ev'=>array('Group'=>'Energy','Unit Name'=>'Electron volt','AllowPrefix'=>True),'HPh'=>array('Group'=>'Energy','Unit Name'=>'Horsepower-hour','AllowPrefix'=>False),'hh'=>array('Group'=>'Energy','Unit Name'=>'Horsepower-hour','AllowPrefix'=>False),'Wh'=>array('Group'=>'Energy','Unit Name'=>'Watt-hour','AllowPrefix'=>True),'wh'=>array('Group'=>'Energy','Unit Name'=>'Watt-hour','AllowPrefix'=>True),'flb'=>array('Group'=>'Energy','Unit Name'=>'Foot-pound','AllowPrefix'=>False),'BTU'=>array('Group'=>'Energy','Unit Name'=>'BTU','AllowPrefix'=>False),'btu'=>array('Group'=>'Energy','Unit Name'=>'BTU','AllowPrefix'=>False),'HP'=>array('Group'=>'Power','Unit Name'=>'Horsepower','AllowPrefix'=>False),'h'=>array('Group'=>'Power','Unit Name'=>'Horsepower','AllowPrefix'=>False),'W'=>array('Group'=>'Power','Unit Name'=>'Watt','AllowPrefix'=>True),'w'=>array('Group'=>'Power','Unit Name'=>'Watt','AllowPrefix'=>True),'T'=>array('Group'=>'Magnetism','Unit Name'=>'Tesla','AllowPrefix'=>True),'ga'=>array('Group'=>'Magnetism','Unit Name'=>'Gauss','AllowPrefix'=>True),'C'=>array('Group'=>'Temperature','Unit Name'=>'Celsius','AllowPrefix'=>False),'cel'=>array('Group'=>'Temperature','Unit Name'=>'Celsius','AllowPrefix'=>False),'F'=>array('Group'=>'Temperature','Unit Name'=>'Fahrenheit','AllowPrefix'=>False),'fah'=>array('Group'=>'Temperature','Unit Name'=>'Fahrenheit','AllowPrefix'=>False),'K'=>array('Group'=>'Temperature','Unit Name'=>'Kelvin','AllowPrefix'=>False),'kel'=>array('Group'=>'Temperature','Unit Name'=>'Kelvin','AllowPrefix'=>False),'tsp'=>array('Group'=>'Liquid','Unit Name'=>'Teaspoon','AllowPrefix'=>False),'tbs'=>array('Group'=>'Liquid','Unit Name'=>'Tablespoon','AllowPrefix'=>False),'oz'=>array('Group'=>'Liquid','Unit Name'=>'Fluid Ounce','AllowPrefix'=>False),'cup'=>array('Group'=>'Liquid','Unit Name'=>'Cup','AllowPrefix'=>False),'pt'=>array('Group'=>'Liquid','Unit Name'=>'U.S. Pint','AllowPrefix'=>False),'us_pt'=>array('Group'=>'Liquid','Unit Name'=>'U.S. Pint','AllowPrefix'=>False),'uk_pt'=>array('Group'=>'Liquid','Unit Name'=>'U.K. Pint','AllowPrefix'=>False),'qt'=>array('Group'=>'Liquid','Unit Name'=>'Quart','AllowPrefix'=>False),'gal'=>array('Group'=>'Liquid','Unit Name'=>'Gallon','AllowPrefix'=>False),'l'=>array('Group'=>'Liquid','Unit Name'=>'Litre','AllowPrefix'=>True),'lt'=>array('Group'=>'Liquid','Unit Name'=>'Litre','AllowPrefix'=>True)) [line 7594] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_errorCodes = array( 'null' => '#NULL!', 'divisionbyzero' => '#DIV/0!', 'value' => '#VALUE!', 'reference' => '#REF!', 'name' => '#NAME?', 'num' => '#NUM!', 'na' => '#N/A', 'gettingdata' => '#GETTING_DATA' ) [line 135] List of error codes List of error codes #### Tags:
access: | private
Type: | array
[ Top ] #### static $_invalidChars = Null [line 5341] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_logBetaCache_p = 0.0 [line 3588] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_logBetaCache_q = 0.0 [line 3589] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_logBetaCache_result = 0.0 [line 3590] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_logGammaCache_result = 0.0 [line 3708] logGamma function logGamma function #### Tags:
return: | for x < 0.0 or when overflow would occur, i.e. x > 2.55E305
author: | Jaco van Kooten Original author was Jaco van Kooten. Ported to PHP by Paul Meagher. The natural logarithm of the gamma function. </ br /> Based on public domain NETLIB (Fortran) code by W. J. Cody and L. Stoltz </ br /> Applied Mathematics Division </ br /> Argonne National Laboratory </ br /> Argonne, IL 60439 </ br /> References: W. J. Cody and K. E. Hillstrom, 'Chebyshev Approximations for the Natural Logarithm of the Gamma Function,' Math. Comp. 21, 1967, pp. 198-203. K. E. Hillstrom, ANL/AMD Program ANLC366S, DGAMMA/DLGAMA, May, 1969. Hart, Et. Al., Computer Approximations, Wiley and sons, New York, 1968. From the original documentation: This routine calculates the LOG(GAMMA) function for a positive real argument X. Computation is based on an algorithm outlined in references 1 and 2. The program uses rational functions that theoretically approximate LOG(GAMMA) to at least 18 significant decimal digits. The approximation for X > 12 is from reference 3, while approximations for X < 12.0 are similar to those in reference 1, but are unpublished. The accuracy achieved depends on the arithmetic system, the compiler, the intrinsic functions, and proper selection of the machine-dependent constants. Error returns: </ br /> The program returns the value XINF for X .LE. 0.0 or when overflow would occur. The computation is believed to be free of underflow and overflow.
version: | 1.1
access: | private
Type: | mixed
[ Top ] #### static $_logGammaCache_x = 0.0 [line 3709] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_one_sqrtpi = 0.564189583547756287 [line 8696] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_two_sqrtpi = 1.128379167095512574 [line 8637] #### Tags:
access: | private
Type: | mixed
[ Top ] #### static $_unitConversions = array( 'Mass' => array( 'g' => array( 'g' => 1.0, 'sg' => 6.85220500053478E-05, 'lbm' => 2.20462291469134E-03, 'u' => 6.02217000000000E+23, 'ozm' => 3.52739718003627E-02 ),'sg'=>array('g'=>1.45938424189287E+04,'sg'=>1.0,'lbm'=>3.21739194101647E+01,'u'=>8.78866000000000E+27,'ozm'=>5.14782785944229E+02),'lbm'=>array('g'=>4.5359230974881148E+02,'sg'=>3.10810749306493E-02,'lbm'=>1.0,'u'=>2.73161000000000E+26,'ozm'=>1.60000023429410E+01),'u'=>array('g'=>1.66053100460465E-24,'sg'=>1.13782988532950E-28,'lbm'=>3.66084470330684E-27,'u'=>1.0,'ozm'=>5.85735238300524E-26),'ozm'=>array('g'=>2.83495152079732E+01,'sg'=>1.94256689870811E-03,'lbm'=>6.24999908478882E-02,'u'=>1.70725600000000E+25,'ozm'=>1.0)),'Distance'=>array('m'=>array('m'=>1.0,'mi'=>6.21371192237334E-04,'Nmi'=>5.39956803455724E-04,'in'=>3.93700787401575E+01,'ft'=>3.28083989501312E+00,'yd'=>1.09361329797891E+00,'ang'=>1.00000000000000E+10,'Pica'=>2.83464566929116E+03),'mi'=>array('m'=>1.60934400000000E+03,'mi'=>1.0,'Nmi'=>8.68976241900648E-01,'in'=>6.33600000000000E+04,'ft'=>5.28000000000000E+03,'yd'=>1.76000000000000E+03,'ang'=>1.60934400000000E+13,'Pica'=>4.56191999999971E+06),'Nmi'=>array('m'=>1.85200000000000E+03,'mi'=>1.15077944802354E+00,'Nmi'=>1.0,'in'=>7.29133858267717E+04,'ft'=>6.07611548556430E+03,'yd'=>2.02537182785694E+03,'ang'=>1.85200000000000E+13,'Pica'=>5.24976377952723E+06),'in'=>array('m'=>2.54000000000000E-02,'mi'=>1.57828282828283E-05,'Nmi'=>1.37149028077754E-05,'in'=>1.0,'ft'=>8.33333333333333E-02,'yd'=>2.77777777686643E-02,'ang'=>2.54000000000000E+08,'Pica'=>7.19999999999955E+01),'ft'=>array('m'=>3.04800000000000E-01,'mi'=>1.89393939393939E-04,'Nmi'=>1.64578833693305E-04,'in'=>1.20000000000000E+01,'ft'=>1.0,'yd'=>3.33333333223972E-01,'ang'=>3.04800000000000E+09,'Pica'=>8.63999999999946E+02),'yd'=>array('m'=>9.14400000300000E-01,'mi'=>5.68181818368230E-04,'Nmi'=>4.93736501241901E-04,'in'=>3.60000000118110E+01,'ft'=>3.00000000000000E+00,'yd'=>1.0,'ang'=>9.14400000300000E+09,'Pica'=>2.59200000085023E+03),'ang'=>array('m'=>1.00000000000000E-10,'mi'=>6.21371192237334E-14,'Nmi'=>5.39956803455724E-14,'in'=>3.93700787401575E-09,'ft'=>3.28083989501312E-10,'yd'=>1.09361329797891E-10,'ang'=>1.0,'Pica'=>2.83464566929116E-07),'Pica'=>array('m'=>3.52777777777800E-04,'mi'=>2.19205948372629E-07,'Nmi'=>1.90484761219114E-07,'in'=>1.38888888888898E-02,'ft'=>1.15740740740748E-03,'yd'=>3.85802469009251E-04,'ang'=>3.52777777777800E+06,'Pica'=>1.0)),'Time'=>array('yr'=>array('yr'=>1.0,'day'=>365.25,'hr'=>8766.0,'mn'=>525960.0,'sec'=>31557600.0),'day'=>array('yr'=>2.73785078713210E-03,'day'=>1.0,'hr'=>24.0,'mn'=>1440.0,'sec'=>86400.0),'hr'=>array('yr'=>1.14077116130504E-04,'day'=>4.16666666666667E-02,'hr'=>1.0,'mn'=>60.0,'sec'=>3600.0),'mn'=>array('yr'=>1.90128526884174E-06,'day'=>6.94444444444444E-04,'hr'=>1.66666666666667E-02,'mn'=>1.0,'sec'=>60.0),'sec'=>array('yr'=>3.16880878140289E-08,'day'=>1.15740740740741E-05,'hr'=>2.77777777777778E-04,'mn'=>1.66666666666667E-02,'sec'=>1.0)),'Pressure'=>array('Pa'=>array('Pa'=>1.0,'p'=>1.0,'atm'=>9.86923299998193E-06,'at'=>9.86923299998193E-06,'mmHg'=>7.50061707998627E-03),'p'=>array('Pa'=>1.0,'p'=>1.0,'atm'=>9.86923299998193E-06,'at'=>9.86923299998193E-06,'mmHg'=>7.50061707998627E-03),'atm'=>array('Pa'=>1.01324996583000E+05,'p'=>1.01324996583000E+05,'atm'=>1.0,'at'=>1.0,'mmHg'=>760.0),'at'=>array('Pa'=>1.01324996583000E+05,'p'=>1.01324996583000E+05,'atm'=>1.0,'at'=>1.0,'mmHg'=>760.0),'mmHg'=>array('Pa'=>1.33322363925000E+02,'p'=>1.33322363925000E+02,'atm'=>1.31578947368421E-03,'at'=>1.31578947368421E-03,'mmHg'=>1.0)),'Force'=>array('N'=>array('N'=>1.0,'dyn'=>1.0E+5,'dy'=>1.0E+5,'lbf'=>2.24808923655339E-01),'dyn'=>array('N'=>1.0E-5,'dyn'=>1.0,'dy'=>1.0,'lbf'=>2.24808923655339E-06),'dy'=>array('N'=>1.0E-5,'dyn'=>1.0,'dy'=>1.0,'lbf'=>2.24808923655339E-06),'lbf'=>array('N'=>4.448222,'dyn'=>4.448222E+5,'dy'=>4.448222E+5,'lbf'=>1.0)),'Energy'=>array('J'=>array('J'=>1.0,'e'=>9.99999519343231E+06,'c'=>2.39006249473467E-01,'cal'=>2.38846190642017E-01,'eV'=>6.24145700000000E+18,'ev'=>6.24145700000000E+18,'HPh'=>3.72506430801000E-07,'hh'=>3.72506430801000E-07,'Wh'=>2.77777916238711E-04,'wh'=>2.77777916238711E-04,'flb'=>2.37304222192651E+01,'BTU'=>9.47815067349015E-04,'btu'=>9.47815067349015E-04),'e'=>array('J'=>1.00000048065700E-07,'e'=>1.0,'c'=>2.39006364353494E-08,'cal'=>2.38846305445111E-08,'eV'=>6.24146000000000E+11,'ev'=>6.24146000000000E+11,'HPh'=>3.72506609848824E-14,'hh'=>3.72506609848824E-14,'Wh'=>2.77778049754611E-11,'wh'=>2.77778049754611E-11,'flb'=>2.37304336254586E-06,'BTU'=>9.47815522922962E-11,'btu'=>9.47815522922962E-11),'c'=>array('J'=>4.18399101363672E+00,'e'=>4.18398900257312E+07,'c'=>1.0,'cal'=>9.99330315287563E-01,'eV'=>2.61142000000000E+19,'ev'=>2.61142000000000E+19,'HPh'=>1.55856355899327E-06,'hh'=>1.55856355899327E-06,'Wh'=>1.16222030532950E-03,'wh'=>1.16222030532950E-03,'flb'=>9.92878733152102E+01,'BTU'=>3.96564972437776E-03,'btu'=>3.96564972437776E-03),'cal'=>array('J'=>4.18679484613929E+00,'e'=>4.18679283372801E+07,'c'=>1.00067013349059E+00,'cal'=>1.0,'eV'=>2.61317000000000E+19,'ev'=>2.61317000000000E+19,'HPh'=>1.55960800463137E-06,'hh'=>1.55960800463137E-06,'Wh'=>1.16299914807955E-03,'wh'=>1.16299914807955E-03,'flb'=>9.93544094443283E+01,'BTU'=>3.96830723907002E-03,'btu'=>3.96830723907002E-03),'eV'=>array('J'=>1.60219000146921E-19,'e'=>1.60218923136574E-12,'c'=>3.82933423195043E-20,'cal'=>3.82676978535648E-20,'eV'=>1.0,'ev'=>1.0,'HPh'=>5.96826078912344E-26,'hh'=>5.96826078912344E-26,'Wh'=>4.45053000026614E-23,'wh'=>4.45053000026614E-23,'flb'=>3.80206452103492E-18,'BTU'=>1.51857982414846E-22,'btu'=>1.51857982414846E-22),'ev'=>array('J'=>1.60219000146921E-19,'e'=>1.60218923136574E-12,'c'=>3.82933423195043E-20,'cal'=>3.82676978535648E-20,'eV'=>1.0,'ev'=>1.0,'HPh'=>5.96826078912344E-26,'hh'=>5.96826078912344E-26,'Wh'=>4.45053000026614E-23,'wh'=>4.45053000026614E-23,'flb'=>3.80206452103492E-18,'BTU'=>1.51857982414846E-22,'btu'=>1.51857982414846E-22),'HPh'=>array('J'=>2.68451741316170E+06,'e'=>2.68451612283024E+13,'c'=>6.41616438565991E+05,'cal'=>6.41186757845835E+05,'eV'=>1.67553000000000E+25,'ev'=>1.67553000000000E+25,'HPh'=>1.0,'hh'=>1.0,'Wh'=>7.45699653134593E+02,'wh'=>7.45699653134593E+02,'flb'=>6.37047316692964E+07,'BTU'=>2.54442605275546E+03,'btu'=>2.54442605275546E+03),'hh'=>array('J'=>2.68451741316170E+06,'e'=>2.68451612283024E+13,'c'=>6.41616438565991E+05,'cal'=>6.41186757845835E+05,'eV'=>1.67553000000000E+25,'ev'=>1.67553000000000E+25,'HPh'=>1.0,'hh'=>1.0,'Wh'=>7.45699653134593E+02,'wh'=>7.45699653134593E+02,'flb'=>6.37047316692964E+07,'BTU'=>2.54442605275546E+03,'btu'=>2.54442605275546E+03),'Wh'=>array('J'=>3.59999820554720E+03,'e'=>3.59999647518369E+10,'c'=>8.60422069219046E+02,'cal'=>8.59845857713046E+02,'eV'=>2.24692340000000E+22,'ev'=>2.24692340000000E+22,'HPh'=>1.34102248243839E-03,'hh'=>1.34102248243839E-03,'Wh'=>1.0,'wh'=>1.0,'flb'=>8.54294774062316E+04,'BTU'=>3.41213254164705E+00,'btu'=>3.41213254164705E+00),'wh'=>array('J'=>3.59999820554720E+03,'e'=>3.59999647518369E+10,'c'=>8.60422069219046E+02,'cal'=>8.59845857713046E+02,'eV'=>2.24692340000000E+22,'ev'=>2.24692340000000E+22,'HPh'=>1.34102248243839E-03,'hh'=>1.34102248243839E-03,'Wh'=>1.0,'wh'=>1.0,'flb'=>8.54294774062316E+04,'BTU'=>3.41213254164705E+00,'btu'=>3.41213254164705E+00),'flb'=>array('J'=>4.21400003236424E-02,'e'=>4.21399800687660E+05,'c'=>1.00717234301644E-02,'cal'=>1.00649785509554E-02,'eV'=>2.63015000000000E+17,'ev'=>2.63015000000000E+17,'HPh'=>1.56974211145130E-08,'hh'=>1.56974211145130E-08,'Wh'=>1.17055614802000E-05,'wh'=>1.17055614802000E-05,'flb'=>1.0,'BTU'=>3.99409272448406E-05,'btu'=>3.99409272448406E-05),'BTU'=>array('J'=>1.05505813786749E+03,'e'=>1.05505763074665E+10,'c'=>2.52165488508168E+02,'cal'=>2.51996617135510E+02,'eV'=>6.58510000000000E+21,'ev'=>6.58510000000000E+21,'HPh'=>3.93015941224568E-04,'hh'=>3.93015941224568E-04,'Wh'=>2.93071851047526E-01,'wh'=>2.93071851047526E-01,'flb'=>2.50369750774671E+04,'BTU'=>1.0,'btu'=>1.0,),'btu'=>array('J'=>1.05505813786749E+03,'e'=>1.05505763074665E+10,'c'=>2.52165488508168E+02,'cal'=>2.51996617135510E+02,'eV'=>6.58510000000000E+21,'ev'=>6.58510000000000E+21,'HPh'=>3.93015941224568E-04,'hh'=>3.93015941224568E-04,'Wh'=>2.93071851047526E-01,'wh'=>2.93071851047526E-01,'flb'=>2.50369750774671E+04,'BTU'=>1.0,'btu'=>1.0,)),'Power'=>array('HP'=>array('HP'=>1.0,'h'=>1.0,'W'=>7.45701000000000E+02,'w'=>7.45701000000000E+02),'h'=>array('HP'=>1.0,'h'=>1.0,'W'=>7.45701000000000E+02,'w'=>7.45701000000000E+02),'W'=>array('HP'=>1.34102006031908E-03,'h'=>1.34102006031908E-03,'W'=>1.0,'w'=>1.0),'w'=>array('HP'=>1.34102006031908E-03,'h'=>1.34102006031908E-03,'W'=>1.0,'w'=>1.0)),'Magnetism'=>array('T'=>array('T'=>1.0,'ga'=>10000.0),'ga'=>array('T'=>0.0001,'ga'=>1.0)),'Liquid'=>array('tsp'=>array('tsp'=>1.0,'tbs'=>3.33333333333333E-01,'oz'=>1.66666666666667E-01,'cup'=>2.08333333333333E-02,'pt'=>1.04166666666667E-02,'us_pt'=>1.04166666666667E-02,'uk_pt'=>8.67558516821960E-03,'qt'=>5.20833333333333E-03,'gal'=>1.30208333333333E-03,'l'=>4.92999408400710E-03,'lt'=>4.92999408400710E-03),'tbs'=>array('tsp'=>3.00000000000000E+00,'tbs'=>1.0,'oz'=>5.00000000000000E-01,'cup'=>6.25000000000000E-02,'pt'=>3.12500000000000E-02,'us_pt'=>3.12500000000000E-02,'uk_pt'=>2.60267555046588E-02,'qt'=>1.56250000000000E-02,'gal'=>3.90625000000000E-03,'l'=>1.47899822520213E-02,'lt'=>1.47899822520213E-02),'oz'=>array('tsp'=>6.00000000000000E+00,'tbs'=>2.00000000000000E+00,'oz'=>1.0,'cup'=>1.25000000000000E-01,'pt'=>6.25000000000000E-02,'us_pt'=>6.25000000000000E-02,'uk_pt'=>5.20535110093176E-02,'qt'=>3.12500000000000E-02,'gal'=>7.81250000000000E-03,'l'=>2.95799645040426E-02,'lt'=>2.95799645040426E-02),'cup'=>array('tsp'=>4.80000000000000E+01,'tbs'=>1.60000000000000E+01,'oz'=>8.00000000000000E+00,'cup'=>1.0,'pt'=>5.00000000000000E-01,'us_pt'=>5.00000000000000E-01,'uk_pt'=>4.16428088074541E-01,'qt'=>2.50000000000000E-01,'gal'=>6.25000000000000E-02,'l'=>2.36639716032341E-01,'lt'=>2.36639716032341E-01),'pt'=>array('tsp'=>9.60000000000000E+01,'tbs'=>3.20000000000000E+01,'oz'=>1.60000000000000E+01,'cup'=>2.00000000000000E+00,'pt'=>1.0,'us_pt'=>1.0,'uk_pt'=>8.32856176149081E-01,'qt'=>5.00000000000000E-01,'gal'=>1.25000000000000E-01,'l'=>4.73279432064682E-01,'lt'=>4.73279432064682E-01),'us_pt'=>array('tsp'=>9.60000000000000E+01,'tbs'=>3.20000000000000E+01,'oz'=>1.60000000000000E+01,'cup'=>2.00000000000000E+00,'pt'=>1.0,'us_pt'=>1.0,'uk_pt'=>8.32856176149081E-01,'qt'=>5.00000000000000E-01,'gal'=>1.25000000000000E-01,'l'=>4.73279432064682E-01,'lt'=>4.73279432064682E-01),'uk_pt'=>array('tsp'=>1.15266000000000E+02,'tbs'=>3.84220000000000E+01,'oz'=>1.92110000000000E+01,'cup'=>2.40137500000000E+00,'pt'=>1.20068750000000E+00,'us_pt'=>1.20068750000000E+00,'uk_pt'=>1.0,'qt'=>6.00343750000000E-01,'gal'=>1.50085937500000E-01,'l'=>5.68260698087162E-01,'lt'=>5.68260698087162E-01),'qt'=>array('tsp'=>1.92000000000000E+02,'tbs'=>6.40000000000000E+01,'oz'=>3.20000000000000E+01,'cup'=>4.00000000000000E+00,'pt'=>2.00000000000000E+00,'us_pt'=>2.00000000000000E+00,'uk_pt'=>1.66571235229816E+00,'qt'=>1.0,'gal'=>2.50000000000000E-01,'l'=>9.46558864129363E-01,'lt'=>9.46558864129363E-01),'gal'=>array('tsp'=>7.68000000000000E+02,'tbs'=>2.56000000000000E+02,'oz'=>1.28000000000000E+02,'cup'=>1.60000000000000E+01,'pt'=>8.00000000000000E+00,'us_pt'=>8.00000000000000E+00,'uk_pt'=>6.66284940919265E+00,'qt'=>4.00000000000000E+00,'gal'=>1.0,'l'=>3.78623545651745E+00,'lt'=>3.78623545651745E+00),'l'=>array('tsp'=>2.02840000000000E+02,'tbs'=>6.76133333333333E+01,'oz'=>3.38066666666667E+01,'cup'=>4.22583333333333E+00,'pt'=>2.11291666666667E+00,'us_pt'=>2.11291666666667E+00,'uk_pt'=>1.75975569552166E+00,'qt'=>1.05645833333333E+00,'gal'=>2.64114583333333E-01,'l'=>1.0,'lt'=>1.0),'lt'=>array('tsp'=>2.02840000000000E+02,'tbs'=>6.76133333333333E+01,'oz'=>3.38066666666667E+01,'cup'=>4.22583333333333E+00,'pt'=>2.11291666666667E+00,'us_pt'=>2.11291666666667E+00,'uk_pt'=>1.75975569552166E+00,'qt'=>1.05645833333333E+00,'gal'=>2.64114583333333E-01,'l'=>1.0,'lt'=>1.0))) [line 7681] #### Tags:
access: | private
Type: | mixed
[ Top ] ### Class Methods ### static method ACCRINT [line 9665]
`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. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
| $basis |
[ Top ] ### static method ACCRINTM [line 9712]
`static float ACCRINTM( mixed $issue, mixed $settlement, float $rate, [float $par = 1000], [int $basis = 0])`
ACCRINTM Returns the discount rate for a security. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method AMORDEGRC [line 9740]
`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 9785]
`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 4975]
`static int ASCIICODE( $characters, string $character)`
ASCIICODE ASCIICODE #### Tags:
access: | public
#### Parameters:
string | $character | Value
| $characters |
[ Top ] ### static method AVEDEV [line 1529]
`static float AVEDEV( mixed $arg,...)`
AVEDEV Returns the average of the absolute deviations of data points from their mean. 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 1272]
`static float AVERAGE( mixed $arg,...)`
AVERAGE 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 1315]
`static float AVERAGEA( mixed $arg,...)`
AVERAGEA 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 BESSELI [line 8373]
`static int BESSELI( float $x, float $n)`
BESSELI 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 8415]
`static int BESSELJ( float $x, float $n)`
BESSELJ BESSELJ Returns the Bessel function #### Tags:
access: | public
#### Parameters:
float | $x |
float | $n |
[ Top ] ### static method BESSELK [line 8493]
`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. 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 8571]
`static int BESSELY( float $x, $ord, float $n)`
BESSELY Returns the Bessel function, which is also called the Weber function or the Neumann function. 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 3930]
`static float BETADIST( float $value, float $alpha, float $beta, [ $rMin = 0], [ $rMax = 1], boolean $cumulative)`
BETADIST Returns the beta distribution. 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 3966]
`static float BETAINV( float $probability, float $alpha, float $beta, [ $rMin = 0], [ $rMax = 1], boolean $cumulative)`
BETAINV Returns the inverse of the beta distribution. 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 3250]
`static float BINOMDIST( float $value, float $trials, float $probability, boolean $cumulative)`
BINOMDIST Returns the individual term binomial distribution probability. 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. babies born are male. 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 6646]
`static string BINTODEC( string $x)`
BINTODEC Return a binary value as Decimal. BINTODEC Return a binary value as Decimal. #### Tags:
access: | public
#### Parameters:
string | $x |
[ Top ] ### static method BINTOHEX [line 6682]
`static string BINTOHEX( string $x, [ $places = null])`
BINTOHEX Return a binary value as Hex. BINTOHEX Return a binary value as Hex. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method BINTOOCT [line 6720]
`static string BINTOOCT( string $x, [ $places = null])`
BINTOOCT Return a binary value as Octal. BINTOOCT Return a binary value as Octal. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method CEILING [line 2766]
`static float CEILING( float $number, [float $significance = null])`
CEILING Returns number rounded up, away from zero, to the nearest multiple of significance. 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 10364]
`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. 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 or omitted Absolute Absolute row; relative column Relative row; absolute column 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 4936]
`static int CHARACTER( string $character)`
CHARACTER CHARACTER #### Tags:
access: | public
#### Parameters:
string | $character | Value
[ Top ] ### static method CHIDIST [line 3435]
`static float CHIDIST( float $value, float $degrees)`
CHIDIST Returns the one-tailed probability of the chi-squared distribution. 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 3464]
`static float CHIINV( float $probability, float $degrees)`
CHIINV Returns the one-tailed probability of the chi-squared distribution. 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 10646]
`static void CHOOSE( )`
#### Tags:
access: | public
[ Top ] ### static method COLUMN [line 10403]
`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. 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 10440]
`static integer COLUMNS( [cellAddress $cellAddress = Null])`
COLUMNS Returns the number of columns in an array or reference. 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 3019]
`static int COMBIN( int $numObjs, int $numInSet)`
COMBIN Returns the number of combinations for a given number of items. determine the total possible number of groups for a given number of items. 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 7066]
`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. 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 5005]
`static string CONCATENATE( )`
CONCATENATE CONCATENATE #### Tags:
access: | public
[ Top ] ### static method CONFIDENCE [line 4694]
`static float CONFIDENCE( float $alpha, float $stdDev, float $size)`
CONFIDENCE 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 8281]
`static float CONVERTUOM( float $value, string $fromUOM, string $toUOM)`
CONVERTUOM CONVERTUOM #### Tags:
access: | public
#### Parameters:
float | $value |
string | $fromUOM |
string | $toUOM |
[ Top ] ### static method CORREL [line 2325]
`static float CORREL( array $yValues, [array $xValues = null])`
CORREL Returns covariance, the average of the products of deviations for each data point pair. 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 1084]
`static int COUNT( mixed $arg,...)`
COUNT 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 1150]
`static int COUNTA( mixed $arg,...)`
COUNTA 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 1119]
`static int COUNTBLANK( mixed $arg,...)`
COUNTBLANK 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 1182]
`static int COUNTIF( $aArgs, string $condition, mixed $arg,...)`
COUNTIF 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 9831]
`static void COUPDAYBS( $settlement, $maturity, $frequency, [ $basis = 0])`
#### Tags:
access: | public
#### Parameters:
| $settlement |
| $maturity |
| $frequency |
| $basis |
[ Top ] ### static method COUPNUM [line 9811]
`static void COUPNUM( $settlement, $maturity, $frequency, [ $basis = 0])`
#### Tags:
access: | public
#### Parameters:
| $settlement |
| $maturity |
| $frequency |
| $basis |
[ Top ] ### static method COVAR [line 2298]
`static float COVAR( array $yValues, array $xValues)`
COVAR Returns covariance, the average of the products of deviations for each data point pair. 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 3335]
`static int CRITBINOM( float $trials, float $probability, float $alpha)`
CRITBINOM 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 9171]
`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. 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 9246]
`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. 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 5545]
`static mixed DATE( [long $year = 0], [long $month = 1], [long $day = 1])`
DATE 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 5929]
`static long DATEDIF( [long $startDate = 0], [long $endDate = 0], [string $unit = 'D'])`
DATEDIF 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 5839]
`static mixed DATENOW( )`
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 5815]
`static mixed DATETIMENOW( )`
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 5677]
`static mixed DATEVALUE( [string $dateValue = 1])`
DATEVALUE 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 6226]
`static int DAYOFMONTH( [long $dateValue = 1])`
DAYOFMONTH DAYOFMONTH #### Tags:
return: | Day
access: | public
#### Parameters:
long | $dateValue | Excel date serial value or a standard date string
[ Top ] ### static method DAYOFWEEK [line 6250]
`static int DAYOFWEEK( [long $dateValue = 1], [ $style = 1])`
DAYOFWEEK DAYOFWEEK #### Tags:
return: | Day
access: | public
#### Parameters:
long | $dateValue | Excel date serial value or a standard date string
| $style |
[ Top ] ### static method DAYS360 [line 5895]
`static long DAYS360( [long $startDate = 0], [long $endDate = 0], [boolean $method = false])`
DAYS360 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 9540]
`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. 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 9592]
`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. 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 6758]
`static string DECTOBIN( string $x, [ $places = null])`
DECTOBIN Return an octal value as binary. DECTOBIN Return an octal value as binary. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method DECTOHEX [line 6828]
`static string DECTOHEX( string $x, [ $places = null])`
DECTOHEX Return an octal value as binary. DECTOHEX Return an octal value as binary. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method DECTOOCT [line 6794]
`static string DECTOOCT( string $x, [ $places = null])`
DECTOOCT Return an octal value as binary. DECTOOCT Return an octal value as binary. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method DELTA [line 8609]
`static int DELTA( float $a, [float $b = 0])`
DELTA Tests whether two values are equal. 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 1479]
`static float DEVSQ( mixed $arg,...)`
DEVSQ Returns the sum of squares of deviations of data points from their sample mean. 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 9870]
`static float DISC( mixed $settlement, mixed $maturity, int $price, int $redemption, [int $basis = 0])`
DISC Returns the discount rate for a security. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method DOLLAR [line 8827]
`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. 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 8860]
`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. 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 8890]
`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. 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 231]
`static string DUMMY( )`
DUMMY DUMMY #### Tags:
return: | #Not Yet Implemented
access: | public
[ Top ] ### static method EDATE [line 6506]
`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). 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 8919]
`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. 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 6542]
`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. 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 8671]
`static int ERF( float $lower, [float $upper = null])`
ERF 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 8733]
`static int ERFC( float $x)`
ERFC 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 5373]
`static boolean ERROR_TYPE( [mixed $value = ''])`
ERROR_TYPE ERROR_TYPE #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method EVEN [line 2796]
`static int EVEN( float $number)`
EVEN Returns number rounded up to the nearest even integer. 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 3523]
`static float EXPONDIST( float $value, float $lambda, boolean $cumulative)`
EXPONDIST Returns the exponential distribution. such as how long an automated bank teller takes to deliver cash. use EXPONDIST to determine the probability that the process takes at most 1 minute. 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 2672]
`static int FACT( float $factVal)`
FACT Returns the factorial of a number. FACT Returns the factorial of a number. #### Tags:
return: | Factorial
access: | public
#### Parameters:
float | $factVal | Factorial Value
[ Top ] ### static method FACTDOUBLE [line 2704]
`static int FACTDOUBLE( float $factVal)`
FACTDOUBLE Returns the double factorial of a number. FACTDOUBLE Returns the double factorial of a number. #### Tags:
return: | Double Factorial
access: | public
#### Parameters:
float | $factVal | Factorial Value
[ Top ] ### static method FISHER [line 3554]
`static float FISHER( float $value)`
FISHER Returns the Fisher transformation at x. is normally distributed rather than skewed. testing on the correlation coefficient. 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 3577]
`static float FISHERINV( float $value)`
FISHERINV Returns the inverse of the Fisher transformation. analyzing correlations between ranges or arrays of data. FISHERINV(y) = x. 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 5292]
`static boolean FIXEDFORMAT( mixed $value, [ $decimals = 2], [ $no_commas = false])`
FIXEDFORMAT FIXEDFORMAT #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $decimals |
| $no_commas |
[ Top ] ### static method flattenArray [line 11266]
`static array flattenArray( array $array)`
Convert a multi-dimensional array to a simple 1-dimensional 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 11298]
`static array flattenArrayIndexed( array $array)`
Convert a multi-dimensional array to a simple 1-dimensional array, but retain an element of indexing 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 11330]
`static mixed flattenSingleValue( [mixed $value = ''])`
Convert an array to a single scalar value by extracting the first element 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 2959]
`static float FLOOR( float $number, [float $significance = null])`
FLOOR Rounds number down, toward zero, to the nearest multiple of significance. 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 2468]
`static float FORECAST( float $xValue, array $yValues, array $xValues)`
FORECAST Calculates, or predicts, a future value by using existing values. 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 9000]
`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). 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 9025]
`static void FVSCHEDULE( $principal, $schedule)`
FVSCHEDULE FVSCHEDULE #### Tags:
access: | public
#### Parameters:
| $principal |
| $schedule |
[ Top ] ### static method GAMMADIST [line 4062]
`static float GAMMADIST( float $value, float $a, float $b, boolean $cumulative)`
GAMMADIST Returns the gamma distribution. 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 4094]
`static float GAMMAINV( float $probability, float $alpha, float $beta)`
GAMMAINV Returns the inverse of the beta distribution. 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 4152]
`static float GAMMALN( float $value)`
GAMMALN Returns the natural logarithm of the gamma function. GAMMALN Returns the natural logarithm of the gamma function. #### Tags:
access: | public
#### Parameters:
float | $value |
[ Top ] ### static method GCD [line 3178]
`static int GCD( $array 0)`
GCD 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 1579]
`static float GEOMEAN( mixed $arg,...)`
GEOMEAN Returns the geometric mean of an array or range of positive data. can use GEOMEAN to calculate average growth rate given compound interest with variable rates. 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 8626]
`static int GESTEP( float $number, [float $step = 0])`
GESTEP GESTEP Returns 1 if number = step; returns 0 (zero) otherwise #### Tags:
access: | public
#### Parameters:
float | $number |
float | $step |
[ Top ] ### static method getCompatibilityMode [line 180]
`static string getCompatibilityMode( )`
Return the current Compatibility Mode 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 8220]
`static array getConversionGroups( )`
getConversionGroups getConversionGroups #### Tags:
access: | public
[ Top ] ### static method getConversionGroupUnitDetails [line 8250]
`static array getConversionGroupUnitDetails( [ $group = NULL])`
getConversionGroupUnitDetails getConversionGroupUnitDetails #### Tags:
access: | public
#### Parameters:
| $group |
[ Top ] ### static method getConversionGroupUnits [line 8234]
`static array getConversionGroupUnits( [ $group = NULL])`
getConversionGroupUnits getConversionGroupUnits #### Tags:
access: | public
#### Parameters:
| $group |
[ Top ] ### static method getConversionMultipliers [line 8268]
`static array getConversionMultipliers( )`
getConversionGroups getConversionGroups #### Tags:
access: | public
[ Top ] ### static method getReturnDateType [line 219]
`static string getReturnDateType( )`
Return the current Return Date Format for functions that return a date/time (Excel, PHP Serialized Numeric or PHP Object) 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 2533]
`static array GROWTH( array $yValues, [array $xValues = array()], [array $newValues = array()], [boolean $const = True])`
GROWTH 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 1607]
`static float HARMEAN( mixed $arg,...)`
HARMEAN Returns the harmonic mean of a data set. arithmetic mean of reciprocals. 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 6862]
`static string HEXTOBIN( string $x, [ $places = null])`
HEXTOBIN Return a hex value as binary. HEXTOBIN Return a hex value as binary. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method HEXTODEC [line 6912]
`static string HEXTODEC( string $x)`
HEXTODEC Return a hex value as octal. HEXTODEC Return a hex value as octal. #### Tags:
access: | public
#### Parameters:
string | $x |
[ Top ] ### static method HEXTOOCT [line 6887]
`static string HEXTOOCT( string $x, [ $places = null])`
HEXTOOCT Return a hex value as octal. HEXTOOCT Return a hex value as octal. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method HOUROFDAY [line 6377]
`static int HOUROFDAY( [mixed $timeValue = 0])`
HOUROFDAY HOUROFDAY #### Tags:
return: | Hour
access: | public
#### Parameters:
mixed | $timeValue | Excel time serial value or a standard time string
[ Top ] ### static method HYPGEOMDIST [line 4543]
`static float HYPGEOMDIST( float $sampleSuccesses, float $sampleNumber, float $populationSuccesses, float $populationNumber)`
HYPGEOMDIST Returns the hypergeometric distribution. sample successes, given the sample size, population successes, and population size. 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 7142]
`static real IMABS( string $complexNumber)`
IMABS Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format. 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 7104]
`static real IMAGINARY( string $complexNumber)`
IMAGINARY Returns the imaginary coefficient of a complex number in x + yi or x + yj text format. 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 7161]
`static string IMARGUMENT( string $complexNumber)`
IMARGUMENT Returns the argument theta of a complex number, i. 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 7195]
`static string IMCONJUGATE( string $complexNumber)`
IMCONJUGATE Returns the complex conjugate of a complex number in x + yi or x + yj text format. 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 7220]
`static string IMCOS( string $complexNumber)`
IMCOS Returns the cosine of a complex number in x + yi or x + yj text format. 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 7447]
`static real IMDIV( string $complexDividend, string $complexDivisor)`
IMDIV Returns the quotient of two complex numbers in x + yi or x + yj text format. 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 7380]
`static string IMEXP( string $complexNumber)`
IMEXP Returns the exponential of a complex number in x + yi or x + yj text format. 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 7297]
`static string IMLN( string $complexNumber)`
IMLN Returns the natural logarithm of a complex number in x + yi or x + yj text format. 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 7354]
`static string IMLOG2( string $complexNumber)`
IMLOG2 Returns the common logarithm (base 10) of a complex number in x + yi or x + yj text format. 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 7328]
`static string IMLOG10( string $complexNumber)`
IMLOG10 Returns the common logarithm (base 10) of a complex number in x + yi or x + yj text format. 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 7412]
`static string IMPOWER( string $complexNumber, $realNumber)`
IMPOWER Returns a complex number in x + yi or x + yj text format raised to a power. 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 7567]
`static real IMPRODUCT( array 0)`
IMPRODUCT Returns the product of two or more complex numbers in x + yi or x + yj text format. 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 7123]
`static real IMREAL( string $complexNumber)`
IMREAL Returns the real coefficient of a complex number in x + yi or x + yj text format. 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 7244]
`static string IMSIN( string $complexNumber)`
IMSIN Returns the sine of a complex number in x + yi or x + yj text format. 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 7268]
`static string IMSQRT( string $complexNumber)`
IMSQRT Returns the square root of a complex number in x + yi or x + yj text format. 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 7495]
`static real IMSUB( string $complexNumber1, string $complexNumber2)`
IMSUB Returns the difference of two complex numbers in x + yi or x + yj text format. 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 7531]
`static real IMSUM( array 0)`
IMSUM Returns the sum of two or more complex numbers in x + yi or x + yj text format. 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 10802]
`static void INDEX( range_array $arrayValues, [row_num $rowNum = 0], [column_num $columnNum = 0])`
Uses an index to choose a value from a reference or array 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 10533]
`static integer INDIRECT( [cellAddress $cellAddress = Null], [ $pCell = null])`
INDIRECT Returns the number of rows in an array or reference. 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 2190]
`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. 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 10057]
`static float INTRATE( mixed $settlement, mixed $maturity, int $investment, int $redemption, [int $basis = 0])`
INTRATE Returns the interest rate for a fully invested security. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method INTVALUE [line 2841]
`static integer INTVALUE( float $number)`
INTVALUE 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 9135]
`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. 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 9368]
`static void IRR( $values, [ $guess = 0.1])`
#### Tags:
access: | public
#### Parameters:
| $values |
| $guess |
[ Top ] ### static method isCellValue [line 306]
`static void isCellValue( $idx)`
#### Tags:
access: | private
#### Parameters:
| $idx |
[ Top ] ### static method isMatrixValue [line 296]
`static void isMatrixValue( $idx)`
#### Tags:
access: | private
#### Parameters:
| $idx |
[ Top ] ### static method ISPMT [line 9288]
`static void ISPMT( )`
ISPMT Returns the interest payment for an investment based on an interest rate and a constant payment schedule. 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 isValue [line 301]
`static void isValue( $idx)`
#### Tags:
access: | private
#### Parameters:
| $idx |
[ Top ] ### static method IS_BLANK [line 5393]
`static boolean IS_BLANK( [mixed $value = null])`
IS_BLANK IS_BLANK #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_ERR [line 5408]
`static boolean IS_ERR( [mixed $value = ''])`
IS_ERR IS_ERR #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_ERROR [line 5421]
`static boolean IS_ERROR( [mixed $value = ''])`
IS_ERROR IS_ERROR #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_EVEN [line 5447]
`static boolean IS_EVEN( [mixed $value = 0])`
IS_EVEN IS_EVEN #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_LOGICAL [line 5495]
`static boolean IS_LOGICAL( [mixed $value = true])`
IS_LOGICAL IS_LOGICAL #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_NA [line 5434]
`static boolean IS_NA( [mixed $value = ''])`
IS_NA IS_NA #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_NONTEXT [line 5521]
`static boolean IS_NONTEXT( [mixed $value = ''])`
IS_NONTEXT IS_NONTEXT #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_NUMBER [line 5479]
`static boolean IS_NUMBER( [mixed $value = 0])`
IS_NUMBER IS_NUMBER #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_ODD [line 5463]
`static boolean IS_ODD( [mixed $value = null])`
IS_ODD IS_ODD #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method IS_TEXT [line 5508]
`static boolean IS_TEXT( [mixed $value = ''])`
IS_TEXT IS_TEXT #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method KURT [line 4859]
`static float KURT( array 0)`
KURT Returns the kurtosis of a data set. or flatness of a distribution compared with the normal distribution. kurtosis indicates a relatively peaked distribution. relatively flat distribution. 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 964]
`static float LARGE( mixed $arg,..., int $entry)`
LARGE Returns the nth largest value in a data set. select a value based on its relative standing. 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 3133]
`static int LCM( $array 0)`
LCM 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 5126]
`static string LEFT( [string $value = ''], [int $chars = 1])`
LEFT LEFT #### Tags:
access: | public
#### Parameters:
string | $value | Value
int | $chars | Number of characters
[ Top ] ### static method LINEST [line 2358]
`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. 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 2411]
`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. 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 332]
`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. 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 435]
`static boolean LOGICAL_FALSE( )`
LOGICAL_FALSE Returns the boolean FALSE. LOGICAL_FALSE Returns the boolean FALSE. Excel Function: =FALSE() #### Tags:
return: | False
access: | public
[ Top ] ### static method LOGICAL_NOT [line 477]
`static boolean LOGICAL_NOT( mixed $logical)`
LOGICAL_NOT Returns the boolean inverse of the argument. 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 388]
`static boolean LOGICAL_OR( mixed $arg,...)`
LOGICAL_OR Returns boolean TRUE if any argument is TRUE; returns FALSE if all arguments are FALSE. 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 452]
`static boolean LOGICAL_TRUE( )`
LOGICAL_TRUE Returns the boolean TRUE. LOGICAL_TRUE Returns the boolean TRUE. Excel Function: =TRUE() #### Tags:
return: | True
access: | public
[ Top ] ### static method LOGINV [line 4515]
`static float LOGINV( $probability, $mean, $stdDev, float $value)`
LOGINV 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 4226]
`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. 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 603]
`static float LOG_BASE( $number, [float $base = 10], float $value)`
LOG_BASE Returns the logarithm of a number to a specified base. 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 11207]
`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. 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 8754]
`static string LOWERCASE( string $mixedCaseString)`
LOWERCASE Converts a string value to upper case. LOWERCASE Converts a string value to upper case. #### Tags:
access: | public
#### Parameters:
string | $mixedCaseString |
[ Top ] ### static method MATCH [line 10682]
`static integer MATCH( lookup_value $lookup_value, lookup_array $lookup_array, [match_type $match_type = 1])`
MATCH 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 884]
`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. 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 920]
`static float MAXA( mixed $arg,...)`
MAXA 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 MDETERM [line 10988]
`static float MDETERM( array $matrixValues)`
MDETERM MDETERM #### Tags:
access: | public
#### Parameters:
array | $matrixValues | A matrix of values
[ Top ] ### static method MEDIAN [line 1364]
`static float MEDIAN( mixed $arg,...)`
MEDIAN Returns the median of the given numbers. 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 5181]
`static string MID( [string $value = ''], [int $start = 1], [int $chars = null])`
MID MID #### Tags:
access: | public
#### Parameters:
string | $value | Value
int | $start | Start character
int | $chars | Number of characters
[ Top ] ### static method MIN [line 765]
`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. 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 801]
`static float MINA( mixed $arg,...)`
MINA 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 MINUTEOFHOUR [line 6410]
`static int MINUTEOFHOUR( [long $timeValue = 0])`
MINUTEOFHOUR MINUTEOFHOUR #### Tags:
return: | Minute
access: | public
#### Parameters:
long | $timeValue | Excel time serial value or a standard time string
[ Top ] ### static method MINVERSE [line 10954]
`static array MINVERSE( array $matrixValues)`
MINVERSE MINVERSE #### Tags:
access: | public
#### Parameters:
array | $matrixValues | A matrix of values
[ Top ] ### static method MIRR [line 9408]
`static void MIRR( $values, $finance_rate, $reinvestment_rate)`
#### Tags:
access: | public
#### Parameters:
| $values |
| $finance_rate |
| $reinvestment_rate |
[ Top ] ### static method MMULT [line 10904]
`static array MMULT( array $matrixData1, array $matrixData2)`
MMULT MMULT #### Tags:
access: | public
#### Parameters:
array | $matrixData1 | A matrix of values
array | $matrixData2 | A matrix of values
[ Top ] ### static method MOD [line 4914]
`static int MOD( [int $a = 1], [int $b = 1])`
MOD MOD #### Tags:
return: | Remainder
access: | public
#### Parameters:
int | $a | Dividend
int | $b | Divisor
[ Top ] ### static method MODE [line 1442]
`static float MODE( mixed $arg,...)`
MODE 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 6333]
`static int MONTHOFYEAR( [long $dateValue = 1])`
MONTHOFYEAR MONTHOFYEAR #### Tags:
return: | Month
access: | public
#### Parameters:
long | $dateValue | Excel date serial value or a standard date string
[ Top ] ### static method MROUND [line 2910]
`static float MROUND( float $number, int $multiple)`
MROUND 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 2730]
`static float MULTINOMIAL( array 0)`
MULTINOMIAL Returns the ratio of the factorial of a sum of values to the product of factorials. 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 NA [line 243]
`static string NA( )`
NA NA #### Tags:
return: | #N/A!
access: | public
[ Top ] ### static method NAME [line 267]
`static string NAME( )`
NAME NAME #### Tags:
return: | #NAME!
access: | public
[ Top ] ### static method NaN [line 255]
`static string NaN( )`
NAN NAN #### Tags:
return: | #NUM!
access: | public
[ Top ] ### static method NEGBINOMDIST [line 3293]
`static float NEGBINOMDIST( float $failures, float $successes, float $probability)`
NEGBINOMDIST Returns the negative binomial distribution. there will be number_f failures before the number_s-th success, when the constant probability of a success is probability_s. distribution, except that the number of successes is fixed, and the number of trials is variable. 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 6082]
`static long NETWORKDAYS( mixed $startDate, mixed $endDate, array 2)`
NETWORKDAYS 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 8941]
`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. 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 4179]
`static float NORMDIST( float $value, float $mean, float $stdDev, boolean $cumulative)`
NORMDIST Returns the normal distribution for the specified mean and standard deviation. function has a very wide range of applications in statistics, including hypothesis testing. 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 4472]
`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. 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 4210]
`static float NORMSDIST( float $value)`
NORMSDIST Returns the standard normal cumulative distribution function. a mean of 0 (zero) and a standard deviation of one. table of standard normal curve areas. 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 4498]
`static float NORMSINV( float $value)`
NORMSINV NORMSINV Returns the inverse of the standard normal cumulative distribution #### Tags:
access: | public
#### Parameters:
float | $value |
[ Top ] ### static method NPER [line 9082]
`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. 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 9322]
`static float NPV( float 0, array 1)`
NPV Returns the Net Present Value of a cash flow series given a discount rate. 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 6934]
`static string OCTTOBIN( string $x, [ $places = null])`
OCTTOBIN Return an octal value as binary. OCTTOBIN Return an octal value as binary. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method OCTTODEC [line 6959]
`static string OCTTODEC( string $x)`
OCTTODEC Return an octal value as binary. OCTTODEC Return an octal value as binary. #### Tags:
access: | public
#### Parameters:
string | $x |
[ Top ] ### static method OCTTOHEX [line 6981]
`static string OCTTOHEX( string $x, [ $places = null])`
OCTTOHEX Return an octal value as hex. OCTTOHEX Return an octal value as hex. #### Tags:
access: | public
#### Parameters:
string | $x |
| $places |
[ Top ] ### static method ODD [line 2815]
`static int ODD( float $number)`
ODD Returns number rounded up to the nearest odd integer. 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 10583]
`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. 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 1004]
`static float PERCENTILE( mixed $arg,..., float $entry)`
PERCENTILE Returns the nth percentile of values in a range. 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 2120]
`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. 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 2994]
`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. events where internal order is significant. combinations, for which the internal order is not significant. for lottery-style probability calculations. 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 9049]
`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. 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 4725]
`static float POISSON( float $value, float $mean, boolean $cumulative)`
POISSON Returns 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. 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 6611]
`static float POWER( [float $x = 0], [float $y = 2])`
POWER Computes x raised to the power y. POWER Computes x raised to the power y. #### Tags:
access: | public
#### Parameters:
float | $x |
float | $y |
[ Top ] ### static method PPMT [line 9210]
`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. 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 PRICEDISC [line 9912]
`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. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method PRICEMAT [line 9955]
`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. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method PRODUCT [line 686]
`static float PRODUCT( mixed $arg,...)`
PRODUCT PRODUCT returns the product of all the values and cells referenced in the argument list. 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 8800]
`static string PROPERCASE( string $mixedCaseString)`
PROPERCASE Converts a string value to upper case. PROPERCASE Converts a string value to upper case. #### Tags:
access: | public
#### Parameters:
string | $mixedCaseString |
[ Top ] ### static method PV [line 8967]
`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). 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 1054]
`static float QUARTILE( mixed $arg,..., int $entry)`
QUARTILE Returns the quartile of a data set. 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 725]
`static float QUOTIENT( mixed $arg,...)`
QUOTIENT QUOTIENT function returns the integer portion of a division. and denominator is the divisor. 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 4895]
`static int RAND( [int $min = 0], [int $max = 0])`
RAND RAND #### Tags:
return: | Random number
access: | public
#### Parameters:
int | $min | Minimal value
int | $max | Maximal value
[ Top ] ### static method RANK [line 2085]
`static float RANK( number $value, array $valueSet, [mixed $order = 0])`
RANK Returns the rank of a number in a list of numbers. 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 9484]
`static void RATE( $nper, $pmt, $pv, [ $fv = 0.0], [ $type = 0], [ $guess = 0.1])`
RATE RATE #### Tags:
access: | public
#### Parameters:
| $nper |
| $pmt |
| $pv |
| $fv |
| $type |
| $guess |
[ Top ] ### static method RECEIVED [line 10015]
`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. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method REF [line 279]
`static string REF( )`
REF REF #### Tags:
return: | #REF!
access: | public
[ Top ] ### static method REPLACE [line 5210]
`static string REPLACE( [ $oldText = ''], [int $start = 1], [int $chars = null], $newText, string $value)`
REPLACE REPLACE #### Tags:
access: | public
#### Parameters:
string | $value | Value
int | $start | Start character
int | $chars | Number of characters
| $oldText |
| $newText |
[ Top ] ### static method RETURNSTRING [line 5276]
`static boolean RETURNSTRING( [ $testValue = ''], mixed $value)`
RETURNSTRING RETURNSTRING #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $testValue |
[ Top ] ### static method REVERSE_ATAN2 [line 577]
`static float REVERSE_ATAN2( float $xCoordinate, float $yCoordinate)`
ATAN2 This function calculates the arc tangent of the two variables x and y. calculating the arc tangent of y ÷ x, except that the signs of both arguments are used to determine the quadrant of the result. 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 5153]
`static string RIGHT( [string $value = ''], [int $chars = 1])`
RIGHT RIGHT #### Tags:
access: | public
#### Parameters:
string | $value | Value
int | $chars | Number of characters
[ Top ] ### static method ROMAN [line 2558]
`static void ROMAN( $aValue, [ $style = 0])`
#### Tags:
access: | public
#### Parameters:
| $aValue |
| $style |
[ Top ] ### static method ROUNDDOWN [line 2885]
`static float ROUNDDOWN( float $number, int $digits)`
ROUNDDOWN 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 2860]
`static float ROUNDUP( float $number, int $digits)`
ROUNDUP 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 10469]
`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. 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 10507]
`static integer ROWS( [cellAddress $cellAddress = Null])`
ROWS Returns the number of rows in an array or reference. 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 2217]
`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. 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 5094]
`static string SEARCHINSENSITIVE( string $needle, string $haystack, [int $offset = 1])`
SEARCHINSENSITIVE 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 5061]
`static string SEARCHSENSITIVE( string $needle, string $haystack, [int $offset = 1])`
SEARCHSENSITIVE 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 6443]
`static int SECONDOFMINUTE( [long $timeValue = 0])`
SECONDOFMINUTE SECONDOFMINUTE #### Tags:
return: | Second
access: | public
#### Parameters:
long | $timeValue | Excel time serial value or a standard time string
[ Top ] ### static method SERIESSUM [line 3046]
`static float SERIESSUM( float $x, float $n, float $m, array 3)`
SERIESSUM 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 158]
`static boolean setCompatibilityMode( string $compatibilityMode)`
Set the Compatibility Mode 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 197]
`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) 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 2937]
`static int SIGN( float $number)`
SIGN Determines the sign of a number. if the number is 0, and -1 if the number is negative. 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 4821]
`static float SKEW( array 0)`
SKEW Returns the skewness of a distribution. of a distribution around its mean. asymmetric tail extending toward more positive values. distribution with an asymmetric tail extending toward more negative values. 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 10222]
`static float SLN( cost $cost, salvage $salvage, life $life)`
SLN 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 2244]
`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. 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 844]
`static float SMALL( mixed $arg,..., int $entry)`
SMALL Returns the nth smallest value in a data set. select a value based on its relative standing. 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 2651]
`static float SQRTPI( float $number)`
SQRTPI Returns the square root of (number * pi). 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 3085]
`static float STANDARDIZE( float $value, float $mean, float $stdDev)`
STANDARDIZE Returns a normalized value from a distribution characterized by mean and standard_dev. 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 526]
`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. 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 547]
`static mixed STATEMENT_IFERROR( [mixed $testValue = ''], [mixed $errorpart = ''])`
STATEMENT_IFERROR 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 1700]
`static float STDEV( mixed $arg,...)`
STDEV Estimates standard deviation based on a sample. widely values are dispersed from the average value (the mean). 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 1747]
`static float STDEVA( mixed $arg,...)`
STDEVA 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 1799]
`static float STDEVP( mixed $arg,...)`
STDEVP 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 1846]
`static float STDEVPA( mixed $arg,...)`
STDEVPA 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 2271]
`static float STEYX( array $yValues, array $xValues)`
STEYX Returns the standard error of the predicted y-value for each x in the regression. 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 5038]
`static string STRINGLENGTH( [string $value = ''], int $chars)`
STRINGLENGTH STRINGLENGTH #### Tags:
access: | public
#### Parameters:
string | $value | Value
int | $chars | Number of characters
[ Top ] ### static method SUBSTITUTE [line 5232]
`static string SUBSTITUTE( [string $text = ''], [string $fromText = ''], [string $toText = ''], [integer $instance = 0])`
SUBSTITUTE 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 2596]
`static float SUBTOTAL( int 0, array 1)`
SUBTOTAL Returns a subtotal in a list or database. 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 624]
`static float SUM( mixed $arg,...)`
SUM SUM computes the sum of all the values and cells referenced in the argument list. 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 1226]
`static float SUMIF( $aArgs, string $condition, [ $sumArgs = array()], mixed $arg,...)`
SUMIF 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 11022]
`static float SUMPRODUCT( mixed $value)`
SUMPRODUCT SUMPRODUCT #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
[ Top ] ### static method SUMSQ [line 655]
`static float SUMSQ( mixed $arg,...)`
SUMSQ 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 11053]
`static float SUMX2MY2( $matrixData1, $matrixData2, mixed $value)`
SUMX2MY2 SUMX2MY2 #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $matrixData1 |
| $matrixData2 |
[ Top ] ### static method SUMX2PY2 [line 11082]
`static float SUMX2PY2( $matrixData1, $matrixData2, mixed $value)`
SUMX2PY2 SUMX2PY2 #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $matrixData1 |
| $matrixData2 |
[ Top ] ### static method SUMXMY2 [line 11111]
`static float SUMXMY2( $matrixData1, $matrixData2, mixed $value)`
SUMXMY2 SUMXMY2 #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $matrixData1 |
| $matrixData2 |
[ Top ] ### static method SYD [line 10855]
`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. 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 10092]
`static float TBILLEQ( mixed $settlement, mixed $maturity, int $discount)`
TBILLEQ Returns the bond-equivalent yield for a Treasury bill. 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 10130]
`static float TBILLPRICE( mixed $settlement, mixed $maturity, int $discount)`
TBILLPRICE Returns the yield for a Treasury bill. 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 10181]
`static float TBILLYIELD( mixed $settlement, mixed $maturity, int $price)`
TBILLYIELD Returns the yield for a Treasury bill. 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 4577]
`static float TDIST( float $value, float $degrees, float $tails)`
TDIST Returns the probability of Student's T distribution. 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 5313]
`static boolean TEXTFORMAT( mixed $value, $format)`
TEXTFORMAT TEXTFORMAT #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $format |
[ Top ] ### static method TIME [line 5601]
`static mixed TIME( [long $hour = 0], [long $minute = 0], [long $second = 0])`
TIME 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 5771]
`static mixed TIMEVALUE( string $timeValue)`
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 4637]
`static float TINV( float $probability, float $degrees)`
TINV Returns the one-tailed probability of the chi-squared distribution. 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 10880]
`static array TRANSPOSE( array $matrixData)`
TRANSPOSE 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 2502]
`static array TREND( array $yValues, [array $xValues = array()], [array $newValues = array()], [boolean $const = True])`
TREND 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 1657]
`static float TRIMMEAN( mixed $arg,..., float $discard)`
TRIMMEAN Returns the mean of the interior of a data set. taken by excluding a percentage of data points from the top and bottom tails of a data set. 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 5349]
`static string TRIMNONPRINTABLE( [ $stringValue = ''], mixed $value)`
TRIMNONPRINTABLE TRIMNONPRINTABLE #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $stringValue |
[ Top ] ### static method TRIMSPACES [line 5331]
`static string TRIMSPACES( [ $stringValue = ''], mixed $value)`
TRIMSPACES TRIMSPACES #### Tags:
access: | public
#### Parameters:
mixed | $value | Value to check
| $stringValue |
[ Top ] ### static method TRUNC [line 6580]
`static float TRUNC( [float $value = 0], [int $number_digits = 0])`
TRUNC Truncates value to the number of fractional digits by number_digits. 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 UPPERCASE [line 8777]
`static string UPPERCASE( string $mixedCaseString)`
UPPERCASE Converts a string value to upper case. UPPERCASE Converts a string value to upper case. #### Tags:
access: | public
#### Parameters:
string | $mixedCaseString |
[ Top ] ### static method VALUE [line 291]
`static string VALUE( )`
VALUE VALUE #### Tags:
return: | #VALUE!
access: | public
[ Top ] ### static method VARA [line 1940]
`static float VARA( mixed $arg,...)`
VARA 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 1898]
`static float VARFunc( mixed $arg,...)`
VARFunc Estimates variance based on a sample. 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 1993]
`static float VARP( mixed $arg,...)`
VARP 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 2035]
`static float VARPA( mixed $arg,...)`
VARPA 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 5531]
`static string VERSION( )`
VERSION VERSION #### Tags:
return: | Version information
access: | public
[ Top ] ### static method VLOOKUP [line 11152]
`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. 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 6297]
`static int WEEKOFYEAR( [long $dateValue = 1], [boolean $method = 1])`
WEEKOFYEAR 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 4762]
`static float WEIBULL( float $value, float $alpha, float $beta, boolean $cumulative)`
WEIBULL Returns the Weibull distribution. analysis, such as calculating a device's mean time to failure. 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 6142]
`static long WORKDAY( mixed $startDate, mixed $endDays, array 2)`
WORKDAY 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 9438]
`static void XIRR( $values, $dates, [ $guess = 0.1])`
#### Tags:
access: | public
#### Parameters:
| $values |
| $dates |
| $guess |
[ Top ] ### static method XNPV [line 9353]
`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. 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 6355]
`static int YEAR( [long $dateValue = 1])`
YEAR YEAR #### Tags:
return: | Year
access: | public
#### Parameters:
long | $dateValue | Excel date serial value or a standard date string
[ Top ] ### static method YEARFRAC [line 6033]
`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). to assign to a specific term. 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 or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method YIELDDISC [line 10318]
`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. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method YIELDMAT [line 10258]
`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. 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. or omitted US (NASD) 30/360 Actual/actual Actual/360 Actual/365 European 30/360
[ Top ] ### static method ZTEST [line 4796]
`static float ZTEST( $dataSet, $m0, [ $sigma = null], float $value, float $alpha, float $beta, boolean $cumulative)`
ZTEST Returns the Weibull distribution. analysis, such as calculating a device's mean time to failure. 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 _adjustDateByMonths [line 6470]
`static void _adjustDateByMonths( [ $dateValue = 0], [ $adjustmentMonths = 0])`
#### Tags:
access: | private
#### Parameters:
| $dateValue |
| $adjustmentMonths |
[ Top ] ### static method _Besselk0 [line 8450]
`static void _Besselk0( $fNum)`
#### Tags:
access: | private
#### Parameters:
| $fNum |
[ Top ] ### static method _Besselk1 [line 8467]
`static void _Besselk1( $fNum)`
#### Tags:
access: | private
#### Parameters:
| $fNum |
[ Top ] ### static method _Bessely0 [line 8522]
`static void _Bessely0( $fNum)`
#### Tags:
access: | private
#### Parameters:
| $fNum |
[ Top ] ### static method _Bessely1 [line 8540]
`static void _Bessely1( $fNum)`
#### Tags:
access: | private
#### Parameters:
| $fNum |
[ Top ] ### static method _beta [line 3880]
`static 0 _beta( p $p, q $q)`
Beta function. Beta function. #### Tags:
return: | if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
author: | Jaco van Kooten
access: | private
#### Parameters:
p | $p | require p>0
q | $q | require q>0
[ Top ] ### static method _betaFraction [line 3618]
`static void _betaFraction( $x, $p, $q)`
Evaluates of continued fraction part of incomplete beta function. Evaluates of continued fraction part of incomplete beta function. Based on an idea from Numerical Recipes (W.H. Press et al, 1992). #### Tags:
author: | Jaco van Kooten
access: | private
#### Parameters:
| $x |
| $p |
| $q |
[ Top ] ### static method _checkTrendArrays [line 2156]
`static void _checkTrendArrays( &$array1, &$array2)`
#### Tags:
access: | private
#### Parameters:
| &$array1 |
| &$array2 |
[ Top ] ### static method _cleanComplex [line 7047]
`static void _cleanComplex( $complexNumber)`
#### Tags:
access: | private
#### Parameters:
| $complexNumber |
[ Top ] ### static method _dateDiff360 [line 5863]
`static void _dateDiff360( $startDay, $startMonth, $startYear, $endDay, $endMonth, $endYear, $methodUS)`
#### Tags:
access: | private
#### Parameters:
| $startDay |
| $startMonth |
| $startYear |
| $endDay |
| $endMonth |
| $endYear |
| $methodUS |
[ Top ] ### static method _daysPerYear [line 9623]
`static void _daysPerYear( $year, $basis)`
#### Tags:
access: | private
#### Parameters:
| $year |
| $basis |
[ Top ] ### static method _erfcVal [line 8698]
`static void _erfcVal( $x)`
#### Tags:
access: | private
#### Parameters:
| $x |
[ Top ] ### static method _erfVal [line 8639]
`static void _erfVal( $x)`
#### Tags:
access: | private
#### Parameters:
| $x |
[ Top ] ### static method _factors [line 3103]
`static void _factors( $value)`
#### Tags:
access: | private
#### Parameters:
| $value |
[ Top ] ### static method _gamma [line 4026]
`static void _gamma( $data)`
#### Tags:
access: | private
#### Parameters:
| $data |
[ Top ] ### static method _getDateValue [line 5746]
`static mixed _getDateValue( string $dateValue)`
_getDateValue _getDateValue #### Tags:
return: | Excel date/time serial value, or string if error
access: | private
#### Parameters:
string | $dateValue |
[ Top ] ### static method _getTimeValue [line 5800]
`static mixed _getTimeValue( string $timeValue)`
_getTimeValue _getTimeValue #### Tags:
return: | Excel date/time serial value, or string if error
access: | private
#### Parameters:
string | $timeValue |
[ Top ] ### static method _incompleteBeta [line 3901]
`static 0 _incompleteBeta( x $x, p $p, q $q)`
Incomplete beta function Incomplete beta function #### Tags:
return: | if x<0, p<=0, q<=0 or p+q>2.55E305 and 1 if x>1 to avoid errors and over/underflow
author: | Paul Meagher The computation is based on formulas from Numerical Recipes, Chapter 6.4 (W.H. Press et al, 1992).
author: | Jaco van Kooten
access: | private
#### Parameters:
x | $x | require 0<=x<=1
p | $p | require p>0
q | $q | require q>0
[ Top ] ### static method _incompleteGamma [line 4009]
`static void _incompleteGamma( $a, $x)`
#### Tags:
access: | private
#### Parameters:
| $a |
| $x |
[ Top ] ### static method _interestAndPrincipal [line 9110]
`static void _interestAndPrincipal( [ $rate = 0], [ $per = 0], [ $nper = 0], [ $pv = 0], [ $fv = 0], [ $type = 0])`
#### Tags:
access: | private
#### Parameters:
| $rate |
| $per |
| $nper |
| $pv |
| $fv |
| $type |
[ Top ] ### static method _inverse_ncdf [line 4249]
`static void _inverse_ncdf( $p)`
************************************************************************* ************************************************************************* inverse_ncdf.php ------------------- begin : Friday, January 16, 2004 copyright : (C) 2004 Michael Nickerson email : nickersonm@yahoo.com ************************************************************************* #### Tags:
access: | private
#### Parameters:
| $p |
[ Top ] ### static method _inverse_ncdf2 [line 4318]
`static void _inverse_ncdf2( $prob)`
#### Tags:
access: | private
#### Parameters:
| $prob |
[ Top ] ### static method _inverse_ncdf3 [line 4361]
`static void _inverse_ncdf3( $p)`
#### Tags:
access: | private
#### Parameters:
| $p |
[ Top ] ### static method _isLeapYear [line 5858]
`static void _isLeapYear( $year)`
#### Tags:
access: | private
#### Parameters:
| $year |
[ Top ] ### static method _logBeta [line 3599]
`static 0 _logBeta( p $p, q $q)`
The natural logarithm of the beta function. The natural logarithm of the beta function. #### Tags:
return: | if p<=0, q<=0 or p+q>2.55E305 to avoid errors and over/underflow
author: | Jaco van Kooten
access: | private
#### Parameters:
p | $p | require p>0
q | $q | require q>0
[ Top ] ### static method _logGamma [line 3711]
`static void _logGamma( $x)`
#### Tags:
access: | private
#### Parameters:
| $x |
[ Top ] ### static method _modeCalc [line 1399]
`static void _modeCalc( $data)`
#### Tags:
access: | private
#### Parameters:
| $data |
[ Top ] ### static method _nbrConversionFormat [line 6625]
`static void _nbrConversionFormat( $xVal, $places)`
#### Tags:
access: | private
#### Parameters:
| $xVal |
| $places |
[ Top ] ### static method _parseComplex [line 6998]
`static void _parseComplex( $complexNumber)`
#### Tags:
access: | public
#### Parameters:
| $complexNumber |
[ Top ] ### static method _romanCut [line 2553]
`static void _romanCut( $num, $n)`
#### Tags:
access: | private
#### Parameters:
| $num |
| $n |
[ Top ] ### static method _uniord [line 4951]
`static void _uniord( $c)`
#### Tags:
access: | private
#### Parameters:
| $c |
[ Top ] ### static method _vlookupSort [line 11134]
`static void _vlookupSort( $a, $b)`
#### Tags:
access: | private
#### Parameters:
| $a |
| $b |
[ Top ] ### Class Constants #### COMPATIBILITY_EXCEL = 'Excel' [line 104] constants constants [ Top ] #### COMPATIBILITY_GNUMERIC = 'Gnumeric' [line 105] [ Top ] #### COMPATIBILITY_OPENOFFICE = 'OpenOfficeCalc' [line 106] [ Top ] #### RETURNDATE_EXCEL = 'E' [line 110] [ Top ] #### RETURNDATE_PHP_NUMERIC = 'P' [line 108] [ Top ] #### RETURNDATE_PHP_OBJECT = 'O' [line 109] [ Top ] Documentation generated on Mon, 11 Jan 2010 08:11:03 +0100 by phpDocumentor 1.4.1