class_sparse_array.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Torque2D Reference: SparseArray&lt; T &gt; Class Template Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#nested-classes">Classes</a> &#124;
  73. <a href="#pub-methods">Public Member Functions</a> &#124;
  74. <a href="#pro-attribs">Protected Attributes</a> &#124;
  75. <a href="class_sparse_array-members.html">List of all members</a> </div>
  76. <div class="headertitle"><div class="title">SparseArray&lt; T &gt; Class Template Reference</div></div>
  77. </div><!--header-->
  78. <div class="contents">
  79. <p><code>#include &lt;sparseArray.h&gt;</code></p>
  80. <div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  81. <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for SparseArray&lt; T &gt;:</div>
  82. <div id="dynsection-0-summary" class="dynsummary" style="display:block;">
  83. </div>
  84. <div id="dynsection-0-content" class="dyncontent" style="display:none;">
  85. <div class="center">
  86. <img src="class_sparse_array.png" usemap="#SparseArray_3C_20T_20_3E_map" alt=""/>
  87. <map id="SparseArray_3C_20T_20_3E_map" name="SparseArray_3C_20T_20_3E_map">
  88. <area href="class_simple_hash_table.html" alt="SimpleHashTable&lt; Dispatcher::MessageQueue &gt;" shape="rect" coords="0,56,313,80"/>
  89. <area href="class_simple_hash_table.html" alt="SimpleHashTable&lt; Vector&lt; Subscriber &gt; &gt;" shape="rect" coords="323,56,636,80"/>
  90. <area href="class_simple_hash_table.html" alt="SimpleHashTable&lt; struct Zip::ZipArchive::ZipEntry &gt;" shape="rect" coords="646,56,959,80"/>
  91. <area href="class_simple_hash_table.html" alt="SimpleHashTable&lt; T &gt;" shape="rect" coords="969,56,1282,80"/>
  92. </map>
  93. </div></div>
  94. <table class="memberdecls">
  95. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  96. Classes</h2></td></tr>
  97. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_sparse_array_1_1_node.html">Node</a></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
  101. Public Member Functions</h2></td></tr>
  102. <tr class="memitem:a165e5ea63e54178236afbabd4058047b" id="r_a165e5ea63e54178236afbabd4058047b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#a165e5ea63e54178236afbabd4058047b">SparseArray</a> (const U32 modulusSize=64)</td></tr>
  103. <tr class="separator:a165e5ea63e54178236afbabd4058047b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:aa4db50e0944e7e6618be00bc7a7a8026" id="r_aa4db50e0944e7e6618be00bc7a7a8026"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#aa4db50e0944e7e6618be00bc7a7a8026">~SparseArray</a> ()</td></tr>
  105. <tr class="separator:aa4db50e0944e7e6618be00bc7a7a8026"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:aef8bbe068f2d4293b7dd8b9fc0320a5a" id="r_aef8bbe068f2d4293b7dd8b9fc0320a5a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#aef8bbe068f2d4293b7dd8b9fc0320a5a">insert</a> (T *pObject, U32 key)</td></tr>
  107. <tr class="separator:aef8bbe068f2d4293b7dd8b9fc0320a5a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ae2ca2a2d9a988161539f4bad1fb9a1a1" id="r_ae2ca2a2d9a988161539f4bad1fb9a1a1"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#ae2ca2a2d9a988161539f4bad1fb9a1a1">remove</a> (U32 key)</td></tr>
  109. <tr class="separator:ae2ca2a2d9a988161539f4bad1fb9a1a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a834715daf036776ea40818ec946db384" id="r_a834715daf036776ea40818ec946db384"><td class="memItemLeft" align="right" valign="top">T *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#a834715daf036776ea40818ec946db384">retrieve</a> (U32 key)</td></tr>
  111. <tr class="separator:a834715daf036776ea40818ec946db384"><td class="memSeparator" colspan="2">&#160;</td></tr>
  112. <tr class="memitem:aa960aa872afa262962896ef65a58fd49" id="r_aa960aa872afa262962896ef65a58fd49"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#aa960aa872afa262962896ef65a58fd49">clearTables</a> ()</td></tr>
  113. <tr class="separator:aa960aa872afa262962896ef65a58fd49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. </table><table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
  116. Protected Attributes</h2></td></tr>
  117. <tr class="memitem:a2d5bd52ba50fa4d5206f7aed4e0ee732" id="r_a2d5bd52ba50fa4d5206f7aed4e0ee732"><td class="memItemLeft" align="right" valign="top">U32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#a2d5bd52ba50fa4d5206f7aed4e0ee732">mModulus</a></td></tr>
  118. <tr class="separator:a2d5bd52ba50fa4d5206f7aed4e0ee732"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:afc854323258b0b7f2cdcc89d72f51a34" id="r_afc854323258b0b7f2cdcc89d72f51a34"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_sparse_array_1_1_node.html">Node</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_sparse_array.html#afc854323258b0b7f2cdcc89d72f51a34">mSentryTables</a></td></tr>
  120. <tr class="separator:afc854323258b0b7f2cdcc89d72f51a34"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. </table>
  122. <h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  123. <a id="a165e5ea63e54178236afbabd4058047b" name="a165e5ea63e54178236afbabd4058047b"></a>
  124. <h2 class="memtitle"><span class="permalink"><a href="#a165e5ea63e54178236afbabd4058047b">&#9670;&#160;</a></span>SparseArray()</h2>
  125. <div class="memitem">
  126. <div class="memproto">
  127. <div class="memtemplate">
  128. template&lt;class T &gt; </div>
  129. <table class="mlabels">
  130. <tr>
  131. <td class="mlabels-left">
  132. <table class="memname">
  133. <tr>
  134. <td class="memname"><a class="el" href="class_sparse_array.html">SparseArray</a> </td>
  135. <td>(</td>
  136. <td class="paramtype">const U32&#160;</td>
  137. <td class="paramname"><em>modulusSize</em> = <code>64</code></td><td>)</td>
  138. <td></td>
  139. </tr>
  140. </table>
  141. </td>
  142. <td class="mlabels-right">
  143. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  144. </tr>
  145. </table>
  146. </div><div class="memdoc">
  147. </div>
  148. </div>
  149. <a id="aa4db50e0944e7e6618be00bc7a7a8026" name="aa4db50e0944e7e6618be00bc7a7a8026"></a>
  150. <h2 class="memtitle"><span class="permalink"><a href="#aa4db50e0944e7e6618be00bc7a7a8026">&#9670;&#160;</a></span>~SparseArray()</h2>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <div class="memtemplate">
  154. template&lt;class T &gt; </div>
  155. <table class="mlabels">
  156. <tr>
  157. <td class="mlabels-left">
  158. <table class="memname">
  159. <tr>
  160. <td class="memname">~<a class="el" href="class_sparse_array.html">SparseArray</a> </td>
  161. <td>(</td>
  162. <td class="paramname"></td><td>)</td>
  163. <td></td>
  164. </tr>
  165. </table>
  166. </td>
  167. <td class="mlabels-right">
  168. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  169. </tr>
  170. </table>
  171. </div><div class="memdoc">
  172. </div>
  173. </div>
  174. <h2 class="groupheader">Member Function Documentation</h2>
  175. <a id="aa960aa872afa262962896ef65a58fd49" name="aa960aa872afa262962896ef65a58fd49"></a>
  176. <h2 class="memtitle"><span class="permalink"><a href="#aa960aa872afa262962896ef65a58fd49">&#9670;&#160;</a></span>clearTables()</h2>
  177. <div class="memitem">
  178. <div class="memproto">
  179. <div class="memtemplate">
  180. template&lt;class T &gt; </div>
  181. <table class="mlabels">
  182. <tr>
  183. <td class="mlabels-left">
  184. <table class="memname">
  185. <tr>
  186. <td class="memname">void clearTables </td>
  187. <td>(</td>
  188. <td class="paramname"></td><td>)</td>
  189. <td></td>
  190. </tr>
  191. </table>
  192. </td>
  193. <td class="mlabels-right">
  194. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  195. </tr>
  196. </table>
  197. </div><div class="memdoc">
  198. </div>
  199. </div>
  200. <a id="aef8bbe068f2d4293b7dd8b9fc0320a5a" name="aef8bbe068f2d4293b7dd8b9fc0320a5a"></a>
  201. <h2 class="memtitle"><span class="permalink"><a href="#aef8bbe068f2d4293b7dd8b9fc0320a5a">&#9670;&#160;</a></span>insert()</h2>
  202. <div class="memitem">
  203. <div class="memproto">
  204. <div class="memtemplate">
  205. template&lt;class T &gt; </div>
  206. <table class="mlabels">
  207. <tr>
  208. <td class="mlabels-left">
  209. <table class="memname">
  210. <tr>
  211. <td class="memname">void insert </td>
  212. <td>(</td>
  213. <td class="paramtype">T *&#160;</td>
  214. <td class="paramname"><em>pObject</em>, </td>
  215. </tr>
  216. <tr>
  217. <td class="paramkey"></td>
  218. <td></td>
  219. <td class="paramtype">U32&#160;</td>
  220. <td class="paramname"><em>key</em>&#160;</td>
  221. </tr>
  222. <tr>
  223. <td></td>
  224. <td>)</td>
  225. <td></td><td></td>
  226. </tr>
  227. </table>
  228. </td>
  229. <td class="mlabels-right">
  230. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  231. </tr>
  232. </table>
  233. </div><div class="memdoc">
  234. </div>
  235. </div>
  236. <a id="ae2ca2a2d9a988161539f4bad1fb9a1a1" name="ae2ca2a2d9a988161539f4bad1fb9a1a1"></a>
  237. <h2 class="memtitle"><span class="permalink"><a href="#ae2ca2a2d9a988161539f4bad1fb9a1a1">&#9670;&#160;</a></span>remove()</h2>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <div class="memtemplate">
  241. template&lt;class T &gt; </div>
  242. <table class="mlabels">
  243. <tr>
  244. <td class="mlabels-left">
  245. <table class="memname">
  246. <tr>
  247. <td class="memname">T * remove </td>
  248. <td>(</td>
  249. <td class="paramtype">U32&#160;</td>
  250. <td class="paramname"><em>key</em></td><td>)</td>
  251. <td></td>
  252. </tr>
  253. </table>
  254. </td>
  255. <td class="mlabels-right">
  256. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  257. </tr>
  258. </table>
  259. </div><div class="memdoc">
  260. </div>
  261. </div>
  262. <a id="a834715daf036776ea40818ec946db384" name="a834715daf036776ea40818ec946db384"></a>
  263. <h2 class="memtitle"><span class="permalink"><a href="#a834715daf036776ea40818ec946db384">&#9670;&#160;</a></span>retrieve()</h2>
  264. <div class="memitem">
  265. <div class="memproto">
  266. <div class="memtemplate">
  267. template&lt;class T &gt; </div>
  268. <table class="mlabels">
  269. <tr>
  270. <td class="mlabels-left">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">T * retrieve </td>
  274. <td>(</td>
  275. <td class="paramtype">U32&#160;</td>
  276. <td class="paramname"><em>key</em></td><td>)</td>
  277. <td></td>
  278. </tr>
  279. </table>
  280. </td>
  281. <td class="mlabels-right">
  282. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  283. </tr>
  284. </table>
  285. </div><div class="memdoc">
  286. </div>
  287. </div>
  288. <h2 class="groupheader">Member Data Documentation</h2>
  289. <a id="a2d5bd52ba50fa4d5206f7aed4e0ee732" name="a2d5bd52ba50fa4d5206f7aed4e0ee732"></a>
  290. <h2 class="memtitle"><span class="permalink"><a href="#a2d5bd52ba50fa4d5206f7aed4e0ee732">&#9670;&#160;</a></span>mModulus</h2>
  291. <div class="memitem">
  292. <div class="memproto">
  293. <div class="memtemplate">
  294. template&lt;class T &gt; </div>
  295. <table class="mlabels">
  296. <tr>
  297. <td class="mlabels-left">
  298. <table class="memname">
  299. <tr>
  300. <td class="memname">U32 mModulus</td>
  301. </tr>
  302. </table>
  303. </td>
  304. <td class="mlabels-right">
  305. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  306. </tr>
  307. </table>
  308. </div><div class="memdoc">
  309. </div>
  310. </div>
  311. <a id="afc854323258b0b7f2cdcc89d72f51a34" name="afc854323258b0b7f2cdcc89d72f51a34"></a>
  312. <h2 class="memtitle"><span class="permalink"><a href="#afc854323258b0b7f2cdcc89d72f51a34">&#9670;&#160;</a></span>mSentryTables</h2>
  313. <div class="memitem">
  314. <div class="memproto">
  315. <div class="memtemplate">
  316. template&lt;class T &gt; </div>
  317. <table class="mlabels">
  318. <tr>
  319. <td class="mlabels-left">
  320. <table class="memname">
  321. <tr>
  322. <td class="memname"><a class="el" href="struct_sparse_array_1_1_node.html">Node</a>* mSentryTables</td>
  323. </tr>
  324. </table>
  325. </td>
  326. <td class="mlabels-right">
  327. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. </div>
  332. </div>
  333. <hr/>The documentation for this class was generated from the following file:<ul>
  334. <li>collection/<b>sparseArray.h</b></li>
  335. </ul>
  336. </div><!-- contents -->
  337. <!-- start footer part -->
  338. <hr class="footer"/><address class="footer"><small>
  339. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  340. </small></address>
  341. </body>
  342. </html>