ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-22 03:55:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

deploy: eac3abdca9

Browse Source
This commit is contained in:
bthomee
2025-01-21 19:58:08 +00:00
parent 8b38c076f5
commit e61ca37029
15549 changed files with 1163583 additions and 908656 deletions
Download Patch File Download Diff File Expand all files Collapse all files

188
QualityFunction_8cpp_source.html
View File

@@ -1,9 +1,9 @@
<!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">
<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=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: QualityFunction.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,8 +19,8 @@
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
@@ -29,21 +29,22 @@
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<!-- Generated by Doxygen 1.9.5 -->
<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 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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
/* @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>
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
@@ -54,100 +55,105 @@ $(function() {
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
<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_df9c78dcf3f59a33b12284f95992a64b.html">ripple</a></li><li class="navelem"><a class="el" href="dir_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li><li class="navelem"><a class="el" href="dir_41c387a0f328eeb295307369675c1162.html">impl</a></li> </ul>
<li class="navelem"><a class="el" href="dir_90ffdbabf412cfdffe6b2193e0ce938a.html">libxrpl</a></li><li class="navelem"><a class="el" href="dir_4cb643486f27a568a0d40f174f670f35.html">protocol</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">QualityFunction.cpp</div> </div>
<div class="headertitle"><div class="title">QualityFunction.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) 2023 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/protocol/QualityFunction.h&gt;</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160; </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#include &lt;ripple/protocol/Quality.h&gt;</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; </div>
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f"> 26</a></span>&#160;<a class="code" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">QualityFunction::QualityFunction</a>(</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160; Quality <span class="keyword">const</span>&amp; quality,</div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160; <a class="code" href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">QualityFunction::CLOBLikeTag</a>)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; : m_(0), b_(0), quality_(quality)</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;{</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>.rate() &lt;= beast::zero)</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160; Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;QualityFunction quality rate is 0.&quot;</span>);</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; <a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> = 1 / <a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>.rate();</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;}</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;<span class="keywordtype">void</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c"> 37</a></span>&#160;<a class="code" href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c">QualityFunction::combine</a>(<a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a> <span class="keyword">const</span>&amp; qf)</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;{</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160; <a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> += <a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> * qf.<a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a>;</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> *= qf.<a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a>;</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> != 0)</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <a class="code" href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">quality_</a> = std::nullopt;</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;}</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;Number&gt;</a></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf"> 46</a></span>&#160;<a class="code" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf">QualityFunction::outFromAvgQ</a>(Quality <span class="keyword">const</span>&amp; quality)</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; <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> != 0 &amp;&amp; <a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>.rate() != beast::zero)</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; <a class="code" href="classripple_1_1saveNumberRoundMode.html">saveNumberRoundMode</a> rm(<a class="code" href="classripple_1_1Number.html#a9f2a0df7ad0f278908643927a19592f2">Number::setround</a>(Number::rounding_mode::upward));</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; <span class="keyword">auto</span> <span class="keyword">const</span> <a class="code" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a> = (1 / <a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>.rate() - <a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a>) / <a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a>;</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; <span class="keywordflow">if</span> (<a class="code" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a> &lt;= 0)</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">return</span> <a class="code" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>;</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="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160; </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;} <span class="comment">// namespace ripple</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a8f7acaac0d3f24deda88254203d11984"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">ripple::QualityFunction::m_</a></div><div class="ttdeci">Number m_</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00043">QualityFunction.h:43</a></div></div>
<div class="ttc" id="aclassripple_1_1saveNumberRoundMode_html"><div class="ttname"><a href="classripple_1_1saveNumberRoundMode.html">ripple::saveNumberRoundMode</a></div><div class="ttdef"><b>Definition:</b> <a href="Number_8h_source.html#l00365">Number.h:365</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a28c3d3568895b2d298d63e7eee762f9c"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c">ripple::QualityFunction::combine</a></div><div class="ttdeci">void combine(QualityFunction const &amp;qf)</div><div class="ttdoc">Combines QF with the next step QF.</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8cpp_source.html#l00037">QualityFunction.cpp:37</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a63696fcfb25d3f9599f3218486eab662"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">ripple::QualityFunction::quality</a></div><div class="ttdeci">std::optional&lt; Quality &gt; const &amp; quality() const</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00086">QualityFunction.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a9a0953a198324da77958230e8adbf782"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">ripple::QualityFunction::quality_</a></div><div class="ttdeci">std::optional&lt; Quality &gt; quality_</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00047">QualityFunction.h:47</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="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) 2023 Ripple Labs Inc.</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"></span> </div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"></span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment">*/</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment">//==============================================================================</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#include &lt;xrpl/protocol/QualityFunction.h&gt;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span><span class="preprocessor">#include &lt;xrpl/protocol/Quality.h&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f"> 26</a></span><a class="code hl_function" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">QualityFunction::QualityFunction</a>(</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> Quality <span class="keyword">const</span>&amp; quality,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_struct" href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">QualityFunction::CLOBLikeTag</a>)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> : m_(0), b_(0), quality_(quality)</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="keywordflow">if</span> (<a class="code hl_function" href="classripple_1_1QualityFunction.html#a50ca81cd33877c37fc89c99bef224f8e">quality</a>.rate() &lt;= beast::zero)</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> Throw&lt;std::runtime_error&gt;(<span class="stringliteral">&quot;QualityFunction quality rate is 0.&quot;</span>);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> = 1 / <a class="code hl_function" href="classripple_1_1QualityFunction.html#a50ca81cd33877c37fc89c99bef224f8e">quality</a>.rate();</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span>}</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span><span class="keywordtype">void</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c"> 37</a></span><a class="code hl_function" href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c">QualityFunction::combine</a>(<a class="code hl_class" href="classripple_1_1QualityFunction.html">QualityFunction</a> <span class="keyword">const</span>&amp; qf)</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span>{</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> += <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> * qf.<a class="code hl_variable" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a>;</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> *= qf.<a class="code hl_variable" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a>;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> != 0)</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">quality_</a> = std::nullopt;</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> </div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;Number&gt;</a></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf"> 46</a></span><a class="code hl_function" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf">QualityFunction::outFromAvgQ</a>(Quality <span class="keyword">const</span>&amp; quality)</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span>{</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> <span class="keywordflow">if</span> (<a class="code hl_variable" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> != 0 &amp;&amp; <a class="code hl_function" href="classripple_1_1QualityFunction.html#a50ca81cd33877c37fc89c99bef224f8e">quality</a>.rate() != beast::zero)</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_1saveNumberRoundMode.html">saveNumberRoundMode</a> rm(<a class="code hl_function" href="classripple_1_1Number.html#a9f2a0df7ad0f278908643927a19592f2">Number::setround</a>(<a class="code hl_enumvalue" href="classripple_1_1Number.html#a33e3d8e7a95979bd1eb22c59703c8534ade4db21da96eedd46544ea52ce11a6f2">Number::rounding_mode::upward</a>));</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keyword">auto</span> <span class="keyword">const</span> <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a> = (1 / <a class="code hl_function" href="classripple_1_1QualityFunction.html#a50ca81cd33877c37fc89c99bef224f8e">quality</a>.rate() - <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a>) / <a class="code hl_variable" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> <span class="keywordflow">if</span> (<a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a> &lt;= 0)</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> <span class="keywordflow">return</span> <a class="code hl_enumvalue" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> }</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> <span class="keywordflow">return</span> std::nullopt;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span>}</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace ripple</span></div>
<div class="ttc" id="aclassripple_1_1Number_html_a33e3d8e7a95979bd1eb22c59703c8534ade4db21da96eedd46544ea52ce11a6f2"><div class="ttname"><a href="classripple_1_1Number.html#a33e3d8e7a95979bd1eb22c59703c8534ade4db21da96eedd46544ea52ce11a6f2">ripple::Number::upward</a></div><div class="ttdeci">@ upward</div><div class="ttdef"><b>Definition:</b> <a href="Number_8h_source.html#l00178">Number.h:178</a></div></div>
<div class="ttc" id="aclassripple_1_1Number_html_a9f2a0df7ad0f278908643927a19592f2"><div class="ttname"><a href="classripple_1_1Number.html#a9f2a0df7ad0f278908643927a19592f2">ripple::Number::setround</a></div><div class="ttdeci">static rounding_mode setround(rounding_mode mode)</div><div class="ttdef"><b>Definition:</b> <a href="Number_8cpp_source.html#l00047">Number.cpp:47</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_1QualityFunction_html"><div class="ttname"><a href="classripple_1_1QualityFunction.html">ripple::QualityFunction</a></div><div class="ttdoc">Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00039">QualityFunction.h:39</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="aclassripple_1_1QualityFunction_html_a48da83ac9d139706dcfaede652659acf"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf">ripple::QualityFunction::outFromAvgQ</a></div><div class="ttdeci">std::optional&lt; Number &gt; outFromAvgQ(Quality const &amp;quality)</div><div class="ttdoc">Find output to produce the requested average quality.</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8cpp_source.html#l00046">QualityFunction.cpp:46</a></div></div>
<div class="ttc" id="astructripple_1_1QualityFunction_1_1CLOBLikeTag_html"><div class="ttname"><a href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">ripple::QualityFunction::CLOBLikeTag</a></div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00055">QualityFunction.h:55</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a53f281d3cd2bc54f2e7f7ad9e8eaee08"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">ripple::QualityFunction::b_</a></div><div class="ttdeci">Number b_</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00045">QualityFunction.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html"><div class="ttname"><a href="classripple_1_1QualityFunction.html">ripple::QualityFunction</a></div><div class="ttdoc">Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00039">QualityFunction.h:40</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a1181f04a9151e95b9623d0bb6f46112f"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">ripple::QualityFunction::QualityFunction</a></div><div class="ttdeci">QualityFunction(Quality const &amp;quality, CLOBLikeTag)</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8cpp_source.html#l00026">QualityFunction.cpp:26</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a28c3d3568895b2d298d63e7eee762f9c"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c">ripple::QualityFunction::combine</a></div><div class="ttdeci">void combine(QualityFunction const &amp;qf)</div><div class="ttdoc">Combines QF with the next step QF.</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8cpp_source.html#l00037">QualityFunction.cpp:37</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a48da83ac9d139706dcfaede652659acf"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf">ripple::QualityFunction::outFromAvgQ</a></div><div class="ttdeci">std::optional&lt; Number &gt; outFromAvgQ(Quality const &amp;quality)</div><div class="ttdoc">Find output to produce the requested average quality.</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8cpp_source.html#l00046">QualityFunction.cpp:46</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a50ca81cd33877c37fc89c99bef224f8e"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a50ca81cd33877c37fc89c99bef224f8e">ripple::QualityFunction::quality</a></div><div class="ttdeci">std::optional&lt; Quality &gt; const &amp; quality() const</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00086">QualityFunction.h:86</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a53f281d3cd2bc54f2e7f7ad9e8eaee08"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">ripple::QualityFunction::b_</a></div><div class="ttdeci">Number b_</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00045">QualityFunction.h:45</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a8f7acaac0d3f24deda88254203d11984"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">ripple::QualityFunction::m_</a></div><div class="ttdeci">Number m_</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00043">QualityFunction.h:43</a></div></div>
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a9a0953a198324da77958230e8adbf782"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">ripple::QualityFunction::quality_</a></div><div class="ttdeci">std::optional&lt; Quality &gt; quality_</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00047">QualityFunction.h:47</a></div></div>
<div class="ttc" id="aclassripple_1_1saveNumberRoundMode_html"><div class="ttname"><a href="classripple_1_1saveNumberRoundMode.html">ripple::saveNumberRoundMode</a></div><div class="ttdef"><b>Definition:</b> <a href="Number_8h_source.html#l00370">Number.h:371</a></div></div>
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition:</b> <a href="algorithm_8h_source.html#l00026">algorithm.h:26</a></div></div>
<div class="ttc" id="anamespaceripple_html_a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275"><div class="ttname"><a href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">ripple::QualityDirection::out</a></div><div class="ttdeci">@ out</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="astructripple_1_1QualityFunction_1_1CLOBLikeTag_html"><div class="ttname"><a href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">ripple::QualityFunction::CLOBLikeTag</a></div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00055">QualityFunction.h:56</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- 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
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>