mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
187 lines
24 KiB
HTML
187 lines
24 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.h Source File</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr 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> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">QualityFunction.h</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">#ifndef RIPPLE_PROTOCOL_QUALITYFUNCTION_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RIPPLE_PROTOCOL_QUALITYFUNCTION_H_INCLUDED</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <ripple/basics/Number.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <ripple/protocol/AMMCore.h></span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#include <ripple/protocol/Quality.h></span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <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>  </div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> {</div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// slope</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984"> 43</a></span>  <a class="code" href="classripple_1_1Number.html">Number</a> <a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a>;</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// intercept</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08"> 45</a></span>  <a class="code" href="classripple_1_1Number.html">Number</a> <a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a>;</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// seated if QF is for CLOB offer.</span></div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782"> 47</a></span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<Quality></a> <a class="code" href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">quality_</a>;</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="structripple_1_1QualityFunction_1_1AMMTag.html"> 50</a></span>  <span class="keyword">struct </span><a class="code" href="structripple_1_1QualityFunction_1_1AMMTag.html">AMMTag</a></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  };</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// AMMOffer for multi-path is like CLOB, i.e. the offer size</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="comment">// changes proportionally to its quality.</span></div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html"> 55</a></span>  <span class="keyword">struct </span><a class="code" href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">CLOBLikeTag</a></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  {</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>  <a class="code" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">QualityFunction</a>(Quality <span class="keyword">const</span>& <a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>, <a class="code" href="structripple_1_1QualityFunction_1_1CLOBLikeTag.html">CLOBLikeTag</a>);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keyword">template</span> <<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <a class="code" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">QualityFunction</a>(</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  TAmounts<TIn, TOut> <span class="keyword">const</span>& amounts,</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> tfee,</div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="structripple_1_1QualityFunction_1_1AMMTag.html">AMMTag</a>);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="keywordtype">void</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classripple_1_1QualityFunction.html#a28c3d3568895b2d298d63e7eee762f9c">combine</a>(<a class="code" href="classripple_1_1QualityFunction.html">QualityFunction</a> <span class="keyword">const</span>& qf);</div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<Number></a></div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <a class="code" href="classripple_1_1QualityFunction.html#a48da83ac9d139706dcfaede652659acf">outFromAvgQ</a>(Quality <span class="keyword">const</span>& <a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>);</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a8a6f3553933868eb461533bac1e3f38c"> 80</a></span>  <a class="code" href="classripple_1_1QualityFunction.html#a8a6f3553933868eb461533bac1e3f38c">isConst</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">quality_</a>.<a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional/operator_bool.html">has_value</a>();</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  }</div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  </div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional<Quality></a> <span class="keyword">const</span>&</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662"> 86</a></span>  <a class="code" href="classripple_1_1QualityFunction.html#a63696fcfb25d3f9599f3218486eab662">quality</a>()<span class="keyword"> const</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="keywordflow">return</span> <a class="code" href="classripple_1_1QualityFunction.html#a9a0953a198324da77958230e8adbf782">quality_</a>;</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  }</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> };</div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">template</span> <<span class="keyword">typename</span> TIn, <span class="keyword">typename</span> TOut></div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="classripple_1_1QualityFunction.html#ae0d816120fb0edd3bb1182e12ed4742b"> 93</a></span> <a class="code" href="classripple_1_1QualityFunction.html#a1181f04a9151e95b9623d0bb6f46112f">QualityFunction::QualityFunction</a>(</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  TAmounts<TIn, TOut> <span class="keyword">const</span>& amounts,</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <a class="codeRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> tfee,</div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <a class="code" href="structripple_1_1QualityFunction_1_1AMMTag.html">QualityFunction::AMMTag</a>)</div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> {</div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">if</span> (amounts.in <= beast::zero || amounts.out <= beast::zero)</div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  Throw<std::runtime_error>(<span class="stringliteral">"QualityFunction amounts are 0."</span>);</div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <a class="code" href="classripple_1_1Number.html">Number</a> <span class="keyword">const</span> cfee = <a class="code" href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">feeMult</a>(tfee);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <a class="code" href="classripple_1_1QualityFunction.html#a8f7acaac0d3f24deda88254203d11984">m_</a> = -cfee / amounts.in;</div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <a class="code" href="classripple_1_1QualityFunction.html#a53f281d3cd2bc54f2e7f7ad9e8eaee08">b_</a> = amounts.out * cfee / amounts.in;</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> }</div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  </div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> } <span class="comment">// namespace ripple</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="preprocessor">#endif // RIPPLE_PROTOCOL_QUALITYFUNCTION_H_INCLUDED</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aoperator_bool_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/utility/optional/operator_bool.html">std::optional::has_value</a></div><div class="ttdeci">T has_value(T... args)</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="anamespaceripple_html_a7894756905fee556c1541cd1de1f697a"><div class="ttname"><a href="namespaceripple.html#a7894756905fee556c1541cd1de1f697a">ripple::feeMult</a></div><div class="ttdeci">Number feeMult(std::uint16_t tfee)</div><div class="ttdoc">Get fee multiplier (1 - tfee) @tfee trading fee in basis points.</div><div class="ttdef"><b>Definition:</b> <a href="AMMCore_8h_source.html#l00118">AMMCore.h:118</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="astructripple_1_1QualityFunction_1_1AMMTag_html"><div class="ttname"><a href="structripple_1_1QualityFunction_1_1AMMTag.html">ripple::QualityFunction::AMMTag</a></div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00050">QualityFunction.h:50</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1Number_html"><div class="ttname"><a href="classripple_1_1Number.html">ripple::Number</a></div><div class="ttdef"><b>Definition:</b> <a href="Number_8h_source.html#l00036">Number.h:36</a></div></div>
|
|
<div class="ttc" id="ainteger_html"><div class="ttname"><a href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1QualityFunction_html_a8a6f3553933868eb461533bac1e3f38c"><div class="ttname"><a href="classripple_1_1QualityFunction.html#a8a6f3553933868eb461533bac1e3f38c">ripple::QualityFunction::isConst</a></div><div class="ttdeci">bool isConst() const</div><div class="ttdoc">Return true if the quality function is constant.</div><div class="ttdef"><b>Definition:</b> <a href="QualityFunction_8h_source.html#l00080">QualityFunction.h:80</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< Quality ></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>
|