classDataStructures_1_1Multilist.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470
  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::Multilist&lt; _MultilistType, _DataType, _KeyType, _IndexType &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_1Multilist.html">Multilist</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="#pub-static-methods">Static Public Member Functions</a> &#124;
  56. <a href="#pro-attribs">Protected Attributes</a> &#124;
  57. <a href="classDataStructures_1_1Multilist-members.html">List of all members</a> </div>
  58. <div class="headertitle">
  59. <div class="title">DataStructures::Multilist&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt; Class Template Reference</div> </div>
  60. </div><!--header-->
  61. <div class="contents">
  62. <p>The multilist, representing an abstract data type that generally holds lists.
  63. <a href="classDataStructures_1_1Multilist.html#details">More...</a></p>
  64. <p><code>#include &lt;DS_Multilist.h&gt;</code></p>
  65. <table class="memberdecls">
  66. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  67. Public Member Functions</h2></td></tr>
  68. <tr class="memitem:afe3f119b9f715a88fc6dd356689f7e72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#afe3f119b9f715a88fc6dd356689f7e72">Push</a> (const _DataType &amp;d, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  69. <tr class="separator:afe3f119b9f715a88fc6dd356689f7e72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:a09e7c33fe9587c1902ed1551d720f7b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09e7c33fe9587c1902ed1551d720f7b7"></a>
  71. _DataType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a09e7c33fe9587c1902ed1551d720f7b7">Pop</a> (const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  72. <tr class="memdesc:a09e7c33fe9587c1902ed1551d720f7b7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or removes and gets an element from the list, according to the same rules as <a class="el" href="classDataStructures_1_1Multilist.html#afe3f119b9f715a88fc6dd356689f7e72">Push()</a>. Ordered list is LIFO for the purposes of Pop and Peek. <br/></td></tr>
  73. <tr class="separator:a09e7c33fe9587c1902ed1551d720f7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74. <tr class="memitem:a1596f547cb2b038726d2d733930e44be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1596f547cb2b038726d2d733930e44be"></a>
  75. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a1596f547cb2b038726d2d733930e44be">PushOpposite</a> (const _DataType &amp;d, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  76. <tr class="memdesc:a1596f547cb2b038726d2d733930e44be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="classDataStructures_1_1Multilist.html#afe3f119b9f715a88fc6dd356689f7e72">Push()</a>, except FIFO and LIFO are reversed. Ordered list still inserts in order. <br/></td></tr>
  77. <tr class="separator:a1596f547cb2b038726d2d733930e44be"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:a5788e4bea29895d318226b5b943d5954"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5788e4bea29895d318226b5b943d5954"></a>
  79. _DataType &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a5788e4bea29895d318226b5b943d5954">PopOpposite</a> (const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  80. <tr class="memdesc:a5788e4bea29895d318226b5b943d5954"><td class="mdescLeft">&#160;</td><td class="mdescRight">Same as <a class="el" href="classDataStructures_1_1Multilist.html#a09e7c33fe9587c1902ed1551d720f7b7" title="Gets or removes and gets an element from the list, according to the same rules as Push()...">Pop()</a> and Peek(), except FIFO and LIFO are reversed. <br/></td></tr>
  81. <tr class="separator:a5788e4bea29895d318226b5b943d5954"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:a2192553f7ca8b678719cef4643d0d143"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2192553f7ca8b678719cef4643d0d143"></a>
  83. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a2192553f7ca8b678719cef4643d0d143">InsertAtIndex</a> (const _DataType &amp;d, _IndexType index, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  84. <tr class="memdesc:a2192553f7ca8b678719cef4643d0d143"><td class="mdescLeft">&#160;</td><td class="mdescRight">Stack,<a class="el" href="classDataStructures_1_1Queue.html" title="A queue implemented as an array with a read and write index.">Queue</a>: Inserts at index indicated, elements are shifted. Ordered list: Inserts, position is ignored. <br/></td></tr>
  85. <tr class="separator:a2192553f7ca8b678719cef4643d0d143"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86. <tr class="memitem:a33dd81344fc1e3ddada972637cfe27c3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a33dd81344fc1e3ddada972637cfe27c3">RemoveAtIndex</a> (_IndexType position, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  87. <tr class="memdesc:a33dd81344fc1e3ddada972637cfe27c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unordered list, removes at index indicated, swaps last element with that element. Otherwise, array is shifted left to overwrite removed element. <a href="#a33dd81344fc1e3ddada972637cfe27c3"></a><br/></td></tr>
  88. <tr class="separator:a33dd81344fc1e3ddada972637cfe27c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89. <tr class="memitem:aa3c83303215bacfc4510640efc062d39"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3c83303215bacfc4510640efc062d39"></a>
  90. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#aa3c83303215bacfc4510640efc062d39">RemoveAtKey</a> (_KeyType key, bool assertIfDoesNotExist, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  91. <tr class="memdesc:aa3c83303215bacfc4510640efc062d39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find the index of <em>key</em>, and remove at that index. <br/></td></tr>
  92. <tr class="separator:aa3c83303215bacfc4510640efc062d39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:a84be6225dbac07350dee2ff8a8210e17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84be6225dbac07350dee2ff8a8210e17"></a>
  94. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a84be6225dbac07350dee2ff8a8210e17">GetIndexOf</a> (_KeyType key) const </td></tr>
  95. <tr class="memdesc:a84be6225dbac07350dee2ff8a8210e17"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the index of <em>key</em>. Return -1 if the key is not found. <br/></td></tr>
  96. <tr class="separator:a84be6225dbac07350dee2ff8a8210e17"><td class="memSeparator" colspan="2">&#160;</td></tr>
  97. <tr class="memitem:af0e4d9aacbd1b22979a50dcd91522735"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0e4d9aacbd1b22979a50dcd91522735"></a>
  98. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#af0e4d9aacbd1b22979a50dcd91522735">GetInsertionIndex</a> (_KeyType key) const </td></tr>
  99. <tr class="memdesc:af0e4d9aacbd1b22979a50dcd91522735"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns where in the list we should insert the item, to preserve list order. Returns -1 if the item is already in the list. <br/></td></tr>
  100. <tr class="separator:af0e4d9aacbd1b22979a50dcd91522735"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:af718a952c67cb8e19e9863f087101340"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af718a952c67cb8e19e9863f087101340"></a>
  102. _DataType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#af718a952c67cb8e19e9863f087101340">GetPtr</a> (_KeyType key) const </td></tr>
  103. <tr class="memdesc:af718a952c67cb8e19e9863f087101340"><td class="mdescLeft">&#160;</td><td class="mdescRight">Finds the index of <em>key</em>. Return 0 if the key is not found. Useful if _DataType is always non-zero pointers. <br/></td></tr>
  104. <tr class="separator:af718a952c67cb8e19e9863f087101340"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a4e49b2800f3cfebdc4fa22e3ded43689"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e49b2800f3cfebdc4fa22e3ded43689"></a>
  106. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a4e49b2800f3cfebdc4fa22e3ded43689">ForEach</a> (void(*func)(_DataType &amp;item, const char *file, unsigned int line), const char *file, unsigned int line)</td></tr>
  107. <tr class="memdesc:a4e49b2800f3cfebdc4fa22e3ded43689"><td class="mdescLeft">&#160;</td><td class="mdescRight">Iterate over the list, calling the function pointer on each element. <br/></td></tr>
  108. <tr class="separator:a4e49b2800f3cfebdc4fa22e3ded43689"><td class="memSeparator" colspan="2">&#160;</td></tr>
  109. <tr class="memitem:a8d58006a5444efa6487d21faa8310bfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d58006a5444efa6487d21faa8310bfe"></a>
  110. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a8d58006a5444efa6487d21faa8310bfe">IsEmpty</a> (void) const </td></tr>
  111. <tr class="memdesc:a8d58006a5444efa6487d21faa8310bfe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns if the list is empty. <br/></td></tr>
  112. <tr class="separator:a8d58006a5444efa6487d21faa8310bfe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:a374ed61cd2124ffd01e0bab732f89e61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a374ed61cd2124ffd01e0bab732f89e61"></a>
  114. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a374ed61cd2124ffd01e0bab732f89e61">GetSize</a> (void) const </td></tr>
  115. <tr class="memdesc:a374ed61cd2124ffd01e0bab732f89e61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of elements used in the list. <br/></td></tr>
  116. <tr class="separator:a374ed61cd2124ffd01e0bab732f89e61"><td class="memSeparator" colspan="2">&#160;</td></tr>
  117. <tr class="memitem:a837e5a1793a397c26580de337c4a4207"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a837e5a1793a397c26580de337c4a4207"></a>
  118. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a837e5a1793a397c26580de337c4a4207">Clear</a> (bool deallocateSmallBlocks=true, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  119. <tr class="memdesc:a837e5a1793a397c26580de337c4a4207"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empties the list. The list is not deallocated if it is small, unless <em>deallocateSmallBlocks</em> is true. <br/></td></tr>
  120. <tr class="separator:a837e5a1793a397c26580de337c4a4207"><td class="memSeparator" colspan="2">&#160;</td></tr>
  121. <tr class="memitem:a8ea6e9cc49fa6c858114db3540264d7b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a8ea6e9cc49fa6c858114db3540264d7b">ClearPointers</a> (bool deallocateSmallBlocks=true, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  122. <tr class="memdesc:a8ea6e9cc49fa6c858114db3540264d7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empties the list, first calling RakNet::OP_Delete on all items. <a href="#a8ea6e9cc49fa6c858114db3540264d7b"></a><br/></td></tr>
  123. <tr class="separator:a8ea6e9cc49fa6c858114db3540264d7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  124. <tr class="memitem:a4d96ab0baeb2c566f3f5e0c20be880ed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d96ab0baeb2c566f3f5e0c20be880ed"></a>
  125. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a4d96ab0baeb2c566f3f5e0c20be880ed">ClearPointer</a> (_KeyType key, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  126. <tr class="memdesc:a4d96ab0baeb2c566f3f5e0c20be880ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty one item from the list, first calling RakNet::OP_Delete on that item. <br/></td></tr>
  127. <tr class="separator:a4d96ab0baeb2c566f3f5e0c20be880ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a1b8cc2c4515e66ace8a1efe3d045eaf0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b8cc2c4515e66ace8a1efe3d045eaf0"></a>
  129. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a1b8cc2c4515e66ace8a1efe3d045eaf0">ReverseList</a> (void)</td></tr>
  130. <tr class="memdesc:a1b8cc2c4515e66ace8a1efe3d045eaf0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reverses the elements in the list, and flips the sort order returned by <a class="el" href="classDataStructures_1_1Multilist.html#a800048ec6f280da5e7a161a22a43b87b" title="Returns true if ascending.">GetSortOrder()</a> if <a class="el" href="classDataStructures_1_1Multilist.html#aacbab3fd63f299185141b0c4a62e9ef5" title="Returns true if the list is currently believed to be in a sorted state.">IsSorted()</a> returns true at the time the function is called. <br/></td></tr>
  131. <tr class="separator:a1b8cc2c4515e66ace8a1efe3d045eaf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:a15148dd58d303f1f6d72ecf5d1663aea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15148dd58d303f1f6d72ecf5d1663aea"></a>
  133. void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a15148dd58d303f1f6d72ecf5d1663aea">Reallocate</a> (_IndexType size, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
  134. <tr class="memdesc:a15148dd58d303f1f6d72ecf5d1663aea"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reallocates the list to a larger size. If <em>size</em> is smaller than the value returned by <a class="el" href="classDataStructures_1_1Multilist.html#a374ed61cd2124ffd01e0bab732f89e61" title="Returns the number of elements used in the list.">GetSize()</a>, the call does nothing. <br/></td></tr>
  135. <tr class="separator:a15148dd58d303f1f6d72ecf5d1663aea"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:af7c98eb3dd4a13343695b810c5f6d2c4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#af7c98eb3dd4a13343695b810c5f6d2c4">Sort</a> (bool force)</td></tr>
  137. <tr class="memdesc:af7c98eb3dd4a13343695b810c5f6d2c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sorts the list unless it is an ordered list, in which it does nothing as the list is assumed to already be sorted. <a href="#af7c98eb3dd4a13343695b810c5f6d2c4"></a><br/></td></tr>
  138. <tr class="separator:af7c98eb3dd4a13343695b810c5f6d2c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  139. <tr class="memitem:a3d07bd2615004b6903a6ae8387238fa9"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a3d07bd2615004b6903a6ae8387238fa9">TagSorted</a> (void)</td></tr>
  140. <tr class="memdesc:a3d07bd2615004b6903a6ae8387238fa9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the list to be remembered as sorted. <a href="#a3d07bd2615004b6903a6ae8387238fa9"></a><br/></td></tr>
  141. <tr class="separator:a3d07bd2615004b6903a6ae8387238fa9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  142. <tr class="memitem:a219bfa477ce7722e32462e97c6876634"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a219bfa477ce7722e32462e97c6876634">SetSortOrder</a> (bool ascending)</td></tr>
  143. <tr class="memdesc:a219bfa477ce7722e32462e97c6876634"><td class="mdescLeft">&#160;</td><td class="mdescRight">Defaults to ascending. <a href="#a219bfa477ce7722e32462e97c6876634"></a><br/></td></tr>
  144. <tr class="separator:a219bfa477ce7722e32462e97c6876634"><td class="memSeparator" colspan="2">&#160;</td></tr>
  145. <tr class="memitem:a800048ec6f280da5e7a161a22a43b87b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a800048ec6f280da5e7a161a22a43b87b"></a>
  146. bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a800048ec6f280da5e7a161a22a43b87b">GetSortOrder</a> (void) const </td></tr>
  147. <tr class="memdesc:a800048ec6f280da5e7a161a22a43b87b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if ascending. <br/></td></tr>
  148. <tr class="separator:a800048ec6f280da5e7a161a22a43b87b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  149. <tr class="memitem:aacbab3fd63f299185141b0c4a62e9ef5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#aacbab3fd63f299185141b0c4a62e9ef5">IsSorted</a> (void) const </td></tr>
  150. <tr class="memdesc:aacbab3fd63f299185141b0c4a62e9ef5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the list is currently believed to be in a sorted state. <a href="#aacbab3fd63f299185141b0c4a62e9ef5"></a><br/></td></tr>
  151. <tr class="separator:aacbab3fd63f299185141b0c4a62e9ef5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  152. <tr class="memitem:ab3a1eb26b60fc9742c3d9d842b1807cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3a1eb26b60fc9742c3d9d842b1807cc"></a>
  153. <a class="el" href="DS__Multilist_8h.html#a8387ff66ed3a8c8a6c0528ddb5650a5b">MultilistType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#ab3a1eb26b60fc9742c3d9d842b1807cc">GetMultilistType</a> (void) const </td></tr>
  154. <tr class="memdesc:ab3a1eb26b60fc9742c3d9d842b1807cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns what type of list this is. <br/></td></tr>
  155. <tr class="separator:ab3a1eb26b60fc9742c3d9d842b1807cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a054b07faf5e383569219911f18615a39"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a054b07faf5e383569219911f18615a39">SetMultilistType</a> (<a class="el" href="DS__Multilist_8h.html#a8387ff66ed3a8c8a6c0528ddb5650a5b">MultilistType</a> newType)</td></tr>
  157. <tr class="memdesc:a054b07faf5e383569219911f18615a39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Changes what type of list this is. <a href="#a054b07faf5e383569219911f18615a39"></a><br/></td></tr>
  158. <tr class="separator:a054b07faf5e383569219911f18615a39"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. </table><table class="memberdecls">
  160. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  161. Static Public Member Functions</h2></td></tr>
  162. <tr class="memitem:a5958435ddcd5ac367ab0406fc797c00a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5958435ddcd5ac367ab0406fc797c00a"></a>
  163. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a5958435ddcd5ac367ab0406fc797c00a">FindIntersection</a> (<a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &amp;source1, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &amp;source2, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &amp;intersection, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &amp;uniqueToSource1, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &amp;uniqueToSource2)</td></tr>
  164. <tr class="memdesc:a5958435ddcd5ac367ab0406fc797c00a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the intersection of two lists. Intersection is items common to both lists. <br/></td></tr>
  165. <tr class="separator:a5958435ddcd5ac367ab0406fc797c00a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table><table class="memberdecls">
  167. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
  168. Protected Attributes</h2></td></tr>
  169. <tr class="memitem:acf634946f450bd5884fb3bcae33fd689"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf634946f450bd5884fb3bcae33fd689"></a>
  170. _DataType *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#acf634946f450bd5884fb3bcae33fd689">data</a></td></tr>
  171. <tr class="memdesc:acf634946f450bd5884fb3bcae33fd689"><td class="mdescLeft">&#160;</td><td class="mdescRight">An array of user values. <br/></td></tr>
  172. <tr class="separator:acf634946f450bd5884fb3bcae33fd689"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:ab6561cddc98dd8ab653f56a4203a8ded"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6561cddc98dd8ab653f56a4203a8ded"></a>
  174. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#ab6561cddc98dd8ab653f56a4203a8ded">dataSize</a></td></tr>
  175. <tr class="memdesc:ab6561cddc98dd8ab653f56a4203a8ded"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of elements in the list. <br/></td></tr>
  176. <tr class="separator:ab6561cddc98dd8ab653f56a4203a8ded"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a6040ead73a8eed4667d92e7b66d13db9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6040ead73a8eed4667d92e7b66d13db9"></a>
  178. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a6040ead73a8eed4667d92e7b66d13db9">allocationSize</a></td></tr>
  179. <tr class="memdesc:a6040ead73a8eed4667d92e7b66d13db9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Size of <em>array</em>. <br/></td></tr>
  180. <tr class="separator:a6040ead73a8eed4667d92e7b66d13db9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a9278b3e4d57e3dedd3f613c78ead4461"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9278b3e4d57e3dedd3f613c78ead4461"></a>
  182. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a9278b3e4d57e3dedd3f613c78ead4461">queueHead</a></td></tr>
  183. <tr class="memdesc:a9278b3e4d57e3dedd3f613c78ead4461"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array index for the head of the queue. <br/></td></tr>
  184. <tr class="separator:a9278b3e4d57e3dedd3f613c78ead4461"><td class="memSeparator" colspan="2">&#160;</td></tr>
  185. <tr class="memitem:a300a64c3629be9ece749f944c5d05525"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a300a64c3629be9ece749f944c5d05525"></a>
  186. _IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a300a64c3629be9ece749f944c5d05525">queueTail</a></td></tr>
  187. <tr class="memdesc:a300a64c3629be9ece749f944c5d05525"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array index for the tail of the queue. <br/></td></tr>
  188. <tr class="separator:a300a64c3629be9ece749f944c5d05525"><td class="memSeparator" colspan="2">&#160;</td></tr>
  189. <tr class="memitem:aaa5f425e786988300c1cc1c782173b4c"><td class="memItemLeft" align="right" valign="top">_IndexType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#aaa5f425e786988300c1cc1c782173b4c">preallocationSize</a></td></tr>
  190. <tr class="separator:aaa5f425e786988300c1cc1c782173b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  191. </table>
  192. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  193. <div class="textblock"><h3>template&lt;const MultilistType _MultilistType, class _DataType, class _KeyType = _DataType, class _IndexType = DefaultIndexType&gt;<br/>
  194. class DataStructures::Multilist&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;</h3>
  195. <p>The multilist, representing an abstract data type that generally holds lists. </p>
  196. <dl class="params"><dt>Parameters</dt><dd>
  197. <table class="params">
  198. <tr><td class="paramdir">[in]</td><td class="paramname">_MultilistType</td><td>What type of list this is, </td></tr>
  199. </table>
  200. </dd>
  201. </dl>
  202. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="DS__Multilist_8h.html#a8387ff66ed3a8c8a6c0528ddb5650a5b" title="What algorithm to use to store the data for the Multilist.">MultilistType</a> </dd></dl>
  203. <dl class="params"><dt>Parameters</dt><dd>
  204. <table class="params">
  205. <tr><td class="paramdir">[in]</td><td class="paramname">_DataType</td><td>What type of data this list holds. </td></tr>
  206. <tr><td class="paramdir">[in]</td><td class="paramname">_KeyType</td><td>If a function takes a key to sort on, what type of key this is. The comparison operator between _DataType and _KeyType must be defined </td></tr>
  207. <tr><td class="paramdir">[in]</td><td class="paramname">_IndexType</td><td>What variable type to use for indices </td></tr>
  208. </table>
  209. </dd>
  210. </dl>
  211. </div><h2 class="groupheader">Member Function Documentation</h2>
  212. <a class="anchor" id="a8ea6e9cc49fa6c858114db3540264d7b"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <div class="memtemplate">
  216. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType &gt; </div>
  217. <table class="memname">
  218. <tr>
  219. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::ClearPointers </td>
  220. <td>(</td>
  221. <td class="paramtype">bool&#160;</td>
  222. <td class="paramname"><em>deallocateSmallBlocks</em> = <code>true</code>, </td>
  223. </tr>
  224. <tr>
  225. <td class="paramkey"></td>
  226. <td></td>
  227. <td class="paramtype">const char *&#160;</td>
  228. <td class="paramname"><em>file</em> = <code>__FILE__</code>, </td>
  229. </tr>
  230. <tr>
  231. <td class="paramkey"></td>
  232. <td></td>
  233. <td class="paramtype">unsigned int&#160;</td>
  234. <td class="paramname"><em>line</em> = <code>__LINE__</code>&#160;</td>
  235. </tr>
  236. <tr>
  237. <td></td>
  238. <td>)</td>
  239. <td></td><td></td>
  240. </tr>
  241. </table>
  242. </div><div class="memdoc">
  243. <p>Empties the list, first calling RakNet::OP_Delete on all items. </p>
  244. <p>The list is not deallocated if it is small, unless <em>deallocateSmallBlocks</em> is true </p>
  245. </div>
  246. </div>
  247. <a class="anchor" id="aacbab3fd63f299185141b0c4a62e9ef5"></a>
  248. <div class="memitem">
  249. <div class="memproto">
  250. <div class="memtemplate">
  251. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType &gt; </div>
  252. <table class="memname">
  253. <tr>
  254. <td class="memname">bool <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::IsSorted </td>
  255. <td>(</td>
  256. <td class="paramtype">void&#160;</td>
  257. <td class="paramname"></td><td>)</td>
  258. <td> const</td>
  259. </tr>
  260. </table>
  261. </div><div class="memdoc">
  262. <p>Returns true if the list is currently believed to be in a sorted state. </p>
  263. <p>Doesn't actually check for sortedness, just if <a class="el" href="classDataStructures_1_1Multilist.html#af7c98eb3dd4a13343695b810c5f6d2c4" title="Sorts the list unless it is an ordered list, in which it does nothing as the list is assumed to alrea...">Sort()</a> was recently called, or MultilistType is ML_ORDERED_LIST </p>
  264. </div>
  265. </div>
  266. <a class="anchor" id="afe3f119b9f715a88fc6dd356689f7e72"></a>
  267. <div class="memitem">
  268. <div class="memproto">
  269. <div class="memtemplate">
  270. template&lt;const MultilistType _MultilistType, class _DataType, class _KeyType , class _IndexType &gt; </div>
  271. <table class="memname">
  272. <tr>
  273. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::Push </td>
  274. <td>(</td>
  275. <td class="paramtype">const _DataType &amp;&#160;</td>
  276. <td class="paramname"><em>d</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">const char *&#160;</td>
  282. <td class="paramname"><em>file</em> = <code>__FILE__</code>, </td>
  283. </tr>
  284. <tr>
  285. <td class="paramkey"></td>
  286. <td></td>
  287. <td class="paramtype">unsigned int&#160;</td>
  288. <td class="paramname"><em>line</em> = <code>__LINE__</code>&#160;</td>
  289. </tr>
  290. <tr>
  291. <td></td>
  292. <td>)</td>
  293. <td></td><td></td>
  294. </tr>
  295. </table>
  296. </div><div class="memdoc">
  297. <p>Unordered list, stack is LIFO QUEUE is FIFO Ordered list is inserted in order </p>
  298. </div>
  299. </div>
  300. <a class="anchor" id="a33dd81344fc1e3ddada972637cfe27c3"></a>
  301. <div class="memitem">
  302. <div class="memproto">
  303. <div class="memtemplate">
  304. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType&gt; </div>
  305. <table class="memname">
  306. <tr>
  307. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::RemoveAtIndex </td>
  308. <td>(</td>
  309. <td class="paramtype">_IndexType&#160;</td>
  310. <td class="paramname"><em>position</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> = <code>__FILE__</code>, </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> = <code>__LINE__</code>&#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>Unordered list, removes at index indicated, swaps last element with that element. Otherwise, array is shifted left to overwrite removed element. </p>
  332. <p>Index[0] returns the same as <a class="el" href="classDataStructures_1_1Multilist.html#a09e7c33fe9587c1902ed1551d720f7b7" title="Gets or removes and gets an element from the list, according to the same rules as Push()...">Pop()</a> for a queue. Same as <a class="el" href="classDataStructures_1_1Multilist.html#a5788e4bea29895d318226b5b943d5954" title="Same as Pop() and Peek(), except FIFO and LIFO are reversed.">PopOpposite()</a> for the list and ordered list </p>
  333. </div>
  334. </div>
  335. <a class="anchor" id="a054b07faf5e383569219911f18615a39"></a>
  336. <div class="memitem">
  337. <div class="memproto">
  338. <div class="memtemplate">
  339. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType &gt; </div>
  340. <table class="memname">
  341. <tr>
  342. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::SetMultilistType </td>
  343. <td>(</td>
  344. <td class="paramtype"><a class="el" href="DS__Multilist_8h.html#a8387ff66ed3a8c8a6c0528ddb5650a5b">MultilistType</a>&#160;</td>
  345. <td class="paramname"><em>newType</em></td><td>)</td>
  346. <td></td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <p>Changes what type of list this is. </p>
  351. <dl class="section pre"><dt>Precondition</dt><dd>Template must be defined with ML_VARIABLE_DURING_RUNTIME for this to do anything </dd></dl>
  352. <dl class="params"><dt>Parameters</dt><dd>
  353. <table class="params">
  354. <tr><td class="paramdir">[in]</td><td class="paramname">mlType</td><td>Any value of the enum MultilistType, except ML_VARIABLE_DURING_RUNTIME </td></tr>
  355. </table>
  356. </dd>
  357. </dl>
  358. </div>
  359. </div>
  360. <a class="anchor" id="a219bfa477ce7722e32462e97c6876634"></a>
  361. <div class="memitem">
  362. <div class="memproto">
  363. <div class="memtemplate">
  364. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType &gt; </div>
  365. <table class="memname">
  366. <tr>
  367. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::SetSortOrder </td>
  368. <td>(</td>
  369. <td class="paramtype">bool&#160;</td>
  370. <td class="paramname"><em>ascending</em></td><td>)</td>
  371. <td></td>
  372. </tr>
  373. </table>
  374. </div><div class="memdoc">
  375. <p>Defaults to ascending. </p>
  376. <p>Used by <a class="el" href="classDataStructures_1_1Multilist.html#af7c98eb3dd4a13343695b810c5f6d2c4" title="Sorts the list unless it is an ordered list, in which it does nothing as the list is assumed to alrea...">Sort()</a>, and by ML_ORDERED_LIST </p>
  377. </div>
  378. </div>
  379. <a class="anchor" id="af7c98eb3dd4a13343695b810c5f6d2c4"></a>
  380. <div class="memitem">
  381. <div class="memproto">
  382. <div class="memtemplate">
  383. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType &gt; </div>
  384. <table class="memname">
  385. <tr>
  386. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::Sort </td>
  387. <td>(</td>
  388. <td class="paramtype">bool&#160;</td>
  389. <td class="paramname"><em>force</em></td><td>)</td>
  390. <td></td>
  391. </tr>
  392. </table>
  393. </div><div class="memdoc">
  394. <p>Sorts the list unless it is an ordered list, in which it does nothing as the list is assumed to already be sorted. </p>
  395. <p>However, if <em>force</em> is true, it will also resort the ordered list, useful if the comparison operator between _KeyType and _DataType would now return different results Once the list is sorted, further operations to lookup by key will be log2(n) until the list is modified </p>
  396. </div>
  397. </div>
  398. <a class="anchor" id="a3d07bd2615004b6903a6ae8387238fa9"></a>
  399. <div class="memitem">
  400. <div class="memproto">
  401. <div class="memtemplate">
  402. template&lt;const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType &gt; </div>
  403. <table class="memname">
  404. <tr>
  405. <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::TagSorted </td>
  406. <td>(</td>
  407. <td class="paramtype">void&#160;</td>
  408. <td class="paramname"></td><td>)</td>
  409. <td></td>
  410. </tr>
  411. </table>
  412. </div><div class="memdoc">
  413. <p>Sets the list to be remembered as sorted. </p>
  414. <p>Optimization if the source is sorted already </p>
  415. </div>
  416. </div>
  417. <h2 class="groupheader">Member Data Documentation</h2>
  418. <a class="anchor" id="aaa5f425e786988300c1cc1c782173b4c"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <div class="memtemplate">
  422. template&lt;const MultilistType _MultilistType, class _DataType, class _KeyType = _DataType, class _IndexType = DefaultIndexType&gt; </div>
  423. <table class="mlabels">
  424. <tr>
  425. <td class="mlabels-left">
  426. <table class="memname">
  427. <tr>
  428. <td class="memname">_IndexType <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>&lt; _MultilistType, _DataType, _KeyType, _IndexType &gt;::preallocationSize</td>
  429. </tr>
  430. </table>
  431. </td>
  432. <td class="mlabels-right">
  433. <span class="mlabels"><span class="mlabel">protected</span></span> </td>
  434. </tr>
  435. </table>
  436. </div><div class="memdoc">
  437. <p>How many bytes the user chose to preallocate Won't automatically deallocate below this </p>
  438. </div>
  439. </div>
  440. <hr/>The documentation for this class was generated from the following file:<ul>
  441. <li>D:/temp/RakNet_PC/Source/<a class="el" href="DS__Multilist_8h.html">DS_Multilist.h</a></li>
  442. </ul>
  443. </div><!-- contents -->
  444. <!-- start footer part -->
  445. <hr class="footer"/><address class="footer"><small>
  446. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  447. <img class="footer" src="doxygen.png" alt="doxygen"/>
  448. </a> 1.8.2
  449. </small></address>
  450. </body>
  451. </html>
粤ICP备19079148号