ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-12-06 17:27:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
2406a770b3a44e5f6be65be67f9d965f93ec614f
rippled/classripple_1_1path_1_1RippleCalc.html
manojsdoshi 1896d70739 deploy: 711608e652
2022-03-31 17:56:44 +00:00

266 lines
17 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: ripple::path::RippleCalc 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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceripple.html">ripple</a></li><li class="navelem"><a class="el" href="namespaceripple_1_1path.html">path</a></li><li class="navelem"><a class="el" href="classripple_1_1path_1_1RippleCalc.html">RippleCalc</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="classripple_1_1path_1_1RippleCalc-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ripple::path::RippleCalc Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classripple_1_1path_1_1RippleCalc.html" title="RippleCalc calculates the quality of a payment path.">RippleCalc</a> calculates the quality of a payment path.
<a href="classripple_1_1path_1_1RippleCalc.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ripple::path::RippleCalc:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1path_1_1RippleCalc__coll__graph.png" border="0" usemap="#ripple_1_1path_1_1RippleCalc_coll__map" alt="Collaboration graph"/></div>
<map name="ripple_1_1path_1_1RippleCalc_coll__map" id="ripple_1_1path_1_1RippleCalc_coll__map">
<area shape="rect" title="RippleCalc calculates the quality of a payment path." alt="" coords="2813,425,2987,452"/>
<area shape="rect" href="classripple_1_1PaymentSandbox.html" title="A wrapper which makes credits unavailable to balances." alt="" coords="2549,425,2729,452"/>
<area shape="rect" href="classripple_1_1detail_1_1ApplyViewBase.html" title=" " alt="" coords="2255,232,2468,259"/>
<area shape="rect" href="classripple_1_1ApplyView.html" title="Writeable view to a ledger, for applying a transaction." alt="" coords="1973,232,2109,259"/>
<area shape="rect" href="classripple_1_1ReadView.html" title="A view into a ledger." alt="" coords="1619,367,1750,393"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1953,408,2129,464"/>
<area shape="rect" href="classripple_1_1detail_1_1ReadViewFwdRange.html" title=" " alt="" coords="1953,551,2129,593"/>
<area shape="rect" href="structripple_1_1ReadView_1_1sles__type.html" title=" " alt="" coords="2261,375,2461,401"/>
<area shape="rect" href="structripple_1_1ReadView_1_1txs__type.html" title=" " alt="" coords="2264,505,2459,532"/>
<area shape="rect" href="classripple_1_1RawView.html" title="Interface for ledger entry changes." alt="" coords="1978,181,2105,208"/>
<area shape="rect" href="classripple_1_1detail_1_1ApplyStateTable.html" title=" " alt="" coords="1950,115,2133,157"/>
<area shape="rect" href="classripple_1_1XRPAmount.html" title=" " alt="" coords="1613,123,1756,149"/>
<area shape="rect" title=" " alt="" coords="1226,57,1391,98"/>
<area shape="rect" title=" " alt="" coords="1196,123,1421,149"/>
<area shape="rect" title=" " alt="" coords="1204,174,1413,215"/>
<area shape="rect" title=" " alt="" coords="1201,239,1416,281"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="1261,5,1356,32"/>
<area shape="rect" href="classripple_1_1detail_1_1DeferredCredits.html" title=" " alt="" coords="2277,610,2446,651"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="889,589,1060,630"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="5,581,108,608"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/array.html" title=" " alt="" coords="221,606,389,647"/>
<area shape="rect" href="classripple_1_1base__uint.html" title="Integers of any length that is a multiple of 32&#45;bits." alt="" coords="542,589,683,630"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="513,657,712,698"/>
<area shape="rect" href="classripple_1_1base__uint.html" title=" " alt="" coords="509,725,716,766"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/size_t.html" title=" " alt="" coords="261,792,349,819"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="1932,680,2151,736"/>
<area shape="rect" href="structripple_1_1detail_1_1DeferredCredits_1_1Value.html" title=" " alt="" coords="1600,687,1769,729"/>
<area shape="rect" href="classripple_1_1STAmount.html" title=" " alt="" coords="1242,713,1375,740"/>
<area shape="rect" href="classripple_1_1STBase.html" title="A type which can be exported to a well known binary format." alt="" coords="917,901,1032,928"/>
<area shape="rect" href="classripple_1_1SField.html" title="Identifies fields." alt="" coords="560,947,665,973"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/container/map.html" title=" " alt="" coords="897,969,1053,1010"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/string/basic_string.html" title="STL class." alt="" coords="262,952,349,979"/>
<area shape="rect" href="classJson_1_1StaticString.html" title="Lightweight wrapper to tag static string." alt="" coords="239,901,371,928"/>
<area shape="rect" href="classripple_1_1CountedObject.html" title=" " alt="" coords="893,715,1056,757"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="923,851,1026,877"/>
<area shape="rect" href="classripple_1_1Issue.html" title="A currency issued by an account." alt="" coords="924,664,1025,691"/>
<area shape="rect" href="http://en.cppreference.com/w/cpp/utility/tuple.html" title=" " alt="" coords="1643,753,1726,780"/>
</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 name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Input.html">Input</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html">Output</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a359d70f8c834cec541d4036f785372c9"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Output.html">Output</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1path_1_1RippleCalc.html#a359d70f8c834cec541d4036f785372c9">rippleCalculate</a> (<a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &amp;<a class="el" href="classripple_1_1path_1_1RippleCalc.html#a0275cba5eec83b3b526f20241c235701">view</a>, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amp;saMaxAmountReq, <a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amp;saDstAmountReq, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;uDstAccountID, <a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;uSrcAccountID, <a class="el" href="classripple_1_1STPathSet.html">STPathSet</a> const &amp;spsPaths, <a class="el" href="classripple_1_1Logs.html">Logs</a> &amp;l, <a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Input.html">Input</a> const *const pInputs=nullptr)</td></tr>
<tr class="separator:a359d70f8c834cec541d4036f785372c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a0275cba5eec83b3b526f20241c235701"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1path_1_1RippleCalc.html#a0275cba5eec83b3b526f20241c235701">view</a></td></tr>
<tr class="separator:a0275cba5eec83b3b526f20241c235701"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90eb3b341309d998b79e824689b37623"><td class="memItemLeft" align="right" valign="top">boost::container::flat_set&lt; <a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1path_1_1RippleCalc.html#a90eb3b341309d998b79e824689b37623">permanentlyUnfundedOffers_</a></td></tr>
<tr class="separator:a90eb3b341309d998b79e824689b37623"><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><a class="el" href="classripple_1_1path_1_1RippleCalc.html" title="RippleCalc calculates the quality of a payment path.">RippleCalc</a> calculates the quality of a payment path. </p>
<p>Quality is the amount of input required to produce a given output along a specified path - another name for this is exchange rate. </p>
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00043">43</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a359d70f8c834cec541d4036f785372c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a359d70f8c834cec541d4036f785372c9">&#9670;&nbsp;</a></span>rippleCalculate()</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="structripple_1_1path_1_1RippleCalc_1_1Output.html">RippleCalc::Output</a> ripple::path::RippleCalc::rippleCalculate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a> &amp;&#160;</td>
<td class="paramname"><em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>saMaxAmountReq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1STAmount.html">STAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>saDstAmountReq</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td>
<td class="paramname"><em>uDstAccountID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="namespaceripple.html#a00ae0d729cb3e35b6bcac9a27ebb5284">AccountID</a> const &amp;&#160;</td>
<td class="paramname"><em>uSrcAccountID</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1STPathSet.html">STPathSet</a> const &amp;&#160;</td>
<td class="paramname"><em>spsPaths</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1Logs.html">Logs</a> &amp;&#160;</td>
<td class="paramname"><em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structripple_1_1path_1_1RippleCalc_1_1Input.html">Input</a> const *const&#160;</td>
<td class="paramname"><em>pInputs</em> = <code>nullptr</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8cpp_source.html#l00031">31</a> of file <a class="el" href="RippleCalc_8cpp_source.html">RippleCalc.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a0275cba5eec83b3b526f20241c235701"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0275cba5eec83b3b526f20241c235701">&#9670;&nbsp;</a></span>view</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1PaymentSandbox.html">PaymentSandbox</a>&amp; ripple::path::RippleCalc::view</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00117">117</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
<a id="a90eb3b341309d998b79e824689b37623"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90eb3b341309d998b79e824689b37623">&#9670;&nbsp;</a></span>permanentlyUnfundedOffers_</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">boost::container::flat_set&lt;<a class="el" href="namespaceripple.html#a356c68147333a9a48a344718038576d9">uint256</a>&gt; ripple::path::RippleCalc::permanentlyUnfundedOffers_</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="RippleCalc_8h_source.html#l00123">123</a> of file <a class="el" href="RippleCalc_8h_source.html">RippleCalc.h</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink