mirror of
https://github.com/XRPLF/rippled.git
synced 2025-12-06 17:27:55 +00:00
deploy: afc05659ed
This commit is contained in:
bthomee
@@ -3,7 +3,7 @@
|
||||
<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.5"/>
|
||||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>rippled: ripple::Step Class Reference</title>
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||||
@@ -29,7 +29,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.9.5 -->
|
||||
<!-- Generated by Doxygen 1.9.8 -->
|
||||
<script type="text/javascript">
|
||||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||||
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
||||
@@ -89,84 +89,84 @@ $(function() {
|
||||
<table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
||||
Public Member Functions</h2></td></tr>
|
||||
<tr class="memitem:a44775ea2303695696046b0e44e436f89"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a44775ea2303695696046b0e44e436f89">~Step</a> ()=default</td></tr>
|
||||
<tr class="memitem:a44775ea2303695696046b0e44e436f89" id="r_a44775ea2303695696046b0e44e436f89"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a44775ea2303695696046b0e44e436f89">~Step</a> ()=default</td></tr>
|
||||
<tr class="separator:a44775ea2303695696046b0e44e436f89"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a71de903b6964caebc060a376b080dc75"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a>, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a71de903b6964caebc060a376b080dc75">rev</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &sb, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &afView, boost::container::flat_set< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> > &ofrsToRm, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>)=0</td></tr>
|
||||
<tr class="memdesc:a71de903b6964caebc060a376b080dc75"><td class="mdescLeft"> </td><td class="mdescRight">Find the amount we need to put into the step to get the requested out subject to liquidity limits. <a href="classripple_1_1Step.html#a71de903b6964caebc060a376b080dc75">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a71de903b6964caebc060a376b080dc75" id="r_a71de903b6964caebc060a376b080dc75"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a>, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a71de903b6964caebc060a376b080dc75">rev</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &sb, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &afView, boost::container::flat_set< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> > &ofrsToRm, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>)=0</td></tr>
|
||||
<tr class="memdesc:a71de903b6964caebc060a376b080dc75"><td class="mdescLeft"> </td><td class="mdescRight">Find the amount we need to put into the step to get the requested out subject to liquidity limits. <br /></td></tr>
|
||||
<tr class="separator:a71de903b6964caebc060a376b080dc75"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a64198235a762cf5e94192247ed264531"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a>, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a64198235a762cf5e94192247ed264531">fwd</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &sb, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &afView, boost::container::flat_set< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> > &ofrsToRm, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>)=0</td></tr>
|
||||
<tr class="memdesc:a64198235a762cf5e94192247ed264531"><td class="mdescLeft"> </td><td class="mdescRight">Find the amount we get out of the step given the input subject to liquidity limits. <a href="classripple_1_1Step.html#a64198235a762cf5e94192247ed264531">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a64198235a762cf5e94192247ed264531" id="r_a64198235a762cf5e94192247ed264531"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a>, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a64198235a762cf5e94192247ed264531">fwd</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &sb, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &afView, boost::container::flat_set< <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> > &ofrsToRm, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>)=0</td></tr>
|
||||
<tr class="memdesc:a64198235a762cf5e94192247ed264531"><td class="mdescLeft"> </td><td class="mdescRight">Find the amount we get out of the step given the input subject to liquidity limits. <br /></td></tr>
|
||||
<tr class="separator:a64198235a762cf5e94192247ed264531"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a3d00d0a9c1b059855236d0abc9dddc4b"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a3d00d0a9c1b059855236d0abc9dddc4b">cachedIn</a> () const =0</td></tr>
|
||||
<tr class="memdesc:a3d00d0a9c1b059855236d0abc9dddc4b"><td class="mdescLeft"> </td><td class="mdescRight">Amount of currency computed coming into the <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> the last time the step ran in reverse. <a href="classripple_1_1Step.html#a3d00d0a9c1b059855236d0abc9dddc4b">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a3d00d0a9c1b059855236d0abc9dddc4b" id="r_a3d00d0a9c1b059855236d0abc9dddc4b"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a3d00d0a9c1b059855236d0abc9dddc4b">cachedIn</a> () const =0</td></tr>
|
||||
<tr class="memdesc:a3d00d0a9c1b059855236d0abc9dddc4b"><td class="mdescLeft"> </td><td class="mdescRight">Amount of currency computed coming into the <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> the last time the step ran in reverse. <br /></td></tr>
|
||||
<tr class="separator:a3d00d0a9c1b059855236d0abc9dddc4b"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a4730def99fb03e971f207d4a3cd0af86"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a4730def99fb03e971f207d4a3cd0af86">cachedOut</a> () const =0</td></tr>
|
||||
<tr class="memdesc:a4730def99fb03e971f207d4a3cd0af86"><td class="mdescLeft"> </td><td class="mdescRight">Amount of currency computed coming out of the <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> the last time the step ran in reverse. <a href="classripple_1_1Step.html#a4730def99fb03e971f207d4a3cd0af86">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a4730def99fb03e971f207d4a3cd0af86" id="r_a4730def99fb03e971f207d4a3cd0af86"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a4730def99fb03e971f207d4a3cd0af86">cachedOut</a> () const =0</td></tr>
|
||||
<tr class="memdesc:a4730def99fb03e971f207d4a3cd0af86"><td class="mdescLeft"> </td><td class="mdescRight">Amount of currency computed coming out of the <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a> the last time the step ran in reverse. <br /></td></tr>
|
||||
<tr class="separator:a4730def99fb03e971f207d4a3cd0af86"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af7cae32307ec25a30fcf5a05407f9e8d"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#af7cae32307ec25a30fcf5a05407f9e8d">directStepSrcAcct</a> () const</td></tr>
|
||||
<tr class="memdesc:af7cae32307ec25a30fcf5a05407f9e8d"><td class="mdescLeft"> </td><td class="mdescRight">If this step is <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> (IOU->IOU direct step), return the src account. <a href="classripple_1_1Step.html#af7cae32307ec25a30fcf5a05407f9e8d">More...</a><br /></td></tr>
|
||||
<tr class="memitem:af7cae32307ec25a30fcf5a05407f9e8d" id="r_af7cae32307ec25a30fcf5a05407f9e8d"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#af7cae32307ec25a30fcf5a05407f9e8d">directStepSrcAcct</a> () const</td></tr>
|
||||
<tr class="memdesc:af7cae32307ec25a30fcf5a05407f9e8d"><td class="mdescLeft"> </td><td class="mdescRight">If this step is <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> (IOU->IOU direct step), return the src account. <br /></td></tr>
|
||||
<tr class="separator:af7cae32307ec25a30fcf5a05407f9e8d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:aa127ef6673dfd3325d0c5b3b04357249"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#aa127ef6673dfd3325d0c5b3b04357249">directStepAccts</a> () const</td></tr>
|
||||
<tr class="memitem:aa127ef6673dfd3325d0c5b3b04357249" id="r_aa127ef6673dfd3325d0c5b3b04357249"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#aa127ef6673dfd3325d0c5b3b04357249">directStepAccts</a> () const</td></tr>
|
||||
<tr class="separator:aa127ef6673dfd3325d0c5b3b04357249"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a13f46801cf68bd4ba5e0c995db490463"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a13f46801cf68bd4ba5e0c995db490463">debtDirection</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &sb, <a class="el" href="namespaceripple.html#a2fca0f72cfacc04d15ad41d84ebf46fd">StrandDirection</a> dir) const =0</td></tr>
|
||||
<tr class="memdesc:a13f46801cf68bd4ba5e0c995db490463"><td class="mdescLeft"> </td><td class="mdescRight">If this step is a <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> and the src redeems to the dst, return true, otherwise return false. <a href="classripple_1_1Step.html#a13f46801cf68bd4ba5e0c995db490463">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a13f46801cf68bd4ba5e0c995db490463" id="r_a13f46801cf68bd4ba5e0c995db490463"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a13f46801cf68bd4ba5e0c995db490463">debtDirection</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &sb, <a class="el" href="namespaceripple.html#a2fca0f72cfacc04d15ad41d84ebf46fd">StrandDirection</a> dir) const =0</td></tr>
|
||||
<tr class="memdesc:a13f46801cf68bd4ba5e0c995db490463"><td class="mdescLeft"> </td><td class="mdescRight">If this step is a <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> and the src redeems to the dst, return true, otherwise return false. <br /></td></tr>
|
||||
<tr class="separator:a13f46801cf68bd4ba5e0c995db490463"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a08d02c3dc700867a12c2772267918bac"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a08d02c3dc700867a12c2772267918bac">lineQualityIn</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &) const</td></tr>
|
||||
<tr class="memdesc:a08d02c3dc700867a12c2772267918bac"><td class="mdescLeft"> </td><td class="mdescRight">If this step is a <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a>, return the quality in of the dst account. <a href="classripple_1_1Step.html#a08d02c3dc700867a12c2772267918bac">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a08d02c3dc700867a12c2772267918bac" id="r_a08d02c3dc700867a12c2772267918bac"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a08d02c3dc700867a12c2772267918bac">lineQualityIn</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &) const</td></tr>
|
||||
<tr class="memdesc:a08d02c3dc700867a12c2772267918bac"><td class="mdescLeft"> </td><td class="mdescRight">If this step is a <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a>, return the quality in of the dst account. <br /></td></tr>
|
||||
<tr class="separator:a08d02c3dc700867a12c2772267918bac"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a702aa10aab4edda95b7ec219eeb58754"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< Quality >, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a702aa10aab4edda95b7ec219eeb58754">qualityUpperBound</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &v, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> prevStepDir) const =0</td></tr>
|
||||
<tr class="memdesc:a702aa10aab4edda95b7ec219eeb58754"><td class="mdescLeft"> </td><td class="mdescRight">Find an upper bound of quality for the step. <a href="classripple_1_1Step.html#a702aa10aab4edda95b7ec219eeb58754">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a702aa10aab4edda95b7ec219eeb58754" id="r_a702aa10aab4edda95b7ec219eeb58754"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< Quality >, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a702aa10aab4edda95b7ec219eeb58754">qualityUpperBound</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &v, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> prevStepDir) const =0</td></tr>
|
||||
<tr class="memdesc:a702aa10aab4edda95b7ec219eeb58754"><td class="mdescLeft"> </td><td class="mdescRight">Find an upper bound of quality for the step. <br /></td></tr>
|
||||
<tr class="separator:a702aa10aab4edda95b7ec219eeb58754"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:af49290013e4d3cda54af6433746c2efc"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1QualityFunction.html">QualityFunction</a> >, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#af49290013e4d3cda54af6433746c2efc">getQualityFunc</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &v, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> prevStepDir) const</td></tr>
|
||||
<tr class="memdesc:af49290013e4d3cda54af6433746c2efc"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classripple_1_1QualityFunction.html" title="Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...">QualityFunction</a>. <a href="classripple_1_1Step.html#af49290013e4d3cda54af6433746c2efc">More...</a><br /></td></tr>
|
||||
<tr class="memitem:af49290013e4d3cda54af6433746c2efc" id="r_af49290013e4d3cda54af6433746c2efc"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1QualityFunction.html">QualityFunction</a> >, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#af49290013e4d3cda54af6433746c2efc">getQualityFunc</a> (<a class="el" href="classripple_1_1ReadView.html">ReadView</a> const &v, <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401e">DebtDirection</a> prevStepDir) const</td></tr>
|
||||
<tr class="memdesc:af49290013e4d3cda54af6433746c2efc"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classripple_1_1QualityFunction.html" title="Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...">QualityFunction</a>. <br /></td></tr>
|
||||
<tr class="separator:af49290013e4d3cda54af6433746c2efc"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a8c0b0fb5f0e476dfee59b2a085f34a93"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a8c0b0fb5f0e476dfee59b2a085f34a93">offersUsed</a> () const</td></tr>
|
||||
<tr class="memdesc:a8c0b0fb5f0e476dfee59b2a085f34a93"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of offers consumed or partially consumed the last time the step ran, including expired and unfunded offers. <a href="classripple_1_1Step.html#a8c0b0fb5f0e476dfee59b2a085f34a93">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a8c0b0fb5f0e476dfee59b2a085f34a93" id="r_a8c0b0fb5f0e476dfee59b2a085f34a93"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint32_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a8c0b0fb5f0e476dfee59b2a085f34a93">offersUsed</a> () const</td></tr>
|
||||
<tr class="memdesc:a8c0b0fb5f0e476dfee59b2a085f34a93"><td class="mdescLeft"> </td><td class="mdescRight">Return the number of offers consumed or partially consumed the last time the step ran, including expired and unfunded offers. <br /></td></tr>
|
||||
<tr class="separator:a8c0b0fb5f0e476dfee59b2a085f34a93"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a9d080cfd47f863e9217fb91d25783e23"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1Book.html">Book</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a9d080cfd47f863e9217fb91d25783e23">bookStepBook</a> () const</td></tr>
|
||||
<tr class="memdesc:a9d080cfd47f863e9217fb91d25783e23"><td class="mdescLeft"> </td><td class="mdescRight">If this step is a <a class="el" href="classripple_1_1BookStep.html">BookStep</a>, return the book. <a href="classripple_1_1Step.html#a9d080cfd47f863e9217fb91d25783e23">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a9d080cfd47f863e9217fb91d25783e23" id="r_a9d080cfd47f863e9217fb91d25783e23"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/optional.html">std::optional</a>< <a class="el" href="classripple_1_1Book.html">Book</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a9d080cfd47f863e9217fb91d25783e23">bookStepBook</a> () const</td></tr>
|
||||
<tr class="memdesc:a9d080cfd47f863e9217fb91d25783e23"><td class="mdescLeft"> </td><td class="mdescRight">If this step is a <a class="el" href="classripple_1_1BookStep.html">BookStep</a>, return the book. <br /></td></tr>
|
||||
<tr class="separator:a9d080cfd47f863e9217fb91d25783e23"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a74ef4eb5de8105bf5e2a741755033e53"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a74ef4eb5de8105bf5e2a741755033e53">isZero</a> (<a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>) const =0</td></tr>
|
||||
<tr class="memdesc:a74ef4eb5de8105bf5e2a741755033e53"><td class="mdescLeft"> </td><td class="mdescRight">Check if amount is zero. <a href="classripple_1_1Step.html#a74ef4eb5de8105bf5e2a741755033e53">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a74ef4eb5de8105bf5e2a741755033e53" id="r_a74ef4eb5de8105bf5e2a741755033e53"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a74ef4eb5de8105bf5e2a741755033e53">isZero</a> (<a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569fedac68271a63ddbc431c307beb7d2918275">out</a>) const =0</td></tr>
|
||||
<tr class="memdesc:a74ef4eb5de8105bf5e2a741755033e53"><td class="mdescLeft"> </td><td class="mdescRight">Check if amount is zero. <br /></td></tr>
|
||||
<tr class="separator:a74ef4eb5de8105bf5e2a741755033e53"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a83ed960ee2841965273b821cbad38730"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a83ed960ee2841965273b821cbad38730">inactive</a> () const</td></tr>
|
||||
<tr class="memdesc:a83ed960ee2841965273b821cbad38730"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the step should be considered inactive. <a href="classripple_1_1Step.html#a83ed960ee2841965273b821cbad38730">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a83ed960ee2841965273b821cbad38730" id="r_a83ed960ee2841965273b821cbad38730"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a83ed960ee2841965273b821cbad38730">inactive</a> () const</td></tr>
|
||||
<tr class="memdesc:a83ed960ee2841965273b821cbad38730"><td class="mdescLeft"> </td><td class="mdescRight">Return true if the step should be considered inactive. <br /></td></tr>
|
||||
<tr class="separator:a83ed960ee2841965273b821cbad38730"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a50a0b56fa74b994f927bf5e6aa0f84bb"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a50a0b56fa74b994f927bf5e6aa0f84bb">equalOut</a> (<a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &lhs, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &rhs) const =0</td></tr>
|
||||
<tr class="memdesc:a50a0b56fa74b994f927bf5e6aa0f84bb"><td class="mdescLeft"> </td><td class="mdescRight">Return true if Out of lhs == Out of rhs. <a href="classripple_1_1Step.html#a50a0b56fa74b994f927bf5e6aa0f84bb">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a50a0b56fa74b994f927bf5e6aa0f84bb" id="r_a50a0b56fa74b994f927bf5e6aa0f84bb"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a50a0b56fa74b994f927bf5e6aa0f84bb">equalOut</a> (<a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &lhs, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &rhs) const =0</td></tr>
|
||||
<tr class="memdesc:a50a0b56fa74b994f927bf5e6aa0f84bb"><td class="mdescLeft"> </td><td class="mdescRight">Return true if Out of lhs == Out of rhs. <br /></td></tr>
|
||||
<tr class="separator:a50a0b56fa74b994f927bf5e6aa0f84bb"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ada8c8a1a658fdfa245ae6d8407166bff"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#ada8c8a1a658fdfa245ae6d8407166bff">equalIn</a> (<a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &lhs, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &rhs) const =0</td></tr>
|
||||
<tr class="memdesc:ada8c8a1a658fdfa245ae6d8407166bff"><td class="mdescLeft"> </td><td class="mdescRight">Return true if In of lhs == In of rhs. <a href="classripple_1_1Step.html#ada8c8a1a658fdfa245ae6d8407166bff">More...</a><br /></td></tr>
|
||||
<tr class="memitem:ada8c8a1a658fdfa245ae6d8407166bff" id="r_ada8c8a1a658fdfa245ae6d8407166bff"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#ada8c8a1a658fdfa245ae6d8407166bff">equalIn</a> (<a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &lhs, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &rhs) const =0</td></tr>
|
||||
<tr class="memdesc:ada8c8a1a658fdfa245ae6d8407166bff"><td class="mdescLeft"> </td><td class="mdescRight">Return true if In of lhs == In of rhs. <br /></td></tr>
|
||||
<tr class="separator:ada8c8a1a658fdfa245ae6d8407166bff"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a987daf2049756d3ac5b3eb66344584fe"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< bool, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a987daf2049756d3ac5b3eb66344584fe">validFwd</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &sb, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &afView, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>)=0</td></tr>
|
||||
<tr class="memdesc:a987daf2049756d3ac5b3eb66344584fe"><td class="mdescLeft"> </td><td class="mdescRight">Check that the step can correctly execute in the forward direction. <a href="classripple_1_1Step.html#a987daf2049756d3ac5b3eb66344584fe">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a987daf2049756d3ac5b3eb66344584fe" id="r_a987daf2049756d3ac5b3eb66344584fe"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/utility/pair.html">std::pair</a>< bool, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a987daf2049756d3ac5b3eb66344584fe">validFwd</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &sb, <a class="el" href="classripple_1_1ApplyView.html">ApplyView</a> &afView, <a class="el" href="structripple_1_1EitherAmount.html">EitherAmount</a> const &<a class="el" href="namespaceripple.html#a7cc64e12723fbc9606d85442a2569feda13b5bfe96f3e2fe411c9f66f4a582adf">in</a>)=0</td></tr>
|
||||
<tr class="memdesc:a987daf2049756d3ac5b3eb66344584fe"><td class="mdescLeft"> </td><td class="mdescRight">Check that the step can correctly execute in the forward direction. <br /></td></tr>
|
||||
<tr class="separator:a987daf2049756d3ac5b3eb66344584fe"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
|
||||
Private Member Functions</h2></td></tr>
|
||||
<tr class="memitem:ae78cdde4e2229e91e7d2076a271f4b87"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#ae78cdde4e2229e91e7d2076a271f4b87">logString</a> () const =0</td></tr>
|
||||
<tr class="memitem:ae78cdde4e2229e91e7d2076a271f4b87" id="r_ae78cdde4e2229e91e7d2076a271f4b87"><td class="memItemLeft" align="right" valign="top">virtual <a class="elRef" href="http://en.cppreference.com/w/cpp/string/basic_string.html">std::string</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#ae78cdde4e2229e91e7d2076a271f4b87">logString</a> () const =0</td></tr>
|
||||
<tr class="separator:ae78cdde4e2229e91e7d2076a271f4b87"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a2e9fdd3b76f5cf635fc5dd37d9f8b772"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a2e9fdd3b76f5cf635fc5dd37d9f8b772">equal</a> (<a class="el" href="classripple_1_1Step.html">Step</a> const &rhs) const =0</td></tr>
|
||||
<tr class="memitem:a2e9fdd3b76f5cf635fc5dd37d9f8b772" id="r_a2e9fdd3b76f5cf635fc5dd37d9f8b772"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a2e9fdd3b76f5cf635fc5dd37d9f8b772">equal</a> (<a class="el" href="classripple_1_1Step.html">Step</a> const &rhs) const =0</td></tr>
|
||||
<tr class="separator:a2e9fdd3b76f5cf635fc5dd37d9f8b772"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table><table class="memberdecls">
|
||||
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="friends" name="friends"></a>
|
||||
Friends</h2></td></tr>
|
||||
<tr class="memitem:aae54af6e7d06361ee3efe7b4f308998d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#aae54af6e7d06361ee3efe7b4f308998d">operator==</a> (<a class="el" href="classripple_1_1Step.html">Step</a> const &lhs, <a class="el" href="classripple_1_1Step.html">Step</a> const &rhs)</td></tr>
|
||||
<tr class="memdesc:aae54af6e7d06361ee3efe7b4f308998d"><td class="mdescLeft"> </td><td class="mdescRight">Return true if lhs == rhs. <a href="classripple_1_1Step.html#aae54af6e7d06361ee3efe7b4f308998d">More...</a><br /></td></tr>
|
||||
<tr class="memitem:aae54af6e7d06361ee3efe7b4f308998d" id="r_aae54af6e7d06361ee3efe7b4f308998d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#aae54af6e7d06361ee3efe7b4f308998d">operator==</a> (<a class="el" href="classripple_1_1Step.html">Step</a> const &lhs, <a class="el" href="classripple_1_1Step.html">Step</a> const &rhs)</td></tr>
|
||||
<tr class="memdesc:aae54af6e7d06361ee3efe7b4f308998d"><td class="mdescLeft"> </td><td class="mdescRight">Return true if lhs == rhs. <br /></td></tr>
|
||||
<tr class="separator:aae54af6e7d06361ee3efe7b4f308998d"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:a713c44c6627b824ed3d594d216678c04"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a713c44c6627b824ed3d594d216678c04">operator!=</a> (<a class="el" href="classripple_1_1Step.html">Step</a> const &lhs, <a class="el" href="classripple_1_1Step.html">Step</a> const &rhs)</td></tr>
|
||||
<tr class="memdesc:a713c44c6627b824ed3d594d216678c04"><td class="mdescLeft"> </td><td class="mdescRight">Return true if lhs != rhs. <a href="classripple_1_1Step.html#a713c44c6627b824ed3d594d216678c04">More...</a><br /></td></tr>
|
||||
<tr class="memitem:a713c44c6627b824ed3d594d216678c04" id="r_a713c44c6627b824ed3d594d216678c04"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#a713c44c6627b824ed3d594d216678c04">operator!=</a> (<a class="el" href="classripple_1_1Step.html">Step</a> const &lhs, <a class="el" href="classripple_1_1Step.html">Step</a> const &rhs)</td></tr>
|
||||
<tr class="memdesc:a713c44c6627b824ed3d594d216678c04"><td class="mdescLeft"> </td><td class="mdescRight">Return true if lhs != rhs. <br /></td></tr>
|
||||
<tr class="separator:a713c44c6627b824ed3d594d216678c04"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
<tr class="memitem:ac7306728e5a93264da417c19a5bc83af"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#ac7306728e5a93264da417c19a5bc83af">operator<<</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &stream, <a class="el" href="classripple_1_1Step.html">Step</a> const &step)</td></tr>
|
||||
<tr class="memdesc:ac7306728e5a93264da417c19a5bc83af"><td class="mdescLeft"> </td><td class="mdescRight">Streaming operator for a <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a>. <a href="classripple_1_1Step.html#ac7306728e5a93264da417c19a5bc83af">More...</a><br /></td></tr>
|
||||
<tr class="memitem:ac7306728e5a93264da417c19a5bc83af" id="r_ac7306728e5a93264da417c19a5bc83af"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1Step.html#ac7306728e5a93264da417c19a5bc83af">operator<<</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &stream, <a class="el" href="classripple_1_1Step.html">Step</a> const &step)</td></tr>
|
||||
<tr class="memdesc:ac7306728e5a93264da417c19a5bc83af"><td class="mdescLeft"> </td><td class="mdescRight">Streaming operator for a <a class="el" href="classripple_1_1Step.html" title="A step in a payment path.">Step</a>. <br /></td></tr>
|
||||
<tr class="separator:ac7306728e5a93264da417c19a5bc83af"><td class="memSeparator" colspan="2"> </td></tr>
|
||||
</table>
|
||||
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||||
<div class="textblock"><p >A step in a payment path. </p>
|
||||
<p >There are five concrete step classes: <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> is an IOU step between accounts BookStepII is an IOU/IOU offer book BookStepIX is an IOU/XRP offer book BookStepXI is an XRP/IOU offer book <a class="el" href="classripple_1_1XRPEndpointStep.html">XRPEndpointStep</a> is the source or destination account for XRP</p>
|
||||
<p >Amounts may be transformed through a step in either the forward or the reverse direction. In the forward direction, the function <code>fwd</code> is used to find the amount the step would output given an input amount. In the reverse direction, the function <code>rev</code> is used to find the amount of input needed to produce the desired output.</p>
|
||||
<p >Amounts are always transformed using liquidity with the same quality (quality is the amount out/amount in). For example, a <a class="el" href="classripple_1_1BookStep.html">BookStep</a> may use multiple offers when executing <code>fwd</code> or <code>rev</code>, but all those offers will be from the same quality directory.</p>
|
||||
<p >A step may not have enough liquidity to transform the entire requested amount. Both <code>fwd</code> and <code>rev</code> return a pair of amounts (one for input amount, one for output amount) that show how much of the requested amount the step was actually able to use. </p>
|
||||
<div class="textblock"><p>A step in a payment path. </p>
|
||||
<p>There are five concrete step classes: <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> is an IOU step between accounts BookStepII is an IOU/IOU offer book BookStepIX is an IOU/XRP offer book BookStepXI is an XRP/IOU offer book <a class="el" href="classripple_1_1XRPEndpointStep.html">XRPEndpointStep</a> is the source or destination account for XRP</p>
|
||||
<p>Amounts may be transformed through a step in either the forward or the reverse direction. In the forward direction, the function <code>fwd</code> is used to find the amount the step would output given an input amount. In the reverse direction, the function <code>rev</code> is used to find the amount of input needed to produce the desired output.</p>
|
||||
<p>Amounts are always transformed using liquidity with the same quality (quality is the amount out/amount in). For example, a <a class="el" href="classripple_1_1BookStep.html">BookStep</a> may use multiple offers when executing <code>fwd</code> or <code>rev</code>, but all those offers will be from the same quality directory.</p>
|
||||
<p>A step may not have enough liquidity to transform the entire requested amount. Both <code>fwd</code> and <code>rev</code> return a pair of amounts (one for input amount, one for output amount) that show how much of the requested amount the step was actually able to use. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00085">85</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
|
||||
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||||
@@ -394,7 +394,7 @@ Friends</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>If this step is <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> (IOU->IOU direct step), return the src account. </p>
|
||||
<p >This is needed for checkNoRipple. </p>
|
||||
<p>This is needed for checkNoRipple. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00145">145</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
|
||||
|
||||
@@ -462,7 +462,7 @@ Friends</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>If this step is a <a class="el" href="classripple_1_1DirectStepI.html">DirectStepI</a> and the src redeems to the dst, return true, otherwise return false. </p>
|
||||
<p >If this step is a <a class="el" href="classripple_1_1BookStep.html">BookStep</a>, return false if the owner pays the transfer fee, otherwise return true.</p>
|
||||
<p>If this step is a <a class="el" href="classripple_1_1BookStep.html">BookStep</a>, return false if the owner pays the transfer fee, otherwise return true.</p>
|
||||
<dl class="params"><dt>Parameters</dt><dd>
|
||||
<table class="params">
|
||||
<tr><td class="paramname">sb</td><td>view with the strand's state of balances and offers </td></tr>
|
||||
@@ -545,7 +545,7 @@ Friends</h2></td></tr>
|
||||
</table>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A pair. The first element is the upper bound of quality for the step, or std::nullopt if the step is dry. The second element will be set to <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401ea7e611dd9f79193db43a5e9983752239e">DebtDirection::redeems</a> if this steps redeems, DebtDirection:issues if this step issues. </dd></dl>
|
||||
<dl class="section return"><dt>Returns</dt><dd>A pair. The first element is the upper bound of quality for the step, or <a class="elRef" href="http://en.cppreference.com/w/cpp/types/is_same.html">std::nullopt</a> if the step is dry. The second element will be set to <a class="el" href="namespaceripple.html#a8c623abdba7fa97ffd148311056d401ea7e611dd9f79193db43a5e9983752239e">DebtDirection::redeems</a> if this steps redeems, DebtDirection:issues if this step issues. </dd></dl>
|
||||
<dl class="section note"><dt>Note</dt><dd>it is an upper bound because offers on the books may be unfunded. If there is always a funded offer at the tip of the book, then we could rename this <code>theoreticalQuality</code> rather than <code>qualityUpperBound</code>. It could still differ from the actual quality, but except for "dust" amounts, it should be a good estimate for the actual quality. </dd></dl>
|
||||
|
||||
</div>
|
||||
@@ -585,7 +585,7 @@ Friends</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Get <a class="el" href="classripple_1_1QualityFunction.html" title="Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...">QualityFunction</a>. </p>
|
||||
<p >Used in one path optimization where the quality function is non-constant (has AMM) and there is limitQuality. <a class="el" href="classripple_1_1QualityFunction.html" title="Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...">QualityFunction</a> allows calculation of required path output given requested limitQuality. All steps, except for <a class="el" href="classripple_1_1BookStep.html">BookStep</a> have the default implementation. </p>
|
||||
<p>Used in one path optimization where the quality function is non-constant (has AMM) and there is limitQuality. <a class="el" href="classripple_1_1QualityFunction.html" title="Average quality of a path as a function of out: q(out) = m * out + b, where m = -1 / poolGets,...">QualityFunction</a> allows calculation of required path output given requested limitQuality. All steps, except for <a class="el" href="classripple_1_1BookStep.html">BookStep</a> have the default implementation. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00312">312</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
|
||||
|
||||
@@ -615,7 +615,7 @@ Friends</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return the number of offers consumed or partially consumed the last time the step ran, including expired and unfunded offers. </p>
|
||||
<p >N.B. This this not the total number offers consumed by this step for the entire payment, it is only the number the last time it ran. Offers may be partially consumed multiple times during a payment. </p>
|
||||
<p>N.B. This this not the total number offers consumed by this step for the entire payment, it is only the number the last time it ran. Offers may be partially consumed multiple times during a payment. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00215">215</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
|
||||
|
||||
@@ -702,7 +702,7 @@ Friends</h2></td></tr>
|
||||
</div><div class="memdoc">
|
||||
|
||||
<p>Return true if the step should be considered inactive. </p>
|
||||
<p >A strand that has additional liquidity may be marked inactive if a step has consumed too many offers. </p>
|
||||
<p>A strand that has additional liquidity may be marked inactive if a step has consumed too many offers. </p>
|
||||
|
||||
<p class="definition">Definition at line <a class="el" href="Steps_8h_source.html#l00241">241</a> of file <a class="el" href="Steps_8h_source.html">Steps.h</a>.</p>
|
||||
|
||||
@@ -888,7 +888,7 @@ Friends</h2></td></tr>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<h2 class="groupheader">Friends And Related Function Documentation</h2>
|
||||
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
|
||||
<a id="aae54af6e7d06361ee3efe7b4f308998d" name="aae54af6e7d06361ee3efe7b4f308998d"></a>
|
||||
<h2 class="memtitle"><span class="permalink"><a href="#aae54af6e7d06361ee3efe7b4f308998d">◆ </a></span>operator==</h2>
|
||||
|
||||
@@ -1028,7 +1028,7 @@ Friends</h2></td></tr>
|
||||
</div><!-- contents -->
|
||||
<!-- start footer part -->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
|
||||
Generated by <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
Block a user