mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-22 12:05:53 +00:00
deploy: 1d42c4f6de
This commit is contained in:
bthomee
@@ -81,68 +81,49 @@ $(document).ready(function() { init_codefold(0); });
|
||||
<div class="headertitle"><div class="title">MathUtilities.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 "AS IS" 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 XRPL_BASICS_MATHUTILITIES_H_INCLUDED</span></div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define XRPL_BASICS_MATHUTILITIES_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 <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a>></span></div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a>></span></div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstddef.html">cstddef</a>></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="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keyword">constexpr</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
|
||||
<div class="foldopen" id="foldopen00044" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628"> 44</a></span><a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> count, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> total)</div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>{</div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> assert(total != 0); <span class="comment">// NOTE No XRPL_ASSERT here, because constexpr</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_functionRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a>(count, total) * 100) + total - 1) / total;</div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span>}</div>
|
||||
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#ifndef XRPL_BASICS_MATHUTILITIES_H_INCLUDED</span></div>
|
||||
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="preprocessor">#define XRPL_BASICS_MATHUTILITIES_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 <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</a>></span></div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cassert.html">cassert</a>></span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <<a class="codeRef" href="http://en.cppreference.com/w/cpp/header/cstddef.html">cstddef</a>></span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">constexpr</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a></div>
|
||||
<div class="foldopen" id="foldopen00025" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"><a class="line" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628"> 25</a></span><a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(<a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> count, <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/types/size_t.html">std::size_t</a> total)</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> assert(total != 0); <span class="comment">// NOTE No XRPL_ASSERT here, because constexpr</span></div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <span class="keywordflow">return</span> ((<a class="code hl_functionRef" href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a>(count, total) * 100) + total - 1) / total;</div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</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><span class="comment">// unit tests</span></div>
|
||||
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 2) == 50);</div>
|
||||
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(0, 100) == 0);</div>
|
||||
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(100, 100) == 100);</div>
|
||||
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(200, 100) == 100);</div>
|
||||
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 100) == 1);</div>
|
||||
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 99) == 2);</div>
|
||||
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(6, 14) == 43);</div>
|
||||
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(29, 33) == 88);</div>
|
||||
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 64) == 2);</div>
|
||||
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(0, 100'000'000) == 0);</div>
|
||||
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 100'000'000) == 1);</div>
|
||||
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(50'000'000, 100'000'000) == 50);</div>
|
||||
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(50'000'001, 100'000'000) == 51);</div>
|
||||
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(99'999'999, 100'000'000) == 100);</div>
|
||||
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div>
|
||||
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>} <span class="comment">// namespace ripple</span></div>
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
||||
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="preprocessor">#endif</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="comment">// unit tests</span></div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 2) == 50);</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(0, 100) == 0);</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(100, 100) == 100);</div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(200, 100) == 100);</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 100) == 1);</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 99) == 2);</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(6, 14) == 43);</div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(29, 33) == 88);</div>
|
||||
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 64) == 2);</div>
|
||||
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(0, 100'000'000) == 0);</div>
|
||||
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(1, 100'000'000) == 1);</div>
|
||||
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(50'000'000, 100'000'000) == 50);</div>
|
||||
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(50'000'001, 100'000'000) == 51);</div>
|
||||
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="keyword">static_assert</span>(<a class="code hl_function" href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">calculatePercent</a>(99'999'999, 100'000'000) == 100);</div>
|
||||
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
|
||||
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>} <span class="comment">// namespace ripple</span></div>
|
||||
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
|
||||
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="aalgorithm_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/algorithm.html">algorithm</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="acstddef_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/header/cstddef.html">cstddef</a></div></div>
|
||||
<div class="ttc" id="amin_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/algorithm/min.html">std::min</a></div><div class="ttdeci">T min(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#l00025">algorithm.h:25</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_html_a80033fe071280d537dbd79e19ba5b628"><div class="ttname"><a href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">ripple::calculatePercent</a></div><div class="ttdeci">constexpr std::size_t calculatePercent(std::size_t count, std::size_t total)</div><div class="ttdoc">Calculate one number divided by another number in percentage.</div><div class="ttdef"><b>Definition</b> <a href="MathUtilities_8h_source.html#l00044">MathUtilities.h:44</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#l00006">algorithm.h:6</a></div></div>
|
||||
<div class="ttc" id="anamespaceripple_html_a80033fe071280d537dbd79e19ba5b628"><div class="ttname"><a href="namespaceripple.html#a80033fe071280d537dbd79e19ba5b628">ripple::calculatePercent</a></div><div class="ttdeci">constexpr std::size_t calculatePercent(std::size_t count, std::size_t total)</div><div class="ttdoc">Calculate one number divided by another number in percentage.</div><div class="ttdef"><b>Definition</b> <a href="MathUtilities_8h_source.html#l00025">MathUtilities.h:25</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><!-- fragment --></div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
|
||||
Reference in New Issue
Block a user