| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <title>RakNet: DataStructures::Multilist< _MultilistType, _DataType, _KeyType, _IndexType > Class Template Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">RakNet
-  <span id="projectnumber">4.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.2 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <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>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="classDataStructures_1_1Multilist-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">DataStructures::Multilist< _MultilistType, _DataType, _KeyType, _IndexType > Class Template Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>The multilist, representing an abstract data type that generally holds lists.
- <a href="classDataStructures_1_1Multilist.html#details">More...</a></p>
- <p><code>#include <DS_Multilist.h></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:afe3f119b9f715a88fc6dd356689f7e72"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#afe3f119b9f715a88fc6dd356689f7e72">Push</a> (const _DataType &d, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
- <tr class="separator:afe3f119b9f715a88fc6dd356689f7e72"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a09e7c33fe9587c1902ed1551d720f7b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09e7c33fe9587c1902ed1551d720f7b7"></a>
- _DataType & </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>
- <tr class="memdesc:a09e7c33fe9587c1902ed1551d720f7b7"><td class="mdescLeft"> </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>
- <tr class="separator:a09e7c33fe9587c1902ed1551d720f7b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1596f547cb2b038726d2d733930e44be"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1596f547cb2b038726d2d733930e44be"></a>
- void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a1596f547cb2b038726d2d733930e44be">PushOpposite</a> (const _DataType &d, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
- <tr class="memdesc:a1596f547cb2b038726d2d733930e44be"><td class="mdescLeft"> </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>
- <tr class="separator:a1596f547cb2b038726d2d733930e44be"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5788e4bea29895d318226b5b943d5954"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5788e4bea29895d318226b5b943d5954"></a>
- _DataType & </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>
- <tr class="memdesc:a5788e4bea29895d318226b5b943d5954"><td class="mdescLeft"> </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>
- <tr class="separator:a5788e4bea29895d318226b5b943d5954"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2192553f7ca8b678719cef4643d0d143"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2192553f7ca8b678719cef4643d0d143"></a>
- void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a2192553f7ca8b678719cef4643d0d143">InsertAtIndex</a> (const _DataType &d, _IndexType index, const char *file=__FILE__, unsigned int line=__LINE__)</td></tr>
- <tr class="memdesc:a2192553f7ca8b678719cef4643d0d143"><td class="mdescLeft"> </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>
- <tr class="separator:a2192553f7ca8b678719cef4643d0d143"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33dd81344fc1e3ddada972637cfe27c3"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:a33dd81344fc1e3ddada972637cfe27c3"><td class="mdescLeft"> </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>
- <tr class="separator:a33dd81344fc1e3ddada972637cfe27c3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa3c83303215bacfc4510640efc062d39"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3c83303215bacfc4510640efc062d39"></a>
- bool </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>
- <tr class="memdesc:aa3c83303215bacfc4510640efc062d39"><td class="mdescLeft"> </td><td class="mdescRight">Find the index of <em>key</em>, and remove at that index. <br/></td></tr>
- <tr class="separator:aa3c83303215bacfc4510640efc062d39"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a84be6225dbac07350dee2ff8a8210e17"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a84be6225dbac07350dee2ff8a8210e17"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a84be6225dbac07350dee2ff8a8210e17">GetIndexOf</a> (_KeyType key) const </td></tr>
- <tr class="memdesc:a84be6225dbac07350dee2ff8a8210e17"><td class="mdescLeft"> </td><td class="mdescRight">Finds the index of <em>key</em>. Return -1 if the key is not found. <br/></td></tr>
- <tr class="separator:a84be6225dbac07350dee2ff8a8210e17"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af0e4d9aacbd1b22979a50dcd91522735"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0e4d9aacbd1b22979a50dcd91522735"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#af0e4d9aacbd1b22979a50dcd91522735">GetInsertionIndex</a> (_KeyType key) const </td></tr>
- <tr class="memdesc:af0e4d9aacbd1b22979a50dcd91522735"><td class="mdescLeft"> </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>
- <tr class="separator:af0e4d9aacbd1b22979a50dcd91522735"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af718a952c67cb8e19e9863f087101340"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af718a952c67cb8e19e9863f087101340"></a>
- _DataType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#af718a952c67cb8e19e9863f087101340">GetPtr</a> (_KeyType key) const </td></tr>
- <tr class="memdesc:af718a952c67cb8e19e9863f087101340"><td class="mdescLeft"> </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>
- <tr class="separator:af718a952c67cb8e19e9863f087101340"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4e49b2800f3cfebdc4fa22e3ded43689"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e49b2800f3cfebdc4fa22e3ded43689"></a>
- void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a4e49b2800f3cfebdc4fa22e3ded43689">ForEach</a> (void(*func)(_DataType &item, const char *file, unsigned int line), const char *file, unsigned int line)</td></tr>
- <tr class="memdesc:a4e49b2800f3cfebdc4fa22e3ded43689"><td class="mdescLeft"> </td><td class="mdescRight">Iterate over the list, calling the function pointer on each element. <br/></td></tr>
- <tr class="separator:a4e49b2800f3cfebdc4fa22e3ded43689"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8d58006a5444efa6487d21faa8310bfe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d58006a5444efa6487d21faa8310bfe"></a>
- bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a8d58006a5444efa6487d21faa8310bfe">IsEmpty</a> (void) const </td></tr>
- <tr class="memdesc:a8d58006a5444efa6487d21faa8310bfe"><td class="mdescLeft"> </td><td class="mdescRight">Returns if the list is empty. <br/></td></tr>
- <tr class="separator:a8d58006a5444efa6487d21faa8310bfe"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a374ed61cd2124ffd01e0bab732f89e61"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a374ed61cd2124ffd01e0bab732f89e61"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a374ed61cd2124ffd01e0bab732f89e61">GetSize</a> (void) const </td></tr>
- <tr class="memdesc:a374ed61cd2124ffd01e0bab732f89e61"><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of elements used in the list. <br/></td></tr>
- <tr class="separator:a374ed61cd2124ffd01e0bab732f89e61"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a837e5a1793a397c26580de337c4a4207"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a837e5a1793a397c26580de337c4a4207"></a>
- void </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>
- <tr class="memdesc:a837e5a1793a397c26580de337c4a4207"><td class="mdescLeft"> </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>
- <tr class="separator:a837e5a1793a397c26580de337c4a4207"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8ea6e9cc49fa6c858114db3540264d7b"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:a8ea6e9cc49fa6c858114db3540264d7b"><td class="mdescLeft"> </td><td class="mdescRight">Empties the list, first calling RakNet::OP_Delete on all items. <a href="#a8ea6e9cc49fa6c858114db3540264d7b"></a><br/></td></tr>
- <tr class="separator:a8ea6e9cc49fa6c858114db3540264d7b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4d96ab0baeb2c566f3f5e0c20be880ed"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d96ab0baeb2c566f3f5e0c20be880ed"></a>
- void </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>
- <tr class="memdesc:a4d96ab0baeb2c566f3f5e0c20be880ed"><td class="mdescLeft"> </td><td class="mdescRight">Empty one item from the list, first calling RakNet::OP_Delete on that item. <br/></td></tr>
- <tr class="separator:a4d96ab0baeb2c566f3f5e0c20be880ed"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1b8cc2c4515e66ace8a1efe3d045eaf0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b8cc2c4515e66ace8a1efe3d045eaf0"></a>
- void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a1b8cc2c4515e66ace8a1efe3d045eaf0">ReverseList</a> (void)</td></tr>
- <tr class="memdesc:a1b8cc2c4515e66ace8a1efe3d045eaf0"><td class="mdescLeft"> </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>
- <tr class="separator:a1b8cc2c4515e66ace8a1efe3d045eaf0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a15148dd58d303f1f6d72ecf5d1663aea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a15148dd58d303f1f6d72ecf5d1663aea"></a>
- void </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>
- <tr class="memdesc:a15148dd58d303f1f6d72ecf5d1663aea"><td class="mdescLeft"> </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>
- <tr class="separator:a15148dd58d303f1f6d72ecf5d1663aea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af7c98eb3dd4a13343695b810c5f6d2c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#af7c98eb3dd4a13343695b810c5f6d2c4">Sort</a> (bool force)</td></tr>
- <tr class="memdesc:af7c98eb3dd4a13343695b810c5f6d2c4"><td class="mdescLeft"> </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>
- <tr class="separator:af7c98eb3dd4a13343695b810c5f6d2c4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3d07bd2615004b6903a6ae8387238fa9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a3d07bd2615004b6903a6ae8387238fa9">TagSorted</a> (void)</td></tr>
- <tr class="memdesc:a3d07bd2615004b6903a6ae8387238fa9"><td class="mdescLeft"> </td><td class="mdescRight">Sets the list to be remembered as sorted. <a href="#a3d07bd2615004b6903a6ae8387238fa9"></a><br/></td></tr>
- <tr class="separator:a3d07bd2615004b6903a6ae8387238fa9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a219bfa477ce7722e32462e97c6876634"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a219bfa477ce7722e32462e97c6876634">SetSortOrder</a> (bool ascending)</td></tr>
- <tr class="memdesc:a219bfa477ce7722e32462e97c6876634"><td class="mdescLeft"> </td><td class="mdescRight">Defaults to ascending. <a href="#a219bfa477ce7722e32462e97c6876634"></a><br/></td></tr>
- <tr class="separator:a219bfa477ce7722e32462e97c6876634"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a800048ec6f280da5e7a161a22a43b87b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a800048ec6f280da5e7a161a22a43b87b"></a>
- bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a800048ec6f280da5e7a161a22a43b87b">GetSortOrder</a> (void) const </td></tr>
- <tr class="memdesc:a800048ec6f280da5e7a161a22a43b87b"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if ascending. <br/></td></tr>
- <tr class="separator:a800048ec6f280da5e7a161a22a43b87b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aacbab3fd63f299185141b0c4a62e9ef5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#aacbab3fd63f299185141b0c4a62e9ef5">IsSorted</a> (void) const </td></tr>
- <tr class="memdesc:aacbab3fd63f299185141b0c4a62e9ef5"><td class="mdescLeft"> </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>
- <tr class="separator:aacbab3fd63f299185141b0c4a62e9ef5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab3a1eb26b60fc9742c3d9d842b1807cc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab3a1eb26b60fc9742c3d9d842b1807cc"></a>
- <a class="el" href="DS__Multilist_8h.html#a8387ff66ed3a8c8a6c0528ddb5650a5b">MultilistType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#ab3a1eb26b60fc9742c3d9d842b1807cc">GetMultilistType</a> (void) const </td></tr>
- <tr class="memdesc:ab3a1eb26b60fc9742c3d9d842b1807cc"><td class="mdescLeft"> </td><td class="mdescRight">Returns what type of list this is. <br/></td></tr>
- <tr class="separator:ab3a1eb26b60fc9742c3d9d842b1807cc"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a054b07faf5e383569219911f18615a39"><td class="memItemLeft" align="right" valign="top">void </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>
- <tr class="memdesc:a054b07faf5e383569219911f18615a39"><td class="mdescLeft"> </td><td class="mdescRight">Changes what type of list this is. <a href="#a054b07faf5e383569219911f18615a39"></a><br/></td></tr>
- <tr class="separator:a054b07faf5e383569219911f18615a39"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a5958435ddcd5ac367ab0406fc797c00a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5958435ddcd5ac367ab0406fc797c00a"></a>
- static void </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> &source1, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &source2, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &intersection, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &uniqueToSource1, <a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a> &uniqueToSource2)</td></tr>
- <tr class="memdesc:a5958435ddcd5ac367ab0406fc797c00a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the intersection of two lists. Intersection is items common to both lists. <br/></td></tr>
- <tr class="separator:a5958435ddcd5ac367ab0406fc797c00a"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:acf634946f450bd5884fb3bcae33fd689"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acf634946f450bd5884fb3bcae33fd689"></a>
- _DataType * </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#acf634946f450bd5884fb3bcae33fd689">data</a></td></tr>
- <tr class="memdesc:acf634946f450bd5884fb3bcae33fd689"><td class="mdescLeft"> </td><td class="mdescRight">An array of user values. <br/></td></tr>
- <tr class="separator:acf634946f450bd5884fb3bcae33fd689"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab6561cddc98dd8ab653f56a4203a8ded"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab6561cddc98dd8ab653f56a4203a8ded"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#ab6561cddc98dd8ab653f56a4203a8ded">dataSize</a></td></tr>
- <tr class="memdesc:ab6561cddc98dd8ab653f56a4203a8ded"><td class="mdescLeft"> </td><td class="mdescRight">Number of elements in the list. <br/></td></tr>
- <tr class="separator:ab6561cddc98dd8ab653f56a4203a8ded"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6040ead73a8eed4667d92e7b66d13db9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6040ead73a8eed4667d92e7b66d13db9"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a6040ead73a8eed4667d92e7b66d13db9">allocationSize</a></td></tr>
- <tr class="memdesc:a6040ead73a8eed4667d92e7b66d13db9"><td class="mdescLeft"> </td><td class="mdescRight">Size of <em>array</em>. <br/></td></tr>
- <tr class="separator:a6040ead73a8eed4667d92e7b66d13db9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9278b3e4d57e3dedd3f613c78ead4461"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9278b3e4d57e3dedd3f613c78ead4461"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a9278b3e4d57e3dedd3f613c78ead4461">queueHead</a></td></tr>
- <tr class="memdesc:a9278b3e4d57e3dedd3f613c78ead4461"><td class="mdescLeft"> </td><td class="mdescRight">Array index for the head of the queue. <br/></td></tr>
- <tr class="separator:a9278b3e4d57e3dedd3f613c78ead4461"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a300a64c3629be9ece749f944c5d05525"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a300a64c3629be9ece749f944c5d05525"></a>
- _IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#a300a64c3629be9ece749f944c5d05525">queueTail</a></td></tr>
- <tr class="memdesc:a300a64c3629be9ece749f944c5d05525"><td class="mdescLeft"> </td><td class="mdescRight">Array index for the tail of the queue. <br/></td></tr>
- <tr class="separator:a300a64c3629be9ece749f944c5d05525"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaa5f425e786988300c1cc1c782173b4c"><td class="memItemLeft" align="right" valign="top">_IndexType </td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html#aaa5f425e786988300c1cc1c782173b4c">preallocationSize</a></td></tr>
- <tr class="separator:aaa5f425e786988300c1cc1c782173b4c"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><h3>template<const MultilistType _MultilistType, class _DataType, class _KeyType = _DataType, class _IndexType = DefaultIndexType><br/>
- class DataStructures::Multilist< _MultilistType, _DataType, _KeyType, _IndexType ></h3>
- <p>The multilist, representing an abstract data type that generally holds lists. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">_MultilistType</td><td>What type of list this is, </td></tr>
- </table>
- </dd>
- </dl>
- <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>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">_DataType</td><td>What type of data this list holds. </td></tr>
- <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>
- <tr><td class="paramdir">[in]</td><td class="paramname">_IndexType</td><td>What variable type to use for indices </td></tr>
- </table>
- </dd>
- </dl>
- </div><h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="a8ea6e9cc49fa6c858114db3540264d7b"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::ClearPointers </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>deallocateSmallBlocks</em> = <code>true</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>file</em> = <code>__FILE__</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>line</em> = <code>__LINE__</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Empties the list, first calling RakNet::OP_Delete on all items. </p>
- <p>The list is not deallocated if it is small, unless <em>deallocateSmallBlocks</em> is true </p>
- </div>
- </div>
- <a class="anchor" id="aacbab3fd63f299185141b0c4a62e9ef5"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">bool <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::IsSorted </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Returns true if the list is currently believed to be in a sorted state. </p>
- <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>
- </div>
- </div>
- <a class="anchor" id="afe3f119b9f715a88fc6dd356689f7e72"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType, class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::Push </td>
- <td>(</td>
- <td class="paramtype">const _DataType & </td>
- <td class="paramname"><em>d</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>file</em> = <code>__FILE__</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>line</em> = <code>__LINE__</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Unordered list, stack is LIFO QUEUE is FIFO Ordered list is inserted in order </p>
- </div>
- </div>
- <a class="anchor" id="a33dd81344fc1e3ddada972637cfe27c3"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType> </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::RemoveAtIndex </td>
- <td>(</td>
- <td class="paramtype">_IndexType </td>
- <td class="paramname"><em>position</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>file</em> = <code>__FILE__</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">unsigned int </td>
- <td class="paramname"><em>line</em> = <code>__LINE__</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Unordered list, removes at index indicated, swaps last element with that element. Otherwise, array is shifted left to overwrite removed element. </p>
- <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>
- </div>
- </div>
- <a class="anchor" id="a054b07faf5e383569219911f18615a39"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::SetMultilistType </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="DS__Multilist_8h.html#a8387ff66ed3a8c8a6c0528ddb5650a5b">MultilistType</a> </td>
- <td class="paramname"><em>newType</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Changes what type of list this is. </p>
- <dl class="section pre"><dt>Precondition</dt><dd>Template must be defined with ML_VARIABLE_DURING_RUNTIME for this to do anything </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <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>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a219bfa477ce7722e32462e97c6876634"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::SetSortOrder </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>ascending</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Defaults to ascending. </p>
- <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>
- </div>
- </div>
- <a class="anchor" id="af7c98eb3dd4a13343695b810c5f6d2c4"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::Sort </td>
- <td>(</td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>force</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <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>
- <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>
- </div>
- </div>
- <a class="anchor" id="a3d07bd2615004b6903a6ae8387238fa9"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType , class _KeyType , class _IndexType > </div>
- <table class="memname">
- <tr>
- <td class="memname">void <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::TagSorted </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sets the list to be remembered as sorted. </p>
- <p>Optimization if the source is sorted already </p>
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a class="anchor" id="aaa5f425e786988300c1cc1c782173b4c"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<const MultilistType _MultilistType, class _DataType, class _KeyType = _DataType, class _IndexType = DefaultIndexType> </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">_IndexType <a class="el" href="classDataStructures_1_1Multilist.html">DataStructures::Multilist</a>< _MultilistType, _DataType, _KeyType, _IndexType >::preallocationSize</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>How many bytes the user chose to preallocate Won't automatically deallocate below this </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following file:<ul>
- <li>D:/temp/RakNet_PC/Source/<a class="el" href="DS__Multilist_8h.html">DS_Multilist.h</a></li>
- </ul>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Mon Jun 2 2014 20:10:28 for RakNet by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.2
- </small></address>
- </body>
- </html>
|