| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=11"/>
- <meta name="generator" content="Doxygen 1.12.0"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>Jolt Physics: LFHMAllocator Class 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>
- <script type="text/javascript" src="clipboard.js"></script>
- <link href="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="navtreedata.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="cookie.js"></script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- extensions: ["tex2jax.js"],
- jax: ["input/TeX","output/HTML-CSS"],
- });
- </script>
- <script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.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 id="projectrow">
- <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
- <td id="projectalign">
- <div id="projectname">Jolt Physics
- </div>
- <div id="projectbrief">A multi core friendly Game Physics Engine</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.12.0 -->
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- var searchBox = new SearchBox("searchBox", "search/",'.html');
- /* @license-end */
- </script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() { codefold.init(0); });
- /* @license-end */
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function() {
- initMenu('',true,false,'search.php','Search',true);
- $(function() { init_search(); });
- });
- /* @license-end */
- </script>
- <div id="main-nav"></div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
- $(function(){initNavTree('class_l_f_h_m_allocator.html',''); initResizable(true); });
- /* @license-end */
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <div id="MSearchResults">
- <div class="SRPage">
- <div id="SRIndex">
- <div id="SRResults"></div>
- <div class="SRStatus" id="Loading">Loading...</div>
- <div class="SRStatus" id="Searching">Searching...</div>
- <div class="SRStatus" id="NoMatches">No Matches</div>
- </div>
- </div>
- </div>
- </div>
- <div class="header">
- <div class="summary">
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="class_l_f_h_m_allocator-members.html">List of all members</a> </div>
- <div class="headertitle"><div class="title">LFHMAllocator Class Reference</div></div>
- </div><!--header-->
- <div class="contents">
- <p>Allocator for a lock free hash map.
- <a href="#details">More...</a></p>
- <p><code>#include <<a class="el" href="_lock_free_hash_map_8h_source.html">LockFreeHashMap.h</a>></code></p>
- <div class="dynheader">
- Inheritance diagram for LFHMAllocator:</div>
- <div class="dyncontent">
- <div class="center">
- <img src="class_l_f_h_m_allocator.png" usemap="#LFHMAllocator_map" alt=""/>
- <map id="LFHMAllocator_map" name="LFHMAllocator_map">
- <area href="class_non_copyable.html" title="Class that makes another class non-copyable. Usage: Inherit from NonCopyable." alt="NonCopyable" shape="rect" coords="0,0,98,24"/>
- </map>
- </div></div>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:a97034c25b38fd7a1c3e3cf59b818afbb" id="r_a97034c25b38fd7a1c3e3cf59b818afbb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#a97034c25b38fd7a1c3e3cf59b818afbb">~LFHMAllocator</a> ()</td></tr>
- <tr class="memdesc:a97034c25b38fd7a1c3e3cf59b818afbb"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
- <tr class="separator:a97034c25b38fd7a1c3e3cf59b818afbb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9eda23a0f8dd6fac54adab81b97e7c60" id="r_a9eda23a0f8dd6fac54adab81b97e7c60"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#a9eda23a0f8dd6fac54adab81b97e7c60">Init</a> (<a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inObjectStoreSizeBytes)</td></tr>
- <tr class="separator:a9eda23a0f8dd6fac54adab81b97e7c60"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add8458530312383491f936a7147a8ce3" id="r_add8458530312383491f936a7147a8ce3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#add8458530312383491f936a7147a8ce3">Clear</a> ()</td></tr>
- <tr class="memdesc:add8458530312383491f936a7147a8ce3"><td class="mdescLeft"> </td><td class="mdescRight">Clear all allocations. <br /></td></tr>
- <tr class="separator:add8458530312383491f936a7147a8ce3"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aca5503a8c5d7c9ac25b4f1baa89c5317" id="r_aca5503a8c5d7c9ac25b4f1baa89c5317"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="#aca5503a8c5d7c9ac25b4f1baa89c5317">Allocate</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inBlockSize, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &ioBegin, <a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &ioEnd)</td></tr>
- <tr class="separator:aca5503a8c5d7c9ac25b4f1baa89c5317"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5b71c811049f9598a499cc58a1f2e8c0" id="r_a5b71c811049f9598a499cc58a1f2e8c0"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
- <tr class="memitem:a5b71c811049f9598a499cc58a1f2e8c0"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#a5b71c811049f9598a499cc58a1f2e8c0">ToOffset</a> (const T *inData) const</td></tr>
- <tr class="memdesc:a5b71c811049f9598a499cc58a1f2e8c0"><td class="mdescLeft"> </td><td class="mdescRight">Convert a pointer to an offset. <br /></td></tr>
- <tr class="separator:a5b71c811049f9598a499cc58a1f2e8c0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abcf9394d71567a53088ce79cf96ed0e1" id="r_abcf9394d71567a53088ce79cf96ed0e1"><td class="memTemplParams" colspan="2">template<class T > </td></tr>
- <tr class="memitem:abcf9394d71567a53088ce79cf96ed0e1"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="#abcf9394d71567a53088ce79cf96ed0e1">FromOffset</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inOffset) const</td></tr>
- <tr class="memdesc:abcf9394d71567a53088ce79cf96ed0e1"><td class="mdescLeft"> </td><td class="mdescRight">Convert an offset to a pointer. <br /></td></tr>
- <tr class="separator:abcf9394d71567a53088ce79cf96ed0e1"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="inherit_header pub_methods_class_non_copyable"><td colspan="2" onclick="javascript:dynsection.toggleInherit('pub_methods_class_non_copyable')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_non_copyable.html">NonCopyable</a></td></tr>
- <tr class="memitem:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable" id="r_a809b6e4ade7ae32f6d248f2a3b783d45"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a809b6e4ade7ae32f6d248f2a3b783d45">NonCopyable</a> ()=default</td></tr>
- <tr class="separator:a809b6e4ade7ae32f6d248f2a3b783d45 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable" id="r_a501d34ffcc34b30de6d541887a901057"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#a501d34ffcc34b30de6d541887a901057">NonCopyable</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &)=delete</td></tr>
- <tr class="separator:a501d34ffcc34b30de6d541887a901057 inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable" id="r_aaf9b12dcaae80c9d304df7a941d4e21f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_non_copyable.html#aaf9b12dcaae80c9d304df7a941d4e21f">operator=</a> (const <a class="el" href="class_non_copyable.html">NonCopyable</a> &)=delete</td></tr>
- <tr class="separator:aaf9b12dcaae80c9d304df7a941d4e21f inherit pub_methods_class_non_copyable"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Allocator for a lock free hash map. </p>
- </div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a id="a97034c25b38fd7a1c3e3cf59b818afbb" name="a97034c25b38fd7a1c3e3cf59b818afbb"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a97034c25b38fd7a1c3e3cf59b818afbb">◆ </a></span>~LFHMAllocator()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> LFHMAllocator::~LFHMAllocator </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Destructor. </p>
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a id="aca5503a8c5d7c9ac25b4f1baa89c5317" name="aca5503a8c5d7c9ac25b4f1baa89c5317"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#aca5503a8c5d7c9ac25b4f1baa89c5317">◆ </a></span>Allocate()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void LFHMAllocator::Allocate </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inBlockSize</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &</td> <td class="paramname"><span class="paramname"><em>ioBegin</em></span>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> &</td> <td class="paramname"><span class="paramname"><em>ioEnd</em></span> )</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Allocate a new block of data </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inBlockSize</td><td>Size of block to allocate (will potentially return a smaller block if memory is full). </td></tr>
- <tr><td class="paramname">ioBegin</td><td>Should be the start of the first free byte in current memory block on input, will contain the start of the first free byte in allocated block on return. </td></tr>
- <tr><td class="paramname">ioEnd</td><td>Should be the byte beyond the current memory block on input, will contain the byte beyond the allocated block on return. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="add8458530312383491f936a7147a8ce3" name="add8458530312383491f936a7147a8ce3"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#add8458530312383491f936a7147a8ce3">◆ </a></span>Clear()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void LFHMAllocator::Clear </td>
- <td>(</td>
- <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Clear all allocations. </p>
- </div>
- </div>
- <a id="abcf9394d71567a53088ce79cf96ed0e1" name="abcf9394d71567a53088ce79cf96ed0e1"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#abcf9394d71567a53088ce79cf96ed0e1">◆ </a></span>FromOffset()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T * LFHMAllocator::FromOffset </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td> <td class="paramname"><span class="paramname"><em>inOffset</em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Convert an offset to a pointer. </p>
- </div>
- </div>
- <a id="a9eda23a0f8dd6fac54adab81b97e7c60" name="a9eda23a0f8dd6fac54adab81b97e7c60"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a9eda23a0f8dd6fac54adab81b97e7c60">◆ </a></span>Init()</h2>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void LFHMAllocator::Init </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td> <td class="paramname"><span class="paramname"><em>inObjectStoreSizeBytes</em></span></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Initialize the allocator </p><dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">inObjectStoreSizeBytes</td><td>Number of bytes to reserve for all key value pairs </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a id="a5b71c811049f9598a499cc58a1f2e8c0" name="a5b71c811049f9598a499cc58a1f2e8c0"></a>
- <h2 class="memtitle"><span class="permalink"><a href="#a5b71c811049f9598a499cc58a1f2e8c0">◆ </a></span>ToOffset()</h2>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<class T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> LFHMAllocator::ToOffset </td>
- <td>(</td>
- <td class="paramtype">const T *</td> <td class="paramname"><span class="paramname"><em>inData</em></span></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Convert a pointer to an offset. </p>
- </div>
- </div>
- <hr/>The documentation for this class was generated from the following files:<ul>
- <li>Jolt/Core/<a class="el" href="_lock_free_hash_map_8h_source.html">LockFreeHashMap.h</a></li>
- <li>Jolt/Core/<a class="el" href="_lock_free_hash_map_8inl_source.html">LockFreeHashMap.inl</a></li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="class_l_f_h_m_allocator.html">LFHMAllocator</a></li>
- <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>
- </ul>
- </div>
- </body>
- </html>
|