mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
154 lines
19 KiB
HTML
154 lines
19 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: QualityFunction.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&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&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_1e765e6a8d5970800a535eb2615ec474.html">protocol</a></li><li class="navelem"><a class="el" href="dir_41c387a0f328eeb295307369675c1162.html">impl</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<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> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a 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 name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2023 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a 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 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 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 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 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 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 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 name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/protocol/QualityFunction.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <ripple/protocol/Quality.h></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <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>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f"> 26</a></span> <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>  Quality <span class="keyword">const</span>& quality,</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  <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>  : m_(0), b_(0), quality_(quality)</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> {</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>.rate() <= beast::zero)</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  Throw<std::runtime_error>(<span class="stringliteral">"QualityFunction quality rate is 0."</span>);</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <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> }</div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <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> <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>& qf)</div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <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>  <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>  <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>  <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> }</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  </div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<Number></a></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf"> 46</a></span> <a class="code" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf">QualityFunction::outFromAvgQ</a>(Quality <span class="keyword">const</span>& quality)</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordflow">if</span> (<a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> != 0 && <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>  {</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <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>  <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>  <span class="keywordflow">if</span> (<a class="code" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a> <= 0)</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordflow">return</span> std::nullopt;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <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>  }</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordflow">return</span> std::nullopt;</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> }</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <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 &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< Quality > const & 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< Quality > 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="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< Number > outFromAvgQ(Quality const &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_a1181f04a9151e95b9623d0bb6f46112f"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">ripple::QualityFunction::QualityFunction</a></div><div class="ttdeci">QualityFunction(Quality const &quality, CLOBLikeTag)</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8cpp_source.html#l00026">QualityFunction.cpp:26</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|