Files
rippled/SHAMapNodeID_8h_source.html
2025-11-04 00:36:48 -08:00

276 lines
42 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.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: SHAMapNodeID.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.8 -->
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0103a8ad82dcc2c51f5cde661b4b5cb7.html">xrpl</a></li><li class="navelem"><a class="el" href="dir_292da32077129148230df7f03daa34af.html">shamap</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">SHAMapNodeID.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="preprocessor">#ifndef XRPL_SHAMAP_SHAMAPNODEID_H_INCLUDED</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_SHAMAP_SHAMAPNODEID_H_INCLUDED</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span> </div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/basics/CountedObject.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/basics/base_uint.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</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="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/string.html">string</a>&gt;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/tuple.html">tuple</a>&gt;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div>
<div class="foldopen" id="foldopen00014" data-start="{" data-end="};">
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html"> 14</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> : <span class="keyword">public</span> <a class="code hl_class" href="classripple_1_1CountedObject.html">CountedObject</a>&lt;SHAMapNodeID&gt;</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>{</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f"> 17</a></span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>;</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb"> 18</a></span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> = 0;</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="keyword">public</span>:</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#ab778be2116f66638981a7e9c0dd9ac6b"> 21</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#ab778be2116f66638981a7e9c0dd9ac6b">SHAMapNodeID</a>() = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a1494e31bb807399f2c39327c247c0072"> 22</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a1494e31bb807399f2c39327c247c0072">SHAMapNodeID</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; other) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#ab778be2116f66638981a7e9c0dd9ac6b">SHAMapNodeID</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> depth, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash);</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> <a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a>&amp;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#ae8cc621032f5ef00b3c61e04f9623cfb"> 26</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#ae8cc621032f5ef00b3c61e04f9623cfb">operator=</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; other) = <span class="keywordflow">default</span>;</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00029" data-start="{" data-end="}">
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a205ce1fb183881d67a7b171533141c6b"> 29</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a205ce1fb183881d67a7b171533141c6b">isRoot</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> == 0;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> }</div>
</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Get the wire format (256-bit nodeID, 1-byte depth)</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a60517c4d78ae36f53c01b84865d5ba7e">getRawString</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span></div>
<div class="foldopen" id="foldopen00039" data-start="{" data-end="}">
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a17a2bccfba4ea39ba3c92570511a4d55"> 39</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a17a2bccfba4ea39ba3c92570511a4d55">getDepth</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a>;</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> }</div>
</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp;</div>
<div class="foldopen" id="foldopen00045" data-start="{" data-end="}">
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a1b49f13ef901549ef1d5bceb94ed4753"> 45</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a1b49f13ef901549ef1d5bceb94ed4753">getNodeID</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>;</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a23e606ffcd8a863d0f678f040001aedf">getChildNodeID</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> <span class="keyword">static</span> <a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a9ff9dfe2cb92d0b3d5a52ad6e3541416">createID</a>(<span class="keywordtype">int</span> depth, <a class="code hl_class" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; key);</div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> <span class="comment">// FIXME-C++20: use spaceship and operator synthesis</span></div>
<div class="foldopen" id="foldopen00066" data-start="{" data-end="}">
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a0ce8791791ff9fcb83d1e8e6ce0c0c27"> 66</a></span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a0ce8791791ff9fcb83d1e8e6ce0c0c27">operator&lt;</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; n)<span class="keyword"> const</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="keywordflow">return</span> <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/utility/tuple/tie.html">std::tie</a>(<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a>, <a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>) &lt; <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/utility/tuple/tie.html">std::tie</a>(n.<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a>, n.<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> }</div>
</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00073" data-start="{" data-end="}">
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#afa21e9fdae0ad9a3b08a3adb40c06b15"> 73</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#afa21e9fdae0ad9a3b08a3adb40c06b15">operator&gt;</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; n)<span class="keyword"> const</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keywordflow">return</span> n &lt; *<span class="keyword">this</span>;</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> }</div>
</div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#aac7517581ee9512f98288ac5f578fead"> 78</a></span> <span class="keywordtype">bool</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#aac7517581ee9512f98288ac5f578fead">operator&lt;=</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; n)<span class="keyword"> const</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordflow">return</span> !(n &lt; *<span class="keyword">this</span>);</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> }</div>
</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00085" data-start="{" data-end="}">
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a21251730266f24d17b4ff3acb1e01973"> 85</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a21251730266f24d17b4ff3acb1e01973">operator&gt;=</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; n)<span class="keyword"> const</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> <span class="keywordflow">return</span> !(*<span class="keyword">this</span> &lt; n);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> }</div>
</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> </div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00091" data-start="{" data-end="}">
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#ab11a987c332754680546d404f048bae4"> 91</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#ab11a987c332754680546d404f048bae4">operator==</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; n)<span class="keyword"> const</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="keywordflow">return</span> (<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> == n.<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a>) &amp;&amp; (<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a> == n.<a class="code hl_variable" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>);</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> }</div>
</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="keywordtype">bool</span></div>
<div class="foldopen" id="foldopen00097" data-start="{" data-end="}">
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a776763973ff5fc4c43b29f6ee8d6261a"> 97</a></span> <a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a776763973ff5fc4c43b29f6ee8d6261a">operator!=</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; n)<span class="keyword"> const</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <span class="keywordflow">return</span> !(*<span class="keyword">this</span> == n);</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> }</div>
</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>};</div>
</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="keyword">inline</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="foldopen" id="foldopen00104" data-start="{" data-end="}">
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"><a class="line" href="namespaceripple.html#ae17017060989c5be0a5e70d8e41dbff2"> 104</a></span><a class="code hl_function" href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">to_string</a>(<a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; node)</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>{</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> <span class="keywordflow">if</span> (node.<a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a205ce1fb183881d67a7b171533141c6b">isRoot</a>())</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;NodeID(root)&quot;</span>;</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> </div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> <span class="keywordflow">return</span> <span class="stringliteral">&quot;NodeID(&quot;</span> + <a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/to_string.html">std::to_string</a>(node.<a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a17a2bccfba4ea39ba3c92570511a4d55">getDepth</a>()) + <span class="stringliteral">&quot;,&quot;</span> +</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <a class="code hl_function" href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">to_string</a>(node.<a class="code hl_function" href="classripple_1_1SHAMapNodeID.html#a1b49f13ef901549ef1d5bceb94ed4753">getNodeID</a>()) + <span class="stringliteral">&quot;)&quot;</span>;</div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span>}</div>
</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> </div>
<div class="foldopen" id="foldopen00113" data-start="{" data-end="}">
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"><a class="line" href="namespaceripple.html#a8a9890e12a57d665eb96f6c0798efedc"> 113</a></span><span class="keyword">inline</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a>&amp;</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><a class="code hl_function" href="namespaceripple.html#a5c77599883897def8bd3e9e4ad140f95">operator&lt;&lt;</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a>&amp; <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>, <a class="code hl_class" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; node)</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span>{</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> <span class="keywordflow">return</span> <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a> &lt;&lt; <a class="code hl_function" href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">to_string</a>(node);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>}</div>
</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>[[nodiscard]] <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;SHAMapNodeID&gt;</a></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><a class="code hl_function" href="namespaceripple.html#a34ca82369c1b5a3fb627089495c74928">deserializeSHAMapNodeID</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* data, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size);</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span>[[nodiscard]] <span class="keyword">inline</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;SHAMapNodeID&gt;</a></div>
<div class="foldopen" id="foldopen00132" data-start="{" data-end="}">
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="namespaceripple.html#a8ecd361f4e399ef6c4e33007bccb3bb2"> 132</a></span><a class="code hl_function" href="namespaceripple.html#a34ca82369c1b5a3fb627089495c74928">deserializeSHAMapNodeID</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> <span class="keyword">const</span>&amp; s)</div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span>{</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span> <span class="keywordflow">return</span> <a class="code hl_function" href="namespaceripple.html#a34ca82369c1b5a3fb627089495c74928">deserializeSHAMapNodeID</a>(s.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/data.html">data</a>(), s.<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">size</a>());</div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span>}</div>
</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span>[[nodiscard]] <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><a class="code hl_function" href="namespaceripple.html#abab985fadeb4b5746ed662c2540f4da5">selectBranch</a>(SHAMapNodeID <span class="keyword">const</span>&amp; <span class="keywordtype">id</span>, <a class="code hl_typedef" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> <span class="keyword">const</span>&amp; hash);</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"> 141</span> </div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="abasic_ostream_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a></div></div>
<div class="ttc" id="abasic_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div></div>
<div class="ttc" id="aclassripple_1_1CountedObject_html"><div class="ttname"><a href="classripple_1_1CountedObject.html">ripple::CountedObject</a></div><div class="ttdoc">Tracks the number of instances of an object.</div><div class="ttdef"><b>Definition</b> <a href="CountedObject_8h_source.html#l00106">CountedObject.h:107</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html">ripple::SHAMapNodeID</a></div><div class="ttdoc">Identifies a node inside a SHAMap.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00014">SHAMapNodeID.h:15</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a0ce8791791ff9fcb83d1e8e6ce0c0c27"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a0ce8791791ff9fcb83d1e8e6ce0c0c27">ripple::SHAMapNodeID::operator&lt;</a></div><div class="ttdeci">bool operator&lt;(SHAMapNodeID const &amp;n) const</div><div class="ttdoc">Comparison operators.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00066">SHAMapNodeID.h:67</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a1494e31bb807399f2c39327c247c0072"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a1494e31bb807399f2c39327c247c0072">ripple::SHAMapNodeID::SHAMapNodeID</a></div><div class="ttdeci">SHAMapNodeID(SHAMapNodeID const &amp;other)=default</div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a17a2bccfba4ea39ba3c92570511a4d55"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a17a2bccfba4ea39ba3c92570511a4d55">ripple::SHAMapNodeID::getDepth</a></div><div class="ttdeci">unsigned int getDepth() const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00039">SHAMapNodeID.h:39</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a1b49f13ef901549ef1d5bceb94ed4753"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a1b49f13ef901549ef1d5bceb94ed4753">ripple::SHAMapNodeID::getNodeID</a></div><div class="ttdeci">uint256 const &amp; getNodeID() const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00045">SHAMapNodeID.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a205ce1fb183881d67a7b171533141c6b"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a205ce1fb183881d67a7b171533141c6b">ripple::SHAMapNodeID::isRoot</a></div><div class="ttdeci">bool isRoot() const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00029">SHAMapNodeID.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a21251730266f24d17b4ff3acb1e01973"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a21251730266f24d17b4ff3acb1e01973">ripple::SHAMapNodeID::operator&gt;=</a></div><div class="ttdeci">bool operator&gt;=(SHAMapNodeID const &amp;n) const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00085">SHAMapNodeID.h:85</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a23e606ffcd8a863d0f678f040001aedf"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a23e606ffcd8a863d0f678f040001aedf">ripple::SHAMapNodeID::getChildNodeID</a></div><div class="ttdeci">SHAMapNodeID getChildNodeID(unsigned int m) const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8cpp_source.html#l00058">SHAMapNodeID.cpp:58</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a60517c4d78ae36f53c01b84865d5ba7e"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a60517c4d78ae36f53c01b84865d5ba7e">ripple::SHAMapNodeID::getRawString</a></div><div class="ttdeci">std::string getRawString() const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8cpp_source.html#l00049">SHAMapNodeID.cpp:49</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a776763973ff5fc4c43b29f6ee8d6261a"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a776763973ff5fc4c43b29f6ee8d6261a">ripple::SHAMapNodeID::operator!=</a></div><div class="ttdeci">bool operator!=(SHAMapNodeID const &amp;n) const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00097">SHAMapNodeID.h:97</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a7cff46032ca875e7f9beaeade09e1c9f"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">ripple::SHAMapNodeID::id_</a></div><div class="ttdeci">uint256 id_</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00017">SHAMapNodeID.h:17</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_a9ff9dfe2cb92d0b3d5a52ad6e3541416"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#a9ff9dfe2cb92d0b3d5a52ad6e3541416">ripple::SHAMapNodeID::createID</a></div><div class="ttdeci">static SHAMapNodeID createID(int depth, uint256 const &amp;key)</div><div class="ttdoc">Create a SHAMapNodeID of a node with the depth of the node and the key of a leaf.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8cpp_source.html#l00125">SHAMapNodeID.cpp:125</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_aac7517581ee9512f98288ac5f578fead"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#aac7517581ee9512f98288ac5f578fead">ripple::SHAMapNodeID::operator&lt;=</a></div><div class="ttdeci">bool operator&lt;=(SHAMapNodeID const &amp;n) const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00078">SHAMapNodeID.h:79</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_ab11a987c332754680546d404f048bae4"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#ab11a987c332754680546d404f048bae4">ripple::SHAMapNodeID::operator==</a></div><div class="ttdeci">bool operator==(SHAMapNodeID const &amp;n) const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00091">SHAMapNodeID.h:91</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_ab778be2116f66638981a7e9c0dd9ac6b"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#ab778be2116f66638981a7e9c0dd9ac6b">ripple::SHAMapNodeID::SHAMapNodeID</a></div><div class="ttdeci">SHAMapNodeID()=default</div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_ae8cc621032f5ef00b3c61e04f9623cfb"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#ae8cc621032f5ef00b3c61e04f9623cfb">ripple::SHAMapNodeID::operator=</a></div><div class="ttdeci">SHAMapNodeID &amp; operator=(SHAMapNodeID const &amp;other)=default</div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_aea1b5520b7d49f8dd05211bbec6465eb"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">ripple::SHAMapNodeID::depth_</a></div><div class="ttdeci">unsigned int depth_</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00018">SHAMapNodeID.h:18</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMapNodeID_html_afa21e9fdae0ad9a3b08a3adb40c06b15"><div class="ttname"><a href="classripple_1_1SHAMapNodeID.html#afa21e9fdae0ad9a3b08a3adb40c06b15">ripple::SHAMapNodeID::operator&gt;</a></div><div class="ttdeci">bool operator&gt;(SHAMapNodeID const &amp;n) const</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8h_source.html#l00073">SHAMapNodeID.h:73</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 256 &gt;</a></div></div>
<div class="ttc" id="adata_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/data.html">std::string::data</a></div><div class="ttdeci">T data(T... args)</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#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespaceripple_html_a34ca82369c1b5a3fb627089495c74928"><div class="ttname"><a href="namespaceripple.html#a34ca82369c1b5a3fb627089495c74928">ripple::deserializeSHAMapNodeID</a></div><div class="ttdeci">std::optional&lt; SHAMapNodeID &gt; deserializeSHAMapNodeID(void const *data, std::size_t size)</div><div class="ttdoc">Return an object representing a serialized SHAMap Node ID.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8cpp_source.html#l00089">SHAMapNodeID.cpp:89</a></div></div>
<div class="ttc" id="anamespaceripple_html_a356c68147333a9a48a344718038576d9"><div class="ttname"><a href="namespaceripple.html#a356c68147333a9a48a344718038576d9">ripple::uint256</a></div><div class="ttdeci">base_uint&lt; 256 &gt; uint256</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00539">base_uint.h:539</a></div></div>
<div class="ttc" id="anamespaceripple_html_a5c77599883897def8bd3e9e4ad140f95"><div class="ttname"><a href="namespaceripple.html#a5c77599883897def8bd3e9e4ad140f95">ripple::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;out, base_uint&lt; Bits, Tag &gt; const &amp;u)</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00627">base_uint.h:628</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275"><div class="ttname"><a href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">ripple::QualityDirection::out</a></div><div class="ttdeci">@ out</div></div>
<div class="ttc" id="anamespaceripple_html_abab985fadeb4b5746ed662c2540f4da5"><div class="ttname"><a href="namespaceripple.html#abab985fadeb4b5746ed662c2540f4da5">ripple::selectBranch</a></div><div class="ttdeci">unsigned int selectBranch(SHAMapNodeID const &amp;id, uint256 const &amp;hash)</div><div class="ttdoc">Returns the branch that would contain the given hash.</div><div class="ttdef"><b>Definition</b> <a href="SHAMapNodeID_8cpp_source.html#l00109">SHAMapNodeID.cpp:109</a></div></div>
<div class="ttc" id="anamespaceripple_html_ac124fe6744b7fe887dec949b56b16d50"><div class="ttname"><a href="namespaceripple.html#ac124fe6744b7fe887dec949b56b16d50">ripple::to_string</a></div><div class="ttdeci">std::string to_string(base_uint&lt; Bits, Tag &gt; const &amp;a)</div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00611">base_uint.h:611</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="asize_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/size.html">std::string::size</a></div><div class="ttdeci">T size(T... args)</div></div>
<div class="ttc" id="asize_t_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div></div>
<div class="ttc" id="astring_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/string.html">string</a></div></div>
<div class="ttc" id="atie_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/tuple/tie.html">std::tie</a></div><div class="ttdeci">T tie(T... args)</div></div>
<div class="ttc" id="ato_string_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/string/basic_string/to_string.html">std::to_string</a></div><div class="ttdeci">T to_string(T... args)</div></div>
<div class="ttc" id="atuple_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/tuple.html">tuple</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.8
</small></address>
</body>
</html>