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.

PHPExcel_HashTable.html 18 KiB

3 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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_HashTable</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___clone" title="__clone :: Implement PHP __clone to create a deep clone, not just a shallow copy."><span class="description">Implement PHP __clone to create a deep clone, not just a shallow copy.</span><pre>__clone()</pre></a></li>
  96. <li class="method public "><a href="#method___construct" title="__construct :: Create a new PHPExcel_HashTable"><span class="description">Create a new PHPExcel_HashTable</span><pre>__construct()</pre></a></li>
  97. <li class="method public "><a href="#method_add" title="add :: Add HashTable item"><span class="description">Add HashTable item</span><pre>add()</pre></a></li>
  98. <li class="method public "><a href="#method_addFromSource" title="addFromSource :: Add HashTable items from source"><span class="description">Add HashTable items from source</span><pre>addFromSource()</pre></a></li>
  99. <li class="method public "><a href="#method_clear" title="clear :: Clear HashTable"><span class="description">Clear HashTable</span><pre>clear()</pre></a></li>
  100. <li class="method public "><a href="#method_count" title="count :: Count"><span class="description">Count</span><pre>count()</pre></a></li>
  101. <li class="method public "><a href="#method_getByHashCode" title="getByHashCode :: Get by hashcode"><span class="description">Get by hashcode</span><pre>getByHashCode()</pre></a></li>
  102. <li class="method public "><a href="#method_getByIndex" title="getByIndex :: Get by index"><span class="description">Get by index</span><pre>getByIndex()</pre></a></li>
  103. <li class="method public "><a href="#method_getIndexForHashCode" title="getIndexForHashCode :: Get index for hash code"><span class="description">Get index for hash code</span><pre>getIndexForHashCode()</pre></a></li>
  104. <li class="method public "><a href="#method_remove" title="remove :: Remove HashTable item"><span class="description">Remove HashTable item</span><pre>remove()</pre></a></li>
  105. <li class="method public "><a href="#method_toArray" title="toArray :: HashTable to array"><span class="description">HashTable to array</span><pre>toArray()</pre></a></li>
  106. </ul>
  107. </li>
  108. <li class="nav-header">
  109. <i class="icon-custom icon-property"></i> Properties
  110. <ul>
  111. <li class="property public "><a href="#property__items" title="$_items :: HashTable elements"><span class="description"></span><pre>$_items</pre></a></li>
  112. <li class="property public "><a href="#property__keyMap" title="$_keyMap :: HashTable key map"><span class="description"></span><pre>$_keyMap</pre></a></li>
  113. </ul>
  114. </li>
  115. </ul>
  116. </div>
  117. <div class="span8">
  118. <a id="\PHPExcel_HashTable"></a><ul class="breadcrumb">
  119. <li>
  120. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  121. </li>
  122. <li><a href="../namespaces/global.html">global</a></li>
  123. <li class="active">
  124. <span class="divider">\</span><a href="../classes/PHPExcel_HashTable.html">PHPExcel_HashTable</a>
  125. </li>
  126. </ul>
  127. <div class="element class">
  128. <p class="short_description">PHPExcel_HashTable</p>
  129. <div class="details">
  130. <div class="long_description"></div>
  131. <table class="table table-bordered">
  132. <tr>
  133. <th>category</th>
  134. <td>PHPExcel</td>
  135. </tr>
  136. <tr>
  137. <th>package</th>
  138. <td><a href="../packages/PHPExcel.html">PHPExcel</a></td>
  139. </tr>
  140. <tr>
  141. <th>copyright</th>
  142. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  143. </tr>
  144. </table>
  145. <h3>
  146. <i class="icon-custom icon-method"></i> Methods</h3>
  147. <a id="method___clone"></a><div class="element clickable method public method___clone" data-toggle="collapse" data-target=".method___clone .collapse">
  148. <h2>Implement PHP __clone to create a deep clone, not just a shallow copy.</h2>
  149. <pre>__clone() </pre>
  150. <div class="labels"></div>
  151. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  152. </div>
  153. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  154. <h2>Create a new PHPExcel_HashTable</h2>
  155. <pre>__construct(<a href="PHPExcel.IComparable.html#%5CPHPExcel_IComparable">\PHPExcel_IComparable[]</a> $pSource) </pre>
  156. <div class="labels"></div>
  157. <div class="row collapse"><div class="detail-description">
  158. <div class="long_description"></div>
  159. <h3>Parameters</h3>
  160. <div class="subelement argument">
  161. <h4>$pSource</h4>
  162. <code><a href="PHPExcel.IComparable.html#%5CPHPExcel_IComparable">\PHPExcel_IComparable[]</a></code><p>Optional source array to create HashTable from</p></div>
  163. <h3>Exceptions</h3>
  164. <table class="table table-bordered"><tr>
  165. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  166. <td></td>
  167. </tr></table>
  168. </div></div>
  169. </div>
  170. <a id="method_add"></a><div class="element clickable method public method_add" data-toggle="collapse" data-target=".method_add .collapse">
  171. <h2>Add HashTable item</h2>
  172. <pre>add(\PHPExcel_IComparable $pSource) </pre>
  173. <div class="labels"></div>
  174. <div class="row collapse"><div class="detail-description">
  175. <div class="long_description"></div>
  176. <h3>Parameters</h3>
  177. <div class="subelement argument">
  178. <h4>$pSource</h4>
  179. <code><a href="../classes/PHPExcel_IComparable.html">\PHPExcel_IComparable</a></code><p>Item to add</p></div>
  180. <h3>Exceptions</h3>
  181. <table class="table table-bordered"><tr>
  182. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  183. <td></td>
  184. </tr></table>
  185. </div></div>
  186. </div>
  187. <a id="method_addFromSource"></a><div class="element clickable method public method_addFromSource" data-toggle="collapse" data-target=".method_addFromSource .collapse">
  188. <h2>Add HashTable items from source</h2>
  189. <pre>addFromSource(<a href="PHPExcel.IComparable.html#%5CPHPExcel_IComparable">\PHPExcel_IComparable[]</a> $pSource) </pre>
  190. <div class="labels"></div>
  191. <div class="row collapse"><div class="detail-description">
  192. <div class="long_description"></div>
  193. <h3>Parameters</h3>
  194. <div class="subelement argument">
  195. <h4>$pSource</h4>
  196. <code><a href="PHPExcel.IComparable.html#%5CPHPExcel_IComparable">\PHPExcel_IComparable[]</a></code><p>Source array to create HashTable from</p></div>
  197. <h3>Exceptions</h3>
  198. <table class="table table-bordered"><tr>
  199. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  200. <td></td>
  201. </tr></table>
  202. </div></div>
  203. </div>
  204. <a id="method_clear"></a><div class="element clickable method public method_clear" data-toggle="collapse" data-target=".method_clear .collapse">
  205. <h2>Clear HashTable</h2>
  206. <pre>clear() </pre>
  207. <div class="labels"></div>
  208. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  209. </div>
  210. <a id="method_count"></a><div class="element clickable method public method_count" data-toggle="collapse" data-target=".method_count .collapse">
  211. <h2>Count</h2>
  212. <pre>count() : int</pre>
  213. <div class="labels"></div>
  214. <div class="row collapse"><div class="detail-description">
  215. <div class="long_description"></div>
  216. <h3>Returns</h3>
  217. <div class="subelement response"><code>int</code></div>
  218. </div></div>
  219. </div>
  220. <a id="method_getByHashCode"></a><div class="element clickable method public method_getByHashCode" data-toggle="collapse" data-target=".method_getByHashCode .collapse">
  221. <h2>Get by hashcode</h2>
  222. <pre>getByHashCode(string $pHashCode) : <a href="../classes/PHPExcel_IComparable.html">\PHPExcel_IComparable</a></pre>
  223. <div class="labels"></div>
  224. <div class="row collapse"><div class="detail-description">
  225. <div class="long_description"></div>
  226. <h3>Parameters</h3>
  227. <div class="subelement argument">
  228. <h4>$pHashCode</h4>
  229. <code>string</code>
  230. </div>
  231. <h3>Returns</h3>
  232. <div class="subelement response"><code><a href="../classes/PHPExcel_IComparable.html">\PHPExcel_IComparable</a></code></div>
  233. </div></div>
  234. </div>
  235. <a id="method_getByIndex"></a><div class="element clickable method public method_getByIndex" data-toggle="collapse" data-target=".method_getByIndex .collapse">
  236. <h2>Get by index</h2>
  237. <pre>getByIndex(int $pIndex) : <a href="../classes/PHPExcel_IComparable.html">\PHPExcel_IComparable</a></pre>
  238. <div class="labels"></div>
  239. <div class="row collapse"><div class="detail-description">
  240. <div class="long_description"></div>
  241. <h3>Parameters</h3>
  242. <div class="subelement argument">
  243. <h4>$pIndex</h4>
  244. <code>int</code>
  245. </div>
  246. <h3>Returns</h3>
  247. <div class="subelement response"><code><a href="../classes/PHPExcel_IComparable.html">\PHPExcel_IComparable</a></code></div>
  248. </div></div>
  249. </div>
  250. <a id="method_getIndexForHashCode"></a><div class="element clickable method public method_getIndexForHashCode" data-toggle="collapse" data-target=".method_getIndexForHashCode .collapse">
  251. <h2>Get index for hash code</h2>
  252. <pre>getIndexForHashCode(string $pHashCode) : int</pre>
  253. <div class="labels"></div>
  254. <div class="row collapse"><div class="detail-description">
  255. <div class="long_description"></div>
  256. <h3>Parameters</h3>
  257. <div class="subelement argument">
  258. <h4>$pHashCode</h4>
  259. <code>string</code>
  260. </div>
  261. <h3>Returns</h3>
  262. <div class="subelement response">
  263. <code>int</code>Index</div>
  264. </div></div>
  265. </div>
  266. <a id="method_remove"></a><div class="element clickable method public method_remove" data-toggle="collapse" data-target=".method_remove .collapse">
  267. <h2>Remove HashTable item</h2>
  268. <pre>remove(\PHPExcel_IComparable $pSource) </pre>
  269. <div class="labels"></div>
  270. <div class="row collapse"><div class="detail-description">
  271. <div class="long_description"></div>
  272. <h3>Parameters</h3>
  273. <div class="subelement argument">
  274. <h4>$pSource</h4>
  275. <code><a href="../classes/PHPExcel_IComparable.html">\PHPExcel_IComparable</a></code><p>Item to remove</p></div>
  276. <h3>Exceptions</h3>
  277. <table class="table table-bordered"><tr>
  278. <th><code><a href="../classes/PHPExcel_Exception.html">\PHPExcel_Exception</a></code></th>
  279. <td></td>
  280. </tr></table>
  281. </div></div>
  282. </div>
  283. <a id="method_toArray"></a><div class="element clickable method public method_toArray" data-toggle="collapse" data-target=".method_toArray .collapse">
  284. <h2>HashTable to array</h2>
  285. <pre>toArray() : <a href="PHPExcel.IComparable.html#%5CPHPExcel_IComparable">\PHPExcel_IComparable[]</a></pre>
  286. <div class="labels"></div>
  287. <div class="row collapse"><div class="detail-description">
  288. <div class="long_description"></div>
  289. <h3>Returns</h3>
  290. <div class="subelement response"><code><a href="PHPExcel.IComparable.html#%5CPHPExcel_IComparable">\PHPExcel_IComparable[]</a></code></div>
  291. </div></div>
  292. </div>
  293. <h3>
  294. <i class="icon-custom icon-property"></i> Properties</h3>
  295. <a id="property__items"> </a><div class="element clickable property public property__items" data-toggle="collapse" data-target=".property__items .collapse">
  296. <h2></h2>
  297. <pre>$_items : array</pre>
  298. <div class="labels"></div>
  299. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  300. </div>
  301. <a id="property__keyMap"> </a><div class="element clickable property public property__keyMap" data-toggle="collapse" data-target=".property__keyMap .collapse">
  302. <h2></h2>
  303. <pre>$_keyMap : array</pre>
  304. <div class="labels"></div>
  305. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  306. </div>
  307. </div>
  308. </div>
  309. </div>
  310. </div>
  311. <div class="row"><footer class="span12">
  312. 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>
  313. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  314. generated on 2014-03-02T15:27:35Z.<br></footer></div>
  315. </div>
  316. </body>
  317. </html>