classDataStructures_1_1List.html 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>RakNet: DataStructures::List&lt; list_type &gt; Class Template Reference</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <script type="text/javascript" src="jquery.js"></script>
  9. <script type="text/javascript" src="dynsections.js"></script>
  10. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  11. </head>
  12. <body>
  13. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  14. <div id="titlearea">
  15. <table cellspacing="0" cellpadding="0">
  16. <tbody>
  17. <tr style="height: 56px;">
  18. <td style="padding-left: 0.5em;">
  19. <div id="projectname">RakNet
  20. &#160;<span id="projectnumber">4.0</span>
  21. </div>
  22. </td>
  23. </tr>
  24. </tbody>
  25. </table>
  26. </div>
  27. <!-- end header part -->
  28. <!-- Generated by Doxygen 1.8.2 -->
  29. <div id="navrow1" class="tabs">
  30. <ul class="tablist">
  31. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  32. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  33. <li><a href="modules.html"><span>Modules</span></a></li>
  34. <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  35. <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  36. <li><a href="files.html"><span>Files</span></a></li>
  37. </ul>
  38. </div>
  39. <div id="navrow2" class="tabs2">
  40. <ul class="tablist">
  41. <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  42. <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  43. <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  44. <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  45. </ul>
  46. </div>
  47. <div id="nav-path" class="navpath">
  48. <ul>
  49. <li class="navelem"><a class="el" href="namespaceDataStructures.html">DataStructures</a></li><li class="navelem"><a class="el" href="classDataStructures_1_1List.html">List</a></li> </ul>
  50. </div>
  51. </div><!-- top -->
  52. <div class="header">
  53. <div class="summary">
  54. <a href="#pub-methods">Public Member Functions</a> &#124;
  55. <a href="classDataStructures_1_1List-members.html">List of all members</a> </div>
  56. <div class="headertitle">
  57. <div class="title">DataStructures::List&lt; list_type &gt; Class Template Reference</div> </div>
  58. </div><!--header-->
  59. <div class="contents">
  60. <p>Array based implementation of a list.
  61. <a href="classDataStructures_1_1List.html#details">More...</a></p>
  62. <p><code>#include &lt;DS_List.h&gt;</code></p>
  63. <table class="memberdecls">
  64. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  65. Public Member Functions</h2></td></tr>
  66. <tr class="memitem:aa063066442a5e28b3c40d0b1206ace35"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa063066442a5e28b3c40d0b1206ace35"></a>
  67. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#aa063066442a5e28b3c40d0b1206ace35">List</a> ()</td></tr>
  68. <tr class="memdesc:aa063066442a5e28b3c40d0b1206ace35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br/></td></tr>
  69. <tr class="separator:aa063066442a5e28b3c40d0b1206ace35"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:abafec4707d1b0b452539afb5acabe1da"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#abafec4707d1b0b452539afb5acabe1da">List</a> (const <a class="el" href="classDataStructures_1_1List.html">List</a> &amp;original_copy)</td></tr>
  71. <tr class="memdesc:abafec4707d1b0b452539afb5acabe1da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="#abafec4707d1b0b452539afb5acabe1da"></a><br/></td></tr>
  72. <tr class="separator:abafec4707d1b0b452539afb5acabe1da"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a7faf28804c9d17c301ee072c7dce005b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7faf28804c9d17c301ee072c7dce005b"></a>
  74. <a class="el" href="classDataStructures_1_1List.html">List</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a7faf28804c9d17c301ee072c7dce005b">operator=</a> (const <a class="el" href="classDataStructures_1_1List.html">List</a> &amp;original_copy)</td></tr>
  75. <tr class="memdesc:a7faf28804c9d17c301ee072c7dce005b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assign one list to another. <br/></td></tr>
  76. <tr class="separator:a7faf28804c9d17c301ee072c7dce005b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. <tr class="memitem:a028d64be4f2c6945be0f31a48b80823a"><td class="memItemLeft" align="right" valign="top">list_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a028d64be4f2c6945be0f31a48b80823a">operator[]</a> (const unsigned int position) const </td></tr>
  78. <tr class="memdesc:a028d64be4f2c6945be0f31a48b80823a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access an element by its index in the array. <a href="#a028d64be4f2c6945be0f31a48b80823a"></a><br/></td></tr>
  79. <tr class="separator:a028d64be4f2c6945be0f31a48b80823a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:a46ce8d0ed396b4de4cc3d4af3e6965db"><td class="memItemLeft" align="right" valign="top">list_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a46ce8d0ed396b4de4cc3d4af3e6965db">Get</a> (const unsigned int position) const </td></tr>
  81. <tr class="memdesc:a46ce8d0ed396b4de4cc3d4af3e6965db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Access an element by its index in the array. <a href="#a46ce8d0ed396b4de4cc3d4af3e6965db"></a><br/></td></tr>
  82. <tr class="separator:a46ce8d0ed396b4de4cc3d4af3e6965db"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83. <tr class="memitem:a771fc63e3b0d892fbb605a379a78bacb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a771fc63e3b0d892fbb605a379a78bacb">Push</a> (const list_type &amp;input, const char *file, unsigned int line)</td></tr>
  84. <tr class="memdesc:a771fc63e3b0d892fbb605a379a78bacb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Push an element at the end of the stack. <a href="#a771fc63e3b0d892fbb605a379a78bacb"></a><br/></td></tr>
  85. <tr class="separator:a771fc63e3b0d892fbb605a379a78bacb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a9be46e78d21543bf28bd473807160024"><td class="memItemLeft" align="right" valign="top">list_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a9be46e78d21543bf28bd473807160024">Pop</a> (void)</td></tr>
  87. <tr class="memdesc:a9be46e78d21543bf28bd473807160024"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop an element from the end of the stack. <a href="#a9be46e78d21543bf28bd473807160024"></a><br/></td></tr>
  88. <tr class="separator:a9be46e78d21543bf28bd473807160024"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:a5cb7d8b68d8d020a34f2186ea8d5b1c6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a5cb7d8b68d8d020a34f2186ea8d5b1c6">Insert</a> (const list_type &amp;input, const unsigned int position, const char *file, unsigned int line)</td></tr>
  90. <tr class="memdesc:a5cb7d8b68d8d020a34f2186ea8d5b1c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert an element at position <em>position</em> in the list. <a href="#a5cb7d8b68d8d020a34f2186ea8d5b1c6"></a><br/></td></tr>
  91. <tr class="separator:a5cb7d8b68d8d020a34f2186ea8d5b1c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92. <tr class="memitem:adfe61ff53151ab61ecba6f8506a4662f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#adfe61ff53151ab61ecba6f8506a4662f">Insert</a> (const list_type &amp;input, const char *file, unsigned int line)</td></tr>
  93. <tr class="memdesc:adfe61ff53151ab61ecba6f8506a4662f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Insert at the end of the list. <a href="#adfe61ff53151ab61ecba6f8506a4662f"></a><br/></td></tr>
  94. <tr class="separator:adfe61ff53151ab61ecba6f8506a4662f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. <tr class="memitem:a953b497c5f51b0b4f98089c08ad15696"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a953b497c5f51b0b4f98089c08ad15696">Replace</a> (const list_type &amp;input, const list_type filler, const unsigned int position, const char *file, unsigned int line)</td></tr>
  96. <tr class="memdesc:a953b497c5f51b0b4f98089c08ad15696"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the value at <em>position</em> by <em>input</em>. <a href="#a953b497c5f51b0b4f98089c08ad15696"></a><br/></td></tr>
  97. <tr class="separator:a953b497c5f51b0b4f98089c08ad15696"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a3eb0624d2bd176d1cc85f2ff45264eb9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a3eb0624d2bd176d1cc85f2ff45264eb9">Replace</a> (const list_type &amp;input)</td></tr>
  99. <tr class="memdesc:a3eb0624d2bd176d1cc85f2ff45264eb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Replace the last element of the list by <em>input</em>. <a href="#a3eb0624d2bd176d1cc85f2ff45264eb9"></a><br/></td></tr>
  100. <tr class="separator:a3eb0624d2bd176d1cc85f2ff45264eb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:a79621376e92b605c4dbdb77aafbb6b60"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a79621376e92b605c4dbdb77aafbb6b60">RemoveAtIndex</a> (const unsigned int position)</td></tr>
  102. <tr class="memdesc:a79621376e92b605c4dbdb77aafbb6b60"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the element at position <em>position</em>. <a href="#a79621376e92b605c4dbdb77aafbb6b60"></a><br/></td></tr>
  103. <tr class="separator:a79621376e92b605c4dbdb77aafbb6b60"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a351a647150169c71cc3f758dbb312096"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a351a647150169c71cc3f758dbb312096">RemoveAtIndexFast</a> (const unsigned int position)</td></tr>
  105. <tr class="memdesc:a351a647150169c71cc3f758dbb312096"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the element at position <em>position</em>. <a href="#a351a647150169c71cc3f758dbb312096"></a><br/></td></tr>
  106. <tr class="separator:a351a647150169c71cc3f758dbb312096"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:aeed32cd1075569515bb825f874dca24e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aeed32cd1075569515bb825f874dca24e"></a>
  108. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#aeed32cd1075569515bb825f874dca24e">RemoveFromEnd</a> (const unsigned num=1)</td></tr>
  109. <tr class="memdesc:aeed32cd1075569515bb825f874dca24e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Delete the element at the end of the list. <br/></td></tr>
  110. <tr class="separator:aeed32cd1075569515bb825f874dca24e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. <tr class="memitem:aae4e608a6f4cc3560ee3b3b20eda67fe"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#aae4e608a6f4cc3560ee3b3b20eda67fe">GetIndexOf</a> (const list_type &amp;input) const </td></tr>
  112. <tr class="memdesc:aae4e608a6f4cc3560ee3b3b20eda67fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the index of the specified item or MAX_UNSIGNED_LONG if not found. <a href="#aae4e608a6f4cc3560ee3b3b20eda67fe"></a><br/></td></tr>
  113. <tr class="separator:aae4e608a6f4cc3560ee3b3b20eda67fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  114. <tr class="memitem:a6f13a4519693cbd16cd13b1fe284f330"><td class="memItemLeft" align="right" valign="top">unsigned int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a6f13a4519693cbd16cd13b1fe284f330">Size</a> (void) const </td></tr>
  115. <tr class="separator:a6f13a4519693cbd16cd13b1fe284f330"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a34219a5ce92981102d06fb1da7842a6b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a34219a5ce92981102d06fb1da7842a6b"></a>
  117. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a34219a5ce92981102d06fb1da7842a6b">Clear</a> (bool doNotDeallocateSmallBlocks, const char *file, unsigned int line)</td></tr>
  118. <tr class="memdesc:a34219a5ce92981102d06fb1da7842a6b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear the list. <br/></td></tr>
  119. <tr class="separator:a34219a5ce92981102d06fb1da7842a6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:a3ccff322ccbf8eca0214d2c39693abc0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ccff322ccbf8eca0214d2c39693abc0"></a>
  121. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a3ccff322ccbf8eca0214d2c39693abc0">Preallocate</a> (unsigned countNeeded, const char *file, unsigned int line)</td></tr>
  122. <tr class="memdesc:a3ccff322ccbf8eca0214d2c39693abc0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Preallocate the list, so it needs fewer reallocations at runtime. <br/></td></tr>
  123. <tr class="separator:a3ccff322ccbf8eca0214d2c39693abc0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a1dd30a84afeb655784dae4351777dce5"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html#a1dd30a84afeb655784dae4351777dce5">Compress</a> (const char *file, unsigned int line)</td></tr>
  125. <tr class="memdesc:a1dd30a84afeb655784dae4351777dce5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees overallocated members, to use the minimum memory necessary. <a href="#a1dd30a84afeb655784dae4351777dce5"></a><br/></td></tr>
  126. <tr class="separator:a1dd30a84afeb655784dae4351777dce5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. </table>
  128. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  129. <div class="textblock"><h3>template&lt;class list_type&gt;<br/>
  130. class DataStructures::List&lt; list_type &gt;</h3>
  131. <p>Array based implementation of a list. </p>
  132. <dl class="section note"><dt>Note</dt><dd>ONLY USE THIS FOR SHALLOW COPIES. I don't bother with operator= to improve performance. </dd></dl>
  133. </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  134. <a class="anchor" id="abafec4707d1b0b452539afb5acabe1da"></a>
  135. <div class="memitem">
  136. <div class="memproto">
  137. <div class="memtemplate">
  138. template&lt;class list_type &gt; </div>
  139. <table class="memname">
  140. <tr>
  141. <td class="memname"><a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::<a class="el" href="classDataStructures_1_1List.html">List</a> </td>
  142. <td>(</td>
  143. <td class="paramtype">const <a class="el" href="classDataStructures_1_1List.html">List</a>&lt; list_type &gt; &amp;&#160;</td>
  144. <td class="paramname"><em>original_copy</em></td><td>)</td>
  145. <td></td>
  146. </tr>
  147. </table>
  148. </div><div class="memdoc">
  149. <p>Copy constructor. </p>
  150. <dl class="params"><dt>Parameters</dt><dd>
  151. <table class="params">
  152. <tr><td class="paramdir">[in]</td><td class="paramname">original_copy</td><td>The list to duplicate </td></tr>
  153. </table>
  154. </dd>
  155. </dl>
  156. </div>
  157. </div>
  158. <h2 class="groupheader">Member Function Documentation</h2>
  159. <a class="anchor" id="a1dd30a84afeb655784dae4351777dce5"></a>
  160. <div class="memitem">
  161. <div class="memproto">
  162. <div class="memtemplate">
  163. template&lt;class list_type &gt; </div>
  164. <table class="memname">
  165. <tr>
  166. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Compress </td>
  167. <td>(</td>
  168. <td class="paramtype">const char *&#160;</td>
  169. <td class="paramname"><em>file</em>, </td>
  170. </tr>
  171. <tr>
  172. <td class="paramkey"></td>
  173. <td></td>
  174. <td class="paramtype">unsigned int&#160;</td>
  175. <td class="paramname"><em>line</em>&#160;</td>
  176. </tr>
  177. <tr>
  178. <td></td>
  179. <td>)</td>
  180. <td></td><td></td>
  181. </tr>
  182. </table>
  183. </div><div class="memdoc">
  184. <p>Frees overallocated members, to use the minimum memory necessary. </p>
  185. <dl class="section attention"><dt>Attention</dt><dd>This is a slow operation </dd></dl>
  186. </div>
  187. </div>
  188. <a class="anchor" id="a46ce8d0ed396b4de4cc3d4af3e6965db"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <div class="memtemplate">
  192. template&lt;class list_type &gt; </div>
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname">list_type &amp; <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Get </td>
  199. <td>(</td>
  200. <td class="paramtype">const unsigned int&#160;</td>
  201. <td class="paramname"><em>position</em></td><td>)</td>
  202. <td> const</td>
  203. </tr>
  204. </table>
  205. </td>
  206. <td class="mlabels-right">
  207. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  208. </tr>
  209. </table>
  210. </div><div class="memdoc">
  211. <p>Access an element by its index in the array. </p>
  212. <dl class="params"><dt>Parameters</dt><dd>
  213. <table class="params">
  214. <tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>The index into the array. </td></tr>
  215. </table>
  216. </dd>
  217. </dl>
  218. <dl class="section return"><dt>Returns</dt><dd>The element at position <em>position</em>. </dd></dl>
  219. </div>
  220. </div>
  221. <a class="anchor" id="aae4e608a6f4cc3560ee3b3b20eda67fe"></a>
  222. <div class="memitem">
  223. <div class="memproto">
  224. <div class="memtemplate">
  225. template&lt;class list_type&gt; </div>
  226. <table class="memname">
  227. <tr>
  228. <td class="memname">unsigned int <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::GetIndexOf </td>
  229. <td>(</td>
  230. <td class="paramtype">const list_type &amp;&#160;</td>
  231. <td class="paramname"><em>input</em></td><td>)</td>
  232. <td> const</td>
  233. </tr>
  234. </table>
  235. </div><div class="memdoc">
  236. <p>Returns the index of the specified item or MAX_UNSIGNED_LONG if not found. </p>
  237. <dl class="params"><dt>Parameters</dt><dd>
  238. <table class="params">
  239. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The element to check for </td></tr>
  240. </table>
  241. </dd>
  242. </dl>
  243. <dl class="section return"><dt>Returns</dt><dd>The index or position of <em>input</em> in the list. </dd></dl>
  244. <dl class="retval"><dt>Return values</dt><dd>
  245. <table class="retval">
  246. <tr><td class="paramname">MAX_UNSIGNED_LONG</td><td>The object is not in the list </td></tr>
  247. <tr><td class="paramname">[Integer]</td><td>The index of the element in the list </td></tr>
  248. </table>
  249. </dd>
  250. </dl>
  251. </div>
  252. </div>
  253. <a class="anchor" id="a5cb7d8b68d8d020a34f2186ea8d5b1c6"></a>
  254. <div class="memitem">
  255. <div class="memproto">
  256. <div class="memtemplate">
  257. template&lt;class list_type&gt; </div>
  258. <table class="memname">
  259. <tr>
  260. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Insert </td>
  261. <td>(</td>
  262. <td class="paramtype">const list_type &amp;&#160;</td>
  263. <td class="paramname"><em>input</em>, </td>
  264. </tr>
  265. <tr>
  266. <td class="paramkey"></td>
  267. <td></td>
  268. <td class="paramtype">const unsigned int&#160;</td>
  269. <td class="paramname"><em>position</em>, </td>
  270. </tr>
  271. <tr>
  272. <td class="paramkey"></td>
  273. <td></td>
  274. <td class="paramtype">const char *&#160;</td>
  275. <td class="paramname"><em>file</em>, </td>
  276. </tr>
  277. <tr>
  278. <td class="paramkey"></td>
  279. <td></td>
  280. <td class="paramtype">unsigned int&#160;</td>
  281. <td class="paramname"><em>line</em>&#160;</td>
  282. </tr>
  283. <tr>
  284. <td></td>
  285. <td>)</td>
  286. <td></td><td></td>
  287. </tr>
  288. </table>
  289. </div><div class="memdoc">
  290. <p>Insert an element at position <em>position</em> in the list. </p>
  291. <dl class="params"><dt>Parameters</dt><dd>
  292. <table class="params">
  293. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The new element. </td></tr>
  294. <tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>The position of the new element. </td></tr>
  295. </table>
  296. </dd>
  297. </dl>
  298. </div>
  299. </div>
  300. <a class="anchor" id="adfe61ff53151ab61ecba6f8506a4662f"></a>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <div class="memtemplate">
  304. template&lt;class list_type&gt; </div>
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Insert </td>
  308. <td>(</td>
  309. <td class="paramtype">const list_type &amp;&#160;</td>
  310. <td class="paramname"><em>input</em>, </td>
  311. </tr>
  312. <tr>
  313. <td class="paramkey"></td>
  314. <td></td>
  315. <td class="paramtype">const char *&#160;</td>
  316. <td class="paramname"><em>file</em>, </td>
  317. </tr>
  318. <tr>
  319. <td class="paramkey"></td>
  320. <td></td>
  321. <td class="paramtype">unsigned int&#160;</td>
  322. <td class="paramname"><em>line</em>&#160;</td>
  323. </tr>
  324. <tr>
  325. <td></td>
  326. <td>)</td>
  327. <td></td><td></td>
  328. </tr>
  329. </table>
  330. </div><div class="memdoc">
  331. <p>Insert at the end of the list. </p>
  332. <dl class="params"><dt>Parameters</dt><dd>
  333. <table class="params">
  334. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The new element. </td></tr>
  335. </table>
  336. </dd>
  337. </dl>
  338. </div>
  339. </div>
  340. <a class="anchor" id="a028d64be4f2c6945be0f31a48b80823a"></a>
  341. <div class="memitem">
  342. <div class="memproto">
  343. <div class="memtemplate">
  344. template&lt;class list_type &gt; </div>
  345. <table class="mlabels">
  346. <tr>
  347. <td class="mlabels-left">
  348. <table class="memname">
  349. <tr>
  350. <td class="memname">list_type &amp; <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::operator[] </td>
  351. <td>(</td>
  352. <td class="paramtype">const unsigned int&#160;</td>
  353. <td class="paramname"><em>position</em></td><td>)</td>
  354. <td> const</td>
  355. </tr>
  356. </table>
  357. </td>
  358. <td class="mlabels-right">
  359. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  360. </tr>
  361. </table>
  362. </div><div class="memdoc">
  363. <p>Access an element by its index in the array. </p>
  364. <dl class="params"><dt>Parameters</dt><dd>
  365. <table class="params">
  366. <tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>The index into the array. </td></tr>
  367. </table>
  368. </dd>
  369. </dl>
  370. <dl class="section return"><dt>Returns</dt><dd>The element at position <em>position</em>. </dd></dl>
  371. </div>
  372. </div>
  373. <a class="anchor" id="a9be46e78d21543bf28bd473807160024"></a>
  374. <div class="memitem">
  375. <div class="memproto">
  376. <div class="memtemplate">
  377. template&lt;class list_type &gt; </div>
  378. <table class="mlabels">
  379. <tr>
  380. <td class="mlabels-left">
  381. <table class="memname">
  382. <tr>
  383. <td class="memname">list_type &amp; <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Pop </td>
  384. <td>(</td>
  385. <td class="paramtype">void&#160;</td>
  386. <td class="paramname"></td><td>)</td>
  387. <td></td>
  388. </tr>
  389. </table>
  390. </td>
  391. <td class="mlabels-right">
  392. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  393. </tr>
  394. </table>
  395. </div><div class="memdoc">
  396. <p>Pop an element from the end of the stack. </p>
  397. <dl class="section pre"><dt>Precondition</dt><dd><a class="el" href="classDataStructures_1_1List.html#a6f13a4519693cbd16cd13b1fe284f330">Size()</a>&gt;0 </dd></dl>
  398. <dl class="section return"><dt>Returns</dt><dd>The element at the end. </dd></dl>
  399. </div>
  400. </div>
  401. <a class="anchor" id="a771fc63e3b0d892fbb605a379a78bacb"></a>
  402. <div class="memitem">
  403. <div class="memproto">
  404. <div class="memtemplate">
  405. template&lt;class list_type&gt; </div>
  406. <table class="memname">
  407. <tr>
  408. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Push </td>
  409. <td>(</td>
  410. <td class="paramtype">const list_type &amp;&#160;</td>
  411. <td class="paramname"><em>input</em>, </td>
  412. </tr>
  413. <tr>
  414. <td class="paramkey"></td>
  415. <td></td>
  416. <td class="paramtype">const char *&#160;</td>
  417. <td class="paramname"><em>file</em>, </td>
  418. </tr>
  419. <tr>
  420. <td class="paramkey"></td>
  421. <td></td>
  422. <td class="paramtype">unsigned int&#160;</td>
  423. <td class="paramname"><em>line</em>&#160;</td>
  424. </tr>
  425. <tr>
  426. <td></td>
  427. <td>)</td>
  428. <td></td><td></td>
  429. </tr>
  430. </table>
  431. </div><div class="memdoc">
  432. <p>Push an element at the end of the stack. </p>
  433. <dl class="params"><dt>Parameters</dt><dd>
  434. <table class="params">
  435. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The new element. </td></tr>
  436. </table>
  437. </dd>
  438. </dl>
  439. </div>
  440. </div>
  441. <a class="anchor" id="a79621376e92b605c4dbdb77aafbb6b60"></a>
  442. <div class="memitem">
  443. <div class="memproto">
  444. <div class="memtemplate">
  445. template&lt;class list_type &gt; </div>
  446. <table class="memname">
  447. <tr>
  448. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::RemoveAtIndex </td>
  449. <td>(</td>
  450. <td class="paramtype">const unsigned int&#160;</td>
  451. <td class="paramname"><em>position</em></td><td>)</td>
  452. <td></td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. <p>Delete the element at position <em>position</em>. </p>
  457. <dl class="params"><dt>Parameters</dt><dd>
  458. <table class="params">
  459. <tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>The index of the element to delete </td></tr>
  460. </table>
  461. </dd>
  462. </dl>
  463. </div>
  464. </div>
  465. <a class="anchor" id="a351a647150169c71cc3f758dbb312096"></a>
  466. <div class="memitem">
  467. <div class="memproto">
  468. <div class="memtemplate">
  469. template&lt;class list_type &gt; </div>
  470. <table class="memname">
  471. <tr>
  472. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::RemoveAtIndexFast </td>
  473. <td>(</td>
  474. <td class="paramtype">const unsigned int&#160;</td>
  475. <td class="paramname"><em>position</em></td><td>)</td>
  476. <td></td>
  477. </tr>
  478. </table>
  479. </div><div class="memdoc">
  480. <p>Delete the element at position <em>position</em>. </p>
  481. <dl class="section note"><dt>Note</dt><dd>- swaps middle with end of list, only use if list order does not matter </dd></dl>
  482. <dl class="params"><dt>Parameters</dt><dd>
  483. <table class="params">
  484. <tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>The index of the element to delete </td></tr>
  485. </table>
  486. </dd>
  487. </dl>
  488. </div>
  489. </div>
  490. <a class="anchor" id="a953b497c5f51b0b4f98089c08ad15696"></a>
  491. <div class="memitem">
  492. <div class="memproto">
  493. <div class="memtemplate">
  494. template&lt;class list_type&gt; </div>
  495. <table class="mlabels">
  496. <tr>
  497. <td class="mlabels-left">
  498. <table class="memname">
  499. <tr>
  500. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Replace </td>
  501. <td>(</td>
  502. <td class="paramtype">const list_type &amp;&#160;</td>
  503. <td class="paramname"><em>input</em>, </td>
  504. </tr>
  505. <tr>
  506. <td class="paramkey"></td>
  507. <td></td>
  508. <td class="paramtype">const list_type&#160;</td>
  509. <td class="paramname"><em>filler</em>, </td>
  510. </tr>
  511. <tr>
  512. <td class="paramkey"></td>
  513. <td></td>
  514. <td class="paramtype">const unsigned int&#160;</td>
  515. <td class="paramname"><em>position</em>, </td>
  516. </tr>
  517. <tr>
  518. <td class="paramkey"></td>
  519. <td></td>
  520. <td class="paramtype">const char *&#160;</td>
  521. <td class="paramname"><em>file</em>, </td>
  522. </tr>
  523. <tr>
  524. <td class="paramkey"></td>
  525. <td></td>
  526. <td class="paramtype">unsigned int&#160;</td>
  527. <td class="paramname"><em>line</em>&#160;</td>
  528. </tr>
  529. <tr>
  530. <td></td>
  531. <td>)</td>
  532. <td></td><td></td>
  533. </tr>
  534. </table>
  535. </td>
  536. <td class="mlabels-right">
  537. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  538. </tr>
  539. </table>
  540. </div><div class="memdoc">
  541. <p>Replace the value at <em>position</em> by <em>input</em>. </p>
  542. <p>If the size of the list is less than <em>position</em>, it increase the capacity of the list and fill slot with <em>filler</em>. </p>
  543. <dl class="params"><dt>Parameters</dt><dd>
  544. <table class="params">
  545. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The element to replace at position <em>position</em>. </td></tr>
  546. <tr><td class="paramdir">[in]</td><td class="paramname">filler</td><td>The element use to fill new allocated capacity. </td></tr>
  547. <tr><td class="paramdir">[in]</td><td class="paramname">position</td><td>The position of input in the list. </td></tr>
  548. </table>
  549. </dd>
  550. </dl>
  551. </div>
  552. </div>
  553. <a class="anchor" id="a3eb0624d2bd176d1cc85f2ff45264eb9"></a>
  554. <div class="memitem">
  555. <div class="memproto">
  556. <div class="memtemplate">
  557. template&lt;class list_type&gt; </div>
  558. <table class="mlabels">
  559. <tr>
  560. <td class="mlabels-left">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname">void <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Replace </td>
  564. <td>(</td>
  565. <td class="paramtype">const list_type &amp;&#160;</td>
  566. <td class="paramname"><em>input</em></td><td>)</td>
  567. <td></td>
  568. </tr>
  569. </table>
  570. </td>
  571. <td class="mlabels-right">
  572. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  573. </tr>
  574. </table>
  575. </div><div class="memdoc">
  576. <p>Replace the last element of the list by <em>input</em>. </p>
  577. <dl class="params"><dt>Parameters</dt><dd>
  578. <table class="params">
  579. <tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>The element used to replace the last element. </td></tr>
  580. </table>
  581. </dd>
  582. </dl>
  583. </div>
  584. </div>
  585. <a class="anchor" id="a6f13a4519693cbd16cd13b1fe284f330"></a>
  586. <div class="memitem">
  587. <div class="memproto">
  588. <div class="memtemplate">
  589. template&lt;class list_type &gt; </div>
  590. <table class="mlabels">
  591. <tr>
  592. <td class="mlabels-left">
  593. <table class="memname">
  594. <tr>
  595. <td class="memname">unsigned int <a class="el" href="classDataStructures_1_1List.html">DataStructures::List</a>&lt; list_type &gt;::Size </td>
  596. <td>(</td>
  597. <td class="paramtype">void&#160;</td>
  598. <td class="paramname"></td><td>)</td>
  599. <td> const</td>
  600. </tr>
  601. </table>
  602. </td>
  603. <td class="mlabels-right">
  604. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  605. </tr>
  606. </table>
  607. </div><div class="memdoc">
  608. <dl class="section return"><dt>Returns</dt><dd>The number of elements in the list </dd></dl>
  609. </div>
  610. </div>
  611. <hr/>The documentation for this class was generated from the following file:<ul>
  612. <li>D:/temp/RakNet_PC/Source/<a class="el" href="DS__List_8h.html">DS_List.h</a></li>
  613. </ul>
  614. </div><!-- contents -->
  615. <!-- start footer part -->
  616. <hr class="footer"/><address class="footer"><small>
  617. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  618. <img class="footer" src="doxygen.png" alt="doxygen"/>
  619. </a> 1.8.2
  620. </small></address>
  621. </body>
  622. </html>
粤ICP备19079148号