Files
rippled/TaggedPointer_8h_source.html
2025-03-25 18:44:58 +00:00

252 lines
40 KiB
HTML

<!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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: TaggedPointer.h Source File</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="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>
<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="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_24457b513c1d1ae078f19eaa8a988688.html">shamap</a></li><li class="navelem"><a class="el" href="dir_dc4d3c641caa30616cd7f4e660c0d82b.html">detail</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">TaggedPointer.h</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment">/*</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Copyright (c) 2020 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#ifndef RIPPLE_SHAMAP_TAGGEDPOINTER_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_SHAMAP_TAGGEDPOINTER_H_INCLUDED</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;xrpld/shamap/SHAMapTreeNode.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/basics/IntrusivePointer.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/array.html">array</a>&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a>&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a>&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html"> 60</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>{</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> <span class="keyword">static_assert</span>(</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="keyword">alignof</span>(<a class="code hl_class" href="classripple_1_1SHAMapHash.html">SHAMapHash</a>) &gt;= 4,</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="stringliteral">&quot;Bad alignment: Tag pointer requires low two bits to be zero.&quot;</span>);</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#ab40eb19b4a834bbf0316bf8b00f985f0"> 69</a></span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uintptr_t</a> <a class="code hl_variable" href="classripple_1_1TaggedPointer.html#ab40eb19b4a834bbf0316bf8b00f985f0">tp_</a> = 0;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a74d9d7bb06643e18a2c6c8f4d9661393"> 71</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uintptr_t</a> <a class="code hl_variable" href="classripple_1_1TaggedPointer.html#a74d9d7bb06643e18a2c6c8f4d9661393">tagMask</a> = 3;</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#aa31e8ae261c16b7cd0e82a5cd9058681"> 73</a></span> <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uintptr_t</a> <a class="code hl_variable" href="classripple_1_1TaggedPointer.html#aa31e8ae261c16b7cd0e82a5cd9058681">ptrMask</a> = ~tagMask;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a4ec97fb274ad7021f7bad639cadbf42f"> 77</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a4ec97fb274ad7021f7bad639cadbf42f">destroyHashesAndChildren</a>();</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"><a class="line" href="structripple_1_1TaggedPointer_1_1RawAllocateTag.html"> 79</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1TaggedPointer_1_1RawAllocateTag.html">RawAllocateTag</a></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> {</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> };</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#ab8fa030a8360a2d5085bad936e8170d3"> 95</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#ab8fa030a8360a2d5085bad936e8170d3">TaggedPointer</a>(<a class="code hl_struct" href="structripple_1_1TaggedPointer_1_1RawAllocateTag.html">RawAllocateTag</a>, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> numChildren);</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#afbb502b281e5ca39f59cda1fd638e73c"> 98</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#afbb502b281e5ca39f59cda1fd638e73c">TaggedPointer</a>() = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#ae7736e90fee32067aa2d91894003d37c"> 99</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#ae7736e90fee32067aa2d91894003d37c">TaggedPointer</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> numChildren);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a51883d57e164a3944e03ae5b23b1af5c"> 115</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a51883d57e164a3944e03ae5b23b1af5c">TaggedPointer</a>(</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a>&amp;&amp; other,</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> isBranch,</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> toAllocate);</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a24fb1b04da2e40a9c96f6ed3b25f46aa"> 141</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a24fb1b04da2e40a9c96f6ed3b25f46aa">TaggedPointer</a>(</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span> <a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a>&amp;&amp; other,</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> srcBranches,</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> dstBranches,</div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> toAllocate);</div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span> </div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a45086d014ec681e668f7bc3e16543ae4"> 147</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a45086d014ec681e668f7bc3e16543ae4">TaggedPointer</a>(<a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a> <span class="keyword">const</span>&amp;) = <span class="keyword">delete</span>;</div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span> </div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a2756e93eab705b52cba9b75666f94b05"> 149</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a2756e93eab705b52cba9b75666f94b05">TaggedPointer</a>(<a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a>&amp;&amp;);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"> 150</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span> <a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a>&amp;</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a824caf26851173aaf15cdb7abd9ce8b9"> 152</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a824caf26851173aaf15cdb7abd9ce8b9">operator=</a>(<a class="code hl_class" href="classripple_1_1TaggedPointer.html">TaggedPointer</a>&amp;&amp;);</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span> </div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#ace0ddb2f1b39cf44f978ec9ca5683522"> 154</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#ace0ddb2f1b39cf44f978ec9ca5683522">~TaggedPointer</a>();</div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span> </div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span> [[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair&lt;std::uint8_t, void*&gt;</a></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a0ad8af935870774f119f6f10f7bb8274"> 158</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a0ad8af935870774f119f6f10f7bb8274">decode</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span> </div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span> [[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#aa3fcb13ead97c21651ae2ea0f60e8909"> 162</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#aa3fcb13ead97c21651ae2ea0f60e8909">capacity</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span> </div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span> [[nodiscard]] <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#ae529fdc057df9e07c40b488d45855b19"> 170</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#ae529fdc057df9e07c40b488d45855b19">isDense</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span> </div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span> [[nodiscard]] std::</div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span> tuple&lt;std::uint8_t, SHAMapHash*, intr_ptr::SharedPtr&lt;SHAMapTreeNode&gt;*&gt;</div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a6078f7eb3fecdb62716c9da1e82ccad4"> 177</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a6078f7eb3fecdb62716c9da1e82ccad4">getHashesAndChildren</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"> 178</span> </div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno"> 180</span> [[nodiscard]] <a class="code hl_class" href="classripple_1_1SHAMapHash.html">SHAMapHash</a>*</div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a7f7fe881693ea0bb3d6539f3591328f4"> 181</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a7f7fe881693ea0bb3d6539f3591328f4">getHashes</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno"> 182</span> </div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno"> 184</span> [[nodiscard]] <a class="code hl_class" href="classripple_1_1SharedIntrusive.html">intr_ptr::SharedPtr&lt;SHAMapTreeNode&gt;</a>*</div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#aeb83a46ac5d69797b7046938a74bff5f"> 185</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#aeb83a46ac5d69797b7046938a74bff5f">getChildren</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno"> 186</span> </div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno"> 195</span> <span class="keyword">template</span> &lt;<span class="keyword">class</span> F&gt;</div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno"> 196</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#ac549f5187a2f29c8fb65a5a399cce913"> 197</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#ac549f5187a2f29c8fb65a5a399cce913">iterChildren</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> isBranch, F&amp;&amp; f) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno"> 198</span> </div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno"> 208</span> <span class="keyword">template</span> &lt;<span class="keyword">class</span> F&gt;</div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno"> 209</span> <span class="keywordtype">void</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a00d143272df241cef3ff904d3291652b"> 210</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a00d143272df241cef3ff904d3291652b">iterNonEmptyChildIndexes</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> isBranch, F&amp;&amp; f) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno"> 211</span> </div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno"> 220</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;int&gt;</a></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno"><a class="line" href="classripple_1_1TaggedPointer.html#a385d3615d8ee4a2d252bcf8bfe2bd4da"> 221</a></span> <a class="code hl_function" href="classripple_1_1TaggedPointer.html#a385d3615d8ee4a2d252bcf8bfe2bd4da">getChildIndex</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> isBranch, <span class="keywordtype">int</span> i) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno"> 222</span>};</div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno"> 223</span> </div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span>[[nodiscard]] <span class="keyword">inline</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"><a class="line" href="namespaceripple.html#af313083334c9a7fedf2bc3142b4b4ccd"> 225</a></span><a class="code hl_function" href="namespaceripple.html#af313083334c9a7fedf2bc3142b4b4ccd">popcnt16</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> a)</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span>{</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span><span class="preprocessor">#if __cpp_lib_bitops</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> <span class="keywordflow">return</span> std::popcount(a);</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span><span class="preprocessor">#elif defined(__clang__) || defined(__GNUC__)</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <span class="keywordflow">return</span> __builtin_popcount(a);</div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno"> 231</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno"> 232</span> <span class="comment">// fallback to table lookup</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno"> 233</span> <span class="keyword">static</span> <span class="keyword">auto</span> <span class="keyword">constexpr</span> <span class="keyword">const</span> tbl = []() {</div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"> 234</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/container/array.html">std::array&lt;std::uint8_t, 256&gt;</a> ret{};</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno"> 235</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i != 256; ++i)</div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno"> 236</span> {</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno"> 237</span> <span class="keywordflow">for</span> (<span class="keywordtype">int</span> j = 0; j != 8; ++j)</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> {</div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <span class="keywordflow">if</span> (i &amp; (1 &lt;&lt; j))</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> ret[i]++;</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> }</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> }</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> <span class="keywordflow">return</span> ret;</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> }();</div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno"> 245</span> <span class="keywordflow">return</span> tbl[a &amp; 0xff] + tbl[a &gt;&gt; 8];</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno"> 246</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"> 247</span>}</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno"> 248</span> </div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno"> 249</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno"> 250</span> </div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno"> 251</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aarray_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/array.html">array</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapHash_html"><div class="ttname"><a href="classripple_1_1SHAMapHash.html">ripple::SHAMapHash</a></div><div class="ttdef"><b>Definition:</b> <a href="SHAMapHash_8h_source.html#l00033">SHAMapHash.h:34</a></div></div>
<div class="ttc" id="aclassripple_1_1SharedIntrusive_html"><div class="ttname"><a href="classripple_1_1SharedIntrusive.html">ripple::SharedIntrusive</a></div><div class="ttdoc">A shared intrusive pointer class that supports weak pointers.</div><div class="ttdef"><b>Definition:</b> <a href="IntrusivePointer_8h_source.html#l00087">IntrusivePointer.h:88</a></div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html"><div class="ttname"><a href="classripple_1_1TaggedPointer.html">ripple::TaggedPointer</a></div><div class="ttdoc">TaggedPointer is a combination of a pointer and a mask stored in the lowest two bits.</div><div class="ttdef"><b>Definition:</b> <a href="TaggedPointer_8h_source.html#l00060">TaggedPointer.h:61</a></div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a00d143272df241cef3ff904d3291652b"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a00d143272df241cef3ff904d3291652b">ripple::TaggedPointer::iterNonEmptyChildIndexes</a></div><div class="ttdeci">void iterNonEmptyChildIndexes(std::uint16_t isBranch, F &amp;&amp;f) const</div><div class="ttdoc">Call the f callback for all non-empty branches.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a0ad8af935870774f119f6f10f7bb8274"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a0ad8af935870774f119f6f10f7bb8274">ripple::TaggedPointer::decode</a></div><div class="ttdeci">std::pair&lt; std::uint8_t, void * &gt; decode() const</div><div class="ttdoc">Decode the tagged pointer into its tag and pointer.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a24fb1b04da2e40a9c96f6ed3b25f46aa"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a24fb1b04da2e40a9c96f6ed3b25f46aa">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer(TaggedPointer &amp;&amp;other, std::uint16_t srcBranches, std::uint16_t dstBranches, std::uint8_t toAllocate)</div><div class="ttdoc">Given other with the specified children in srcBranches, create a new TaggedPointer with the allocated...</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a2756e93eab705b52cba9b75666f94b05"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a2756e93eab705b52cba9b75666f94b05">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer(TaggedPointer &amp;&amp;)</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a385d3615d8ee4a2d252bcf8bfe2bd4da"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a385d3615d8ee4a2d252bcf8bfe2bd4da">ripple::TaggedPointer::getChildIndex</a></div><div class="ttdeci">std::optional&lt; int &gt; getChildIndex(std::uint16_t isBranch, int i) const</div><div class="ttdoc">Get the child's index inside the hashes or children array (which may or may not be sparse).</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a45086d014ec681e668f7bc3e16543ae4"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a45086d014ec681e668f7bc3e16543ae4">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer(TaggedPointer const &amp;)=delete</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a4ec97fb274ad7021f7bad639cadbf42f"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a4ec97fb274ad7021f7bad639cadbf42f">ripple::TaggedPointer::destroyHashesAndChildren</a></div><div class="ttdeci">void destroyHashesAndChildren()</div><div class="ttdoc">Deallocate memory and run destructors.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a51883d57e164a3944e03ae5b23b1af5c"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a51883d57e164a3944e03ae5b23b1af5c">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer(TaggedPointer &amp;&amp;other, std::uint16_t isBranch, std::uint8_t toAllocate)</div><div class="ttdoc">Constructor is used change the number of allocated children.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a6078f7eb3fecdb62716c9da1e82ccad4"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a6078f7eb3fecdb62716c9da1e82ccad4">ripple::TaggedPointer::getHashesAndChildren</a></div><div class="ttdeci">std::tuple&lt; std::uint8_t, SHAMapHash *, intr_ptr::SharedPtr&lt; SHAMapTreeNode &gt; * &gt; getHashesAndChildren() const</div><div class="ttdoc">Get the number of elements in each array and a pointer to the start of each array.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a74d9d7bb06643e18a2c6c8f4d9661393"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a74d9d7bb06643e18a2c6c8f4d9661393">ripple::TaggedPointer::tagMask</a></div><div class="ttdeci">static constexpr std::uintptr_t tagMask</div><div class="ttdoc">bit-and with this mask to get the tag bits (lowest two bits)</div><div class="ttdef"><b>Definition:</b> <a href="TaggedPointer_8h_source.html#l00071">TaggedPointer.h:71</a></div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a7f7fe881693ea0bb3d6539f3591328f4"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a7f7fe881693ea0bb3d6539f3591328f4">ripple::TaggedPointer::getHashes</a></div><div class="ttdeci">SHAMapHash * getHashes() const</div><div class="ttdoc">Get the hashes array.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_a824caf26851173aaf15cdb7abd9ce8b9"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#a824caf26851173aaf15cdb7abd9ce8b9">ripple::TaggedPointer::operator=</a></div><div class="ttdeci">TaggedPointer &amp; operator=(TaggedPointer &amp;&amp;)</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_aa31e8ae261c16b7cd0e82a5cd9058681"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#aa31e8ae261c16b7cd0e82a5cd9058681">ripple::TaggedPointer::ptrMask</a></div><div class="ttdeci">static constexpr std::uintptr_t ptrMask</div><div class="ttdoc">bit-and with this mask to get the pointer bits (mask out the tag)</div><div class="ttdef"><b>Definition:</b> <a href="TaggedPointer_8h_source.html#l00073">TaggedPointer.h:73</a></div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_aa3fcb13ead97c21651ae2ea0f60e8909"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#aa3fcb13ead97c21651ae2ea0f60e8909">ripple::TaggedPointer::capacity</a></div><div class="ttdeci">std::uint8_t capacity() const</div><div class="ttdoc">Get the number of elements allocated for each array.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_ab40eb19b4a834bbf0316bf8b00f985f0"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#ab40eb19b4a834bbf0316bf8b00f985f0">ripple::TaggedPointer::tp_</a></div><div class="ttdeci">std::uintptr_t tp_</div><div class="ttdoc">Upper bits are the pointer, lowest two bits are the tag A moved-from object will have a tp_ of zero.</div><div class="ttdef"><b>Definition:</b> <a href="TaggedPointer_8h_source.html#l00069">TaggedPointer.h:69</a></div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_ab8fa030a8360a2d5085bad936e8170d3"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#ab8fa030a8360a2d5085bad936e8170d3">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer(RawAllocateTag, std::uint8_t numChildren)</div><div class="ttdoc">This constructor allocates space for the hashes and children, but does not run constructors.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_ac549f5187a2f29c8fb65a5a399cce913"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#ac549f5187a2f29c8fb65a5a399cce913">ripple::TaggedPointer::iterChildren</a></div><div class="ttdeci">void iterChildren(std::uint16_t isBranch, F &amp;&amp;f) const</div><div class="ttdoc">Call the f callback for all 16 (branchFactor) branches - even if the branch is empty.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_ace0ddb2f1b39cf44f978ec9ca5683522"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#ace0ddb2f1b39cf44f978ec9ca5683522">ripple::TaggedPointer::~TaggedPointer</a></div><div class="ttdeci">~TaggedPointer()</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_ae529fdc057df9e07c40b488d45855b19"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#ae529fdc057df9e07c40b488d45855b19">ripple::TaggedPointer::isDense</a></div><div class="ttdeci">bool isDense() const</div><div class="ttdoc">Check if the arrays have a dense format.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_ae7736e90fee32067aa2d91894003d37c"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#ae7736e90fee32067aa2d91894003d37c">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer(std::uint8_t numChildren)</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_aeb83a46ac5d69797b7046938a74bff5f"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#aeb83a46ac5d69797b7046938a74bff5f">ripple::TaggedPointer::getChildren</a></div><div class="ttdeci">intr_ptr::SharedPtr&lt; SHAMapTreeNode &gt; * getChildren() const</div><div class="ttdoc">Get the children array.</div></div>
<div class="ttc" id="aclassripple_1_1TaggedPointer_html_afbb502b281e5ca39f59cda1fd638e73c"><div class="ttname"><a href="classripple_1_1TaggedPointer.html#afbb502b281e5ca39f59cda1fd638e73c">ripple::TaggedPointer::TaggedPointer</a></div><div class="ttdeci">TaggedPointer()=delete</div></div>
<div class="ttc" id="acstdint_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstdint.html">cstdint</a></div></div>
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uintptr_t</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8h_source.html#l00026">algorithm.h:26</a></div></div>
<div class="ttc" id="anamespaceripple_html_af313083334c9a7fedf2bc3142b4b4ccd"><div class="ttname"><a href="namespaceripple.html#af313083334c9a7fedf2bc3142b4b4ccd">ripple::popcnt16</a></div><div class="ttdeci">int popcnt16(std::uint16_t a)</div><div class="ttdef"><b>Definition:</b> <a href="TaggedPointer_8h_source.html#l00225">TaggedPointer.h:225</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/optional.html">optional</a></div></div>
<div class="ttc" id="apair_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a></div></div>
<div class="ttc" id="astructripple_1_1TaggedPointer_1_1RawAllocateTag_html"><div class="ttname"><a href="structripple_1_1TaggedPointer_1_1RawAllocateTag.html">ripple::TaggedPointer::RawAllocateTag</a></div><div class="ttdef"><b>Definition:</b> <a href="TaggedPointer_8h_source.html#l00079">TaggedPointer.h:80</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>