ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2025-11-20 02:55:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/classripple_1_1IOUAmount.html
bthomee 33451fdc96 deploy: 1d42c4f6de
2025-11-04 00:36:48 -08:00

689 lines
36 KiB
HTML
Raw Permalink 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::IOUAmount 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_1IOUAmount.html">IOUAmount</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-methods">Static Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classripple_1_1IOUAmount-members.html">List of all members</a> </div>
<div class="headertitle"><div class="title">ripple::IOUAmount Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Floating point representation of amounts with high dynamic range.
<a href="classripple_1_1IOUAmount.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ripple::IOUAmount:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1IOUAmount__inherit__graph.png" border="0" usemap="#aripple_1_1IOUAmount_inherit__map" alt="Inheritance graph"/></div>
<map name="aripple_1_1IOUAmount_inherit__map" id="aripple_1_1IOUAmount_inherit__map">
<area shape="rect" title="Floating point representation of amounts with high dynamic range." alt="" coords="126,93,269,119"/>
<area shape="rect" title=" " alt="" coords="5,5,171,45"/>
<area shape="poly" title=" " alt="" coords="127,51,182,91,179,95,124,56"/>
<area shape="rect" title=" " alt="" coords="195,13,419,38"/>
<area shape="poly" title=" " alt="" coords="281,48,215,95,212,91,278,44"/>
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ripple::IOUAmount:</div>
<div class="dyncontent">
<div class="center"><img src="classripple_1_1IOUAmount__coll__graph.png" border="0" usemap="#aripple_1_1IOUAmount_coll__map" alt="Collaboration graph"/></div>
<map name="aripple_1_1IOUAmount_coll__map" id="aripple_1_1IOUAmount_coll__map">
<area shape="rect" title="Floating point representation of amounts with high dynamic range." alt="" coords="235,108,378,133"/>
<area shape="rect" title=" " alt="" coords="5,5,171,45"/>
<area shape="poly" title=" " alt="" coords="146,48,281,105,279,110,144,53"/>
<area shape="rect" title=" " alt="" coords="195,13,419,38"/>
<area shape="poly" title=" " alt="" coords="309,52,309,108,304,108,304,52"/>
<area shape="rect" target="_parent" href="http://en.cppreference.com/w/cpp/types/integer.html" title=" " alt="" coords="443,13,538,38"/>
<area shape="poly" title=" " alt="" coords="457,47,331,110,328,105,455,42"/>
</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:a9ad31953488b4fc880a9700da03e2a71" id="r_a9ad31953488b4fc880a9700da03e2a71"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a9ad31953488b4fc880a9700da03e2a71">IOUAmount</a> ()=default</td></tr>
<tr class="separator:a9ad31953488b4fc880a9700da03e2a71"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af346ea69bfcc118ea700e618f32dffc3" id="r_af346ea69bfcc118ea700e618f32dffc3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#af346ea69bfcc118ea700e618f32dffc3">IOUAmount</a> (<a class="el" href="classripple_1_1Number.html">Number</a> const &amp;other)</td></tr>
<tr class="separator:af346ea69bfcc118ea700e618f32dffc3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65f7a8b13a5e1fd4ebe199d57e2c6393" id="r_a65f7a8b13a5e1fd4ebe199d57e2c6393"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a65f7a8b13a5e1fd4ebe199d57e2c6393">IOUAmount</a> (<a class="el" href="structbeast_1_1Zero.html">beast::Zero</a>)</td></tr>
<tr class="separator:a65f7a8b13a5e1fd4ebe199d57e2c6393"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95467fc67fc518d10ae94764a967e8bd" id="r_a95467fc67fc518d10ae94764a967e8bd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a95467fc67fc518d10ae94764a967e8bd">IOUAmount</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a> <a class="el" href="classripple_1_1IOUAmount.html#a7569b6462cf1abb6018ccfbe8428bfab">mantissa</a>, int <a class="el" href="classripple_1_1IOUAmount.html#a4123b52991469e91f146e23382f49d6c">exponent</a>)</td></tr>
<tr class="separator:a95467fc67fc518d10ae94764a967e8bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a944535077f9e08610d1c17388545ca0b" id="r_a944535077f9e08610d1c17388545ca0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a944535077f9e08610d1c17388545ca0b">operator=</a> (<a class="el" href="structbeast_1_1Zero.html">beast::Zero</a>)</td></tr>
<tr class="separator:a944535077f9e08610d1c17388545ca0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9506f7388ec535a6c76070c6edb2695" id="r_ab9506f7388ec535a6c76070c6edb2695"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#ab9506f7388ec535a6c76070c6edb2695">operator Number</a> () const</td></tr>
<tr class="separator:ab9506f7388ec535a6c76070c6edb2695"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a94bdd4a08732aed55054592776aab6f9" id="r_a94bdd4a08732aed55054592776aab6f9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a94bdd4a08732aed55054592776aab6f9">operator+=</a> (<a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;other)</td></tr>
<tr class="separator:a94bdd4a08732aed55054592776aab6f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aeddfae3b99ac76f0366c46a8e968e155" id="r_aeddfae3b99ac76f0366c46a8e968e155"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#aeddfae3b99ac76f0366c46a8e968e155">operator-=</a> (<a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;other)</td></tr>
<tr class="separator:aeddfae3b99ac76f0366c46a8e968e155"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a07c0b17dfc3105af46dd765b677180c5" id="r_a07c0b17dfc3105af46dd765b677180c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a07c0b17dfc3105af46dd765b677180c5">operator-</a> () const</td></tr>
<tr class="separator:a07c0b17dfc3105af46dd765b677180c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b736e8818bf5a0484a50c0e504403ac" id="r_a6b736e8818bf5a0484a50c0e504403ac"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a6b736e8818bf5a0484a50c0e504403ac">operator==</a> (<a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;other) const</td></tr>
<tr class="separator:a6b736e8818bf5a0484a50c0e504403ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a54fe493cdec286f473c4f56e528dff8b" id="r_a54fe493cdec286f473c4f56e528dff8b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a54fe493cdec286f473c4f56e528dff8b">operator&lt;</a> (<a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;other) const</td></tr>
<tr class="separator:a54fe493cdec286f473c4f56e528dff8b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a363b9624137660e4d95e347f74bd5e50" id="r_a363b9624137660e4d95e347f74bd5e50"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a363b9624137660e4d95e347f74bd5e50">operator bool</a> () const noexcept</td></tr>
<tr class="memdesc:a363b9624137660e4d95e347f74bd5e50"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the amount is not zero. <br /></td></tr>
<tr class="separator:a363b9624137660e4d95e347f74bd5e50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a66e63cfa770707b084d0e1467426099d" id="r_a66e63cfa770707b084d0e1467426099d"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a66e63cfa770707b084d0e1467426099d">signum</a> () const noexcept</td></tr>
<tr class="memdesc:a66e63cfa770707b084d0e1467426099d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the sign of the amount. <br /></td></tr>
<tr class="separator:a66e63cfa770707b084d0e1467426099d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4123b52991469e91f146e23382f49d6c" id="r_a4123b52991469e91f146e23382f49d6c"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a4123b52991469e91f146e23382f49d6c">exponent</a> () const noexcept</td></tr>
<tr class="separator:a4123b52991469e91f146e23382f49d6c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7569b6462cf1abb6018ccfbe8428bfab" id="r_a7569b6462cf1abb6018ccfbe8428bfab"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a7569b6462cf1abb6018ccfbe8428bfab">mantissa</a> () const noexcept</td></tr>
<tr class="separator:a7569b6462cf1abb6018ccfbe8428bfab"><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-methods" name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:adab2635959eab5a38bd62200a538d908" id="r_adab2635959eab5a38bd62200a538d908"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#adab2635959eab5a38bd62200a538d908">minPositiveAmount</a> ()</td></tr>
<tr class="separator:adab2635959eab5a38bd62200a538d908"><td class="memSeparator" colspan="2">&#160;</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:a6eb0c4cb3891601ef809e13c1088f3fd" id="r_a6eb0c4cb3891601ef809e13c1088f3fd"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a6eb0c4cb3891601ef809e13c1088f3fd">normalize</a> ()</td></tr>
<tr class="memdesc:a6eb0c4cb3891601ef809e13c1088f3fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjusts the mantissa and exponent to the proper range. <br /></td></tr>
<tr class="separator:a6eb0c4cb3891601ef809e13c1088f3fd"><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:a44f1b32037a68e67d02237a170c5425b" id="r_a44f1b32037a68e67d02237a170c5425b"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a44f1b32037a68e67d02237a170c5425b">mantissa_</a></td></tr>
<tr class="separator:a44f1b32037a68e67d02237a170c5425b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aea9cd345c8da57dbbd2372ff434bfb23" id="r_aea9cd345c8da57dbbd2372ff434bfb23"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#aea9cd345c8da57dbbd2372ff434bfb23">exponent_</a></td></tr>
<tr class="separator:aea9cd345c8da57dbbd2372ff434bfb23"><td class="memSeparator" colspan="2">&#160;</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:a3033468f777067c56a5c49d0523fdd18" id="r_a3033468f777067c56a5c49d0523fdd18"><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classripple_1_1IOUAmount.html#a3033468f777067c56a5c49d0523fdd18">operator&lt;&lt;</a> (<a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;os, <a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;x)</td></tr>
<tr class="separator:a3033468f777067c56a5c49d0523fdd18"><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>Floating point representation of amounts with high dynamic range. </p>
<p>Amounts are stored as a normalized signed mantissa and an exponent. The range of the normalized exponent is [-96,80] and the range of the absolute value of the normalized mantissa is [1000000000000000, 9999999999999999].</p>
<p>Arithmetic operations can throw <a class="elRef" href="http://en.cppreference.com/w/cpp/error/overflow_error.html">std::overflow_error</a> during normalization if the amount exceeds the largest representable amount, but underflows will silently trunctate to zero. </p>
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00025">25</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9ad31953488b4fc880a9700da03e2a71" name="a9ad31953488b4fc880a9700da03e2a71"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9ad31953488b4fc880a9700da03e2a71">&#9670;&#160;</a></span>IOUAmount() <span class="overload">[1/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::IOUAmount::IOUAmount </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="af346ea69bfcc118ea700e618f32dffc3" name="af346ea69bfcc118ea700e618f32dffc3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af346ea69bfcc118ea700e618f32dffc3">&#9670;&#160;</a></span>IOUAmount() <span class="overload">[2/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::IOUAmount::IOUAmount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1Number.html">Number</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8cpp_source.html#l00109">109</a> of file <a class="el" href="IOUAmount_8cpp_source.html">IOUAmount.cpp</a>.</p>
</div>
</div>
<a id="a65f7a8b13a5e1fd4ebe199d57e2c6393" name="a65f7a8b13a5e1fd4ebe199d57e2c6393"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65f7a8b13a5e1fd4ebe199d57e2c6393">&#9670;&#160;</a></span>IOUAmount() <span class="overload">[3/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::IOUAmount::IOUAmount </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbeast_1_1Zero.html">beast::Zero</a>&#160;</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="IOUAmount_8h_source.html#l00090">90</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a95467fc67fc518d10ae94764a967e8bd" name="a95467fc67fc518d10ae94764a967e8bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95467fc67fc518d10ae94764a967e8bd">&#9670;&#160;</a></span>IOUAmount() <span class="overload">[4/4]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::IOUAmount::IOUAmount </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/types/integer.html">std::int64_t</a>&#160;</td>
<td class="paramname"><em>mantissa</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>exponent</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="IOUAmount_8h_source.html#l00095">95</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a6eb0c4cb3891601ef809e13c1088f3fd" name="a6eb0c4cb3891601ef809e13c1088f3fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6eb0c4cb3891601ef809e13c1088f3fd">&#9670;&#160;</a></span>normalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ripple::IOUAmount::normalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></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>Adjusts the mantissa and exponent to the proper range. </p>
<p>This can throw if the amount cannot be normalized, or is larger than the largest value that can be represented as an IOU amount. Amounts that are too small to be represented normalize to 0. </p>
<p class="definition">Definition at line <a class="el" href="IOUAmount_8cpp_source.html#l00056">56</a> of file <a class="el" href="IOUAmount_8cpp_source.html">IOUAmount.cpp</a>.</p>
</div>
</div>
<a id="a944535077f9e08610d1c17388545ca0b" name="a944535077f9e08610d1c17388545ca0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a944535077f9e08610d1c17388545ca0b">&#9670;&#160;</a></span>operator=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> &amp; ripple::IOUAmount::operator= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structbeast_1_1Zero.html">beast::Zero</a>&#160;</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="IOUAmount_8h_source.html#l00102">102</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="ab9506f7388ec535a6c76070c6edb2695" name="ab9506f7388ec535a6c76070c6edb2695"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9506f7388ec535a6c76070c6edb2695">&#9670;&#160;</a></span>operator Number()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ripple::IOUAmount::operator <a class="el" href="classripple_1_1Number.html">Number</a> </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="IOUAmount_8h_source.html#l00111">111</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a94bdd4a08732aed55054592776aab6f9" name="a94bdd4a08732aed55054592776aab6f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94bdd4a08732aed55054592776aab6f9">&#9670;&#160;</a></span>operator+=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> &amp; ripple::IOUAmount::operator+= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8cpp_source.html#l00119">119</a> of file <a class="el" href="IOUAmount_8cpp_source.html">IOUAmount.cpp</a>.</p>
</div>
</div>
<a id="aeddfae3b99ac76f0366c46a8e968e155" name="aeddfae3b99ac76f0366c46a8e968e155"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeddfae3b99ac76f0366c46a8e968e155">&#9670;&#160;</a></span>operator-=()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> &amp; ripple::IOUAmount::operator-= </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00117">117</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a07c0b17dfc3105af46dd765b677180c5" name="a07c0b17dfc3105af46dd765b677180c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a07c0b17dfc3105af46dd765b677180c5">&#9670;&#160;</a></span>operator-()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> ripple::IOUAmount::operator- </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="IOUAmount_8h_source.html#l00124">124</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a6b736e8818bf5a0484a50c0e504403ac" name="a6b736e8818bf5a0484a50c0e504403ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b736e8818bf5a0484a50c0e504403ac">&#9670;&#160;</a></span>operator==()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::IOUAmount::operator== </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00130">130</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a54fe493cdec286f473c4f56e528dff8b" name="a54fe493cdec286f473c4f56e528dff8b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a54fe493cdec286f473c4f56e528dff8b">&#9670;&#160;</a></span>operator&lt;()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ripple::IOUAmount::operator&lt; </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00135">135</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a363b9624137660e4d95e347f74bd5e50" name="a363b9624137660e4d95e347f74bd5e50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a363b9624137660e4d95e347f74bd5e50">&#9670;&#160;</a></span>operator bool()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ripple::IOUAmount::operator bool </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns true if the amount is not zero. </p>
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00141">141</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a66e63cfa770707b084d0e1467426099d" name="a66e63cfa770707b084d0e1467426099d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a66e63cfa770707b084d0e1467426099d">&#9670;&#160;</a></span>signum()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::IOUAmount::signum </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the sign of the amount. </p>
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00147">147</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a4123b52991469e91f146e23382f49d6c" name="a4123b52991469e91f146e23382f49d6c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4123b52991469e91f146e23382f49d6c">&#9670;&#160;</a></span>exponent()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::IOUAmount::exponent </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00153">153</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="a7569b6462cf1abb6018ccfbe8428bfab" name="a7569b6462cf1abb6018ccfbe8428bfab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7569b6462cf1abb6018ccfbe8428bfab">&#9670;&#160;</a></span>mantissa()</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::int64_t</a> ripple::IOUAmount::mantissa </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00159">159</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="adab2635959eab5a38bd62200a538d908" name="adab2635959eab5a38bd62200a538d908"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adab2635959eab5a38bd62200a538d908">&#9670;&#160;</a></span>minPositiveAmount()</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_1IOUAmount.html">IOUAmount</a> ripple::IOUAmount::minPositiveAmount </td>
<td>(</td>
<td class="paramname"></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="IOUAmount_8cpp_source.html#l00050">50</a> of file <a class="el" href="IOUAmount_8cpp_source.html">IOUAmount.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Symbol Documentation</h2>
<a id="a3033468f777067c56a5c49d0523fdd18" name="a3033468f777067c56a5c49d0523fdd18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3033468f777067c56a5c49d0523fdd18">&#9670;&#160;</a></span>operator&lt;&lt;</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/io/basic_ostream.html">std::ostream</a> &amp; operator&lt;&lt; </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="http://en.cppreference.com/w/cpp/io/basic_ostream.html">std::ostream</a> &amp;&#160;</td>
<td class="paramname"><em>os</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classripple_1_1IOUAmount.html">IOUAmount</a> const &amp;&#160;</td>
<td class="paramname"><em>x</em>&#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">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IOUAmount_8h_source.html#l00083">83</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a44f1b32037a68e67d02237a170c5425b" name="a44f1b32037a68e67d02237a170c5425b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44f1b32037a68e67d02237a170c5425b">&#9670;&#160;</a></span>mantissa_</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::int64_t</a> ripple::IOUAmount::mantissa_</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="IOUAmount_8h_source.html#l00029">29</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.h</a>.</p>
</div>
</div>
<a id="aea9cd345c8da57dbbd2372ff434bfb23" name="aea9cd345c8da57dbbd2372ff434bfb23"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aea9cd345c8da57dbbd2372ff434bfb23">&#9670;&#160;</a></span>exponent_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int ripple::IOUAmount::exponent_</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="IOUAmount_8h_source.html#l00030">30</a> of file <a class="el" href="IOUAmount_8h_source.html">IOUAmount.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