nizongfeng
/
ZZCS
1
0
Vork 0
Code Kwesties 0 Pull-aanvragen 0 Publicaties 0 Wiki Activiteit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
14 MiB
 
 
 
 
Tree: 0d86f80fa0
Branches Labels
${ item.name }
Maak branch ${ searchTerm }
van '0d86f80fa0'
${ noResults }
ZZCS/coding/st-xm/ORG/Documentation/API/classes/PHPExcel_Calculation_Engine...

1555 regels
77 KiB
Ruw Blame Geschiedenis 

  1. <!DOCTYPE html><html lang="en">

  2. <head>

  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">

  5. <meta charset="utf-8">

  6. <title>PHPExcel classes » \PHPExcel_Calculation_Engineering</title>

  7. <meta name="author" content="Mike van Riel">

  8. <meta name="description" content="">

  9. <link href="../css/template.css" rel="stylesheet" media="all">

  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">

  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">

  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">

  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">

  14. </head>

  15. <body>

  16. <div class="navbar navbar-fixed-top">

  17. <div class="navbar-inner"><div class="container">

  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">

  19. <li class="dropdown">

  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">

  21.                                     API Documentation <b class="caret"></b></a><ul class="dropdown-menu">

  22. <li><a>Packages</a></li>

  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>

  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>

  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA

  26. Cholesky decomposition class

  27. For a symmetric, positive definite matrix A, the Cholesky decomposition

  28. is an lower triangular matrix L so that A = L*L'</a></li>

  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA

  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>

  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA

  32. Error handling</a></li>

  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA

  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n

  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,

  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>

  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA

  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n

  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that

  40. A = Q*R</a></li>

  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA

  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is

  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and

  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>

  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA

  46. Pythagorean Theorem:

  47. a = 3

  48. b = 4

  49. r = sqrt(square(a) + square(b))

  50. r = 5

  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>

  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>

  53. </ul>

  54. </li>

  55. <li class="dropdown" id="charts-menu">

  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">

  57.                                     Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>

  58. </li>

  59. <li class="dropdown" id="reports-menu">

  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">

  61.                                     Reports <b class="caret"></b></a><ul class="dropdown-menu">

  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 

  63.                 <span class="label label-info">551</span></a></li>

  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 

  65.                 <ul>

  66. <li>todo 

  67.                 <span class="label label-info">19</span>

  68. </li>

  69. <li>fixme 

  70.                 <span class="label label-info">10</span>

  71. </li>

  72. </ul></a></li>

  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 

  74.                 <span class="label label-info">12</span></a></li>

  75. </ul>

  76. </li>

  77. </ul></div>

  78. </div></div>

  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>

  80. </div>

  81. <div id="___" class="container">

  82. <noscript><div class="alert alert-warning">

  83.                             Javascript is disabled; several features are only available

  84.                             if Javascript is enabled.

  85.                         </div></noscript>

  86. <div class="row">

  87. <div class="span4">

  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">

  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>

  90. </div>

  91. <ul class="side-nav nav nav-list">

  92. <li class="nav-header">

  93. <i class="icon-custom icon-method"></i> Methods

  94.                     <ul>

  95. <li class="method public "><a href="#method_BESSELI" title="BESSELI :: BESSELI"><span class="description">BESSELI</span><pre>BESSELI()</pre></a></li>

  96. <li class="method public "><a href="#method_BESSELJ" title="BESSELJ :: BESSELJ"><span class="description">BESSELJ</span><pre>BESSELJ()</pre></a></li>

  97. <li class="method public "><a href="#method_BESSELK" title="BESSELK :: BESSELK"><span class="description">BESSELK</span><pre>BESSELK()</pre></a></li>

  98. <li class="method public "><a href="#method_BESSELY" title="BESSELY :: BESSELY"><span class="description">BESSELY</span><pre>BESSELY()</pre></a></li>

  99. <li class="method public "><a href="#method_BINTODEC" title="BINTODEC :: BINTODEC"><span class="description">BINTODEC</span><pre>BINTODEC()</pre></a></li>

  100. <li class="method public "><a href="#method_BINTOHEX" title="BINTOHEX :: BINTOHEX"><span class="description">BINTOHEX</span><pre>BINTOHEX()</pre></a></li>

  101. <li class="method public "><a href="#method_BINTOOCT" title="BINTOOCT :: BINTOOCT"><span class="description">BINTOOCT</span><pre>BINTOOCT()</pre></a></li>

  102. <li class="method public "><a href="#method_COMPLEX" title="COMPLEX :: COMPLEX"><span class="description">COMPLEX</span><pre>COMPLEX()</pre></a></li>

  103. <li class="method public "><a href="#method_CONVERTUOM" title="CONVERTUOM :: CONVERTUOM"><span class="description">CONVERTUOM</span><pre>CONVERTUOM()</pre></a></li>

  104. <li class="method public "><a href="#method_DECTOBIN" title="DECTOBIN :: DECTOBIN"><span class="description">DECTOBIN</span><pre>DECTOBIN()</pre></a></li>

  105. <li class="method public "><a href="#method_DECTOHEX" title="DECTOHEX :: DECTOHEX"><span class="description">DECTOHEX</span><pre>DECTOHEX()</pre></a></li>

  106. <li class="method public "><a href="#method_DECTOOCT" title="DECTOOCT :: DECTOOCT"><span class="description">DECTOOCT</span><pre>DECTOOCT()</pre></a></li>

  107. <li class="method public "><a href="#method_DELTA" title="DELTA :: DELTA"><span class="description">DELTA</span><pre>DELTA()</pre></a></li>

  108. <li class="method public "><a href="#method_ERF" title="ERF :: ERF"><span class="description">ERF</span><pre>ERF()</pre></a></li>

  109. <li class="method public "><a href="#method_ERFC" title="ERFC :: ERFC"><span class="description">ERFC</span><pre>ERFC()</pre></a></li>

  110. <li class="method public "><a href="#method_GESTEP" title="GESTEP :: GESTEP"><span class="description">GESTEP</span><pre>GESTEP()</pre></a></li>

  111. <li class="method public "><a href="#method_HEXTOBIN" title="HEXTOBIN :: HEXTOBIN"><span class="description">HEXTOBIN</span><pre>HEXTOBIN()</pre></a></li>

  112. <li class="method public "><a href="#method_HEXTODEC" title="HEXTODEC :: HEXTODEC"><span class="description">HEXTODEC</span><pre>HEXTODEC()</pre></a></li>

  113. <li class="method public "><a href="#method_HEXTOOCT" title="HEXTOOCT :: HEXTOOCT"><span class="description">HEXTOOCT</span><pre>HEXTOOCT()</pre></a></li>

  114. <li class="method public "><a href="#method_IMABS" title="IMABS :: IMABS"><span class="description">IMABS</span><pre>IMABS()</pre></a></li>

  115. <li class="method public "><a href="#method_IMAGINARY" title="IMAGINARY :: IMAGINARY"><span class="description">IMAGINARY</span><pre>IMAGINARY()</pre></a></li>

  116. <li class="method public "><a href="#method_IMARGUMENT" title="IMARGUMENT :: IMARGUMENT"><span class="description">IMARGUMENT</span><pre>IMARGUMENT()</pre></a></li>

  117. <li class="method public "><a href="#method_IMCONJUGATE" title="IMCONJUGATE :: IMCONJUGATE"><span class="description">IMCONJUGATE</span><pre>IMCONJUGATE()</pre></a></li>

  118. <li class="method public "><a href="#method_IMCOS" title="IMCOS :: IMCOS"><span class="description">IMCOS</span><pre>IMCOS()</pre></a></li>

  119. <li class="method public "><a href="#method_IMDIV" title="IMDIV :: IMDIV"><span class="description">IMDIV</span><pre>IMDIV()</pre></a></li>

  120. <li class="method public "><a href="#method_IMEXP" title="IMEXP :: IMEXP"><span class="description">IMEXP</span><pre>IMEXP()</pre></a></li>

  121. <li class="method public "><a href="#method_IMLN" title="IMLN :: IMLN"><span class="description">IMLN</span><pre>IMLN()</pre></a></li>

  122. <li class="method public "><a href="#method_IMLOG10" title="IMLOG10 :: IMLOG10"><span class="description">IMLOG10</span><pre>IMLOG10()</pre></a></li>

  123. <li class="method public "><a href="#method_IMLOG2" title="IMLOG2 :: IMLOG2"><span class="description">IMLOG2</span><pre>IMLOG2()</pre></a></li>

  124. <li class="method public "><a href="#method_IMPOWER" title="IMPOWER :: IMPOWER"><span class="description">IMPOWER</span><pre>IMPOWER()</pre></a></li>

  125. <li class="method public "><a href="#method_IMPRODUCT" title="IMPRODUCT :: IMPRODUCT"><span class="description">IMPRODUCT</span><pre>IMPRODUCT()</pre></a></li>

  126. <li class="method public "><a href="#method_IMREAL" title="IMREAL :: IMREAL"><span class="description">IMREAL</span><pre>IMREAL()</pre></a></li>

  127. <li class="method public "><a href="#method_IMSIN" title="IMSIN :: IMSIN"><span class="description">IMSIN</span><pre>IMSIN()</pre></a></li>

  128. <li class="method public "><a href="#method_IMSQRT" title="IMSQRT :: IMSQRT"><span class="description">IMSQRT</span><pre>IMSQRT()</pre></a></li>

  129. <li class="method public "><a href="#method_IMSUB" title="IMSUB :: IMSUB"><span class="description">IMSUB</span><pre>IMSUB()</pre></a></li>

  130. <li class="method public "><a href="#method_IMSUM" title="IMSUM :: IMSUM"><span class="description">IMSUM</span><pre>IMSUM()</pre></a></li>

  131. <li class="method public "><a href="#method_OCTTOBIN" title="OCTTOBIN :: OCTTOBIN"><span class="description">OCTTOBIN</span><pre>OCTTOBIN()</pre></a></li>

  132. <li class="method public "><a href="#method_OCTTODEC" title="OCTTODEC :: OCTTODEC"><span class="description">OCTTODEC</span><pre>OCTTODEC()</pre></a></li>

  133. <li class="method public "><a href="#method_OCTTOHEX" title="OCTTOHEX :: OCTTOHEX"><span class="description">OCTTOHEX</span><pre>OCTTOHEX()</pre></a></li>

  134. <li class="method public "><a href="#method__erfVal" title="_erfVal :: "><span class="description">_erfVal()

  135.         </span><pre>_erfVal()</pre></a></li>

  136. <li class="method public "><a href="#method__parseComplex" title="_parseComplex :: _parseComplex"><span class="description">_parseComplex</span><pre>_parseComplex()</pre></a></li>

  137. <li class="method public "><a href="#method_getConversionGroupUnitDetails" title="getConversionGroupUnitDetails :: getConversionGroupUnitDetails"><span class="description">getConversionGroupUnitDetails</span><pre>getConversionGroupUnitDetails()</pre></a></li>

  138. <li class="method public "><a href="#method_getConversionGroupUnits" title="getConversionGroupUnits :: getConversionGroupUnits

  139. Returns an array of units of measure, for a specified conversion group, or for all groups"><span class="description">getConversionGroupUnits

  140. Returns an array of units of measure, for a specified conversion group, or for all groups</span><pre>getConversionGroupUnits()</pre></a></li>

  141. <li class="method public "><a href="#method_getConversionGroups" title="getConversionGroups :: getConversionGroups

  142. Returns a list of the different conversion groups for UOM conversions"><span class="description">getConversionGroups

  143. Returns a list of the different conversion groups for UOM conversions</span><pre>getConversionGroups()</pre></a></li>

  144. <li class="method public "><a href="#method_getConversionMultipliers" title="getConversionMultipliers :: getConversionMultipliers

  145. Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM()"><span class="description">getConversionMultipliers

  146. Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM()</span><pre>getConversionMultipliers()</pre></a></li>

  147. </ul>

  148. </li>

  149. <li class="nav-header private">» Private

  150.                     <ul>

  151. <li class="method private "><a href="#method__Besselk0" title="_Besselk0 :: "><span class="description">_Besselk0()

  152.         </span><pre>_Besselk0()</pre></a></li>

  153. <li class="method private "><a href="#method__Besselk1" title="_Besselk1 :: "><span class="description">_Besselk1()

  154.         </span><pre>_Besselk1()</pre></a></li>

  155. <li class="method private "><a href="#method__Bessely0" title="_Bessely0 :: "><span class="description">_Bessely0()

  156.         </span><pre>_Bessely0()</pre></a></li>

  157. <li class="method private "><a href="#method__Bessely1" title="_Bessely1 :: "><span class="description">_Bessely1()

  158.         </span><pre>_Bessely1()</pre></a></li>

  159. <li class="method private "><a href="#method__cleanComplex" title="_cleanComplex :: Cleans the leading characters in a complex number string"><span class="description">Cleans the leading characters in a complex number string</span><pre>_cleanComplex()</pre></a></li>

  160. <li class="method private "><a href="#method__erfcVal" title="_erfcVal :: "><span class="description">_erfcVal()

  161.         </span><pre>_erfcVal()</pre></a></li>

  162. <li class="method private "><a href="#method__nbrConversionFormat" title="_nbrConversionFormat :: Formats a number base string value with leading zeroes"><span class="description">Formats a number base string value with leading zeroes</span><pre>_nbrConversionFormat()</pre></a></li>

  163. </ul>

  164. </li>

  165. <li class="nav-header">

  166. <i class="icon-custom icon-property"></i> Properties

  167.                     <ul></ul>

  168. </li>

  169. <li class="nav-header private">» Private

  170.                     <ul>

  171. <li class="property private "><a href="#property__conversionMultipliers" title="$_conversionMultipliers :: Details of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM()"><span class="description"></span><pre>$_conversionMultipliers</pre></a></li>

  172. <li class="property private "><a href="#property__conversionUnits" title="$_conversionUnits :: Details of the Units of measure that can be used in CONVERTUOM()"><span class="description"></span><pre>$_conversionUnits</pre></a></li>

  173. <li class="property private "><a href="#property__one_sqrtpi" title="$_one_sqrtpi :: "><span class="description"></span><pre>$_one_sqrtpi</pre></a></li>

  174. <li class="property private "><a href="#property__two_sqrtpi" title="$_two_sqrtpi :: "><span class="description"></span><pre>$_two_sqrtpi</pre></a></li>

  175. <li class="property private "><a href="#property__unitConversions" title="$_unitConversions :: Details of the Units of measure conversion factors, organised by group"><span class="description"></span><pre>$_unitConversions</pre></a></li>

  176. </ul>

  177. </li>

  178. </ul>

  179. </div>

  180. <div class="span8">

  181. <a id="\PHPExcel_Calculation_Engineering"></a><ul class="breadcrumb">

  182. <li>

  183. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>

  184. </li>

  185. <li><a href="../namespaces/global.html">global</a></li>

  186. <li class="active">

  187. <span class="divider">\</span><a href="../classes/PHPExcel_Calculation_Engineering.html">PHPExcel_Calculation_Engineering</a>

  188. </li>

  189. </ul>

  190. <div class="element class">

  191. <p class="short_description">PHPExcel_Calculation_Engineering</p>

  192. <div class="details">

  193. <div class="long_description"></div>

  194. <table class="table table-bordered">

  195. <tr>

  196. <th>category</th>

  197. <td>PHPExcel</td>

  198. </tr>

  199. <tr>

  200. <th>package</th>

  201. <td><a href="../packages/PHPExcel.Calculation.html">PHPExcel_Calculation</a></td>

  202. </tr>

  203. <tr>

  204. <th>copyright</th>

  205. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>

  206. </tr>

  207. </table>

  208. <h3>

  209. <i class="icon-custom icon-method"></i> Methods</h3>

  210. <a id="method_BESSELI"></a><div class="element clickable method public method_BESSELI" data-toggle="collapse" data-target=".method_BESSELI .collapse">

  211. <h2>BESSELI</h2>

  212. <pre>BESSELI(float $x, integer $ord) : float</pre>

  213. <div class="labels"><span class="label">Static</span></div>

  214. <div class="row collapse"><div class="detail-description">

  215. <div class="long_description"><p>Returns the modified Bessel function In(x), which is equivalent to the Bessel function evaluated

  216.     for purely imaginary arguments</p>

  217. 

  218. <p>Excel Function:

  219.     BESSELI(x,ord)</p></div>

  220. <table class="table table-bordered">

  221. <tr>

  222. <th>access</th>

  223. <td>public</td>

  224. </tr>

  225. <tr>

  226. <th>category</th>

  227. <td>Engineering Functions</td>

  228. </tr>

  229. </table>

  230. <h3>Parameters</h3>

  231. <div class="subelement argument">

  232. <h4>$x</h4>

  233. <code>float</code><p>The value at which to evaluate the function.

  234.                             If x is nonnumeric, BESSELI returns the #VALUE! error value.</p>

  235. </div>

  236. <div class="subelement argument">

  237. <h4>$ord</h4>

  238. <code>integer</code><p>The order of the Bessel function.

  239.                             If ord is not an integer, it is truncated.

  240.                             If $ord is nonnumeric, BESSELI returns the #VALUE! error value.

  241.                             If $ord < 0, BESSELI returns the #NUM! error value.</p>

  242. </div>

  243. <h3>Returns</h3>

  244. <div class="subelement response"><code>float</code></div>

  245. </div></div>

  246. </div>

  247. <a id="method_BESSELJ"></a><div class="element clickable method public method_BESSELJ" data-toggle="collapse" data-target=".method_BESSELJ .collapse">

  248. <h2>BESSELJ</h2>

  249. <pre>BESSELJ(float $x, integer $ord) : float</pre>

  250. <div class="labels"><span class="label">Static</span></div>

  251. <div class="row collapse"><div class="detail-description">

  252. <div class="long_description"><p>Returns the Bessel function</p>

  253. 

  254. <p>Excel Function:

  255.     BESSELJ(x,ord)</p></div>

  256. <table class="table table-bordered">

  257. <tr>

  258. <th>access</th>

  259. <td>public</td>

  260. </tr>

  261. <tr>

  262. <th>category</th>

  263. <td>Engineering Functions</td>

  264. </tr>

  265. </table>

  266. <h3>Parameters</h3>

  267. <div class="subelement argument">

  268. <h4>$x</h4>

  269. <code>float</code><p>The value at which to evaluate the function.

  270.                             If x is nonnumeric, BESSELJ returns the #VALUE! error value.</p>

  271. </div>

  272. <div class="subelement argument">

  273. <h4>$ord</h4>

  274. <code>integer</code><p>The order of the Bessel function. If n is not an integer, it is truncated.

  275.                             If $ord is nonnumeric, BESSELJ returns the #VALUE! error value.

  276.                             If $ord < 0, BESSELJ returns the #NUM! error value.</p>

  277. </div>

  278. <h3>Returns</h3>

  279. <div class="subelement response"><code>float</code></div>

  280. </div></div>

  281. </div>

  282. <a id="method_BESSELK"></a><div class="element clickable method public method_BESSELK" data-toggle="collapse" data-target=".method_BESSELK .collapse">

  283. <h2>BESSELK</h2>

  284. <pre>BESSELK(float $x, integer $ord) : float</pre>

  285. <div class="labels"><span class="label">Static</span></div>

  286. <div class="row collapse"><div class="detail-description">

  287. <div class="long_description"><p>Returns the modified Bessel function Kn(x), which is equivalent to the Bessel functions evaluated

  288.     for purely imaginary arguments.</p>

  289. 

  290. <p>Excel Function:

  291.     BESSELK(x,ord)</p></div>

  292. <table class="table table-bordered">

  293. <tr>

  294. <th>access</th>

  295. <td>public</td>

  296. </tr>

  297. <tr>

  298. <th>category</th>

  299. <td>Engineering Functions</td>

  300. </tr>

  301. </table>

  302. <h3>Parameters</h3>

  303. <div class="subelement argument">

  304. <h4>$x</h4>

  305. <code>float</code><p>The value at which to evaluate the function.

  306.                             If x is nonnumeric, BESSELK returns the #VALUE! error value.</p>

  307. </div>

  308. <div class="subelement argument">

  309. <h4>$ord</h4>

  310. <code>integer</code><p>The order of the Bessel function. If n is not an integer, it is truncated.

  311.                             If $ord is nonnumeric, BESSELK returns the #VALUE! error value.

  312.                             If $ord < 0, BESSELK returns the #NUM! error value.</p>

  313. </div>

  314. <h3>Returns</h3>

  315. <div class="subelement response"><code>float</code></div>

  316. </div></div>

  317. </div>

  318. <a id="method_BESSELY"></a><div class="element clickable method public method_BESSELY" data-toggle="collapse" data-target=".method_BESSELY .collapse">

  319. <h2>BESSELY</h2>

  320. <pre>BESSELY(float $x, integer $ord) : float</pre>

  321. <div class="labels"><span class="label">Static</span></div>

  322. <div class="row collapse"><div class="detail-description">

  323. <div class="long_description"><p>Returns the Bessel function, which is also called the Weber function or the Neumann function.</p>

  324. 

  325. <p>Excel Function:

  326.     BESSELY(x,ord)</p></div>

  327. <table class="table table-bordered">

  328. <tr>

  329. <th>access</th>

  330. <td>public</td>

  331. </tr>

  332. <tr>

  333. <th>category</th>

  334. <td>Engineering Functions</td>

  335. </tr>

  336. </table>

  337. <h3>Parameters</h3>

  338. <div class="subelement argument">

  339. <h4>$x</h4>

  340. <code>float</code><p>The value at which to evaluate the function.

  341.                             If x is nonnumeric, BESSELK returns the #VALUE! error value.</p>

  342. </div>

  343. <div class="subelement argument">

  344. <h4>$ord</h4>

  345. <code>integer</code><p>The order of the Bessel function. If n is not an integer, it is truncated.

  346.                             If $ord is nonnumeric, BESSELK returns the #VALUE! error value.

  347.                             If $ord < 0, BESSELK returns the #NUM! error value.</p>

  348. </div>

  349. <h3>Returns</h3>

  350. <div class="subelement response"><code>float</code></div>

  351. </div></div>

  352. </div>

  353. <a id="method_BINTODEC"></a><div class="element clickable method public method_BINTODEC" data-toggle="collapse" data-target=".method_BINTODEC .collapse">

  354. <h2>BINTODEC</h2>

  355. <pre>BINTODEC(string $x) : string</pre>

  356. <div class="labels"><span class="label">Static</span></div>

  357. <div class="row collapse"><div class="detail-description">

  358. <div class="long_description"><p>Return a binary value as decimal.</p>

  359. 

  360. <p>Excel Function:

  361.     BIN2DEC(x)</p></div>

  362. <table class="table table-bordered">

  363. <tr>

  364. <th>access</th>

  365. <td>public</td>

  366. </tr>

  367. <tr>

  368. <th>category</th>

  369. <td>Engineering Functions</td>

  370. </tr>

  371. </table>

  372. <h3>Parameters</h3>

  373. <div class="subelement argument">

  374. <h4>$x</h4>

  375. <code>string</code><p>The binary number (as a string) that you want to convert. The number

  376.                             cannot contain more than 10 characters (10 bits). The most significant

  377.                             bit of number is the sign bit. The remaining 9 bits are magnitude bits.

  378.                             Negative numbers are represented using two's-complement notation.

  379.                             If number is not a valid binary number, or if number contains more than

  380.                             10 characters (10 bits), BIN2DEC returns the #NUM! error value.</p>

  381. </div>

  382. <h3>Returns</h3>

  383. <div class="subelement response"><code>string</code></div>

  384. </div></div>

  385. </div>

  386. <a id="method_BINTOHEX"></a><div class="element clickable method public method_BINTOHEX" data-toggle="collapse" data-target=".method_BINTOHEX .collapse">

  387. <h2>BINTOHEX</h2>

  388. <pre>BINTOHEX(string $x, integer $places) : string</pre>

  389. <div class="labels"><span class="label">Static</span></div>

  390. <div class="row collapse"><div class="detail-description">

  391. <div class="long_description"><p>Return a binary value as hex.</p>

  392. 

  393. <p>Excel Function:

  394.     BIN2HEX(x[,places])</p></div>

  395. <table class="table table-bordered">

  396. <tr>

  397. <th>access</th>

  398. <td>public</td>

  399. </tr>

  400. <tr>

  401. <th>category</th>

  402. <td>Engineering Functions</td>

  403. </tr>

  404. </table>

  405. <h3>Parameters</h3>

  406. <div class="subelement argument">

  407. <h4>$x</h4>

  408. <code>string</code><p>The binary number (as a string) that you want to convert. The number

  409.                             cannot contain more than 10 characters (10 bits). The most significant

  410.                             bit of number is the sign bit. The remaining 9 bits are magnitude bits.

  411.                             Negative numbers are represented using two's-complement notation.

  412.                             If number is not a valid binary number, or if number contains more than

  413.                             10 characters (10 bits), BIN2HEX returns the #NUM! error value.</p>

  414. </div>

  415. <div class="subelement argument">

  416. <h4>$places</h4>

  417. <code>integer</code><p>The number of characters to use. If places is omitted, BIN2HEX uses the

  418.                             minimum number of characters necessary. Places is useful for padding the

  419.                             return value with leading 0s (zeros).

  420.                             If places is not an integer, it is truncated.

  421.                             If places is nonnumeric, BIN2HEX returns the #VALUE! error value.

  422.                             If places is negative, BIN2HEX returns the #NUM! error value.</p>

  423. </div>

  424. <h3>Returns</h3>

  425. <div class="subelement response"><code>string</code></div>

  426. </div></div>

  427. </div>

  428. <a id="method_BINTOOCT"></a><div class="element clickable method public method_BINTOOCT" data-toggle="collapse" data-target=".method_BINTOOCT .collapse">

  429. <h2>BINTOOCT</h2>

  430. <pre>BINTOOCT(string $x, integer $places) : string</pre>

  431. <div class="labels"><span class="label">Static</span></div>

  432. <div class="row collapse"><div class="detail-description">

  433. <div class="long_description"><p>Return a binary value as octal.</p>

  434. 

  435. <p>Excel Function:

  436.     BIN2OCT(x[,places])</p></div>

  437. <table class="table table-bordered">

  438. <tr>

  439. <th>access</th>

  440. <td>public</td>

  441. </tr>

  442. <tr>

  443. <th>category</th>

  444. <td>Engineering Functions</td>

  445. </tr>

  446. </table>

  447. <h3>Parameters</h3>

  448. <div class="subelement argument">

  449. <h4>$x</h4>

  450. <code>string</code><p>The binary number (as a string) that you want to convert. The number

  451.                             cannot contain more than 10 characters (10 bits). The most significant

  452.                             bit of number is the sign bit. The remaining 9 bits are magnitude bits.

  453.                             Negative numbers are represented using two's-complement notation.

  454.                             If number is not a valid binary number, or if number contains more than

  455.                             10 characters (10 bits), BIN2OCT returns the #NUM! error value.</p>

  456. </div>

  457. <div class="subelement argument">

  458. <h4>$places</h4>

  459. <code>integer</code><p>The number of characters to use. If places is omitted, BIN2OCT uses the

  460.                             minimum number of characters necessary. Places is useful for padding the

  461.                             return value with leading 0s (zeros).

  462.                             If places is not an integer, it is truncated.

  463.                             If places is nonnumeric, BIN2OCT returns the #VALUE! error value.

  464.                             If places is negative, BIN2OCT returns the #NUM! error value.</p>

  465. </div>

  466. <h3>Returns</h3>

  467. <div class="subelement response"><code>string</code></div>

  468. </div></div>

  469. </div>

  470. <a id="method_COMPLEX"></a><div class="element clickable method public method_COMPLEX" data-toggle="collapse" data-target=".method_COMPLEX .collapse">

  471. <h2>COMPLEX</h2>

  472. <pre>COMPLEX(float $realNumber, float $imaginary, string $suffix) : string</pre>

  473. <div class="labels"><span class="label">Static</span></div>

  474. <div class="row collapse"><div class="detail-description">

  475. <div class="long_description"><p>Converts real and imaginary coefficients into a complex number of the form x + yi or x + yj.</p>

  476. 

  477. <p>Excel Function:

  478.     COMPLEX(realNumber,imaginary[,places])</p></div>

  479. <table class="table table-bordered">

  480. <tr>

  481. <th>access</th>

  482. <td>public</td>

  483. </tr>

  484. <tr>

  485. <th>category</th>

  486. <td>Engineering Functions</td>

  487. </tr>

  488. </table>

  489. <h3>Parameters</h3>

  490. <div class="subelement argument">

  491. <h4>$realNumber</h4>

  492. <code>float</code><p>The real coefficient of the complex number.</p></div>

  493. <div class="subelement argument">

  494. <h4>$imaginary</h4>

  495. <code>float</code><p>The imaginary coefficient of the complex number.</p></div>

  496. <div class="subelement argument">

  497. <h4>$suffix</h4>

  498. <code>string</code><p>The suffix for the imaginary component of the complex number.

  499.                                     If omitted, the suffix is assumed to be "i".</p>

  500. </div>

  501. <h3>Returns</h3>

  502. <div class="subelement response"><code>string</code></div>

  503. </div></div>

  504. </div>

  505. <a id="method_CONVERTUOM"></a><div class="element clickable method public method_CONVERTUOM" data-toggle="collapse" data-target=".method_CONVERTUOM .collapse">

  506. <h2>CONVERTUOM</h2>

  507. <pre>CONVERTUOM(float $value, string $fromUOM, string $toUOM) : float</pre>

  508. <div class="labels"><span class="label">Static</span></div>

  509. <div class="row collapse"><div class="detail-description">

  510. <div class="long_description"><p>Converts a number from one measurement system to another.

  511. For example, CONVERT can translate a table of distances in miles to a table of distances

  512. in kilometers.</p>

  513. 

  514. <p>Excel Function:

  515.     CONVERT(value,fromUOM,toUOM)</p></div>

  516. <h3>Parameters</h3>

  517. <div class="subelement argument">

  518. <h4>$value</h4>

  519. <code>float</code><p>The value in fromUOM to convert.</p></div>

  520. <div class="subelement argument">

  521. <h4>$fromUOM</h4>

  522. <code>string</code><p>The units for value.</p></div>

  523. <div class="subelement argument">

  524. <h4>$toUOM</h4>

  525. <code>string</code><p>The units for the result.</p></div>

  526. <h3>Returns</h3>

  527. <div class="subelement response"><code>float</code></div>

  528. </div></div>

  529. </div>

  530. <a id="method_DECTOBIN"></a><div class="element clickable method public method_DECTOBIN" data-toggle="collapse" data-target=".method_DECTOBIN .collapse">

  531. <h2>DECTOBIN</h2>

  532. <pre>DECTOBIN(string $x, integer $places) : string</pre>

  533. <div class="labels"><span class="label">Static</span></div>

  534. <div class="row collapse"><div class="detail-description">

  535. <div class="long_description"><p>Return a decimal value as binary.</p>

  536. 

  537. <p>Excel Function:

  538.     DEC2BIN(x[,places])</p></div>

  539. <table class="table table-bordered">

  540. <tr>

  541. <th>access</th>

  542. <td>public</td>

  543. </tr>

  544. <tr>

  545. <th>category</th>

  546. <td>Engineering Functions</td>

  547. </tr>

  548. </table>

  549. <h3>Parameters</h3>

  550. <div class="subelement argument">

  551. <h4>$x</h4>

  552. <code>string</code><p>The decimal integer you want to convert. If number is negative,

  553.                             valid place values are ignored and DEC2BIN returns a 10-character

  554.                             (10-bit) binary number in which the most significant bit is the sign

  555.                             bit. The remaining 9 bits are magnitude bits. Negative numbers are

  556.                             represented using two's-complement notation.

  557.                             If number < -512 or if number > 511, DEC2BIN returns the #NUM! error

  558.                             value.

  559.                             If number is nonnumeric, DEC2BIN returns the #VALUE! error value.

  560.                             If DEC2BIN requires more than places characters, it returns the #NUM!

  561.                             error value.</p>

  562. </div>

  563. <div class="subelement argument">

  564. <h4>$places</h4>

  565. <code>integer</code><p>The number of characters to use. If places is omitted, DEC2BIN uses

  566.                             the minimum number of characters necessary. Places is useful for

  567.                             padding the return value with leading 0s (zeros).

  568.                             If places is not an integer, it is truncated.

  569.                             If places is nonnumeric, DEC2BIN returns the #VALUE! error value.

  570.                             If places is zero or negative, DEC2BIN returns the #NUM! error value.</p>

  571. </div>

  572. <h3>Returns</h3>

  573. <div class="subelement response"><code>string</code></div>

  574. </div></div>

  575. </div>

  576. <a id="method_DECTOHEX"></a><div class="element clickable method public method_DECTOHEX" data-toggle="collapse" data-target=".method_DECTOHEX .collapse">

  577. <h2>DECTOHEX</h2>

  578. <pre>DECTOHEX(string $x, integer $places) : string</pre>

  579. <div class="labels"><span class="label">Static</span></div>

  580. <div class="row collapse"><div class="detail-description">

  581. <div class="long_description"><p>Return a decimal value as hex.</p>

  582. 

  583. <p>Excel Function:

  584.     DEC2HEX(x[,places])</p></div>

  585. <table class="table table-bordered">

  586. <tr>

  587. <th>access</th>

  588. <td>public</td>

  589. </tr>

  590. <tr>

  591. <th>category</th>

  592. <td>Engineering Functions</td>

  593. </tr>

  594. </table>

  595. <h3>Parameters</h3>

  596. <div class="subelement argument">

  597. <h4>$x</h4>

  598. <code>string</code><p>The decimal integer you want to convert. If number is negative,

  599.                             places is ignored and DEC2HEX returns a 10-character (40-bit)

  600.                             hexadecimal number in which the most significant bit is the sign

  601.                             bit. The remaining 39 bits are magnitude bits. Negative numbers

  602.                             are represented using two's-complement notation.

  603.                             If number < -549,755,813,888 or if number > 549,755,813,887,

  604.                             DEC2HEX returns the #NUM! error value.

  605.                             If number is nonnumeric, DEC2HEX returns the #VALUE! error value.

  606.                             If DEC2HEX requires more than places characters, it returns the

  607.                             #NUM! error value.</p>

  608. </div>

  609. <div class="subelement argument">

  610. <h4>$places</h4>

  611. <code>integer</code><p>The number of characters to use. If places is omitted, DEC2HEX uses

  612.                             the minimum number of characters necessary. Places is useful for

  613.                             padding the return value with leading 0s (zeros).

  614.                             If places is not an integer, it is truncated.

  615.                             If places is nonnumeric, DEC2HEX returns the #VALUE! error value.

  616.                             If places is zero or negative, DEC2HEX returns the #NUM! error value.</p>

  617. </div>

  618. <h3>Returns</h3>

  619. <div class="subelement response"><code>string</code></div>

  620. </div></div>

  621. </div>

  622. <a id="method_DECTOOCT"></a><div class="element clickable method public method_DECTOOCT" data-toggle="collapse" data-target=".method_DECTOOCT .collapse">

  623. <h2>DECTOOCT</h2>

  624. <pre>DECTOOCT(string $x, integer $places) : string</pre>

  625. <div class="labels"><span class="label">Static</span></div>

  626. <div class="row collapse"><div class="detail-description">

  627. <div class="long_description"><p>Return an decimal value as octal.</p>

  628. 

  629. <p>Excel Function:

  630.     DEC2OCT(x[,places])</p></div>

  631. <table class="table table-bordered">

  632. <tr>

  633. <th>access</th>

  634. <td>public</td>

  635. </tr>

  636. <tr>

  637. <th>category</th>

  638. <td>Engineering Functions</td>

  639. </tr>

  640. </table>

  641. <h3>Parameters</h3>

  642. <div class="subelement argument">

  643. <h4>$x</h4>

  644. <code>string</code><p>The decimal integer you want to convert. If number is negative,

  645.                             places is ignored and DEC2OCT returns a 10-character (30-bit)

  646.                             octal number in which the most significant bit is the sign bit.

  647.                             The remaining 29 bits are magnitude bits. Negative numbers are

  648.                             represented using two's-complement notation.

  649.                             If number < -536,870,912 or if number > 536,870,911, DEC2OCT

  650.                             returns the #NUM! error value.

  651.                             If number is nonnumeric, DEC2OCT returns the #VALUE! error value.

  652.                             If DEC2OCT requires more than places characters, it returns the

  653.                             #NUM! error value.</p>

  654. </div>

  655. <div class="subelement argument">

  656. <h4>$places</h4>

  657. <code>integer</code><p>The number of characters to use. If places is omitted, DEC2OCT uses

  658.                             the minimum number of characters necessary. Places is useful for

  659.                             padding the return value with leading 0s (zeros).

  660.                             If places is not an integer, it is truncated.

  661.                             If places is nonnumeric, DEC2OCT returns the #VALUE! error value.

  662.                             If places is zero or negative, DEC2OCT returns the #NUM! error value.</p>

  663. </div>

  664. <h3>Returns</h3>

  665. <div class="subelement response"><code>string</code></div>

  666. </div></div>

  667. </div>

  668. <a id="method_DELTA"></a><div class="element clickable method public method_DELTA" data-toggle="collapse" data-target=".method_DELTA .collapse">

  669. <h2>DELTA</h2>

  670. <pre>DELTA(float $a, float $b) : int</pre>

  671. <div class="labels"><span class="label">Static</span></div>

  672. <div class="row collapse"><div class="detail-description">

  673. <div class="long_description"><p>Tests whether two values are equal. Returns 1 if number1 = number2; returns 0 otherwise.

  674. Use this function to filter a set of values. For example, by summing several DELTA

  675. functions you calculate the count of equal pairs. This function is also known as the

  676. Kronecker Delta function.</p>

  677. 

  678. <p>Excel Function:

  679.     DELTA(a[,b])</p></div>

  680. <h3>Parameters</h3>

  681. <div class="subelement argument">

  682. <h4>$a</h4>

  683. <code>float</code><p>The first number.</p></div>

  684. <div class="subelement argument">

  685. <h4>$b</h4>

  686. <code>float</code><p>The second number. If omitted, b is assumed to be zero.</p></div>

  687. <h3>Returns</h3>

  688. <div class="subelement response"><code>int</code></div>

  689. </div></div>

  690. </div>

  691. <a id="method_ERF"></a><div class="element clickable method public method_ERF" data-toggle="collapse" data-target=".method_ERF .collapse">

  692. <h2>ERF</h2>

  693. <pre>ERF(float $lower, float $upper) : float</pre>

  694. <div class="labels"><span class="label">Static</span></div>

  695. <div class="row collapse"><div class="detail-description">

  696. <div class="long_description"><p>Returns the error function integrated between the lower and upper bound arguments.</p>

  697. 

  698. <p>Note: In Excel 2007 or earlier, if you input a negative value for the upper or lower bound arguments,

  699.         the function would return a #NUM! error. However, in Excel 2010, the function algorithm was

  700.         improved, so that it can now calculate the function for both positive and negative ranges.

  701.         PHPExcel follows Excel 2010 behaviour, and accepts nagative arguments.</p>

  702. 

  703. <p>Excel Function:

  704.     ERF(lower[,upper])</p></div>

  705. <h3>Parameters</h3>

  706. <div class="subelement argument">

  707. <h4>$lower</h4>

  708. <code>float</code><p>lower bound for integrating ERF</p></div>

  709. <div class="subelement argument">

  710. <h4>$upper</h4>

  711. <code>float</code><p>upper bound for integrating ERF.

  712. 							If omitted, ERF integrates between zero and lower_limit</p></div>

  713. <h3>Returns</h3>

  714. <div class="subelement response"><code>float</code></div>

  715. </div></div>

  716. </div>

  717. <a id="method_ERFC"></a><div class="element clickable method public method_ERFC" data-toggle="collapse" data-target=".method_ERFC .collapse">

  718. <h2>ERFC</h2>

  719. <pre>ERFC(float $x) : float</pre>

  720. <div class="labels"><span class="label">Static</span></div>

  721. <div class="row collapse"><div class="detail-description">

  722. <div class="long_description"><p>Returns the complementary ERF function integrated between x and infinity</p>

  723. 

  724. <p>Note: In Excel 2007 or earlier, if you input a negative value for the lower bound argument,

  725.     the function would return a #NUM! error. However, in Excel 2010, the function algorithm was

  726.     improved, so that it can now calculate the function for both positive and negative x values.

  727.         PHPExcel follows Excel 2010 behaviour, and accepts nagative arguments.</p>

  728. 

  729. <p>Excel Function:

  730.     ERFC(x)</p></div>

  731. <h3>Parameters</h3>

  732. <div class="subelement argument">

  733. <h4>$x</h4>

  734. <code>float</code><p>The lower bound for integrating ERFC</p></div>

  735. <h3>Returns</h3>

  736. <div class="subelement response"><code>float</code></div>

  737. </div></div>

  738. </div>

  739. <a id="method_GESTEP"></a><div class="element clickable method public method_GESTEP" data-toggle="collapse" data-target=".method_GESTEP .collapse">

  740. <h2>GESTEP</h2>

  741. <pre>GESTEP(float $number, float $step) : int</pre>

  742. <div class="labels"><span class="label">Static</span></div>

  743. <div class="row collapse"><div class="detail-description">

  744. <div class="long_description"><p>Excel Function:

  745.     GESTEP(number[,step])</p>

  746. 

  747. <p>Returns 1 if number >= step; returns 0 (zero) otherwise

  748. Use this function to filter a set of values. For example, by summing several GESTEP

  749. functions you calculate the count of values that exceed a threshold.</p></div>

  750. <h3>Parameters</h3>

  751. <div class="subelement argument">

  752. <h4>$number</h4>

  753. <code>float</code><p>The value to test against step.</p></div>

  754. <div class="subelement argument">

  755. <h4>$step</h4>

  756. <code>float</code><p>The threshold value.

  757. 								If you omit a value for step, GESTEP uses zero.</p></div>

  758. <h3>Returns</h3>

  759. <div class="subelement response"><code>int</code></div>

  760. </div></div>

  761. </div>

  762. <a id="method_HEXTOBIN"></a><div class="element clickable method public method_HEXTOBIN" data-toggle="collapse" data-target=".method_HEXTOBIN .collapse">

  763. <h2>HEXTOBIN</h2>

  764. <pre>HEXTOBIN(string $x, integer $places) : string</pre>

  765. <div class="labels"><span class="label">Static</span></div>

  766. <div class="row collapse"><div class="detail-description">

  767. <div class="long_description"><p>Return a hex value as binary.</p>

  768. 

  769. <p>Excel Function:

  770.     HEX2BIN(x[,places])</p></div>

  771. <table class="table table-bordered">

  772. <tr>

  773. <th>access</th>

  774. <td>public</td>

  775. </tr>

  776. <tr>

  777. <th>category</th>

  778. <td>Engineering Functions</td>

  779. </tr>

  780. </table>

  781. <h3>Parameters</h3>

  782. <div class="subelement argument">

  783. <h4>$x</h4>

  784. <code>string</code><p>the hexadecimal number you want to convert. Number cannot

  785.                                 contain more than 10 characters. The most significant bit of

  786.                                 number is the sign bit (40th bit from the right). The remaining

  787.                                 9 bits are magnitude bits. Negative numbers are represented

  788.                                 using two's-complement notation.

  789.                                 If number is negative, HEX2BIN ignores places and returns a

  790.                                 10-character binary number.

  791.                                 If number is negative, it cannot be less than FFFFFFFE00, and

  792.                                 if number is positive, it cannot be greater than 1FF.

  793.                                 If number is not a valid hexadecimal number, HEX2BIN returns

  794.                                 the #NUM! error value.

  795.                                 If HEX2BIN requires more than places characters, it returns

  796.                                 the #NUM! error value.</p>

  797. </div>

  798. <div class="subelement argument">

  799. <h4>$places</h4>

  800. <code>integer</code><p>The number of characters to use. If places is omitted,

  801.                                 HEX2BIN uses the minimum number of characters necessary. Places

  802.                                 is useful for padding the return value with leading 0s (zeros).

  803.                                 If places is not an integer, it is truncated.

  804.                                 If places is nonnumeric, HEX2BIN returns the #VALUE! error value.

  805.                                 If places is negative, HEX2BIN returns the #NUM! error value.</p>

  806. </div>

  807. <h3>Returns</h3>

  808. <div class="subelement response"><code>string</code></div>

  809. </div></div>

  810. </div>

  811. <a id="method_HEXTODEC"></a><div class="element clickable method public method_HEXTODEC" data-toggle="collapse" data-target=".method_HEXTODEC .collapse">

  812. <h2>HEXTODEC</h2>

  813. <pre>HEXTODEC(string $x) : string</pre>

  814. <div class="labels"><span class="label">Static</span></div>

  815. <div class="row collapse"><div class="detail-description">

  816. <div class="long_description"><p>Return a hex value as decimal.</p>

  817. 

  818. <p>Excel Function:

  819.     HEX2DEC(x)</p></div>

  820. <table class="table table-bordered">

  821. <tr>

  822. <th>access</th>

  823. <td>public</td>

  824. </tr>

  825. <tr>

  826. <th>category</th>

  827. <td>Engineering Functions</td>

  828. </tr>

  829. </table>

  830. <h3>Parameters</h3>

  831. <div class="subelement argument">

  832. <h4>$x</h4>

  833. <code>string</code><p>The hexadecimal number you want to convert. This number cannot

  834.                             contain more than 10 characters (40 bits). The most significant

  835.                             bit of number is the sign bit. The remaining 39 bits are magnitude

  836.                             bits. Negative numbers are represented using two's-complement

  837.                             notation.

  838.                             If number is not a valid hexadecimal number, HEX2DEC returns the

  839.                             #NUM! error value.</p>

  840. </div>

  841. <h3>Returns</h3>

  842. <div class="subelement response"><code>string</code></div>

  843. </div></div>

  844. </div>

  845. <a id="method_HEXTOOCT"></a><div class="element clickable method public method_HEXTOOCT" data-toggle="collapse" data-target=".method_HEXTOOCT .collapse">

  846. <h2>HEXTOOCT</h2>

  847. <pre>HEXTOOCT(string $x, integer $places) : string</pre>

  848. <div class="labels"><span class="label">Static</span></div>

  849. <div class="row collapse"><div class="detail-description">

  850. <div class="long_description"><p>Return a hex value as octal.</p>

  851. 

  852. <p>Excel Function:

  853.     HEX2OCT(x[,places])</p></div>

  854. <table class="table table-bordered">

  855. <tr>

  856. <th>access</th>

  857. <td>public</td>

  858. </tr>

  859. <tr>

  860. <th>category</th>

  861. <td>Engineering Functions</td>

  862. </tr>

  863. </table>

  864. <h3>Parameters</h3>

  865. <div class="subelement argument">

  866. <h4>$x</h4>

  867. <code>string</code><p>The hexadecimal number you want to convert. Number cannot

  868.                                 contain more than 10 characters. The most significant bit of

  869.                                 number is the sign bit. The remaining 39 bits are magnitude

  870.                                 bits. Negative numbers are represented using two's-complement

  871.                                 notation.

  872.                                 If number is negative, HEX2OCT ignores places and returns a

  873.                                 10-character octal number.

  874.                                 If number is negative, it cannot be less than FFE0000000, and

  875.                                 if number is positive, it cannot be greater than 1FFFFFFF.

  876.                                 If number is not a valid hexadecimal number, HEX2OCT returns

  877.                                 the #NUM! error value.

  878.                                 If HEX2OCT requires more than places characters, it returns

  879.                                 the #NUM! error value.</p>

  880. </div>

  881. <div class="subelement argument">

  882. <h4>$places</h4>

  883. <code>integer</code><p>The number of characters to use. If places is omitted, HEX2OCT

  884.                                 uses the minimum number of characters necessary. Places is

  885.                                 useful for padding the return value with leading 0s (zeros).

  886.                                 If places is not an integer, it is truncated.

  887.                                 If places is nonnumeric, HEX2OCT returns the #VALUE! error

  888.                                 value.

  889.                                 If places is negative, HEX2OCT returns the #NUM! error value.</p>

  890. </div>

  891. <h3>Returns</h3>

  892. <div class="subelement response"><code>string</code></div>

  893. </div></div>

  894. </div>

  895. <a id="method_IMABS"></a><div class="element clickable method public method_IMABS" data-toggle="collapse" data-target=".method_IMABS .collapse">

  896. <h2>IMABS</h2>

  897. <pre>IMABS(string $complexNumber) : float</pre>

  898. <div class="labels"><span class="label">Static</span></div>

  899. <div class="row collapse"><div class="detail-description">

  900. <div class="long_description"><p>Returns the absolute value (modulus) of a complex number in x + yi or x + yj text format.</p>

  901. 

  902. <p>Excel Function:

  903.     IMABS(complexNumber)</p></div>

  904. <h3>Parameters</h3>

  905. <div class="subelement argument">

  906. <h4>$complexNumber</h4>

  907. <code>string</code><p>The complex number for which you want the absolute value.</p></div>

  908. <h3>Returns</h3>

  909. <div class="subelement response"><code>float</code></div>

  910. </div></div>

  911. </div>

  912. <a id="method_IMAGINARY"></a><div class="element clickable method public method_IMAGINARY" data-toggle="collapse" data-target=".method_IMAGINARY .collapse">

  913. <h2>IMAGINARY</h2>

  914. <pre>IMAGINARY(string $complexNumber) : float</pre>

  915. <div class="labels"><span class="label">Static</span></div>

  916. <div class="row collapse"><div class="detail-description">

  917. <div class="long_description"><p>Returns the imaginary coefficient of a complex number in x + yi or x + yj text format.</p>

  918. 

  919. <p>Excel Function:

  920.     IMAGINARY(complexNumber)</p></div>

  921. <table class="table table-bordered">

  922. <tr>

  923. <th>access</th>

  924. <td>public</td>

  925. </tr>

  926. <tr>

  927. <th>category</th>

  928. <td>Engineering Functions</td>

  929. </tr>

  930. </table>

  931. <h3>Parameters</h3>

  932. <div class="subelement argument">

  933. <h4>$complexNumber</h4>

  934. <code>string</code><p>The complex number for which you want the imaginary

  935. 										coefficient.</p></div>

  936. <h3>Returns</h3>

  937. <div class="subelement response"><code>float</code></div>

  938. </div></div>

  939. </div>

  940. <a id="method_IMARGUMENT"></a><div class="element clickable method public method_IMARGUMENT" data-toggle="collapse" data-target=".method_IMARGUMENT .collapse">

  941. <h2>IMARGUMENT</h2>

  942. <pre>IMARGUMENT(string $complexNumber) : float</pre>

  943. <div class="labels"><span class="label">Static</span></div>

  944. <div class="row collapse"><div class="detail-description">

  945. <div class="long_description"><p>Returns the argument theta of a complex number, i.e. the angle in radians from the real

  946. axis to the representation of the number in polar coordinates.</p>

  947. 

  948. <p>Excel Function:

  949.     IMARGUMENT(complexNumber)</p></div>

  950. <h3>Parameters</h3>

  951. <div class="subelement argument">

  952. <h4>$complexNumber</h4>

  953. <code>string</code><p>The complex number for which you want the argument theta.</p></div>

  954. <h3>Returns</h3>

  955. <div class="subelement response"><code>float</code></div>

  956. </div></div>

  957. </div>

  958. <a id="method_IMCONJUGATE"></a><div class="element clickable method public method_IMCONJUGATE" data-toggle="collapse" data-target=".method_IMCONJUGATE .collapse">

  959. <h2>IMCONJUGATE</h2>

  960. <pre>IMCONJUGATE(string $complexNumber) : string</pre>

  961. <div class="labels"><span class="label">Static</span></div>

  962. <div class="row collapse"><div class="detail-description">

  963. <div class="long_description"><p>Returns the complex conjugate of a complex number in x + yi or x + yj text format.</p>

  964. 

  965. <p>Excel Function:

  966.     IMCONJUGATE(complexNumber)</p></div>

  967. <h3>Parameters</h3>

  968. <div class="subelement argument">

  969. <h4>$complexNumber</h4>

  970. <code>string</code><p>The complex number for which you want the conjugate.</p></div>

  971. <h3>Returns</h3>

  972. <div class="subelement response"><code>string</code></div>

  973. </div></div>

  974. </div>

  975. <a id="method_IMCOS"></a><div class="element clickable method public method_IMCOS" data-toggle="collapse" data-target=".method_IMCOS .collapse">

  976. <h2>IMCOS</h2>

  977. <pre>IMCOS(string $complexNumber) : string | float</pre>

  978. <div class="labels"><span class="label">Static</span></div>

  979. <div class="row collapse"><div class="detail-description">

  980. <div class="long_description"><p>Returns the cosine of a complex number in x + yi or x + yj text format.</p>

  981. 

  982. <p>Excel Function:

  983.     IMCOS(complexNumber)</p></div>

  984. <h3>Parameters</h3>

  985. <div class="subelement argument">

  986. <h4>$complexNumber</h4>

  987. <code>string</code><p>The complex number for which you want the cosine.</p></div>

  988. <h3>Returns</h3>

  989. <div class="subelement response">

  990. <code>string</code><code>float</code>

  991. </div>

  992. </div></div>

  993. </div>

  994. <a id="method_IMDIV"></a><div class="element clickable method public method_IMDIV" data-toggle="collapse" data-target=".method_IMDIV .collapse">

  995. <h2>IMDIV</h2>

  996. <pre>IMDIV(string $complexDividend, string $complexDivisor) : string</pre>

  997. <div class="labels"><span class="label">Static</span></div>

  998. <div class="row collapse"><div class="detail-description">

  999. <div class="long_description"><p>Returns the quotient of two complex numbers in x + yi or x + yj text format.</p>

  1000. 

  1001. <p>Excel Function:

  1002.     IMDIV(complexDividend,complexDivisor)</p></div>

  1003. <h3>Parameters</h3>

  1004. <div class="subelement argument">

  1005. <h4>$complexDividend</h4>

  1006. <code>string</code><p>The complex numerator or dividend.</p></div>

  1007. <div class="subelement argument">

  1008. <h4>$complexDivisor</h4>

  1009. <code>string</code><p>The complex denominator or divisor.</p></div>

  1010. <h3>Returns</h3>

  1011. <div class="subelement response"><code>string</code></div>

  1012. </div></div>

  1013. </div>

  1014. <a id="method_IMEXP"></a><div class="element clickable method public method_IMEXP" data-toggle="collapse" data-target=".method_IMEXP .collapse">

  1015. <h2>IMEXP</h2>

  1016. <pre>IMEXP(string $complexNumber) : string</pre>

  1017. <div class="labels"><span class="label">Static</span></div>

  1018. <div class="row collapse"><div class="detail-description">

  1019. <div class="long_description"><p>Returns the exponential of a complex number in x + yi or x + yj text format.</p>

  1020. 

  1021. <p>Excel Function:

  1022.     IMEXP(complexNumber)</p></div>

  1023. <h3>Parameters</h3>

  1024. <div class="subelement argument">

  1025. <h4>$complexNumber</h4>

  1026. <code>string</code><p>The complex number for which you want the exponential.</p></div>

  1027. <h3>Returns</h3>

  1028. <div class="subelement response"><code>string</code></div>

  1029. </div></div>

  1030. </div>

  1031. <a id="method_IMLN"></a><div class="element clickable method public method_IMLN" data-toggle="collapse" data-target=".method_IMLN .collapse">

  1032. <h2>IMLN</h2>

  1033. <pre>IMLN(string $complexNumber) : string</pre>

  1034. <div class="labels"><span class="label">Static</span></div>

  1035. <div class="row collapse"><div class="detail-description">

  1036. <div class="long_description"><p>Returns the natural logarithm of a complex number in x + yi or x + yj text format.</p>

  1037. 

  1038. <p>Excel Function:

  1039.     IMLN(complexNumber)</p></div>

  1040. <h3>Parameters</h3>

  1041. <div class="subelement argument">

  1042. <h4>$complexNumber</h4>

  1043. <code>string</code><p>The complex number for which you want the natural logarithm.</p></div>

  1044. <h3>Returns</h3>

  1045. <div class="subelement response"><code>string</code></div>

  1046. </div></div>

  1047. </div>

  1048. <a id="method_IMLOG10"></a><div class="element clickable method public method_IMLOG10" data-toggle="collapse" data-target=".method_IMLOG10 .collapse">

  1049. <h2>IMLOG10</h2>

  1050. <pre>IMLOG10(string $complexNumber) : string</pre>

  1051. <div class="labels"><span class="label">Static</span></div>

  1052. <div class="row collapse"><div class="detail-description">

  1053. <div class="long_description"><p>Returns the common logarithm (base 10) of a complex number in x + yi or x + yj text format.</p>

  1054. 

  1055. <p>Excel Function:

  1056.     IMLOG10(complexNumber)</p></div>

  1057. <h3>Parameters</h3>

  1058. <div class="subelement argument">

  1059. <h4>$complexNumber</h4>

  1060. <code>string</code><p>The complex number for which you want the common logarithm.</p></div>

  1061. <h3>Returns</h3>

  1062. <div class="subelement response"><code>string</code></div>

  1063. </div></div>

  1064. </div>

  1065. <a id="method_IMLOG2"></a><div class="element clickable method public method_IMLOG2" data-toggle="collapse" data-target=".method_IMLOG2 .collapse">

  1066. <h2>IMLOG2</h2>

  1067. <pre>IMLOG2(string $complexNumber) : string</pre>

  1068. <div class="labels"><span class="label">Static</span></div>

  1069. <div class="row collapse"><div class="detail-description">

  1070. <div class="long_description"><p>Returns the base-2 logarithm of a complex number in x + yi or x + yj text format.</p>

  1071. 

  1072. <p>Excel Function:

  1073.     IMLOG2(complexNumber)</p></div>

  1074. <h3>Parameters</h3>

  1075. <div class="subelement argument">

  1076. <h4>$complexNumber</h4>

  1077. <code>string</code><p>The complex number for which you want the base-2 logarithm.</p>

  1078. </div>

  1079. <h3>Returns</h3>

  1080. <div class="subelement response"><code>string</code></div>

  1081. </div></div>

  1082. </div>

  1083. <a id="method_IMPOWER"></a><div class="element clickable method public method_IMPOWER" data-toggle="collapse" data-target=".method_IMPOWER .collapse">

  1084. <h2>IMPOWER</h2>

  1085. <pre>IMPOWER(string $complexNumber, float $realNumber) : string</pre>

  1086. <div class="labels"><span class="label">Static</span></div>

  1087. <div class="row collapse"><div class="detail-description">

  1088. <div class="long_description"><p>Returns a complex number in x + yi or x + yj text format raised to a power.</p>

  1089. 

  1090. <p>Excel Function:

  1091.     IMPOWER(complexNumber,realNumber)</p></div>

  1092. <h3>Parameters</h3>

  1093. <div class="subelement argument">

  1094. <h4>$complexNumber</h4>

  1095. <code>string</code><p>The complex number you want to raise to a power.</p></div>

  1096. <div class="subelement argument">

  1097. <h4>$realNumber</h4>

  1098. <code>float</code><p>The power to which you want to raise the complex number.</p></div>

  1099. <h3>Returns</h3>

  1100. <div class="subelement response"><code>string</code></div>

  1101. </div></div>

  1102. </div>

  1103. <a id="method_IMPRODUCT"></a><div class="element clickable method public method_IMPRODUCT" data-toggle="collapse" data-target=".method_IMPRODUCT .collapse">

  1104. <h2>IMPRODUCT</h2>

  1105. <pre>IMPRODUCT() : string</pre>

  1106. <div class="labels"><span class="label">Static</span></div>

  1107. <div class="row collapse"><div class="detail-description">

  1108. <div class="long_description"><p>Returns the product of two or more complex numbers in x + yi or x + yj text format.</p>

  1109. 

  1110. <p>Excel Function:

  1111.     IMPRODUCT(complexNumber[,complexNumber[,...]])</p></div>

  1112. <h3>Returns</h3>

  1113. <div class="subelement response"><code>string</code></div>

  1114. </div></div>

  1115. </div>

  1116. <a id="method_IMREAL"></a><div class="element clickable method public method_IMREAL" data-toggle="collapse" data-target=".method_IMREAL .collapse">

  1117. <h2>IMREAL</h2>

  1118. <pre>IMREAL(string $complexNumber) : float</pre>

  1119. <div class="labels"><span class="label">Static</span></div>

  1120. <div class="row collapse"><div class="detail-description">

  1121. <div class="long_description"><p>Returns the real coefficient of a complex number in x + yi or x + yj text format.</p>

  1122. 

  1123. <p>Excel Function:

  1124.     IMREAL(complexNumber)</p></div>

  1125. <table class="table table-bordered">

  1126. <tr>

  1127. <th>access</th>

  1128. <td>public</td>

  1129. </tr>

  1130. <tr>

  1131. <th>category</th>

  1132. <td>Engineering Functions</td>

  1133. </tr>

  1134. </table>

  1135. <h3>Parameters</h3>

  1136. <div class="subelement argument">

  1137. <h4>$complexNumber</h4>

  1138. <code>string</code><p>The complex number for which you want the real coefficient.</p></div>

  1139. <h3>Returns</h3>

  1140. <div class="subelement response"><code>float</code></div>

  1141. </div></div>

  1142. </div>

  1143. <a id="method_IMSIN"></a><div class="element clickable method public method_IMSIN" data-toggle="collapse" data-target=".method_IMSIN .collapse">

  1144. <h2>IMSIN</h2>

  1145. <pre>IMSIN(string $complexNumber) : string | float</pre>

  1146. <div class="labels"><span class="label">Static</span></div>

  1147. <div class="row collapse"><div class="detail-description">

  1148. <div class="long_description"><p>Returns the sine of a complex number in x + yi or x + yj text format.</p>

  1149. 

  1150. <p>Excel Function:

  1151.     IMSIN(complexNumber)</p></div>

  1152. <h3>Parameters</h3>

  1153. <div class="subelement argument">

  1154. <h4>$complexNumber</h4>

  1155. <code>string</code><p>The complex number for which you want the sine.</p></div>

  1156. <h3>Returns</h3>

  1157. <div class="subelement response">

  1158. <code>string</code><code>float</code>

  1159. </div>

  1160. </div></div>

  1161. </div>

  1162. <a id="method_IMSQRT"></a><div class="element clickable method public method_IMSQRT" data-toggle="collapse" data-target=".method_IMSQRT .collapse">

  1163. <h2>IMSQRT</h2>

  1164. <pre>IMSQRT(string $complexNumber) : string</pre>

  1165. <div class="labels"><span class="label">Static</span></div>

  1166. <div class="row collapse"><div class="detail-description">

  1167. <div class="long_description"><p>Returns the square root of a complex number in x + yi or x + yj text format.</p>

  1168. 

  1169. <p>Excel Function:

  1170.     IMSQRT(complexNumber)</p></div>

  1171. <h3>Parameters</h3>

  1172. <div class="subelement argument">

  1173. <h4>$complexNumber</h4>

  1174. <code>string</code><p>The complex number for which you want the square root.</p></div>

  1175. <h3>Returns</h3>

  1176. <div class="subelement response"><code>string</code></div>

  1177. </div></div>

  1178. </div>

  1179. <a id="method_IMSUB"></a><div class="element clickable method public method_IMSUB" data-toggle="collapse" data-target=".method_IMSUB .collapse">

  1180. <h2>IMSUB</h2>

  1181. <pre>IMSUB(string $complexNumber1, string $complexNumber2) : string</pre>

  1182. <div class="labels"><span class="label">Static</span></div>

  1183. <div class="row collapse"><div class="detail-description">

  1184. <div class="long_description"><p>Returns the difference of two complex numbers in x + yi or x + yj text format.</p>

  1185. 

  1186. <p>Excel Function:

  1187.     IMSUB(complexNumber1,complexNumber2)</p></div>

  1188. <h3>Parameters</h3>

  1189. <div class="subelement argument">

  1190. <h4>$complexNumber1</h4>

  1191. <code>string</code><p>The complex number from which to subtract complexNumber2.</p></div>

  1192. <div class="subelement argument">

  1193. <h4>$complexNumber2</h4>

  1194. <code>string</code><p>The complex number to subtract from complexNumber1.</p></div>

  1195. <h3>Returns</h3>

  1196. <div class="subelement response"><code>string</code></div>

  1197. </div></div>

  1198. </div>

  1199. <a id="method_IMSUM"></a><div class="element clickable method public method_IMSUM" data-toggle="collapse" data-target=".method_IMSUM .collapse">

  1200. <h2>IMSUM</h2>

  1201. <pre>IMSUM() : string</pre>

  1202. <div class="labels"><span class="label">Static</span></div>

  1203. <div class="row collapse"><div class="detail-description">

  1204. <div class="long_description"><p>Returns the sum of two or more complex numbers in x + yi or x + yj text format.</p>

  1205. 

  1206. <p>Excel Function:

  1207.     IMSUM(complexNumber[,complexNumber[,...]])</p></div>

  1208. <h3>Returns</h3>

  1209. <div class="subelement response"><code>string</code></div>

  1210. </div></div>

  1211. </div>

  1212. <a id="method_OCTTOBIN"></a><div class="element clickable method public method_OCTTOBIN" data-toggle="collapse" data-target=".method_OCTTOBIN .collapse">

  1213. <h2>OCTTOBIN</h2>

  1214. <pre>OCTTOBIN(string $x, integer $places) : string</pre>

  1215. <div class="labels"><span class="label">Static</span></div>

  1216. <div class="row collapse"><div class="detail-description">

  1217. <div class="long_description"><p>Return an octal value as binary.</p>

  1218. 

  1219. <p>Excel Function:

  1220.     OCT2BIN(x[,places])</p></div>

  1221. <table class="table table-bordered">

  1222. <tr>

  1223. <th>access</th>

  1224. <td>public</td>

  1225. </tr>

  1226. <tr>

  1227. <th>category</th>

  1228. <td>Engineering Functions</td>

  1229. </tr>

  1230. </table>

  1231. <h3>Parameters</h3>

  1232. <div class="subelement argument">

  1233. <h4>$x</h4>

  1234. <code>string</code><p>The octal number you want to convert. Number may not

  1235.                                 contain more than 10 characters. The most significant

  1236.                                 bit of number is the sign bit. The remaining 29 bits

  1237.                                 are magnitude bits. Negative numbers are represented

  1238.                                 using two's-complement notation.

  1239.                                 If number is negative, OCT2BIN ignores places and returns

  1240.                                 a 10-character binary number.

  1241.                                 If number is negative, it cannot be less than 7777777000,

  1242.                                 and if number is positive, it cannot be greater than 777.

  1243.                                 If number is not a valid octal number, OCT2BIN returns

  1244.                                 the #NUM! error value.

  1245.                                 If OCT2BIN requires more than places characters, it

  1246.                                 returns the #NUM! error value.</p>

  1247. </div>

  1248. <div class="subelement argument">

  1249. <h4>$places</h4>

  1250. <code>integer</code><p>The number of characters to use. If places is omitted,

  1251.                                 OCT2BIN uses the minimum number of characters necessary.

  1252.                                 Places is useful for padding the return value with

  1253.                                 leading 0s (zeros).

  1254.                                 If places is not an integer, it is truncated.

  1255.                                 If places is nonnumeric, OCT2BIN returns the #VALUE!

  1256.                                 error value.

  1257.                                 If places is negative, OCT2BIN returns the #NUM! error

  1258.                                 value.</p>

  1259. </div>

  1260. <h3>Returns</h3>

  1261. <div class="subelement response"><code>string</code></div>

  1262. </div></div>

  1263. </div>

  1264. <a id="method_OCTTODEC"></a><div class="element clickable method public method_OCTTODEC" data-toggle="collapse" data-target=".method_OCTTODEC .collapse">

  1265. <h2>OCTTODEC</h2>

  1266. <pre>OCTTODEC(string $x) : string</pre>

  1267. <div class="labels"><span class="label">Static</span></div>

  1268. <div class="row collapse"><div class="detail-description">

  1269. <div class="long_description"><p>Return an octal value as decimal.</p>

  1270. 

  1271. <p>Excel Function:

  1272.     OCT2DEC(x)</p></div>

  1273. <table class="table table-bordered">

  1274. <tr>

  1275. <th>access</th>

  1276. <td>public</td>

  1277. </tr>

  1278. <tr>

  1279. <th>category</th>

  1280. <td>Engineering Functions</td>

  1281. </tr>

  1282. </table>

  1283. <h3>Parameters</h3>

  1284. <div class="subelement argument">

  1285. <h4>$x</h4>

  1286. <code>string</code><p>The octal number you want to convert. Number may not contain

  1287.                             more than 10 octal characters (30 bits). The most significant

  1288.                             bit of number is the sign bit. The remaining 29 bits are

  1289.                             magnitude bits. Negative numbers are represented using

  1290.                             two's-complement notation.

  1291.                             If number is not a valid octal number, OCT2DEC returns the

  1292.                             #NUM! error value.</p>

  1293. </div>

  1294. <h3>Returns</h3>

  1295. <div class="subelement response"><code>string</code></div>

  1296. </div></div>

  1297. </div>

  1298. <a id="method_OCTTOHEX"></a><div class="element clickable method public method_OCTTOHEX" data-toggle="collapse" data-target=".method_OCTTOHEX .collapse">

  1299. <h2>OCTTOHEX</h2>

  1300. <pre>OCTTOHEX(string $x, integer $places) : string</pre>

  1301. <div class="labels"><span class="label">Static</span></div>

  1302. <div class="row collapse"><div class="detail-description">

  1303. <div class="long_description"><p>Return an octal value as hex.</p>

  1304. 

  1305. <p>Excel Function:

  1306.     OCT2HEX(x[,places])</p></div>

  1307. <table class="table table-bordered">

  1308. <tr>

  1309. <th>access</th>

  1310. <td>public</td>

  1311. </tr>

  1312. <tr>

  1313. <th>category</th>

  1314. <td>Engineering Functions</td>

  1315. </tr>

  1316. </table>

  1317. <h3>Parameters</h3>

  1318. <div class="subelement argument">

  1319. <h4>$x</h4>

  1320. <code>string</code><p>The octal number you want to convert. Number may not contain

  1321.                                 more than 10 octal characters (30 bits). The most significant

  1322.                                 bit of number is the sign bit. The remaining 29 bits are

  1323.                                 magnitude bits. Negative numbers are represented using

  1324.                                 two's-complement notation.

  1325.                                 If number is negative, OCT2HEX ignores places and returns a

  1326.                                 10-character hexadecimal number.

  1327.                                 If number is not a valid octal number, OCT2HEX returns the

  1328.                                 #NUM! error value.

  1329.                                 If OCT2HEX requires more than places characters, it returns

  1330.                                 the #NUM! error value.</p>

  1331. </div>

  1332. <div class="subelement argument">

  1333. <h4>$places</h4>

  1334. <code>integer</code><p>The number of characters to use. If places is omitted, OCT2HEX

  1335.                                 uses the minimum number of characters necessary. Places is useful

  1336.                                 for padding the return value with leading 0s (zeros).

  1337.                                 If places is not an integer, it is truncated.

  1338.                                 If places is nonnumeric, OCT2HEX returns the #VALUE! error value.

  1339.                                 If places is negative, OCT2HEX returns the #NUM! error value.</p>

  1340. </div>

  1341. <h3>Returns</h3>

  1342. <div class="subelement response"><code>string</code></div>

  1343. </div></div>

  1344. </div>

  1345. <a id="method__erfVal"></a><div class="element clickable method public method__erfVal" data-toggle="collapse" data-target=".method__erfVal .collapse">

  1346. <h2>_erfVal()

  1347.         </h2>

  1348. <pre>_erfVal($x) </pre>

  1349. <div class="labels"><span class="label">Static</span></div>

  1350. <div class="row collapse"><div class="detail-description">

  1351. <div class="long_description"></div>

  1352. <h3>Parameters</h3>

  1353. <div class="subelement argument"><h4>$x</h4></div>

  1354. </div></div>

  1355. </div>

  1356. <a id="method__parseComplex"></a><div class="element clickable method public method__parseComplex" data-toggle="collapse" data-target=".method__parseComplex .collapse">

  1357. <h2>_parseComplex</h2>

  1358. <pre>_parseComplex(string $complexNumber) : string[]</pre>

  1359. <div class="labels"><span class="label">Static</span></div>

  1360. <div class="row collapse"><div class="detail-description">

  1361. <div class="long_description"><p>Parses a complex number into its real and imaginary parts, and an I or J suffix</p></div>

  1362. <h3>Parameters</h3>

  1363. <div class="subelement argument">

  1364. <h4>$complexNumber</h4>

  1365. <code>string</code><p>The complex number</p></div>

  1366. <h3>Returns</h3>

  1367. <div class="subelement response">

  1368. <code>string[]</code>Indexed on "real", "imaginary" and "suffix"</div>

  1369. </div></div>

  1370. </div>

  1371. <a id="method_getConversionGroupUnitDetails"></a><div class="element clickable method public method_getConversionGroupUnitDetails" data-toggle="collapse" data-target=".method_getConversionGroupUnitDetails .collapse">

  1372. <h2>getConversionGroupUnitDetails</h2>

  1373. <pre>getConversionGroupUnitDetails(string $group) : array</pre>

  1374. <div class="labels"><span class="label">Static</span></div>

  1375. <div class="row collapse"><div class="detail-description">

  1376. <div class="long_description"></div>

  1377. <h3>Parameters</h3>

  1378. <div class="subelement argument">

  1379. <h4>$group</h4>

  1380. <code>string</code><p>The group whose units of measure you want to retrieve</p></div>

  1381. <h3>Returns</h3>

  1382. <div class="subelement response"><code>array</code></div>

  1383. </div></div>

  1384. </div>

  1385. <a id="method_getConversionGroupUnits"></a><div class="element clickable method public method_getConversionGroupUnits" data-toggle="collapse" data-target=".method_getConversionGroupUnits .collapse">

  1386. <h2>getConversionGroupUnits

  1387. Returns an array of units of measure, for a specified conversion group, or for all groups</h2>

  1388. <pre>getConversionGroupUnits(string $group) : array</pre>

  1389. <div class="labels"><span class="label">Static</span></div>

  1390. <div class="row collapse"><div class="detail-description">

  1391. <div class="long_description"></div>

  1392. <h3>Parameters</h3>

  1393. <div class="subelement argument">

  1394. <h4>$group</h4>

  1395. <code>string</code><p>The group whose units of measure you want to retrieve</p></div>

  1396. <h3>Returns</h3>

  1397. <div class="subelement response"><code>array</code></div>

  1398. </div></div>

  1399. </div>

  1400. <a id="method_getConversionGroups"></a><div class="element clickable method public method_getConversionGroups" data-toggle="collapse" data-target=".method_getConversionGroups .collapse">

  1401. <h2>getConversionGroups

  1402. Returns a list of the different conversion groups for UOM conversions</h2>

  1403. <pre>getConversionGroups() : array</pre>

  1404. <div class="labels"><span class="label">Static</span></div>

  1405. <div class="row collapse"><div class="detail-description">

  1406. <div class="long_description"></div>

  1407. <h3>Returns</h3>

  1408. <div class="subelement response"><code>array</code></div>

  1409. </div></div>

  1410. </div>

  1411. <a id="method_getConversionMultipliers"></a><div class="element clickable method public method_getConversionMultipliers" data-toggle="collapse" data-target=".method_getConversionMultipliers .collapse">

  1412. <h2>getConversionMultipliers

  1413. Returns an array of the Multiplier prefixes that can be used with Units of Measure in CONVERTUOM()</h2>

  1414. <pre>getConversionMultipliers() : array</pre>

  1415. <div class="labels"><span class="label">Static</span></div>

  1416. <div class="row collapse"><div class="detail-description">

  1417. <div class="long_description"></div>

  1418. <h3>Returns</h3>

  1419. <div class="subelement response">

  1420. <code>array</code>of mixed</div>

  1421. </div></div>

  1422. </div>

  1423. <a id="method__Besselk0"></a><div class="element clickable method private method__Besselk0" data-toggle="collapse" data-target=".method__Besselk0 .collapse">

  1424. <h2>_Besselk0()

  1425.         </h2>

  1426. <pre>_Besselk0($fNum) </pre>

  1427. <div class="labels"><span class="label">Static</span></div>

  1428. <div class="row collapse"><div class="detail-description">

  1429. <div class="long_description"></div>

  1430. <h3>Parameters</h3>

  1431. <div class="subelement argument"><h4>$fNum</h4></div>

  1432. </div></div>

  1433. </div>

  1434. <a id="method__Besselk1"></a><div class="element clickable method private method__Besselk1" data-toggle="collapse" data-target=".method__Besselk1 .collapse">

  1435. <h2>_Besselk1()

  1436.         </h2>

  1437. <pre>_Besselk1($fNum) </pre>

  1438. <div class="labels"><span class="label">Static</span></div>

  1439. <div class="row collapse"><div class="detail-description">

  1440. <div class="long_description"></div>

  1441. <h3>Parameters</h3>

  1442. <div class="subelement argument"><h4>$fNum</h4></div>

  1443. </div></div>

  1444. </div>

  1445. <a id="method__Bessely0"></a><div class="element clickable method private method__Bessely0" data-toggle="collapse" data-target=".method__Bessely0 .collapse">

  1446. <h2>_Bessely0()

  1447.         </h2>

  1448. <pre>_Bessely0($fNum) </pre>

  1449. <div class="labels"><span class="label">Static</span></div>

  1450. <div class="row collapse"><div class="detail-description">

  1451. <div class="long_description"></div>

  1452. <h3>Parameters</h3>

  1453. <div class="subelement argument"><h4>$fNum</h4></div>

  1454. </div></div>

  1455. </div>

  1456. <a id="method__Bessely1"></a><div class="element clickable method private method__Bessely1" data-toggle="collapse" data-target=".method__Bessely1 .collapse">

  1457. <h2>_Bessely1()

  1458.         </h2>

  1459. <pre>_Bessely1($fNum) </pre>

  1460. <div class="labels"><span class="label">Static</span></div>

  1461. <div class="row collapse"><div class="detail-description">

  1462. <div class="long_description"></div>

  1463. <h3>Parameters</h3>

  1464. <div class="subelement argument"><h4>$fNum</h4></div>

  1465. </div></div>

  1466. </div>

  1467. <a id="method__cleanComplex"></a><div class="element clickable method private method__cleanComplex" data-toggle="collapse" data-target=".method__cleanComplex .collapse">

  1468. <h2>Cleans the leading characters in a complex number string</h2>

  1469. <pre>_cleanComplex(string $complexNumber) : string</pre>

  1470. <div class="labels"><span class="label">Static</span></div>

  1471. <div class="row collapse"><div class="detail-description">

  1472. <div class="long_description"></div>

  1473. <h3>Parameters</h3>

  1474. <div class="subelement argument">

  1475. <h4>$complexNumber</h4>

  1476. <code>string</code><p>The complex number to clean</p></div>

  1477. <h3>Returns</h3>

  1478. <div class="subelement response">

  1479. <code>string</code>The "cleaned" complex number</div>

  1480. </div></div>

  1481. </div>

  1482. <a id="method__erfcVal"></a><div class="element clickable method private method__erfcVal" data-toggle="collapse" data-target=".method__erfcVal .collapse">

  1483. <h2>_erfcVal()

  1484.         </h2>

  1485. <pre>_erfcVal($x) </pre>

  1486. <div class="labels"><span class="label">Static</span></div>

  1487. <div class="row collapse"><div class="detail-description">

  1488. <div class="long_description"></div>

  1489. <h3>Parameters</h3>

  1490. <div class="subelement argument"><h4>$x</h4></div>

  1491. </div></div>

  1492. </div>

  1493. <a id="method__nbrConversionFormat"></a><div class="element clickable method private method__nbrConversionFormat" data-toggle="collapse" data-target=".method__nbrConversionFormat .collapse">

  1494. <h2>Formats a number base string value with leading zeroes</h2>

  1495. <pre>_nbrConversionFormat(string $xVal, integer $places) : string</pre>

  1496. <div class="labels"><span class="label">Static</span></div>

  1497. <div class="row collapse"><div class="detail-description">

  1498. <div class="long_description"></div>

  1499. <h3>Parameters</h3>

  1500. <div class="subelement argument">

  1501. <h4>$xVal</h4>

  1502. <code>string</code><p>The "number" to pad</p>

  1503. </div>

  1504. <div class="subelement argument">

  1505. <h4>$places</h4>

  1506. <code>integer</code><p>The length that we want to pad this value</p></div>

  1507. <h3>Returns</h3>

  1508. <div class="subelement response">

  1509. <code>string</code>The padded "number"</div>

  1510. </div></div>

  1511. </div>

  1512. <h3>

  1513. <i class="icon-custom icon-property"></i> Properties</h3>

  1514. <a id="property__conversionMultipliers"> </a><div class="element clickable property private property__conversionMultipliers" data-toggle="collapse" data-target=".property__conversionMultipliers .collapse">

  1515. <h2></h2>

  1516. <pre>$_conversionMultipliers : mixed[]</pre>

  1517. <div class="labels"></div>

  1518. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1519. </div>

  1520. <a id="property__conversionUnits"> </a><div class="element clickable property private property__conversionUnits" data-toggle="collapse" data-target=".property__conversionUnits .collapse">

  1521. <h2></h2>

  1522. <pre>$_conversionUnits : mixed[]</pre>

  1523. <div class="labels"></div>

  1524. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1525. </div>

  1526. <a id="property__one_sqrtpi"> </a><div class="element clickable property private property__one_sqrtpi" data-toggle="collapse" data-target=".property__one_sqrtpi .collapse">

  1527. <h2></h2>

  1528. <pre>$_one_sqrtpi </pre>

  1529. <div class="labels"></div>

  1530. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1531. </div>

  1532. <a id="property__two_sqrtpi"> </a><div class="element clickable property private property__two_sqrtpi" data-toggle="collapse" data-target=".property__two_sqrtpi .collapse">

  1533. <h2></h2>

  1534. <pre>$_two_sqrtpi </pre>

  1535. <div class="labels"></div>

  1536. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1537. </div>

  1538. <a id="property__unitConversions"> </a><div class="element clickable property private property__unitConversions" data-toggle="collapse" data-target=".property__unitConversions .collapse">

  1539. <h2></h2>

  1540. <pre>$_unitConversions : mixed[]</pre>

  1541. <div class="labels"></div>

  1542. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>

  1543. </div>

  1544. </div>

  1545. </div>

  1546. </div>

  1547. </div>

  1548. <div class="row"><footer class="span12">

  1549.             Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>

  1550.             Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>

  1551.             generated on 2014-03-02T15:27:33Z.<br></footer></div>

  1552. </div>

  1553. </body>

  1554. </html>