ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 11:05:54 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
e1dae4fb62ce2d05ca34c66a26724e0568d0f75a
rippled/classripple_1_1AMMContext.html
bthomee e7f4ae8bed deploy: afc05659ed
2025-08-19 09:49:50 -07:00

552 lines
29 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: ripple::AMMContext Class Reference</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>
<!-- 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="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="classripple_1_1AMMContext-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::AMMContext Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Maintains AMM info per overall payment engine execution and individual iteration.
<a href="classripple_1_1AMMContext.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ripple::AMMContext:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1AMMContext__coll__graph.png" border="0" usemap="#aripple_1_1AMMContext_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1AMMContext_coll__map" id="aripple_1_1AMMContext_coll__map">
<area shape="rect" title="Maintains AMM info per overall payment engine execution and individual iteration." alt="" coords="152,313,303,339"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,218,100,243"/>
<area shape="poly" title=" " alt="" coords="77,250,129,287,187,311,185,316,126,292,74,255"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="124,211,331,251"/>
<area shape="poly" title=" " alt="" coords="230,265,230,313,225,313,225,265"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="125,101,213,126"/>
<area shape="poly" title=" " alt="" coords="183,137,220,209,215,212,178,140"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="237,93,405,133"/>
<area shape="poly" title=" " alt="" coords="299,146,245,212,241,209,294,143"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="269,5,372,31"/>
<area shape="poly" title=" " alt="" coords="323,44,323,93,318,93,318,44"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="355,218,457,243"/>
<area shape="poly" title=" " alt="" coords="373,252,251,316,248,311,371,247"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a67e402fbee8713c05c5cf402f67a79d4" id="r_a67e402fbee8713c05c5cf402f67a79d4"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a67e402fbee8713c05c5cf402f67a79d4">AMMContext</a> (<a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;<a class="el" href="classripple_1_1AMMContext.html#a11a431811d7e91d2615bbe86557b4b06">account</a>, bool <a class="el" href="classripple_1_1AMMContext.html#aa5131ca8c3c5190fc5ae3d5d75cebcea">multiPath</a>)</td></tr>
<tr class="separator:a67e402fbee8713c05c5cf402f67a79d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a465e72e307da281f6af4947933258eb6" id="r_a465e72e307da281f6af4947933258eb6"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a465e72e307da281f6af4947933258eb6">~AMMContext</a> ()=default</td></tr>
<tr class="separator:a465e72e307da281f6af4947933258eb6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1217be8fe1a7a54d1b968e65b91e2c1a" id="r_a1217be8fe1a7a54d1b968e65b91e2c1a"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a1217be8fe1a7a54d1b968e65b91e2c1a">AMMContext</a> (<a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> const &amp;)=delete</td></tr>
<tr class="separator:a1217be8fe1a7a54d1b968e65b91e2c1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5aea57e36c4f95bb3ecee667b00a536e" id="r_a5aea57e36c4f95bb3ecee667b00a536e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a5aea57e36c4f95bb3ecee667b00a536e">operator=</a> (<a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> const &amp;)=delete</td></tr>
<tr class="separator:a5aea57e36c4f95bb3ecee667b00a536e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa5131ca8c3c5190fc5ae3d5d75cebcea" id="r_aa5131ca8c3c5190fc5ae3d5d75cebcea"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#aa5131ca8c3c5190fc5ae3d5d75cebcea">multiPath</a> () const</td></tr>
<tr class="separator:aa5131ca8c3c5190fc5ae3d5d75cebcea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcbd78fc21b665fcb32a30f29d392993" id="r_abcbd78fc21b665fcb32a30f29d392993"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#abcbd78fc21b665fcb32a30f29d392993">setMultiPath</a> (bool fs)</td></tr>
<tr class="separator:abcbd78fc21b665fcb32a30f29d392993"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3137277698da3ced1735bd699c4e416c" id="r_a3137277698da3ced1735bd699c4e416c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a3137277698da3ced1735bd699c4e416c">setAMMUsed</a> ()</td></tr>
<tr class="separator:a3137277698da3ced1735bd699c4e416c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e5706e836b12761e2d0d263c6ed5235" id="r_a0e5706e836b12761e2d0d263c6ed5235"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a0e5706e836b12761e2d0d263c6ed5235">update</a> ()</td></tr>
<tr class="separator:a0e5706e836b12761e2d0d263c6ed5235"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abaf545f8cf19a6f8b5d63c497a464f8c" id="r_abaf545f8cf19a6f8b5d63c497a464f8c"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#abaf545f8cf19a6f8b5d63c497a464f8c">maxItersReached</a> () const</td></tr>
<tr class="separator:abaf545f8cf19a6f8b5d63c497a464f8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a649ca912ffe153882ae0aaaec072bdf4" id="r_a649ca912ffe153882ae0aaaec072bdf4"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a649ca912ffe153882ae0aaaec072bdf4">curIters</a> () const</td></tr>
<tr class="separator:a649ca912ffe153882ae0aaaec072bdf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a11a431811d7e91d2615bbe86557b4b06" id="r_a11a431811d7e91d2615bbe86557b4b06"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a11a431811d7e91d2615bbe86557b4b06">account</a> () const</td></tr>
<tr class="separator:a11a431811d7e91d2615bbe86557b4b06"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abec2e6d73481df858d50472c420295d4" id="r_abec2e6d73481df858d50472c420295d4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#abec2e6d73481df858d50472c420295d4">clear</a> ()</td></tr>
<tr class="memdesc:abec2e6d73481df858d50472c420295d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Strand execution may fail. <br /></td></tr>
<tr class="separator:abec2e6d73481df858d50472c420295d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aea7e5358e70e509bed9b019bf6c8c79a" id="r_aea7e5358e70e509bed9b019bf6c8c79a"><td class="memItemLeft" align="right" valign="top">static constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#aea7e5358e70e509bed9b019bf6c8c79a">MaxIterations</a> = 30</td></tr>
<tr class="separator:aea7e5358e70e509bed9b019bf6c8c79a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:af903f0da1b83aecdcffcbd3923e79f3a" id="r_af903f0da1b83aecdcffcbd3923e79f3a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#af903f0da1b83aecdcffcbd3923e79f3a">account_</a></td></tr>
<tr class="separator:af903f0da1b83aecdcffcbd3923e79f3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af2ceab5dc72a0a5fdef126a5f8508566" id="r_af2ceab5dc72a0a5fdef126a5f8508566"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#af2ceab5dc72a0a5fdef126a5f8508566">multiPath_</a> {false}</td></tr>
<tr class="separator:af2ceab5dc72a0a5fdef126a5f8508566"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a206c6f7ce4c29294297ca2529be9d4c7" id="r_a206c6f7ce4c29294297ca2529be9d4c7"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a206c6f7ce4c29294297ca2529be9d4c7">ammUsed_</a> {false}</td></tr>
<tr class="separator:a206c6f7ce4c29294297ca2529be9d4c7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a23a3978e3ca1c47570556d720f401764" id="r_a23a3978e3ca1c47570556d720f401764"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1AMMContext.html#a23a3978e3ca1c47570556d720f401764">ammIters_</a> {0}</td></tr>
<tr class="separator:a23a3978e3ca1c47570556d720f401764"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Maintains AMM info per overall payment engine execution and individual iteration. </p>
<p>Only one instance of this class is created in Flow.cpp::flow(). The reference is percolated through calls to <a class="el" href="classripple_1_1AMMLiquidity.html" title="AMMLiquidity class provides AMM offers to BookStep class.">AMMLiquidity</a> class, which handles AMM offer generation. </p>
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00035">35</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a67e402fbee8713c05c5cf402f67a79d4" name="a67e402fbee8713c05c5cf402f67a79d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a67e402fbee8713c05c5cf402f67a79d4">&#9670;&#160;</a></span>AMMContext() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::AMMContext::AMMContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td>
<td class="paramname"><em>account</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>multiPath</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00054">54</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a465e72e307da281f6af4947933258eb6" name="a465e72e307da281f6af4947933258eb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a465e72e307da281f6af4947933258eb6">&#9670;&#160;</a></span>~AMMContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::AMMContext::~AMMContext </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">default</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1217be8fe1a7a54d1b968e65b91e2c1a" name="a1217be8fe1a7a54d1b968e65b91e2c1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1217be8fe1a7a54d1b968e65b91e2c1a">&#9670;&#160;</a></span>AMMContext() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::AMMContext::AMMContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a5aea57e36c4f95bb3ecee667b00a536e" name="a5aea57e36c4f95bb3ecee667b00a536e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5aea57e36c4f95bb3ecee667b00a536e">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> &amp; ripple::AMMContext::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1AMMContext.html">AMMContext</a> const &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">delete</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="aa5131ca8c3c5190fc5ae3d5d75cebcea" name="aa5131ca8c3c5190fc5ae3d5d75cebcea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa5131ca8c3c5190fc5ae3d5d75cebcea">&#9670;&#160;</a></span>multiPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::AMMContext::multiPath </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00064">64</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="abcbd78fc21b665fcb32a30f29d392993" name="abcbd78fc21b665fcb32a30f29d392993"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abcbd78fc21b665fcb32a30f29d392993">&#9670;&#160;</a></span>setMultiPath()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::AMMContext::setMultiPath </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fs</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00070">70</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a3137277698da3ced1735bd699c4e416c" name="a3137277698da3ced1735bd699c4e416c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3137277698da3ced1735bd699c4e416c">&#9670;&#160;</a></span>setAMMUsed()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::AMMContext::setAMMUsed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00076">76</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a0e5706e836b12761e2d0d263c6ed5235" name="a0e5706e836b12761e2d0d263c6ed5235"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e5706e836b12761e2d0d263c6ed5235">&#9670;&#160;</a></span>update()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::AMMContext::update </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00082">82</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="abaf545f8cf19a6f8b5d63c497a464f8c" name="abaf545f8cf19a6f8b5d63c497a464f8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abaf545f8cf19a6f8b5d63c497a464f8c">&#9670;&#160;</a></span>maxItersReached()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::AMMContext::maxItersReached </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00090">90</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a649ca912ffe153882ae0aaaec072bdf4" name="a649ca912ffe153882ae0aaaec072bdf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a649ca912ffe153882ae0aaaec072bdf4">&#9670;&#160;</a></span>curIters()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> ripple::AMMContext::curIters </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00096">96</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a11a431811d7e91d2615bbe86557b4b06" name="a11a431811d7e91d2615bbe86557b4b06"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a11a431811d7e91d2615bbe86557b4b06">&#9670;&#160;</a></span>account()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> ripple::AMMContext::account </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00102">102</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="abec2e6d73481df858d50472c420295d4" name="abec2e6d73481df858d50472c420295d4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abec2e6d73481df858d50472c420295d4">&#9670;&#160;</a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ripple::AMMContext::clear </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Strand execution may fail. </p>
<p>Reset the flag at the start of each payment engine iteration. </p>
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00111">111</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="aea7e5358e70e509bed9b019bf6c8c79a" name="aea7e5358e70e509bed9b019bf6c8c79a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea7e5358e70e509bed9b019bf6c8c79a">&#9670;&#160;</a></span>MaxIterations</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">constexpr <a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint8_t</a> ripple::AMMContext::MaxIterations = 30</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00041">41</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="af903f0da1b83aecdcffcbd3923e79f3a" name="af903f0da1b83aecdcffcbd3923e79f3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af903f0da1b83aecdcffcbd3923e79f3a">&#9670;&#160;</a></span>account_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> ripple::AMMContext::account_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00045">45</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="af2ceab5dc72a0a5fdef126a5f8508566" name="af2ceab5dc72a0a5fdef126a5f8508566"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2ceab5dc72a0a5fdef126a5f8508566">&#9670;&#160;</a></span>multiPath_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::AMMContext::multiPath_ {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00047">47</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a206c6f7ce4c29294297ca2529be9d4c7" name="a206c6f7ce4c29294297ca2529be9d4c7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a206c6f7ce4c29294297ca2529be9d4c7">&#9670;&#160;</a></span>ammUsed_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ripple::AMMContext::ammUsed_ {false}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00049">49</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
<a id="a23a3978e3ca1c47570556d720f401764" name="a23a3978e3ca1c47570556d720f401764"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a23a3978e3ca1c47570556d720f401764">&#9670;&#160;</a></span>ammIters_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::uint16_t</a> ripple::AMMContext::ammIters_ {0}</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="AMMContext_8h_source.html#l00051">51</a> of file <a class="el" href="AMMContext_8h_source.html">AMMContext.h</a>.</p>
</div>
</div>
</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