Files
rippled/SHAMapNodeID_8cpp_source.html
2021-03-12 22:34:28 +00:00

250 lines
37 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: SHAMapNodeID.cpp 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_380eda8174f5eb060d37b8b034a94866.html">shamap</a></li><li class="navelem"><a class="el" href="dir_105cccbbf432365df53e381b580b4a54.html">impl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SHAMapNodeID.cpp</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">//------------------------------------------------------------------------------</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> Copyright (c) 2012, 2013 Ripple Labs Inc.</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">*/</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">//==============================================================================</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#include &lt;ripple/beast/core/LexicalCast.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#include &lt;ripple/crypto/csprng.h&gt;</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/Serializer.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="preprocessor">#include &lt;ripple/shamap/SHAMap.h&gt;</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#include &lt;ripple/shamap/SHAMapNodeID.h&gt;</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#include &lt;<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a>&gt;</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="keyword">static</span> <a class="code" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> <span class="keyword">const</span>&amp;</div>
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168"> 30</a></span>&#160;<a class="code" href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168">depthMask</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> depth)</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;{</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; <span class="keyword">enum</span> { mask_size = 65 };</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; <span class="keyword">struct </span>masks_t</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; {</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; <a class="code" href="classripple_1_1base__uint.html">uint256</a> entry[mask_size];</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160; </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160; masks_t()</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; {</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classripple_1_1base__uint.html">uint256</a> selector;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">for</span> (<span class="keywordtype">int</span> i = 0; i &lt; mask_size - 1; i += 2)</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; {</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160; entry[i] = selector;</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; *(selector.<a class="code" href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">begin</a>() + (i / 2)) = 0xF0;</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; entry[i + 1] = selector;</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; *(selector.<a class="code" href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">begin</a>() + (i / 2)) = 0xFF;</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; }</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; entry[mask_size - 1] = selector;</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; }</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; };</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; </div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keyword">static</span> masks_t <span class="keyword">const</span> masks;</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> masks.entry[depth];</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;}</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; </div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;<span class="comment">// canonicalize the hash to a node ID for this depth</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a07d89225c82c518e88d15b2ed3138ca5"> 57</a></span>&#160;<a class="code" href="classripple_1_1SHAMapNodeID.html#ab778be2116f66638981a7e9c0dd9ac6b">SHAMapNodeID::SHAMapNodeID</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> depth, <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash)</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; : id_(hash), depth_(depth)</div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;{</div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; assert(depth &lt;= <a class="code" href="classripple_1_1SHAMap.html#a16961b82bb1c661845b14c88b4e80dc3">SHAMap::leafDepth</a>);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160; assert(<a class="code" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a> == (<a class="code" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a> &amp; <a class="code" href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168">depthMask</a>(depth)));</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;}</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a></div>
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a60517c4d78ae36f53c01b84865d5ba7e"> 65</a></span>&#160;<a class="code" href="classripple_1_1SHAMapNodeID.html#a60517c4d78ae36f53c01b84865d5ba7e">SHAMapNodeID::getRawString</a>()<span class="keyword"> const</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; <a class="code" href="classripple_1_1Serializer.html">Serializer</a> s(33);</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; s.<a class="code" href="classripple_1_1Serializer.html#a96daec54ca0c8ec7f6e7e683e9abbe0e">addBitString</a>(<a class="code" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>);</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; s.<a class="code" href="classripple_1_1Serializer.html#ab6de064efbc9b2efaeff2b069a02b644">add8</a>(<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a>);</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; <span class="keywordflow">return</span> s.<a class="code" href="classripple_1_1Serializer.html#afb9f001046e4767db6780bbee86d93c3">getString</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;}</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160;<a class="code" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a></div>
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a23e606ffcd8a863d0f678f040001aedf"> 74</a></span>&#160;<a class="code" href="classripple_1_1SHAMapNodeID.html#a23e606ffcd8a863d0f678f040001aedf">SHAMapNodeID::getChildNodeID</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> m)<span class="keyword"> const</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160;<span class="keyword"></span>{</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; assert(m &lt; <a class="code" href="classripple_1_1SHAMap.html#af8599964238eb94d795606f220654db9">SHAMap::branchFactor</a>);</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; </div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="comment">// A SHAMap has exactly 65 levels, so nodes must not exceed that</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; <span class="comment">// depth; if they do, this breaks the invariant of never allowing</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; <span class="comment">// the construction of a SHAMapNodeID at an invalid depth. We assert</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; <span class="comment">// to catch this in debug builds.</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="comment">//</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="comment">// We throw (but never assert) if the node is at level 64, since</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="comment">// entries at that depth are leaf nodes and have no children and even</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <span class="comment">// constructing a child node from them would break the above invariant.</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; assert(<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> &lt;= <a class="code" href="classripple_1_1SHAMap.html#a16961b82bb1c661845b14c88b4e80dc3">SHAMap::leafDepth</a>);</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160; </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> &gt;= <a class="code" href="classripple_1_1SHAMap.html#a16961b82bb1c661845b14c88b4e80dc3">SHAMap::leafDepth</a>)</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; Throw&lt;std::logic_error&gt;(</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160; <span class="stringliteral">&quot;Request for child node ID of &quot;</span> + <a class="code" href="namespaceripple.html#af9776f187d3686a7fba4c2d2fbeebdf4">to_string</a>(*<span class="keyword">this</span>));</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a> != (<a class="code" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a> &amp; <a class="code" href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168">depthMask</a>(<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a>)))</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; Throw&lt;std::logic_error&gt;(<span class="stringliteral">&quot;Incorrect mask for &quot;</span> + <a class="code" href="namespaceripple.html#af9776f187d3686a7fba4c2d2fbeebdf4">to_string</a>(*<span class="keyword">this</span>));</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; </div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; <a class="code" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> node{<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> + 1, <a class="code" href="classripple_1_1SHAMapNodeID.html#a7cff46032ca875e7f9beaeade09e1c9f">id_</a>};</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; node.id_.<a class="code" href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">begin</a>()[<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> / 2] |= (<a class="code" href="classripple_1_1SHAMapNodeID.html#aea1b5520b7d49f8dd05211bbec6465eb">depth_</a> &amp; 1) ? m : (m &lt;&lt; 4);</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">return</span> node;</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160;}</div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; </div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;[[nodiscard]] <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;SHAMapNodeID&gt;</a></div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="namespaceripple.html#a2f08d50eaefe0b52afe21deac6048746"> 101</a></span>&#160;<a class="code" href="namespaceripple.html#a2f08d50eaefe0b52afe21deac6048746">deserializeSHAMapNodeID</a>(<span class="keywordtype">void</span> <span class="keyword">const</span>* data, <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> size)</div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;{</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;SHAMapNodeID&gt;</a> ret;</div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; </div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; <span class="keywordflow">if</span> (size == 33)</div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; {</div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> depth = *(<span class="keyword">static_cast&lt;</span><span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> const*<span class="keyword">&gt;</span>(data) + 32);</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; <span class="keywordflow">if</span> (depth &lt;= <a class="code" href="classripple_1_1SHAMap.html#a16961b82bb1c661845b14c88b4e80dc3">SHAMap::leafDepth</a>)</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; {</div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> <span class="keywordtype">id</span> = <a class="code" href="classripple_1_1base__uint.html#a4e9de7a706374a3d016b89c9ecb4f80d">uint256::fromVoid</a>(data);</div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; </div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; <span class="keywordflow">if</span> (<span class="keywordtype">id</span> == (<span class="keywordtype">id</span> &amp; <a class="code" href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168">depthMask</a>(depth)))</div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160; ret.<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional/emplace.html">emplace</a>(depth, <span class="keywordtype">id</span>);</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160; }</div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>&#160; }</div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>&#160; </div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span>&#160; <span class="keywordflow">return</span> ret;</div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>&#160;}</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>&#160; </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>&#160;[[nodiscard]] <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="line" href="namespaceripple.html#a179c66641961c1b976e7c050860064a3"> 121</a></span>&#160;<a class="code" href="namespaceripple.html#a179c66641961c1b976e7c050860064a3">selectBranch</a>(<a class="code" href="classripple_1_1SHAMapNodeID.html">SHAMapNodeID</a> <span class="keyword">const</span>&amp; <span class="keywordtype">id</span>, <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; hash)</div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;{</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> depth = <span class="keywordtype">id</span>.getDepth();</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">auto</span> branch = <span class="keyword">static_cast&lt;</span><span class="keywordtype">unsigned</span> <span class="keywordtype">int</span><span class="keyword">&gt;</span>(*(hash.<a class="code" href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">begin</a>() + (depth / 2)));</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; </div>
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keywordflow">if</span> (depth &amp; 1)</div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; branch &amp;= 0xf;</div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; <span class="keywordflow">else</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; branch &gt;&gt;= 4;</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; </div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; assert(branch &lt; <a class="code" href="classripple_1_1SHAMap.html#af8599964238eb94d795606f220654db9">SHAMap::branchFactor</a>);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; <span class="keywordflow">return</span> branch;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;}</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160; </div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;SHAMapNodeID</div>
<div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="classripple_1_1SHAMapNodeID.html#a9ff9dfe2cb92d0b3d5a52ad6e3541416"> 136</a></span>&#160;<a class="code" href="classripple_1_1SHAMapNodeID.html#a9ff9dfe2cb92d0b3d5a52ad6e3541416">SHAMapNodeID::createID</a>(<span class="keywordtype">int</span> depth, <a class="code" href="classripple_1_1base__uint.html">uint256</a> <span class="keyword">const</span>&amp; key)</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>&#160;{</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>&#160; assert((depth &gt;= 0) &amp;&amp; (depth &lt; 65));</div>
<div class="line"><a name="l00139"></a><span class="lineno"> 139</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classripple_1_1SHAMapNodeID.html#ab778be2116f66638981a7e9c0dd9ac6b">SHAMapNodeID</a>(depth, key &amp; <a class="code" href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168">depthMask</a>(depth));</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160;}</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160;} <span class="comment">// namespace ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1SHAMap_html_af8599964238eb94d795606f220654db9"><div class="ttname"><a href="classripple_1_1SHAMap.html#af8599964238eb94d795606f220654db9">ripple::SHAMap::branchFactor</a></div><div class="ttdeci">static constexpr unsigned int branchFactor</div><div class="ttdoc">Number of children each non-leaf node has (the 'radix tree' part of the map)</div><div class="ttdef"><b>Definition:</b> <a href="SHAMap_8h_source.html#l00116">SHAMap.h:116</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#l00074">SHAMapNodeID.cpp:74</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 class="ttdoc">STL class.</div></div>
<div class="ttc" id="anamespaceripple_html_a179c66641961c1b976e7c050860064a3"><div class="ttname"><a href="namespaceripple.html#a179c66641961c1b976e7c050860064a3">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#l00121">SHAMapNodeID.cpp:121</a></div></div>
<div class="ttc" id="anamespaceripple_html_a2f08d50eaefe0b52afe21deac6048746"><div class="ttname"><a href="namespaceripple.html#a2f08d50eaefe0b52afe21deac6048746">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#l00101">SHAMapNodeID.cpp:101</a></div></div>
<div class="ttc" id="aclassripple_1_1Serializer_html_afb9f001046e4767db6780bbee86d93c3"><div class="ttname"><a href="classripple_1_1Serializer.html#afb9f001046e4767db6780bbee86d93c3">ripple::Serializer::getString</a></div><div class="ttdeci">std::string getString() const</div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8h_source.html#l00204">Serializer.h:204</a></div></div>
<div class="ttc" id="aclassripple_1_1Serializer_html_ab6de064efbc9b2efaeff2b069a02b644"><div class="ttname"><a href="classripple_1_1Serializer.html#ab6de064efbc9b2efaeff2b069a02b644">ripple::Serializer::add8</a></div><div class="ttdeci">int add8(unsigned char i)</div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8cpp_source.html#l00166">Serializer.cpp:166</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#l00036">SHAMapNodeID.h:36</a></div></div>
<div class="ttc" id="aemplace_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional/emplace.html">std::optional::emplace</a></div><div class="ttdeci">T emplace(T... args)</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#l00033">SHAMapNodeID.h:33</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#l00526">base_uint.h:526</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_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint</a></div><div class="ttdoc">Integers of any length that is a multiple of 32-bits.</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00074">base_uint.h:74</a></div></div>
<div class="ttc" id="anamespaceripple_html_acd47ea998572e5b479a48cdbb088d168"><div class="ttname"><a href="namespaceripple.html#acd47ea998572e5b479a48cdbb088d168">ripple::depthMask</a></div><div class="ttdeci">static uint256 const &amp; depthMask(unsigned int depth)</div><div class="ttdef"><b>Definition:</b> <a href="SHAMapNodeID_8cpp_source.html#l00030">SHAMapNodeID.cpp:30</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#l00065">SHAMapNodeID.cpp:65</a></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#l00037">SHAMapNodeID.h:37</a></div></div>
<div class="ttc" id="aclassripple_1_1Serializer_html"><div class="ttname"><a href="classripple_1_1Serializer.html">ripple::Serializer</a></div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8h_source.html#l00039">Serializer.h:39</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
<div class="ttc" id="aclassripple_1_1Serializer_html_a96daec54ca0c8ec7f6e7e683e9abbe0e"><div class="ttname"><a href="classripple_1_1Serializer.html#a96daec54ca0c8ec7f6e7e683e9abbe0e">ripple::Serializer::addBitString</a></div><div class="ttdeci">int addBitString(base_uint&lt; Bits, Tag &gt; const &amp;v)</div><div class="ttdef"><b>Definition:</b> <a href="Serializer_8h_source.html#l00097">Serializer.h:97</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html_a2ffd09234d574e5554c5d84199a9f287"><div class="ttname"><a href="classripple_1_1base__uint.html#a2ffd09234d574e5554c5d84199a9f287">ripple::base_uint::begin</a></div><div class="ttdeci">iterator begin()</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00125">base_uint.h:125</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html_a4e9de7a706374a3d016b89c9ecb4f80d"><div class="ttname"><a href="classripple_1_1base__uint.html#a4e9de7a706374a3d016b89c9ecb4f80d">ripple::base_uint&lt; 256 &gt;::fromVoid</a></div><div class="ttdeci">static base_uint fromVoid(void const *data)</div><div class="ttdef"><b>Definition:</b> <a href="base__uint_8h_source.html#l00311">base_uint.h:311</a></div></div>
<div class="ttc" id="acassert_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a></div></div>
<div class="ttc" id="aclassripple_1_1SHAMap_html_a16961b82bb1c661845b14c88b4e80dc3"><div class="ttname"><a href="classripple_1_1SHAMap.html#a16961b82bb1c661845b14c88b4e80dc3">ripple::SHAMap::leafDepth</a></div><div class="ttdeci">static constexpr unsigned int leafDepth</div><div class="ttdoc">The depth of the hash map: data is only present in the leaves.</div><div class="ttdef"><b>Definition:</b> <a href="SHAMap_8h_source.html#l00120">SHAMap.h:120</a></div></div>
<div class="ttc" id="aoptional_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a></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="anamespaceripple_html_af9776f187d3686a7fba4c2d2fbeebdf4"><div class="ttname"><a href="namespaceripple.html#af9776f187d3686a7fba4c2d2fbeebdf4">ripple::to_string</a></div><div class="ttdeci">std::string to_string(Manifest const &amp;m)</div><div class="ttdoc">Format the specified manifest to a string for debugging purposes.</div><div class="ttdef"><b>Definition:</b> <a href="app_2misc_2impl_2Manifest_8cpp_source.html#l00038">app/misc/impl/Manifest.cpp:38</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#l00136">SHAMapNodeID.cpp:136</a></div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>