_hash_combine_8h.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.12.0"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>Jolt Physics: Jolt/Core/HashCombine.h File Reference</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="clipboard.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="navtreedata.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript" src="resize.js"></script>
  17. <script type="text/javascript" src="cookie.js"></script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/searchdata.js"></script>
  20. <script type="text/javascript" src="search/search.js"></script>
  21. <script type="text/x-mathjax-config">
  22. MathJax.Hub.Config({
  23. extensions: ["tex2jax.js"],
  24. jax: ["input/TeX","output/HTML-CSS"],
  25. });
  26. </script>
  27. <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
  28. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  29. </head>
  30. <body>
  31. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  32. <div id="titlearea">
  33. <table cellspacing="0" cellpadding="0">
  34. <tbody>
  35. <tr id="projectrow">
  36. <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  37. <td id="projectalign">
  38. <div id="projectname">Jolt Physics
  39. </div>
  40. <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  41. </td>
  42. </tr>
  43. </tbody>
  44. </table>
  45. </div>
  46. <!-- end header part -->
  47. <!-- Generated by Doxygen 1.12.0 -->
  48. <script type="text/javascript">
  49. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  50. var searchBox = new SearchBox("searchBox", "search/",'.html');
  51. /* @license-end */
  52. </script>
  53. <script type="text/javascript">
  54. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  55. $(function() { codefold.init(0); });
  56. /* @license-end */
  57. </script>
  58. <script type="text/javascript" src="menudata.js"></script>
  59. <script type="text/javascript" src="menu.js"></script>
  60. <script type="text/javascript">
  61. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  62. $(function() {
  63. initMenu('',true,false,'search.php','Search',true);
  64. $(function() { init_search(); });
  65. });
  66. /* @license-end */
  67. </script>
  68. <div id="main-nav"></div>
  69. </div><!-- top -->
  70. <div id="side-nav" class="ui-resizable side-nav-resizable">
  71. <div id="nav-tree">
  72. <div id="nav-tree-contents">
  73. <div id="nav-sync" class="sync"></div>
  74. </div>
  75. </div>
  76. <div id="splitbar" style="-moz-user-select:none;"
  77. class="ui-resizable-handle">
  78. </div>
  79. </div>
  80. <script type="text/javascript">
  81. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  82. $(function(){initNavTree('_hash_combine_8h.html',''); initResizable(true); });
  83. /* @license-end */
  84. </script>
  85. <div id="doc-content">
  86. <!-- window showing the filter options -->
  87. <div id="MSearchSelectWindow"
  88. onmouseover="return searchBox.OnSearchSelectShow()"
  89. onmouseout="return searchBox.OnSearchSelectHide()"
  90. onkeydown="return searchBox.OnSearchSelectKey(event)">
  91. </div>
  92. <!-- iframe showing the search results (closed by default) -->
  93. <div id="MSearchResultsWindow">
  94. <div id="MSearchResults">
  95. <div class="SRPage">
  96. <div id="SRIndex">
  97. <div id="SRResults"></div>
  98. <div class="SRStatus" id="Loading">Loading...</div>
  99. <div class="SRStatus" id="Searching">Searching...</div>
  100. <div class="SRStatus" id="NoMatches">No Matches</div>
  101. </div>
  102. </div>
  103. </div>
  104. </div>
  105. <div class="header">
  106. <div class="summary">
  107. <a href="#nested-classes">Classes</a> &#124;
  108. <a href="#define-members">Macros</a> &#124;
  109. <a href="#func-members">Functions</a> </div>
  110. <div class="headertitle"><div class="title">HashCombine.h File Reference</div></div>
  111. </div><!--header-->
  112. <div class="contents">
  113. <p><a href="_hash_combine_8h_source.html">Go to the source code of this file.</a></p>
  114. <table class="memberdecls">
  115. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
  116. Classes</h2></td></tr>
  117. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash.html">Hash&lt; T &gt;</a></td></tr>
  118. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fallback hash function that calls T::GetHash() <a href="struct_hash.html#details">More...</a><br /></td></tr>
  119. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  120. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash_3_01float_01_4.html">Hash&lt; float &gt;</a></td></tr>
  121. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash function for floats. <a href="struct_hash_3_01float_01_4.html#details">More...</a><br /></td></tr>
  122. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  123. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash_3_01double_01_4.html">Hash&lt; double &gt;</a></td></tr>
  124. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash function for doubles. <a href="struct_hash_3_01double_01_4.html#details">More...</a><br /></td></tr>
  125. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  126. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash_3_01const_01char_01_5_01_4.html">Hash&lt; const char * &gt;</a></td></tr>
  127. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash function for character pointers. <a href="struct_hash_3_01const_01char_01_5_01_4.html#details">More...</a><br /></td></tr>
  128. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  129. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash_3_01std_1_1string__view_01_4.html">Hash&lt; std::string_view &gt;</a></td></tr>
  130. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash function for std::string_view. <a href="struct_hash_3_01std_1_1string__view_01_4.html#details">More...</a><br /></td></tr>
  131. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  132. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash_3_01_string_01_4.html">Hash&lt; String &gt;</a></td></tr>
  133. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hash function for String. <a href="struct_hash_3_01_string_01_4.html#details">More...</a><br /></td></tr>
  134. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  135. <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_hash_3_01_t_01_5_01_4.html">Hash&lt; T * &gt;</a></td></tr>
  136. <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A fallback function for generic pointers. <a href="struct_hash_3_01_t_01_5_01_4.html#details">More...</a><br /></td></tr>
  137. <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  138. </table><table class="memberdecls">
  139. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
  140. Macros</h2></td></tr>
  141. <tr class="memitem:ae769863cf16f969cdea429484609d34e" id="r_ae769863cf16f969cdea429484609d34e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae769863cf16f969cdea429484609d34e">JPH_DEFINE_TRIVIAL_HASH</a>(type)</td></tr>
  142. <tr class="memdesc:ae769863cf16f969cdea429484609d34e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Helper macro to define a hash function for trivial types. <br /></td></tr>
  143. <tr class="separator:ae769863cf16f969cdea429484609d34e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:aedd0cd83dae14bf34f99338587ab043d" id="r_aedd0cd83dae14bf34f99338587ab043d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aedd0cd83dae14bf34f99338587ab043d">JPH_MAKE_HASH_STRUCT</a>(type, name, ...)</td></tr>
  145. <tr class="separator:aedd0cd83dae14bf34f99338587ab043d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. <tr class="memitem:a17475665ce4ff763a68a3fd9e82e826b" id="r_a17475665ce4ff763a68a3fd9e82e826b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a17475665ce4ff763a68a3fd9e82e826b">JPH_MAKE_STD_HASH</a>(type)</td></tr>
  147. <tr class="separator:a17475665ce4ff763a68a3fd9e82e826b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. <tr class="memitem:acb214eb23a4f6646330f74bc5f72c938" id="r_acb214eb23a4f6646330f74bc5f72c938"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#acb214eb23a4f6646330f74bc5f72c938">JPH_MAKE_HASHABLE</a>(type, ...)</td></tr>
  149. <tr class="separator:acb214eb23a4f6646330f74bc5f72c938"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. </table><table class="memberdecls">
  151. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  152. Functions</h2></td></tr>
  153. <tr class="memitem:a396c677c4eb61f19e11cc202aac23c38" id="r_a396c677c4eb61f19e11cc202aac23c38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a396c677c4eb61f19e11cc202aac23c38">HashBytes</a> (const void *inData, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inSize, <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inSeed=0xcbf29ce484222325UL)</td></tr>
  154. <tr class="separator:a396c677c4eb61f19e11cc202aac23c38"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:a117e2894f38fb560424040083a44de95" id="r_a117e2894f38fb560424040083a44de95"><td class="memItemLeft" align="right" valign="top">constexpr <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a117e2894f38fb560424040083a44de95">HashString</a> (const char *inString, <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inSeed=0xcbf29ce484222325UL)</td></tr>
  156. <tr class="separator:a117e2894f38fb560424040083a44de95"><td class="memSeparator" colspan="2">&#160;</td></tr>
  157. <tr class="memitem:a8ce241fe287672b4a559499d341d2ee7" id="r_a8ce241fe287672b4a559499d341d2ee7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ce241fe287672b4a559499d341d2ee7">Hash64</a> (<a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> inValue)</td></tr>
  158. <tr class="separator:a8ce241fe287672b4a559499d341d2ee7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:aca48702d50d6db86a2bfba77688707d3" id="r_aca48702d50d6db86a2bfba77688707d3"><td class="memTemplParams" colspan="2">template&lt;typename T &gt; </td></tr>
  160. <tr class="memitem:aca48702d50d6db86a2bfba77688707d3"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#aca48702d50d6db86a2bfba77688707d3">HashCombine</a> (<a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> &amp;ioSeed, const T &amp;inValue)</td></tr>
  161. <tr class="memdesc:aca48702d50d6db86a2bfba77688707d3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Commonly used types. <br /></td></tr>
  162. <tr class="separator:aca48702d50d6db86a2bfba77688707d3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  163. <tr class="memitem:a54628f60d56870ba54746a7829d4e403" id="r_a54628f60d56870ba54746a7829d4e403"><td class="memTemplParams" colspan="2">template&lt;typename FirstValue , typename... Values&gt; </td></tr>
  164. <tr class="memitem:a54628f60d56870ba54746a7829d4e403"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a>&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a54628f60d56870ba54746a7829d4e403">HashCombineArgs</a> (const FirstValue &amp;inFirstValue, Values... inValues)</td></tr>
  165. <tr class="separator:a54628f60d56870ba54746a7829d4e403"><td class="memSeparator" colspan="2">&#160;</td></tr>
  166. </table>
  167. <h2 class="groupheader">Macro Definition Documentation</h2>
  168. <a id="ae769863cf16f969cdea429484609d34e" name="ae769863cf16f969cdea429484609d34e"></a>
  169. <h2 class="memtitle"><span class="permalink"><a href="#ae769863cf16f969cdea429484609d34e">&#9670;&#160;</a></span>JPH_DEFINE_TRIVIAL_HASH</h2>
  170. <div class="memitem">
  171. <div class="memproto">
  172. <table class="memname">
  173. <tr>
  174. <td class="memname">#define JPH_DEFINE_TRIVIAL_HASH</td>
  175. <td>(</td>
  176. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
  177. <td></td>
  178. </tr>
  179. </table>
  180. </div><div class="memdoc">
  181. <b>Value:</b><div class="fragment"><div class="line"><span class="keyword">template</span> &lt;&gt; \</div>
  182. <div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="struct_hash.html">Hash</a>&lt;type&gt; \</div>
  183. <div class="line">{ \</div>
  184. <div class="line"> <a class="code hl_typedef" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> <a class="code hl_function" href="struct_hash.html#a006c911ef82c10473d3773398654cbe1">operator () </a>(<span class="keyword">const</span> type &amp;inValue) <span class="keyword">const</span> \</div>
  185. <div class="line"> { \</div>
  186. <div class="line"> <span class="keywordflow">return</span> <a class="code hl_function" href="#a396c677c4eb61f19e11cc202aac23c38">HashBytes</a>(&amp;inValue, <span class="keyword">sizeof</span>(inValue)); \</div>
  187. <div class="line"> } \</div>
  188. <div class="line">};</div>
  189. <div class="ttc" id="a_core_8h_html_a60e8696a4678cd348e991a1f172e53f7"><div class="ttname"><a href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></div><div class="ttdeci">std::uint64_t uint64</div><div class="ttdef"><b>Definition</b> Core.h:504</div></div>
  190. <div class="ttc" id="a_hash_combine_8h_html_a396c677c4eb61f19e11cc202aac23c38"><div class="ttname"><a href="#a396c677c4eb61f19e11cc202aac23c38">HashBytes</a></div><div class="ttdeci">JPH_NAMESPACE_BEGIN uint64 HashBytes(const void *inData, uint inSize, uint64 inSeed=0xcbf29ce484222325UL)</div><div class="ttdef"><b>Definition</b> HashCombine.h:15</div></div>
  191. <div class="ttc" id="astruct_hash_html"><div class="ttname"><a href="struct_hash.html">Hash</a></div><div class="ttdoc">Fallback hash function that calls T::GetHash()</div><div class="ttdef"><b>Definition</b> HashCombine.h:59</div></div>
  192. <div class="ttc" id="astruct_hash_html_a006c911ef82c10473d3773398654cbe1"><div class="ttname"><a href="struct_hash.html#a006c911ef82c10473d3773398654cbe1">Hash::operator()</a></div><div class="ttdeci">uint64 operator()(const T &amp;inValue) const</div><div class="ttdef"><b>Definition</b> HashCombine.h:60</div></div>
  193. </div><!-- fragment -->
  194. <p>Helper macro to define a hash function for trivial types. </p>
  195. </div>
  196. </div>
  197. <a id="aedd0cd83dae14bf34f99338587ab043d" name="aedd0cd83dae14bf34f99338587ab043d"></a>
  198. <h2 class="memtitle"><span class="permalink"><a href="#aedd0cd83dae14bf34f99338587ab043d">&#9670;&#160;</a></span>JPH_MAKE_HASH_STRUCT</h2>
  199. <div class="memitem">
  200. <div class="memproto">
  201. <table class="memname">
  202. <tr>
  203. <td class="memname">#define JPH_MAKE_HASH_STRUCT</td>
  204. <td>(</td>
  205. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
  206. </tr>
  207. <tr>
  208. <td class="paramkey"></td>
  209. <td></td>
  210. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>name</em></span>, </td>
  211. </tr>
  212. <tr>
  213. <td class="paramkey"></td>
  214. <td></td>
  215. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...&#160;)</td>
  216. </tr>
  217. </table>
  218. </div><div class="memdoc">
  219. <b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">struct </span>[[nodiscard]] name \</div>
  220. <div class="line"> { \</div>
  221. <div class="line"> ::JPH::uint64 operator()(<span class="keyword">const</span> type &amp;t) <span class="keyword">const</span> \</div>
  222. <div class="line"> { \</div>
  223. <div class="line"> return ::JPH::HashCombineArgs(__VA_ARGS__); \</div>
  224. <div class="line"> } \</div>
  225. <div class="line"> };</div>
  226. </div><!-- fragment -->
  227. </div>
  228. </div>
  229. <a id="acb214eb23a4f6646330f74bc5f72c938" name="acb214eb23a4f6646330f74bc5f72c938"></a>
  230. <h2 class="memtitle"><span class="permalink"><a href="#acb214eb23a4f6646330f74bc5f72c938">&#9670;&#160;</a></span>JPH_MAKE_HASHABLE</h2>
  231. <div class="memitem">
  232. <div class="memproto">
  233. <table class="memname">
  234. <tr>
  235. <td class="memname">#define JPH_MAKE_HASHABLE</td>
  236. <td>(</td>
  237. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
  238. </tr>
  239. <tr>
  240. <td class="paramkey"></td>
  241. <td></td>
  242. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em></em></span>...&#160;)</td>
  243. </tr>
  244. </table>
  245. </div><div class="memdoc">
  246. <b>Value:</b><div class="fragment"><div class="line"> JPH_SUPPRESS_WARNING_PUSH \</div>
  247. <div class="line"> JPH_SUPPRESS_WARNINGS \</div>
  248. <div class="line"> namespace JPH \</div>
  249. <div class="line"> { \</div>
  250. <div class="line"> template&lt;&gt; \</div>
  251. <div class="line"> JPH_MAKE_HASH_STRUCT(type, <a class="code hl_struct" href="struct_hash.html">Hash&lt;type&gt;</a>, __VA_ARGS__) \</div>
  252. <div class="line"> } \</div>
  253. <div class="line"> JPH_SUPPRESS_WARNING_POP \</div>
  254. <div class="line"> JPH_MAKE_STD_HASH(type)</div>
  255. </div><!-- fragment -->
  256. </div>
  257. </div>
  258. <a id="a17475665ce4ff763a68a3fd9e82e826b" name="a17475665ce4ff763a68a3fd9e82e826b"></a>
  259. <h2 class="memtitle"><span class="permalink"><a href="#a17475665ce4ff763a68a3fd9e82e826b">&#9670;&#160;</a></span>JPH_MAKE_STD_HASH</h2>
  260. <div class="memitem">
  261. <div class="memproto">
  262. <table class="memname">
  263. <tr>
  264. <td class="memname">#define JPH_MAKE_STD_HASH</td>
  265. <td>(</td>
  266. <td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>type</em></span></td><td>)</td>
  267. <td></td>
  268. </tr>
  269. </table>
  270. </div><div class="memdoc">
  271. <b>Value:</b><div class="fragment"><div class="line"> JPH_SUPPRESS_WARNING_PUSH \</div>
  272. <div class="line"> JPH_SUPPRESS_WARNINGS \</div>
  273. <div class="line"> namespace <a class="code hl_namespace" href="namespacestd.html">std</a> \</div>
  274. <div class="line"> { \</div>
  275. <div class="line"> <span class="keyword">template</span>&lt;&gt; \</div>
  276. <div class="line"> <span class="keyword">struct </span>[[nodiscard]] hash&lt;type&gt; \</div>
  277. <div class="line"> { \</div>
  278. <div class="line"> <span class="keywordtype">size_t</span> operator()(<span class="keyword">const</span> type &amp;t) <span class="keyword">const</span> \</div>
  279. <div class="line"> { \</div>
  280. <div class="line"> <span class="keywordflow">return</span> size_t(::JPH::Hash&lt;type&gt;{ }(t)); \</div>
  281. <div class="line"> } \</div>
  282. <div class="line"> }; \</div>
  283. <div class="line"> } \</div>
  284. <div class="line"> JPH_SUPPRESS_WARNING_POP</div>
  285. <div class="ttc" id="anamespacestd_html"><div class="ttname"><a href="namespacestd.html">std</a></div><div class="ttdef"><b>Definition</b> Array.h:699</div></div>
  286. </div><!-- fragment -->
  287. </div>
  288. </div>
  289. <h2 class="groupheader">Function Documentation</h2>
  290. <a id="a8ce241fe287672b4a559499d341d2ee7" name="a8ce241fe287672b4a559499d341d2ee7"></a>
  291. <h2 class="memtitle"><span class="permalink"><a href="#a8ce241fe287672b4a559499d341d2ee7">&#9670;&#160;</a></span>Hash64()</h2>
  292. <div class="memitem">
  293. <div class="memproto">
  294. <table class="mlabels">
  295. <tr>
  296. <td class="mlabels-left">
  297. <table class="memname">
  298. <tr>
  299. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> Hash64 </td>
  300. <td>(</td>
  301. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inValue</em></span></td><td>)</td>
  302. <td></td>
  303. </tr>
  304. </table>
  305. </td>
  306. <td class="mlabels-right">
  307. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  308. </tr>
  309. </table>
  310. </div><div class="memdoc">
  311. <p>A 64 bit hash function by Thomas Wang, Jan 1997 See: <a href="http://web.archive.org/web/20071223173210/http://www.concentric.net/~Ttwang/tech/inthash.htm">http://web.archive.org/web/20071223173210/http://www.concentric.net/~Ttwang/tech/inthash.htm</a> </p><dl class="params"><dt>Parameters</dt><dd>
  312. <table class="params">
  313. <tr><td class="paramname">inValue</td><td>Value to hash </td></tr>
  314. </table>
  315. </dd>
  316. </dl>
  317. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_hash.html" title="Fallback hash function that calls T::GetHash()">Hash</a> </dd></dl>
  318. </div>
  319. </div>
  320. <a id="a396c677c4eb61f19e11cc202aac23c38" name="a396c677c4eb61f19e11cc202aac23c38"></a>
  321. <h2 class="memtitle"><span class="permalink"><a href="#a396c677c4eb61f19e11cc202aac23c38">&#9670;&#160;</a></span>HashBytes()</h2>
  322. <div class="memitem">
  323. <div class="memproto">
  324. <table class="mlabels">
  325. <tr>
  326. <td class="mlabels-left">
  327. <table class="memname">
  328. <tr>
  329. <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> HashBytes </td>
  330. <td>(</td>
  331. <td class="paramtype">const void *</td> <td class="paramname"><span class="paramname"><em>inData</em></span>, </td>
  332. </tr>
  333. <tr>
  334. <td class="paramkey"></td>
  335. <td></td>
  336. <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inSize</em></span>, </td>
  337. </tr>
  338. <tr>
  339. <td class="paramkey"></td>
  340. <td></td>
  341. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inSeed</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0xcbf29ce484222325UL</span>&#160;)</td>
  342. </tr>
  343. </table>
  344. </td>
  345. <td class="mlabels-right">
  346. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  347. </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. <p>Implements the FNV-1a hash algorithm </p><dl class="section see"><dt>See also</dt><dd><a href="https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function">https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function</a> </dd></dl>
  351. <dl class="params"><dt>Parameters</dt><dd>
  352. <table class="params">
  353. <tr><td class="paramname">inData</td><td>Data block of bytes </td></tr>
  354. <tr><td class="paramname">inSize</td><td>Number of bytes </td></tr>
  355. <tr><td class="paramname">inSeed</td><td>Seed of the hash (can be used to pass in the hash of a previous operation, otherwise leave default) </td></tr>
  356. </table>
  357. </dd>
  358. </dl>
  359. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="struct_hash.html" title="Fallback hash function that calls T::GetHash()">Hash</a> </dd></dl>
  360. </div>
  361. </div>
  362. <a id="aca48702d50d6db86a2bfba77688707d3" name="aca48702d50d6db86a2bfba77688707d3"></a>
  363. <h2 class="memtitle"><span class="permalink"><a href="#aca48702d50d6db86a2bfba77688707d3">&#9670;&#160;</a></span>HashCombine()</h2>
  364. <div class="memitem">
  365. <div class="memproto">
  366. <div class="memtemplate">
  367. template&lt;typename T &gt; </div>
  368. <table class="mlabels">
  369. <tr>
  370. <td class="mlabels-left">
  371. <table class="memname">
  372. <tr>
  373. <td class="memname">void HashCombine </td>
  374. <td>(</td>
  375. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> &amp;</td> <td class="paramname"><span class="paramname"><em>ioSeed</em></span>, </td>
  376. </tr>
  377. <tr>
  378. <td class="paramkey"></td>
  379. <td></td>
  380. <td class="paramtype">const T &amp;</td> <td class="paramname"><span class="paramname"><em>inValue</em></span>&#160;)</td>
  381. </tr>
  382. </table>
  383. </td>
  384. <td class="mlabels-right">
  385. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  386. </tr>
  387. </table>
  388. </div><div class="memdoc">
  389. <p>Commonly used types. </p>
  390. <p>Helper function that hashes a single value into ioSeed Based on <a href="https://github.com/jonmaiga/mx3">https://github.com/jonmaiga/mx3</a> by Jon Maiga </p>
  391. </div>
  392. </div>
  393. <a id="a54628f60d56870ba54746a7829d4e403" name="a54628f60d56870ba54746a7829d4e403"></a>
  394. <h2 class="memtitle"><span class="permalink"><a href="#a54628f60d56870ba54746a7829d4e403">&#9670;&#160;</a></span>HashCombineArgs()</h2>
  395. <div class="memitem">
  396. <div class="memproto">
  397. <div class="memtemplate">
  398. template&lt;typename FirstValue , typename... Values&gt; </div>
  399. <table class="mlabels">
  400. <tr>
  401. <td class="mlabels-left">
  402. <table class="memname">
  403. <tr>
  404. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> HashCombineArgs </td>
  405. <td>(</td>
  406. <td class="paramtype">const FirstValue &amp;</td> <td class="paramname"><span class="paramname"><em>inFirstValue</em></span>, </td>
  407. </tr>
  408. <tr>
  409. <td class="paramkey"></td>
  410. <td></td>
  411. <td class="paramtype">Values...</td> <td class="paramname"><span class="paramname"><em>inValues</em></span>&#160;)</td>
  412. </tr>
  413. </table>
  414. </td>
  415. <td class="mlabels-right">
  416. <span class="mlabels"><span class="mlabel">inline</span></span> </td>
  417. </tr>
  418. </table>
  419. </div><div class="memdoc">
  420. <p><a class="el" href="struct_hash.html" title="Fallback hash function that calls T::GetHash()">Hash</a> combiner to use a custom struct in an unordered map or set</p>
  421. <p>Usage: </p><pre class="fragment">struct SomeHashKey
  422. {
  423. std::string key1;
  424. std::string key2;
  425. bool key3;
  426. };
  427. JPH_MAKE_HASHABLE(SomeHashKey, t.key1, t.key2, t.key3)
  428. </pre>
  429. </div>
  430. </div>
  431. <a id="a117e2894f38fb560424040083a44de95" name="a117e2894f38fb560424040083a44de95"></a>
  432. <h2 class="memtitle"><span class="permalink"><a href="#a117e2894f38fb560424040083a44de95">&#9670;&#160;</a></span>HashString()</h2>
  433. <div class="memitem">
  434. <div class="memproto">
  435. <table class="mlabels">
  436. <tr>
  437. <td class="mlabels-left">
  438. <table class="memname">
  439. <tr>
  440. <td class="memname"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a> HashString </td>
  441. <td>(</td>
  442. <td class="paramtype">const char *</td> <td class="paramname"><span class="paramname"><em>inString</em></span>, </td>
  443. </tr>
  444. <tr>
  445. <td class="paramkey"></td>
  446. <td></td>
  447. <td class="paramtype"><a class="el" href="_core_8h.html#a60e8696a4678cd348e991a1f172e53f7">uint64</a></td> <td class="paramname"><span class="paramname"><em>inSeed</em></span><span class="paramdefsep"> = </span><span class="paramdefval">0xcbf29ce484222325UL</span>&#160;)</td>
  448. </tr>
  449. </table>
  450. </td>
  451. <td class="mlabels-right">
  452. <span class="mlabels"><span class="mlabel">constexpr</span></span> </td>
  453. </tr>
  454. </table>
  455. </div><div class="memdoc">
  456. <p>Calculate the FNV-1a hash of inString. </p><dl class="section see"><dt>See also</dt><dd><a href="https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function">https://en.wikipedia.org/wiki/Fowler%E2%80%93Noll%E2%80%93Vo_hash_function</a> </dd></dl>
  457. </div>
  458. </div>
  459. </div><!-- contents -->
  460. </div><!-- doc-content -->
  461. <!-- start footer part -->
  462. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  463. <ul>
  464. <li class="navelem"><a class="el" href="dir_d99289a5d3c46cf26f14ff6c90658d9f.html">Jolt</a></li><li class="navelem"><a class="el" href="dir_1b21a6f5692b6d84bf3b848a79181d46.html">Core</a></li><li class="navelem"><a class="el" href="_hash_combine_8h.html">HashCombine.h</a></li>
  465. <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  466. </ul>
  467. </div>
  468. </body>
  469. </html>