ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-21 03:26:01 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/RippleCalc_8h_source.html
bthomee 099ba7da4d deploy: dc8b37a524
2025-09-18 08:15:26 -07:00

254 lines
36 KiB
HTML
Raw Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: RippleCalc.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 id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<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_a62226f9e3a6c7c5a3be455e2f87ae01.html">xrpld</a></li><li class="navelem"><a class="el" href="dir_c69db3203fa08a9ff994909ba6ee9783.html">app</a></li><li class="navelem"><a class="el" href="dir_a6d14a898e5042b88feceb06bece5732.html">paths</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">RippleCalc.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) 2012, 2013 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">#ifndef RIPPLE_APP_PATHS_RIPPLECALC_H_INCLUDED</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#define RIPPLE_APP_PATHS_RIPPLECALC_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 &lt;xrpl/basics/Log.h&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;xrpl/ledger/PaymentSandbox.h&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;xrpl/protocol/STAmount.h&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include &lt;xrpl/protocol/TER.h&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="preprocessor">#include &lt;boost/container/flat_set.hpp&gt;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceripple.html">ripple</a> {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">class </span>Config;</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="keyword">namespace </span>path {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="keyword">namespace </span>detail {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">struct </span>FlowDebugInfo;</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span>}</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="foldopen" id="foldopen00043" data-start="{" data-end="};">
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="classripple_1_1path_1_1RippleCalc.html"> 43</a></span><span class="keyword">class </span><a class="code hl_class" href="classripple_1_1path_1_1RippleCalc.html">RippleCalc</a></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><span class="keyword">public</span>:</div>
<div class="foldopen" id="foldopen00046" data-start="{" data-end="};">
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Input.html"> 46</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1path_1_1RippleCalc_1_1Input.html">Input</a></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"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a8a1b7d1f0d6b237c0906b0ac777022ac"> 48</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a8a1b7d1f0d6b237c0906b0ac777022ac">Input</a>() = <span class="keywordflow">default</span>;</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"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a6f79984cb663abdbeb7723f9a8d27895"> 50</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a6f79984cb663abdbeb7723f9a8d27895">partialPaymentAllowed</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a5913b8a574634a704a8359529c5deff9"> 51</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a5913b8a574634a704a8359529c5deff9">defaultPathsAllowed</a> = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#ae29bd31fd5f430c171b84071584f310f"> 52</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#ae29bd31fd5f430c171b84071584f310f">limitQuality</a> = <span class="keyword">false</span>;</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#af4ffb41f82dc83812f388dc0fc111c2e"> 53</a></span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Input.html#af4ffb41f82dc83812f388dc0fc111c2e">isLedgerOpen</a> = <span class="keyword">true</span>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> };</div>
</div>
<div class="foldopen" id="foldopen00055" data-start="{" data-end="};">
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html"> 55</a></span> <span class="keyword">struct </span><a class="code hl_struct" href="structripple_1_1path_1_1RippleCalc_1_1Output.html">Output</a></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> {</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a3225ab1eaadd5816c9d4a7d3908219e7"> 57</a></span> <span class="keyword">explicit</span> <a class="code hl_function" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a3225ab1eaadd5816c9d4a7d3908219e7">Output</a>() = <span class="keywordflow">default</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">// The computed input amount.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#aa0308a8f67f3c3eb723803459b46d1e6"> 60</a></span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#aa0308a8f67f3c3eb723803459b46d1e6">actualAmountIn</a>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> <span class="comment">// The computed output amount.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a4bb53c6084caa799ffbd574c13d13ed8"> 63</a></span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a4bb53c6084caa799ffbd574c13d13ed8">actualAmountOut</a>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> <span class="comment">// Collection of offers found expired or unfunded. When a payment</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// succeeds, unfunded and expired offers are removed. When a payment</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> <span class="comment">// fails, they are not removed. This vector contains the offers that</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span> <span class="comment">// could have been removed but were not because the payment fails. It is</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> <span class="comment">// useful for offer crossing, which does remove the offers.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a7910c82102d9b9ecd4d345f7579278d1"> 70</a></span> boost::container::flat_set&lt;uint256&gt; <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a7910c82102d9b9ecd4d345f7579278d1">removableOffers</a>;</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a1497da2426690d3e28266ffad4fa6d8c"> 73</a></span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a1497da2426690d3e28266ffad4fa6d8c">calculationResult_</a> = <a class="code hl_enumvalue" href="namespaceripple.html#afe21c8454670d46fb93751a5edffed46a1dad6e2d630423dd67f4a540305f8b3c">temUNKNOWN</a>;</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> <a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a></div>
<div class="foldopen" id="foldopen00077" data-start="{" data-end="}">
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a94945b6df065d61d3463e87281900fce"> 77</a></span> <a class="code hl_function" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a94945b6df065d61d3463e87281900fce">result</a>()<span class="keyword"> const</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> <span class="keywordflow">return</span> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a1497da2426690d3e28266ffad4fa6d8c">calculationResult_</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> }</div>
</div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00082" data-start="{" data-end="}">
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"><a class="line" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#abfb54432dd167403ef7211b513af1e82"> 82</a></span> <a class="code hl_function" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#abfb54432dd167403ef7211b513af1e82">setResult</a>(<a class="code hl_class" href="classripple_1_1TERSubset.html">TER</a> <span class="keyword">const</span> value)</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span> {</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> <a class="code hl_variable" href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a1497da2426690d3e28266ffad4fa6d8c">calculationResult_</a> = value;</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span> }</div>
</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span> };</div>
</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">static</span> Output</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span> <a class="code hl_function" href="classripple_1_1path_1_1RippleCalc.html#acd78cd8714414d4ccf5abf384c8d8d01">rippleCalculate</a>(</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> <a class="code hl_class" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a>&amp; <a class="code hl_variable" href="classripple_1_1path_1_1RippleCalc.html#a0275cba5eec83b3b526f20241c235701">view</a>,</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> <span class="comment">// Compute paths using this ledger entry set. Up to caller to actually</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> <span class="comment">// apply to ledger.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span> </div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span> <span class="comment">// Issuer:</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <span class="comment">// XRP: xrpAccount()</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> <span class="comment">// non-XRP: uSrcAccountID (for any issuer) or another account with</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span> <span class="comment">// trust node.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; saMaxAmountReq, <span class="comment">// --&gt; -1 = no limit.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span> <span class="comment">// Issuer:</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> <span class="comment">// XRP: xrpAccount()</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span> <span class="comment">// non-XRP: uDstAccountID (for any issuer) or another account with</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> <span class="comment">// trust node.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span> <a class="code hl_class" href="classripple_1_1STAmount.html">STAmount</a> <span class="keyword">const</span>&amp; saDstAmountReq,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; uDstAccountID,</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span> <a class="code hl_class" href="classripple_1_1base__uint.html">AccountID</a> <span class="keyword">const</span>&amp; uSrcAccountID,</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <span class="comment">// A set of paths that are included in the transaction that we&#39;ll</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// explore for liquidity.</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span> <a class="code hl_class" href="classripple_1_1STPathSet.html">STPathSet</a> <span class="keyword">const</span>&amp; spsPaths,</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span> <a class="code hl_classRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional&lt;uint256&gt;</a> <span class="keyword">const</span>&amp; domainID,</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> <a class="code hl_class" href="classripple_1_1Logs.html">Logs</a>&amp; l,</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span> Input <span class="keyword">const</span>* <span class="keyword">const</span> pInputs = <span class="keyword">nullptr</span>);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span> <span class="comment">// The view we are currently working on</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="classripple_1_1path_1_1RippleCalc.html#a0275cba5eec83b3b526f20241c235701"> 119</a></span> <a class="code hl_class" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a>&amp; <a class="code hl_variable" href="classripple_1_1path_1_1RippleCalc.html#a0275cba5eec83b3b526f20241c235701">view</a>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span> <span class="comment">// If the transaction fails to meet some constraint, still need to delete</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span> <span class="comment">// unfunded offers in a deterministic order (hence the ordered container).</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span> <span class="comment">//</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span> <span class="comment">// Offers that were found unfunded.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classripple_1_1path_1_1RippleCalc.html#a90eb3b341309d998b79e824689b37623"> 125</a></span> boost::container::flat_set&lt;uint256&gt; <a class="code hl_variable" href="classripple_1_1path_1_1RippleCalc.html#a90eb3b341309d998b79e824689b37623">permanentlyUnfundedOffers_</a>;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span>};</div>
</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span>} <span class="comment">// namespace path</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span>} <span class="comment">// namespace ripple</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aclassripple_1_1Logs_html"><div class="ttname"><a href="classripple_1_1Logs.html">ripple::Logs</a></div><div class="ttdoc">Manages partitions for logging.</div><div class="ttdef"><b>Definition</b> <a href="Log_8h_source.html#l00051">Log.h:52</a></div></div>
<div class="ttc" id="aclassripple_1_1PaymentSandbox_html"><div class="ttname"><a href="classripple_1_1PaymentSandbox.html">ripple::PaymentSandbox</a></div><div class="ttdoc">A wrapper which makes credits unavailable to balances.</div><div class="ttdef"><b>Definition</b> <a href="PaymentSandbox_8h_source.html#l00112">PaymentSandbox.h:113</a></div></div>
<div class="ttc" id="aclassripple_1_1STAmount_html"><div class="ttname"><a href="classripple_1_1STAmount.html">ripple::STAmount</a></div><div class="ttdef"><b>Definition</b> <a href="STAmount_8h_source.html#l00049">STAmount.h:50</a></div></div>
<div class="ttc" id="aclassripple_1_1STPathSet_html"><div class="ttname"><a href="classripple_1_1STPathSet.html">ripple::STPathSet</a></div><div class="ttdef"><b>Definition</b> <a href="STPathSet_8h_source.html#l00177">STPathSet.h:178</a></div></div>
<div class="ttc" id="aclassripple_1_1TERSubset_html"><div class="ttname"><a href="classripple_1_1TERSubset.html">ripple::TERSubset&lt; CanCvtToTER &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1base__uint_html"><div class="ttname"><a href="classripple_1_1base__uint.html">ripple::base_uint&lt; 160, detail::AccountIDTag &gt;</a></div></div>
<div class="ttc" id="aclassripple_1_1path_1_1RippleCalc_html"><div class="ttname"><a href="classripple_1_1path_1_1RippleCalc.html">ripple::path::RippleCalc</a></div><div class="ttdoc">RippleCalc calculates the quality of a payment path.</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00043">RippleCalc.h:44</a></div></div>
<div class="ttc" id="aclassripple_1_1path_1_1RippleCalc_html_a0275cba5eec83b3b526f20241c235701"><div class="ttname"><a href="classripple_1_1path_1_1RippleCalc.html#a0275cba5eec83b3b526f20241c235701">ripple::path::RippleCalc::view</a></div><div class="ttdeci">PaymentSandbox &amp; view</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00119">RippleCalc.h:119</a></div></div>
<div class="ttc" id="aclassripple_1_1path_1_1RippleCalc_html_a90eb3b341309d998b79e824689b37623"><div class="ttname"><a href="classripple_1_1path_1_1RippleCalc.html#a90eb3b341309d998b79e824689b37623">ripple::path::RippleCalc::permanentlyUnfundedOffers_</a></div><div class="ttdeci">boost::container::flat_set&lt; uint256 &gt; permanentlyUnfundedOffers_</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00125">RippleCalc.h:125</a></div></div>
<div class="ttc" id="aclassripple_1_1path_1_1RippleCalc_html_acd78cd8714414d4ccf5abf384c8d8d01"><div class="ttname"><a href="classripple_1_1path_1_1RippleCalc.html#acd78cd8714414d4ccf5abf384c8d8d01">ripple::path::RippleCalc::rippleCalculate</a></div><div class="ttdeci">static Output rippleCalculate(PaymentSandbox &amp;view, STAmount const &amp;saMaxAmountReq, STAmount const &amp;saDstAmountReq, AccountID const &amp;uDstAccountID, AccountID const &amp;uSrcAccountID, STPathSet const &amp;spsPaths, std::optional&lt; uint256 &gt; const &amp;domainID, Logs &amp;l, Input const *const pInputs=nullptr)</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8cpp_source.html#l00032">RippleCalc.cpp:32</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#l00025">algorithm.h:25</a></div></div>
<div class="ttc" id="anamespaceripple_html_afe21c8454670d46fb93751a5edffed46a1dad6e2d630423dd67f4a540305f8b3c"><div class="ttname"><a href="namespaceripple.html#afe21c8454670d46fb93751a5edffed46a1dad6e2d630423dd67f4a540305f8b3c">ripple::temUNKNOWN</a></div><div class="ttdeci">@ temUNKNOWN</div><div class="ttdef"><b>Definition</b> <a href="TER_8h_source.html#l00124">TER.h:124</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="astructripple_1_1path_1_1RippleCalc_1_1Input_html"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Input.html">ripple::path::RippleCalc::Input</a></div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00046">RippleCalc.h:47</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Input_html_a5913b8a574634a704a8359529c5deff9"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a5913b8a574634a704a8359529c5deff9">ripple::path::RippleCalc::Input::defaultPathsAllowed</a></div><div class="ttdeci">bool defaultPathsAllowed</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00051">RippleCalc.h:51</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Input_html_a6f79984cb663abdbeb7723f9a8d27895"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a6f79984cb663abdbeb7723f9a8d27895">ripple::path::RippleCalc::Input::partialPaymentAllowed</a></div><div class="ttdeci">bool partialPaymentAllowed</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00050">RippleCalc.h:50</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Input_html_a8a1b7d1f0d6b237c0906b0ac777022ac"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Input.html#a8a1b7d1f0d6b237c0906b0ac777022ac">ripple::path::RippleCalc::Input::Input</a></div><div class="ttdeci">Input()=default</div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Input_html_ae29bd31fd5f430c171b84071584f310f"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Input.html#ae29bd31fd5f430c171b84071584f310f">ripple::path::RippleCalc::Input::limitQuality</a></div><div class="ttdeci">bool limitQuality</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00052">RippleCalc.h:52</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Input_html_af4ffb41f82dc83812f388dc0fc111c2e"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Input.html#af4ffb41f82dc83812f388dc0fc111c2e">ripple::path::RippleCalc::Input::isLedgerOpen</a></div><div class="ttdeci">bool isLedgerOpen</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00053">RippleCalc.h:53</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html">ripple::path::RippleCalc::Output</a></div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00055">RippleCalc.h:56</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_a1497da2426690d3e28266ffad4fa6d8c"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a1497da2426690d3e28266ffad4fa6d8c">ripple::path::RippleCalc::Output::calculationResult_</a></div><div class="ttdeci">TER calculationResult_</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00073">RippleCalc.h:73</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_a3225ab1eaadd5816c9d4a7d3908219e7"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a3225ab1eaadd5816c9d4a7d3908219e7">ripple::path::RippleCalc::Output::Output</a></div><div class="ttdeci">Output()=default</div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_a4bb53c6084caa799ffbd574c13d13ed8"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a4bb53c6084caa799ffbd574c13d13ed8">ripple::path::RippleCalc::Output::actualAmountOut</a></div><div class="ttdeci">STAmount actualAmountOut</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00063">RippleCalc.h:63</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_a7910c82102d9b9ecd4d345f7579278d1"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a7910c82102d9b9ecd4d345f7579278d1">ripple::path::RippleCalc::Output::removableOffers</a></div><div class="ttdeci">boost::container::flat_set&lt; uint256 &gt; removableOffers</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00070">RippleCalc.h:70</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_a94945b6df065d61d3463e87281900fce"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#a94945b6df065d61d3463e87281900fce">ripple::path::RippleCalc::Output::result</a></div><div class="ttdeci">TER result() const</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00077">RippleCalc.h:77</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_aa0308a8f67f3c3eb723803459b46d1e6"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#aa0308a8f67f3c3eb723803459b46d1e6">ripple::path::RippleCalc::Output::actualAmountIn</a></div><div class="ttdeci">STAmount actualAmountIn</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00060">RippleCalc.h:60</a></div></div>
<div class="ttc" id="astructripple_1_1path_1_1RippleCalc_1_1Output_html_abfb54432dd167403ef7211b513af1e82"><div class="ttname"><a href="structripple_1_1path_1_1RippleCalc_1_1Output.html#abfb54432dd167403ef7211b513af1e82">ripple::path::RippleCalc::Output::setResult</a></div><div class="ttdeci">void setResult(TER const value)</div><div class="ttdef"><b>Definition</b> <a href="RippleCalc_8h_source.html#l00082">RippleCalc.h:82</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink