namespaceDataStructures.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206
  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 Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
  35. <li><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="namespaces.html"><span>Namespace&#160;List</span></a></li>
  42. <li><a href="namespacemembers.html"><span>Namespace&#160;Members</span></a></li>
  43. </ul>
  44. </div>
  45. </div><!-- top -->
  46. <div class="header">
  47. <div class="summary">
  48. <a href="#nested-classes">Classes</a> &#124;
  49. <a href="#func-members">Functions</a> </div>
  50. <div class="headertitle">
  51. <div class="title">DataStructures Namespace Reference</div> </div>
  52. </div><!--header-->
  53. <div class="contents">
  54. <table class="memberdecls">
  55. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  56. Classes</h2></td></tr>
  57. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1BinarySearchTree.html">BinarySearchTree</a></td></tr>
  58. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A binary search tree and an AVL balanced binary search tree. <a href="classDataStructures_1_1BinarySearchTree.html#details">More...</a><br/></td></tr>
  59. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  60. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1AVLBalancedBinarySearchTree.html">AVLBalancedBinarySearchTree</a></td></tr>
  61. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">An <a class="el" href="classDataStructures_1_1AVLBalancedBinarySearchTree.html" title="An AVLBalancedBinarySearchTree is a binary tree that is always balanced.">AVLBalancedBinarySearchTree</a> is a binary tree that is always balanced. <a href="classDataStructures_1_1AVLBalancedBinarySearchTree.html#details">More...</a><br/></td></tr>
  62. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  63. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structDataStructures_1_1Page.html">Page</a></td></tr>
  64. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1BPlusTree.html">BPlusTree</a></td></tr>
  66. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Hash.html">Hash</a></td></tr>
  68. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Using a string as a identifier for a node, store an allocated pointer to that node. <a href="classDataStructures_1_1Hash.html#details">More...</a><br/></td></tr>
  69. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1CircularLinkedList.html">CircularLinkedList</a></td></tr>
  71. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">(Circular) Linked <a class="el" href="classDataStructures_1_1List.html" title="Array based implementation of a list.">List</a> ADT (Doubly Linked Pointer to Node Style) - <a href="classDataStructures_1_1CircularLinkedList.html#details">More...</a><br/></td></tr>
  72. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1List.html">List</a></td></tr>
  74. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Array based implementation of a list. <a href="classDataStructures_1_1List.html#details">More...</a><br/></td></tr>
  75. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  76. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Map.html">Map</a></td></tr>
  77. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1MemoryPool.html">MemoryPool</a></td></tr>
  79. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1MLKeyRef.html">MLKeyRef</a></td></tr>
  81. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Multilist.html">Multilist</a></td></tr>
  83. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">The multilist, representing an abstract data type that generally holds lists. <a href="classDataStructures_1_1Multilist.html#details">More...</a><br/></td></tr>
  84. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1OrderedList.html">OrderedList</a></td></tr>
  86. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  87. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Queue.html">Queue</a></td></tr>
  88. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A queue implemented as an array with a read and write index. <a href="classDataStructures_1_1Queue.html#details">More...</a><br/></td></tr>
  89. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1QueueLinkedList.html">QueueLinkedList</a></td></tr>
  91. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A queue implemented using a linked list. Rarely used. <a href="classDataStructures_1_1QueueLinkedList.html#details">More...</a><br/></td></tr>
  92. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  93. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1Table.html">Table</a></td></tr>
  94. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Holds a set of columns, a set of rows, and rows times columns cells. <a href="classDataStructures_1_1Table.html#details">More...</a><br/></td></tr>
  95. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  96. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classDataStructures_1_1SingleProducerConsumer.html">SingleProducerConsumer</a></td></tr>
  97. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A single producer consumer implementation without critical sections. <a href="classDataStructures_1_1SingleProducerConsumer.html#details">More...</a><br/></td></tr>
  98. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  99. </table><table class="memberdecls">
  100. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  101. Functions</h2></td></tr>
  102. <tr class="memitem:a141573e51ef42434451188a050e9a577"><td class="memTemplParams" colspan="2">template&lt;class key_type &gt; </td></tr>
  103. <tr class="memitem:a141573e51ef42434451188a050e9a577"><td class="memTemplItemLeft" align="right" valign="top">int&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceDataStructures.html#a141573e51ef42434451188a050e9a577">defaultMapKeyComparison</a> (const key_type &amp;a, const key_type &amp;b)</td></tr>
  104. <tr class="separator:a141573e51ef42434451188a050e9a577"><td class="memSeparator" colspan="2">&#160;</td></tr>
  105. <tr class="memitem:a4122fd2c409644863e7cb884c2f95bc4"><td class="memTemplParams" colspan="2">template&lt;class templateType &gt; </td></tr>
  106. <tr class="memitem:a4122fd2c409644863e7cb884c2f95bc4"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceDataStructures.html#a4122fd2c409644863e7cb884c2f95bc4">DeletePtr_RakNet</a> (templateType &amp;ptr, const char *file, unsigned int line)</td></tr>
  107. <tr class="separator:a4122fd2c409644863e7cb884c2f95bc4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:ac554257c583d96878931af2bd10bbe2f"><td class="memTemplParams" colspan="2">template&lt;class templateType &gt; </td></tr>
  109. <tr class="memitem:ac554257c583d96878931af2bd10bbe2f"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceDataStructures.html#ac554257c583d96878931af2bd10bbe2f">DeletePtr</a> (templateType &amp;ptr)</td></tr>
  110. <tr class="separator:ac554257c583d96878931af2bd10bbe2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  111. </table>
  112. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  113. <div class="textblock"><p>The namespace <a class="el" href="namespaceDataStructures.html">DataStructures</a> was only added to avoid compiler errors for commonly named data structures As these data structures are stand-alone, you can use them outside of <a class="el" href="namespaceRakNet.html" title="Simple class to send changes between directories. In essence, a simple autopatcher that can be used f...">RakNet</a> for your own projects if you wish. </p>
  114. </div><h2 class="groupheader">Function Documentation</h2>
  115. <a class="anchor" id="a141573e51ef42434451188a050e9a577"></a>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <div class="memtemplate">
  119. template&lt;class key_type &gt; </div>
  120. <table class="memname">
  121. <tr>
  122. <td class="memname">int DataStructures::defaultMapKeyComparison </td>
  123. <td>(</td>
  124. <td class="paramtype">const key_type &amp;&#160;</td>
  125. <td class="paramname"><em>a</em>, </td>
  126. </tr>
  127. <tr>
  128. <td class="paramkey"></td>
  129. <td></td>
  130. <td class="paramtype">const key_type &amp;&#160;</td>
  131. <td class="paramname"><em>b</em>&#160;</td>
  132. </tr>
  133. <tr>
  134. <td></td>
  135. <td>)</td>
  136. <td></td><td></td>
  137. </tr>
  138. </table>
  139. </div><div class="memdoc">
  140. <p>The default comparison has to be first so it can be called as a default parameter. It then is followed by MapNode, followed by NodeComparisonFunc </p>
  141. </div>
  142. </div>
  143. <a class="anchor" id="ac554257c583d96878931af2bd10bbe2f"></a>
  144. <div class="memitem">
  145. <div class="memproto">
  146. <div class="memtemplate">
  147. template&lt;class templateType &gt; </div>
  148. <table class="memname">
  149. <tr>
  150. <td class="memname">void DataStructures::DeletePtr </td>
  151. <td>(</td>
  152. <td class="paramtype">templateType &amp;&#160;</td>
  153. <td class="paramname"><em>ptr</em></td><td>)</td>
  154. <td></td>
  155. </tr>
  156. </table>
  157. </div><div class="memdoc">
  158. <p>Can be used with <a class="el" href="classDataStructures_1_1Multilist.html#a4e49b2800f3cfebdc4fa22e3ded43689" title="Iterate over the list, calling the function pointer on each element.">Multilist::ForEach</a> Assuming the <a class="el" href="classDataStructures_1_1Multilist.html" title="The multilist, representing an abstract data type that generally holds lists.">Multilist</a> holds pointers, will delete those pointers </p>
  159. </div>
  160. </div>
  161. <a class="anchor" id="a4122fd2c409644863e7cb884c2f95bc4"></a>
  162. <div class="memitem">
  163. <div class="memproto">
  164. <div class="memtemplate">
  165. template&lt;class templateType &gt; </div>
  166. <table class="memname">
  167. <tr>
  168. <td class="memname">void DataStructures::DeletePtr_RakNet </td>
  169. <td>(</td>
  170. <td class="paramtype">templateType &amp;&#160;</td>
  171. <td class="paramname"><em>ptr</em>, </td>
  172. </tr>
  173. <tr>
  174. <td class="paramkey"></td>
  175. <td></td>
  176. <td class="paramtype">const char *&#160;</td>
  177. <td class="paramname"><em>file</em>, </td>
  178. </tr>
  179. <tr>
  180. <td class="paramkey"></td>
  181. <td></td>
  182. <td class="paramtype">unsigned int&#160;</td>
  183. <td class="paramname"><em>line</em>&#160;</td>
  184. </tr>
  185. <tr>
  186. <td></td>
  187. <td>)</td>
  188. <td></td><td></td>
  189. </tr>
  190. </table>
  191. </div><div class="memdoc">
  192. <p>Can be used with <a class="el" href="classDataStructures_1_1Multilist.html#a4e49b2800f3cfebdc4fa22e3ded43689" title="Iterate over the list, calling the function pointer on each element.">Multilist::ForEach</a> Assuming the <a class="el" href="classDataStructures_1_1Multilist.html" title="The multilist, representing an abstract data type that generally holds lists.">Multilist</a> holds pointers, will delete those pointers </p>
  193. </div>
  194. </div>
  195. </div><!-- contents -->
  196. <!-- start footer part -->
  197. <hr class="footer"/><address class="footer"><small>
  198. Generated on Mon Jun 2 2014 20:10:28 for RakNet by &#160;<a href="http://www.doxygen.org/index.html">
  199. <img class="footer" src="doxygen.png" alt="doxygen"/>
  200. </a> 1.8.2
  201. </small></address>
  202. </body>
  203. </html>
粤ICP备19079148号