File Manager

003 File Manager

Current Path: /usr/local/share/doc/mpdecimal/libmpdec++

usr / local / share / doc / mpdecimal / libmpdec++ /

📁 ..
📄 README.txt(88 B)
📁 _static
📄 constants.html(11.82 KB)
📄 context.html(21.78 KB)
📄 decimal.html(121.08 KB)
📄 exceptions.html(12 KB)
📄 index.html(8.71 KB)
📄 objects.inv(2.55 KB)
📄 search.html(2.76 KB)
📄 searchindex.js(26.02 KB)

Editing: decimal.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<title>Decimal class &#8212; mpdecimal 2.5.1 documentation</title>
 <link rel="stylesheet" href="_static/mpdecimal-doc.css" type="text/css" />
 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
 <script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
 <script src="_static/jquery.js"></script>
 <script src="_static/underscore.js"></script>
 <script src="_static/doctools.js"></script>
 <script src="_static/language_data.js"></script>
 
 <link rel="search" title="Search" href="search.html" />
 <link rel="prev" title="Context" href="context.html" /> 
 </head><body>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="context.html" title="Context"
 accesskey="P">previous</a></li>
 <li><a href="http://www.bytereef.org/mpdecimal/index.html">project home</a></li>
 
 </ul>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <h3><a href="index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">Decimal class</a><ul>
<li><a class="reference internal" href="#exact-constructors">Exact constructors</a></li>
<li><a class="reference internal" href="#inexact-constructors">Inexact constructors</a></li>
<li><a class="reference internal" href="#accessors">Accessors</a></li>
<li><a class="reference internal" href="#exact-assignment-operators">Exact assignment operators</a></li>
<li><a class="reference internal" href="#inexact-assignment-operators">Inexact assignment operators</a></li>
<li><a class="reference internal" href="#exact-comparison-operators">Exact comparison operators</a></li>
<li><a class="reference internal" href="#exact-reverse-comparison-operators">Exact reverse comparison operators</a></li>
<li><a class="reference internal" href="#unary-arithmetic-operators">Unary arithmetic operators</a></li>
<li><a class="reference internal" href="#binary-arithmetic-operators">Binary arithmetic operators</a></li>
<li><a class="reference internal" href="#reverse-binary-arithmetic-operators">Reverse binary arithmetic operators</a></li>
<li><a class="reference internal" href="#predicates">Predicates</a></li>
<li><a class="reference internal" href="#predicates-with-an-optional-context-argument">Predicates with an optional context argument</a></li>
<li><a class="reference internal" href="#unary-functions-no-context-argument">Unary functions, no context argument</a></li>
<li><a class="reference internal" href="#unary-functions-optional-context-argument">Unary functions, optional context argument</a></li>
<li><a class="reference internal" href="#binary-functions-no-context-argument">Binary functions, no context argument</a></li>
<li><a class="reference internal" href="#binary-functions-optional-context-argument">Binary functions, optional context argument</a></li>
<li><a class="reference internal" href="#binary-functions-two-return-values">Binary functions, two return values</a></li>
<li><a class="reference internal" href="#ternary-functions">Ternary functions</a></li>
<li><a class="reference internal" href="#irregular-functions">Irregular functions</a></li>
<li><a class="reference internal" href="#exact-integer-conversion">Exact integer conversion</a></li>
<li><a class="reference internal" href="#exact-triple-conversion">Exact triple conversion</a></li>
<li><a class="reference internal" href="#exact-string-conversion">Exact string conversion</a></li>
<li><a class="reference internal" href="#inexact-string-conversion">Inexact string conversion</a></li>
<li><a class="reference internal" href="#streams">Streams</a></li>
<li><a class="reference internal" href="#required-by-the-specification">Required by the specification</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="context.html"
 title="previous chapter">Context</a>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" />
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>$('#searchbox').show(0);</script>
 </div>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <div class="section" id="decimal-class">
<h1>Decimal class</h1>
<div class="section" id="exact-constructors">
<h2>Exact constructors</h2>
<dl class="class">
<dt id="_CPPv4N7decimal7DecimalE">
class <code class="descname">Decimal</code> </dt>
<dd><dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalEv">
<code class="descname">Decimal</code>() </dt>
<dd>Default constructor. The value is initialized to a signaling <cite>NaN</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalERK7Decimal">
<code class="descname">Decimal</code>(const <a class="reference internal" href="#_CPPv4N7decimal7Decimal7DecimalEv" title="decimal::Decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>Exact construction by copying the argument.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalERRK7Decimal">
<code class="descname">Decimal</code>(const <a class="reference internal" href="#_CPPv4N7decimal7Decimal7DecimalEv" title="decimal::Decimal::Decimal">Decimal</a> &amp;&amp;other) </dt>
<dd>Exact construction by moving the argument. The argument is reset to a
signaling <cite>NaN</cite>, so it is still in a valid state.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalERK1T">
<code class="descname">Decimal</code>(const T &amp;other) </dt>
<dd>Exact integer conversions. <cite>T</cite> is one of:
<blockquote>
<div><table border="1" class="docutils align-default">
<colgroup>
<col width="41%" />
<col width="59%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><cite>int8_t</cite></td>
<td><cite>uint8_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int16_t</cite></td>
<td><cite>uint16_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>int32_t</cite></td>
<td><cite>uint32_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int64_t</cite></td>
<td><cite>uint64_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>signed char</cite></td>
<td><cite>unsigned char</cite></td>
</tr>
<tr class="row-even"><td><cite>short</cite></td>
<td><cite>unsigned short</cite></td>
</tr>
<tr class="row-odd"><td><cite>int</cite></td>
<td><cite>unsigned int</cite></td>
</tr>
<tr class="row-even"><td><cite>long</cite></td>
<td><cite>unsigned long</cite></td>
</tr>
<tr class="row-odd"><td><cite>long long</cite></td>
<td><cite>unsigned long long</cite></td>
</tr>
</tbody>
</table>
</div></blockquote>
Since construction is always exact, it is safe to allow implicit conversions.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalEPCKc">
explicit <code class="descname">Decimal</code>(const char *const s) </dt>
<dd>Exact conversion from a <cite>C</cite> string. If an internal limit is exceeded
(e.g. the exponent exceeds <cite>MAX_EMAX</cite>), <cite>InvalidOperation</cite> is set
and the result is <cite>NaN</cite>.
Raises <cite>ValueError</cite> if the argument is <cite>NULL</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalERKNSt6stringE">
explicit <code class="descname">Decimal</code>(const std::string &amp;s) </dt>
<dd>Exact conversion from a <cite>std::string</cite>. If an internal limit is exceeded
(e.g. the exponent exceeds <cite>MAX_EMAX</cite>), <cite>InvalidOperation</cite> is set
and the result is <cite>NaN</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7Decimal7DecimalERK20mpd_uint128_triple_t">
explicit <code class="descname">Decimal</code>(const mpd_uint128_triple_t &amp;triple) </dt>
<dd>Exact conversion from an <cite>mpd_uint128_triple_t</cite>. The triple can represent
Decimals with a coefficient up to 38 decimal digits. Refer to the <cite>libmpdec</cite>
documentation for details (See: <cite>mpd_from_uint128_triple</cite>).
Raises <cite>InvalidOperation</cite> for invalid input and <cite>MemoryError</cite> for allocation
failures.
</dd></dl>

</dd></dl>

</div>
<div class="section" id="inexact-constructors">
<h2>Inexact constructors</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimal7DecimalERK7DecimalR7Context">
explicit <code class="descname">Decimal</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c) </dt>
<dd>Inexact construction according to the context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7DecimalERK1TR7Context">
explicit <code class="descname">Decimal</code>(const T &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c) </dt>
<dd>Inexact integer conversions according to the context. <cite>T</cite> is one of:
<blockquote>
<div><table border="1" class="docutils align-default">
<colgroup>
<col width="41%" />
<col width="59%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><cite>int8_t</cite></td>
<td><cite>uint8_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int16_t</cite></td>
<td><cite>uint16_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>int32_t</cite></td>
<td><cite>uint32_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int64_t</cite></td>
<td><cite>uint64_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>signed char</cite></td>
<td><cite>unsigned char</cite></td>
</tr>
<tr class="row-even"><td><cite>short</cite></td>
<td><cite>unsigned short</cite></td>
</tr>
<tr class="row-odd"><td><cite>int</cite></td>
<td><cite>unsigned int</cite></td>
</tr>
<tr class="row-even"><td><cite>long</cite></td>
<td><cite>unsigned long</cite></td>
</tr>
<tr class="row-odd"><td><cite>long long</cite></td>
<td><cite>unsigned long long</cite></td>
</tr>
</tbody>
</table>
</div></blockquote>
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7DecimalEPCKcR7Context">
explicit <code class="descname">Decimal</code>(const char *const s, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c) </dt>
<dd>Inexact conversion from a <cite>C</cite> string according to the context. If an
internal limit is exceeded (e.g. the exponent exceeds <cite>MAX_EMAX</cite>),
<cite>InvalidOperation</cite> is set and the result is <cite>NaN</cite>.
Raises <cite>ValueError</cite> if the argument is <cite>NULL</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal7DecimalERKNSt6stringER7Context">
explicit <code class="descname">Decimal</code>(const std::string &amp;s, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c) </dt>
<dd>Inexact conversion from a <cite>std::string</cite> according to the context. If an
internal limit is exceeded (e.g. the exponent exceeds <cite>MAX_EMAX</cite>),
<cite>InvalidOperation</cite> is set and the result is <cite>NaN</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="accessors">
<h2>Accessors</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimal3getEv">
mpd_t *<code class="descname">get</code>() </dt>
<dd>Return a pointer to the private <cite>mpd_t</cite>. This should only be used for passing
a Decimal’s internal value to <cite>libmpdec</cite> functions, where the Decimal is in
the output position.
This is an advanced function that is not necessary for normal use.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal8getconstEv">
const mpd_t *<code class="descname">getconst</code>() const </dt>
<dd>Return a const pointer to the private <cite>mpd_t</cite>. This should only be used for
passing a Decimal’s internal value to <cite>libmpdec</cite> functions, where the Decimal
is in the input position.
This is an advanced function that is not necessary for normal use.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal4signEv">
int <code class="descname">sign</code>() const </dt>
<dd>Return the arithmetic sign of the Decimal: <cite>1</cite> for positive values, <cite>-1</cite>
for negative values.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5coeffEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">coeff</code>() const </dt>
<dd>Return the coefficient of the Decimal. If the Decimal is a special value,
raise <cite>ValueError</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal8exponentEv">
int64_t <code class="descname">exponent</code>() const </dt>
<dd>Return the exponent of the Decimal. If the Decimal is a special value,
raise <cite>ValueError</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal7payloadEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">payload</code>() const </dt>
<dd>Return the <cite>NaN</cite> payload of the Decimal. The default value for <cite>NaNs</cite>
without a payload is <cite>0</cite>.
If the Decimal is not a <cite>NaN</cite>, raise <cite>ValueError</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="exact-assignment-operators">
<h2>Exact assignment operators</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimalaSERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>Make an exact copy of the argument. This function can raise <cite>MallocError</cite>
if <cite>self</cite> is an arbitrary precision Decimal with a very large coefficient.
In practice this does not occur with regular context precisions from
9 to 38 digits.
Copying has a strong exception guarantee, so the lvalue is unchanged
in case of <cite>MallocError</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalaSERR7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator=</code>(<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;&amp;other) noexcept </dt>
<dd>Move the argument. The argument is reset to <cite>sNaN</cite> and is still in
a valid state.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="inexact-assignment-operators">
<h2>Inexact assignment operators</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimalpLERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator+=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>In-place add. Uses the thread local context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalmIERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator-=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>In-place subtract. Uses the thread local context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalmLERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator*=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>In-place multiply. Uses the thread local context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimaldVERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator/=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>In-place divide. Uses the thread local context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalrMERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;<code class="descname">operator%=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) </dt>
<dd>In-place remainder. Uses the thread local context.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="exact-comparison-operators">
<h2>Exact comparison operators</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimaleqERK7Decimal">
bool <code class="descname">operator==</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Determine if the values are exactly equal. Infinities compare equal
if the signs are equal. Quiet <cite>NaNs</cite> are not equal to anything else
(including quiet <cite>NaNs</cite>).
Signaling <cite>NaNs</cite> set <cite>InvalidOperation</cite>, using the thread local context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalneERK7Decimal">
bool <code class="descname">operator!=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Determine if the values are not equal. The above rules apply
(adapted for <cite>!=</cite>).
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalltERK7Decimal">
bool <code class="descname">operator&lt;</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Determine if <cite>self &lt; other</cite>. In the case of ordering comparisons quiet
<cite>NaNs</cite> also set <cite>InvalidOperation</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalleERK7Decimal">
bool <code class="descname">operator&lt;=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Determine if <cite>self &lt;= other</cite>. In the case of ordering comparisons quiet
<cite>NaNs</cite> also set <cite>InvalidOperation</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalgeERK7Decimal">
bool <code class="descname">operator&gt;=</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Determine if <cite>self &gt;= other</cite>. In the case of ordering comparisons quiet
<cite>NaNs</cite> also set <cite>InvalidOperation</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalgtERK7Decimal">
bool <code class="descname">operator&gt;</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Determine if <cite>self &gt; other</cite>. In the case of ordering comparisons quiet
<cite>NaNs</cite> also set <cite>InvalidOperation</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="exact-reverse-comparison-operators">
<h2>Exact reverse comparison operators</h2>
<blockquote>
<div>Reverse comparison operators. <cite>T</cite> is one of:
<blockquote>
<div><table border="1" class="docutils align-default">
<colgroup>
<col width="41%" />
<col width="59%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><cite>int8_t</cite></td>
<td><cite>uint8_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int16_t</cite></td>
<td><cite>uint16_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>int32_t</cite></td>
<td><cite>uint32_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int64_t</cite></td>
<td><cite>uint64_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>signed char</cite></td>
<td><cite>unsigned char</cite></td>
</tr>
<tr class="row-even"><td><cite>short</cite></td>
<td><cite>unsigned short</cite></td>
</tr>
<tr class="row-odd"><td><cite>int</cite></td>
<td><cite>unsigned int</cite></td>
</tr>
<tr class="row-even"><td><cite>long</cite></td>
<td><cite>unsigned long</cite></td>
</tr>
<tr class="row-odd"><td><cite>long long</cite></td>
<td><cite>unsigned long long</cite></td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="function">
<dt id="_CPPv4N7decimaleqERK1TRK7Decimal">
bool <code class="descname">operator==</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalneERK1TRK7Decimal">
bool <code class="descname">operator!=</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalltERK1TRK7Decimal">
bool <code class="descname">operator&lt;</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalleERK1TRK7Decimal">
bool <code class="descname">operator&lt;=</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalgeERK1TRK7Decimal">
bool <code class="descname">operator&gt;=</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalgtERK1TRK7Decimal">
bool <code class="descname">operator&gt;</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

</div></blockquote>
</div>
<div class="section" id="unary-arithmetic-operators">
<h2>Unary arithmetic operators</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimalmiEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator-</code>() const </dt>
<dd>Negate the input operand. This function is equivalent to <cite>Decimal.minus</cite> and
applies the thread local context. Note that positive zeros keep their sign,
unless the rounding is set to <cite>ROUND_FLOOR</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalplEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator+</code>() const </dt>
<dd>Return the input operand after applying the thread local context. This function is equivalent
to <cite>Decimal.plus</cite>. Note that negative zeros lose their sign, unless the rounding is set to
<cite>ROUND_FLOOR</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="binary-arithmetic-operators">
<h2>Binary arithmetic operators</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimalplERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator+</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Return <cite>self + other</cite>. The operation is performed on the unrounded input operands
and has a single final rounding step. The thread local context is used.
Same as <cite>self.add(other, context)</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalmiERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator-</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Return <cite>self - other</cite>. The operation is performed on the unrounded input operands
and has a single final rounding step. The thread local context is used.
Same as <cite>self.sub(other, context)</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalmlERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator*</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Return <cite>self * other</cite>. The operation is performed on the unrounded input operands
and has a single final rounding step. The thread local context is used.
Same as <cite>self.mul(other, context)</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimaldvERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator/</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Return <cite>self / other</cite>. The operation is performed on the unrounded input operands
and has a single final rounding step. The thread local context is used.
Same as <cite>self.div(other, context)</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimalrmERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator%</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Return <cite>self % other</cite>. The operation is performed on the unrounded input operands
and has a single final rounding step. The thread local context is used.
Same as <cite>self.rem(other, context)</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="reverse-binary-arithmetic-operators">
<h2>Reverse binary arithmetic operators</h2>
<blockquote>
<div>Reverse binary arithmetic operators. <cite>T</cite> is one of:
<blockquote>
<div><table border="1" class="docutils align-default">
<colgroup>
<col width="41%" />
<col width="59%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td><cite>int8_t</cite></td>
<td><cite>uint8_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int16_t</cite></td>
<td><cite>uint16_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>int32_t</cite></td>
<td><cite>uint32_t</cite></td>
</tr>
<tr class="row-even"><td><cite>int64_t</cite></td>
<td><cite>uint64_t</cite></td>
</tr>
<tr class="row-odd"><td><cite>signed char</cite></td>
<td><cite>unsigned char</cite></td>
</tr>
<tr class="row-even"><td><cite>short</cite></td>
<td><cite>unsigned short</cite></td>
</tr>
<tr class="row-odd"><td><cite>int</cite></td>
<td><cite>unsigned int</cite></td>
</tr>
<tr class="row-even"><td><cite>long</cite></td>
<td><cite>unsigned long</cite></td>
</tr>
<tr class="row-odd"><td><cite>long long</cite></td>
<td><cite>unsigned long long</cite></td>
</tr>
</tbody>
</table>
</div></blockquote>
<dl class="function">
<dt id="_CPPv4N7decimalplERK1TRK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator+</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalmiERK1TRK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator-</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalmlERK1TRK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator*</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimaldvERK1TRK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator/</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimalrmERK1TRK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">operator%</code>(const T &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd></dd></dl>

</div></blockquote>
</div>
<div class="section" id="predicates">
<h2>Predicates</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal8isfiniteEv">
bool <code class="descname">isfinite</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is a finite number, and <cite>false</cite> if <cite>self</cite>
is infinite or a quiet or signaling <cite>NaN</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal10isinfiniteEv">
bool <code class="descname">isinfinite</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is either a positive or negative infinity and
<cite>false</cite> otherwise.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal9isspecialEv">
bool <code class="descname">isspecial</code>() const </dt>
<dd>Return true if <cite>self</cite> is a quiet or signaling <cite>NaN</cite> or infinite, <cite>false</cite>
otherwise.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5isnanEv">
bool <code class="descname">isnan</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is a quiet or signaling <cite>NaN</cite> and <cite>false</cite>
otherwise.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6isqnanEv">
bool <code class="descname">isqnan</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is a quiet <cite>NaN</cite>, and <cite>false</cite> otherwise.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6issnanEv">
bool <code class="descname">issnan</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is a signaling <cite>NaN</cite> and <cite>false</cite> otherwise.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal8issignedEv">
bool <code class="descname">issigned</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> has a negative sign and <cite>false</cite> otherwise.
Note that both zeros and <cite>NaNs</cite> can carry signs.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6iszeroEv">
bool <code class="descname">iszero</code>() const </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is a positive or negative zero, <cite>false</cite> otherwise.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal9isintegerEv">
bool <code class="descname">isinteger</code>() const </dt>
<dd>Determine whether <cite>self</cite> is an integer. The exponent of an integer is not
necessarily zero and may be negative if the coefficient has trailing zeros.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="predicates-with-an-optional-context-argument">
<h2>Predicates with an optional context argument</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimal8isnormalERK7Context">
bool <code class="descname">isnormal</code>(const <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is a normal finite non-zero number with an adjusted
exponent greater than or equal to <cite>emin</cite>. Return <cite>false</cite> if <cite>self</cite> is zero,
subnormal, infinite or a quiet or signaling <cite>NaN</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal11issubnormalERK7Context">
bool <code class="descname">issubnormal</code>(const <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) </dt>
<dd>Return <cite>true</cite> if <cite>self</cite> is subnormal, and <cite>false</cite> otherwise. A number is
subnormal if it is non-zero, finite, and has an adjusted exponent less
than <cite>emin</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="unary-functions-no-context-argument">
<h2>Unary functions, no context argument</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal6adjexpEv">
int64_t <code class="descname">adjexp</code>() const </dt>
<dd>Return the adjusted exponent of <cite>self</cite>. Defined as exp + digits - 1.
Raises <cite>ValueError</cite> for special values.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal8copy_absEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">copy_abs</code>() const </dt>
<dd>Return an exact copy of the absolute value of <cite>self</cite>. In contrast to
<cite>Decimal.abs</cite>, this function does not use the thread local context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal11copy_negateEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">copy_negate</code>() const </dt>
<dd>Return an exact copy of the negation of <cite>self</cite>. In contrast to <cite>-self</cite>,
this function does not use the thread local context.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="unary-functions-optional-context-argument">
<h2>Unary functions, optional context argument</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimal12number_classER7Context">
std::string <code class="descname">number_class</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) </dt>
<dd>Return a string describing the class of the operand. The returned value
is one of the following ten strings:
<ul class="simple">
<li>“-Infinity”, indicating that the operand is negative infinity.</li>
<li>“-Normal”, indicating that the operand is a negative normal number.</li>
<li>“-Subnormal”, indicating that the operand is negative and subnormal.</li>
<li>“-Zero”, indicating that the operand is a negative zero.</li>
<li>“+Zero”, indicating that the operand is a positive zero.</li>
<li>“+Subnormal”, indicating that the operand is positive and subnormal.</li>
<li>“+Normal”, indicating that the operand is a positive normal number.</li>
<li>“+Infinity”, indicating that the operand is positive infinity.</li>
<li>“NaN”, indicating that the operand is a quiet <cite>NaN</cite> (Not a Number).</li>
<li>“sNaN”, indicating that the operand is a signaling <cite>NaN`</cite>.</li>
</ul>
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3absER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">abs</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the absolute value of x.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal4ceilER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">ceil</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the ceiling of <cite>self</cite>. Not part of the standard.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3expER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">exp</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the value of the exponential function <cite>e**x</cite> at the given
number. The function always uses the <cite>ROUND_HALF_EVEN</cite> mode.
If <cite>c.allcr() == 1</cite>, the result is always correctly rounded.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5floorER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">floor</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the floor of <cite>self</cite>. Not part of the standard.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal7invrootER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">invroot</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the reciprocal of the square root of <cite>self</cite>. The function always
uses the <cite>ROUND_HALF_EVEN</cite> mode. Results are not correctly rounded, even
if the <cite>allcr</cite> context field is set to 1. This might change in a future
release.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal2lnER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">ln</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the natural (base <cite>e</cite>) logarithm of the operand. The function always
uses the <cite>ROUND_HALF_EVEN</cite> mode.
If <cite>c.allcr() == 1</cite>, the result is always correctly rounded.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5log10ER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">log10</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the base ten logarithm of the operand. The function always uses the
<cite>ROUND_HALF_EVEN</cite> mode.
If <cite>c.allcr() == 1</cite>, the result is always correctly rounded.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal4logbER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">logb</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>For a non-zero number, return the adjusted exponent of the operand as a
Decimal instance. If the operand is a zero, then <cite>Decimal(“-Infinity”)</cite> is
returned and the <cite>DivisionByZero</cite> condition is raised. If the operand is
an infinity then <cite>Decimal(“Infinity”)</cite> is returned.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5minusER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">minus</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Negate the input operand and apply the context. Note that positive zeros keep
their sign, unless the rounding is set to <cite>ROUND_FLOOR</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal10next_minusER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">next_minus</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the largest number representable in the given context that is
smaller than the given operand.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal9next_plusER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">next_plus</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the smallest number representable in the given context that is
larger than the given operand.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal4plusER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">plus</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Copy the input operand and apply the context. Note that negative zeros lose
their sign, unless the rounding is set to <cite>ROUND_FLOOR</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6reduceER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">reduce</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Normalize the number by stripping the rightmost trailing zeros and
converting any result equal to <cite>Decimal(“0”)</cite> to <cite>Decimal(“0e0”)</cite>.
Used for producing representative values for members of an equivalence
class. For example, Decimal(“32.100”) and Decimal(“0.321000e+2”) both
normalize to the equivalent value Decimal(“32.1”).
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal11to_integralER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">to_integral</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Round to the nearest integer without signaling Inexact or Rounded.
The rounding mode is determined by the by the given context.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal17to_integral_exactER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">to_integral_exact</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Round to the nearest integer, signaling <cite>Inexact</cite> or <cite>Rounded</cite> as
appropriate if rounding occurs. The rounding mode is determined by
the rounding parameter if given, else by the given context. If neither
parameter is given, then the rounding mode of the current default
context is used.
Note that the use of <cite>exact</cite> in this name is determined by the
specification and differs from the terminology in <cite>libmpdec++</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal4sqrtER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">sqrt</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the square root of <cite>self</cite> to context precision. The rounding mode is
always <cite>ROUND_HALF_EVEN</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5truncER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">trunc</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return <cite>self</cite>, truncated towards zero. Not part of the standard.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="binary-functions-no-context-argument">
<h2>Binary functions, no context argument</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal13compare_totalERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">compare_total</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Compare two operands using their abstract representation rather than
their numerical value. Similar to <cite>Decimal.compare</cite>, but the result
gives a total ordering on Decimal instances. Two Decimal instances with
the same numeric value but different representations compare unequal
in this ordering:
<div class="highlight-cpp notranslate"><div class="highlight"><pre>Decimal(&quot;12.0&quot;).compare_total(Decimal(&quot;12&quot;)) == Decimal(&quot;-1&quot;)
</pre></div>
</div>
Quiet and signaling NaNs are also included in the total ordering. The result
of this function is Decimal(“0”) if both operands have the same representation,
Decimal(“-1”) if the first operand is lower in the total order than the second,
and Decimal(“1”) if the first operand is higher in the total order than the
second operand. See the specification for details of the total order.
This operation is unaffected by context and is quiet: no flags are changed
and no rounding is performed.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal17compare_total_magERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">compare_total_mag</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Compare two operands using their abstract representation rather than their
value as in <cite>Decimal.compare_total</cite>, but ignoring the sign of each operand.
<div class="highlight-cpp notranslate"><div class="highlight"><pre>x.compare_total_mag(y) == x.copy_abs().compare_total(y.copy_abs())
</pre></div>
</div>
This operation is unaffected by context and is quiet: no flags are changed
and no rounding is performed.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="binary-functions-optional-context-argument">
<h2>Binary functions, optional context argument</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal3addERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">add</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the sum of <cite>self</cite> and <cite>other</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3divERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">div</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return <cite>self</cite> divided by other.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6divintERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">divint</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return <cite>self</cite> divided by <cite>other</cite>, truncated to an integer.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal7compareERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">compare</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Compare self to other. Return a decimal value:
<div class="highlight-default notranslate"><div class="highlight"><pre>a.issnan() || b.issnan() =&gt; InvalidOperation
a.isqnan() || b.isqnan() =&gt; Decimal(&quot;NaN&quot;)
a &lt; b =&gt; Decimal(&quot;-1&quot;)
a == b =&gt; Decimal(&quot;0&quot;)
a &gt; b =&gt; Decimal(&quot;1&quot;)
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal14compare_signalERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">compare_signal</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Compare self to other. Return a decimal value:
<div class="highlight-default notranslate"><div class="highlight"><pre>a.issnan() || b.issnan() =&gt; InvalidOperation
a.isqnan() || b.isqnan() =&gt; InvalidOperation
a &lt; b =&gt; Decimal(&quot;-1&quot;)
a == b =&gt; Decimal(&quot;0&quot;)
a &gt; b =&gt; Decimal(&quot;1&quot;)
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3maxERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">max</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Maximum of <cite>self</cite> and <cite>other</cite>. NOTE: If one operand is a quiet <cite>NaN</cite> and
the other is numeric, the numeric operand is returned.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal7max_magERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">max_mag</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Similar to <cite>Decimal.max</cite>, but the comparison is done using the absolute
values of the operands.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3minERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">min</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Minimum of <cite>self</cite> and <cite>other</cite>. NOTE: If one operand is a quiet NaN and
the other is numeric, the numeric operand is returned.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal7min_magERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">min_mag</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Similar to <cite>Decimal.min</cite>, but the comparison is done using the absolute
values of the operands.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3mulERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">mul</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the product of <cite>self</cite> and <cite>other</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal11next_towardERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">next_toward</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>If the two operands are unequal, return the number closest to the first
operand in the direction of the second operand. If both operands are
numerically equal, return a copy of the first operand with the sign set
to be the same as the sign of the second operand.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3powERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">pow</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Compute <cite>self</cite> raised to the power of <cite>other</cite>. If <cite>self</cite> is negative, then
<cite>other</cite> must be integral. The result will be inexact unless <cite>self</cite> is integral
and the result is finite and can be expressed exactly in <cite>prec</cite> digits.
The result is almost always correctly rounded, but correct rounding is not
guaranteed even if <cite>c.allcr()</cite> is set.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal8quantizeERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">quantize</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return a value equal to <cite>self</cite> after rounding and having the exponent of
the second operand.
<div class="highlight-cpp notranslate"><div class="highlight"><pre>Decimal(&quot;1.41421356&quot;).quantize(Decimal(&quot;1.000&quot;)) == Decimal(&quot;1.414&quot;)
</pre></div>
</div>
Unlike other operations, if the length of the coefficient after the quantize
operation would be greater than precision, then <cite>InvalidOperation</cite> is set.
This guarantees that, unless there is an error condition, the quantized exponent
is always equal to that of the right-hand operand.
Also unlike other operations, quantize never sets Underflow, even if the
result is subnormal and inexact.
If the exponent of the second operand is larger than that of the first, then
rounding may be necessary. In this case, the rounding mode is determined by the
the given context argument.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3remERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">rem</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>The remainder from the division by <cite>Decimal.divint</cite>. Fails under the same
conditions as <cite>Decimal.divint</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal8rem_nearERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">rem_near</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return <cite>self - other * n</cite>, where <cite>n</cite> is the integer nearest the exact value of
<cite>self / other</cite>. If the result is 0 then its sign will be the sign of <cite>self</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6scalebERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">scaleb</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the <cite>self</cite> with the exponent adjusted by the value of <cite>other</cite>. Equivalently,
return the first operand multiplied by <cite>10 ** other</cite>. The second operand must be
an integer.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3subERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">sub</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the difference between <cite>self</cite> and <cite>other</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="binary-functions-two-return-values">
<h2>Binary functions, two return values</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal6divmodERK7DecimalR7Context">
std::pair&lt;<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a>, <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a>&gt; <code class="descname">divmod</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return quotient and remainder of the division <cite>self / other</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="ternary-functions">
<h2>Ternary functions</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal3fmaERK7DecimalRK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">fma</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;third, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Fused multiply-add. Return <cite>self * other + third</cite> with no rounding of
the intermediate product <cite>self * other</cite>.
<div class="highlight-cpp notranslate"><div class="highlight"><pre>Decimal(2).fma(3, 5) == Decimal(11)
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6powmodERK7DecimalRK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">powmod</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;third, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd><cite>self ** other % third</cite>. The following restrictions hold:
<ul class="simple">
<li>All three arguments must be integral.</li>
<li><cite>other</cite> must be nonnegative.</li>
<li>At least one of <cite>self</cite> or <cite>other</cite> must be nonzero.</li>
<li><cite>third</cite> must be nonzero and less than <cite>10 ** prec</cite> in absolute value.</li>
</ul>
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="irregular-functions">
<h2>Irregular functions</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal5applyER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">apply</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return a copy of <cite>self</cite> with the given context applied. This directly wraps <code class="xref cpp cpp-func docutils literal notranslate">mpd_finalize</code>.
It is very similar to <cite>Decimal.plus</cite>, but does not have special rules for zeros.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3cmpERK7Decimal">
int <code class="descname">cmp</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Same as <cite>Decimal.compare_signal</cite>, but with an integer return value. Return
<cite>INT_MAX</cite> if any operand is <cite>NaN</cite>. Not part of the specification.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal9cmp_totalERK7Decimal">
int <code class="descname">cmp_total</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Same as <cite>Decimal.compare_total</cite>, but with an integer return value.
Not part of the specification.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal13cmp_total_magERK7Decimal">
int <code class="descname">cmp_total_mag</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Same as <cite>Decimal.compare_total_mag</cite>, but with an integer return value.
Not part of the specification.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal9copy_signERK7Decimal">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">copy_sign</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Return a copy of the first operand with the sign set to be the same as the
sign of the second operand. For example:
<div class="highlight-cpp notranslate"><div class="highlight"><pre>Decimal(&quot;2.3&quot;).copy_sign(Decimal(&quot;-1.5&quot;)) == Decimal(&quot;-2.3&quot;)
</pre></div>
</div>
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal7rescaleEK7int64_tR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">rescale</code>(const int64_t exp, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the number that is equal in value to <cite>self</cite>, but has the exponent <cite>exp</cite>.
Special numbers are copied without signaling. This function is not part of the
standard. It is also not equivalent to the <cite>rescale</cite> function that was removed
from the standard.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal12same_quantumERK7Decimal">
bool <code class="descname">same_quantum</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other) const </dt>
<dd>Test whether self and other have the same exponent or whether both are <cite>NaN</cite>.
This operation is unaffected by context and is quiet: no flags are changed
and no rounding is performed.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6shiftlEK7int64_tR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">shiftl</code>(const int64_t n, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return a copy of <cite>self</cite>, with its coefficient shifted by <cite>n</cite> places to
the left. <cite>self</cite> must not be a special number. Digits are never discarded,
so the coefficient of the result might exceed <cite>prec</cite>.
This function is not part of the specification.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6shiftrEK7int64_tR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">shiftr</code>(const int64_t n, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return a copy of <cite>self</cite>, with its coefficient shifted by <cite>n</cite> places to
the right.
This function is not part of the specification.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal5exactEPCKcR7Context">
static <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">exact</code>(const char *const s, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c) </dt>
<dd>This constructs an exact decimal from a <cite>C</cite> string. The context is only passed
for error reporting in case the internal limits are exceeded.
This is a convenience function that is rarely used. Not part of the specification.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal5exactERKNSt6stringER7Context">
static <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">exact</code>(const std::string &amp;s, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c) </dt>
<dd>Same as above, except for the argument type.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal4ln10E7int64_tR7Context">
static <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">ln10</code>(int64_t n, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) </dt>
<dd>Compute <cite>ln(10)</cite> to <cite>n</cite> digits of precision. Rounding is always <cite>ROUND_HALF_EVEN</cite>.
If <cite>c.allcr()</cite> is set, the result is correctly rounded.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="exact-integer-conversion">
<h2>Exact integer conversion</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal3i64Ev">
int64_t <code class="descname">i64</code>() const </dt>
<dd>Convert a Decimal that is exactly representable as an <cite>int64_t</cite>. In case of
failure, raise <cite>ValueError</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3i32Ev">
int32_t <code class="descname">i32</code>() const </dt>
<dd>Convert a Decimal that is exactly representable as an <cite>int32_t</cite>. In case of
failure, raise <cite>ValueError</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3u64Ev">
uint64_t <code class="descname">u64</code>() const </dt>
<dd>Convert a Decimal that is exactly representable as a <cite>uint64_t</cite>. In case of
failure, raise <cite>ValueError</cite>.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal3u32Ev">
uint32_t <code class="descname">u32</code>() const </dt>
<dd>Convert a Decimal that is exactly representable as a <cite>uint32_t</cite>. In case of
failure, raise <cite>ValueError</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="exact-triple-conversion">
<h2>Exact triple conversion</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal17as_uint128_tripleEv">
mpd_uint128_triple_t <code class="descname">as_uint128_triple</code>() const </dt>
<dd>Exact conversion to an <cite>mpd_uint128_triple_t</cite>. The triple can represent
Decimals with a coefficient up to 38 decimal digits. Refer to the <cite>libmpdec</cite>
documentation for details on how to handle the return value and errors
(See: <cite>mpd_as_uint128_triple</cite>).
Raises <cite>InvalidOperation</cite> if the coefficient is too large.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="exact-string-conversion">
<h2>Exact string conversion</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal4reprEb">
std::string <code class="descname">repr</code>(bool capitals = true) const </dt>
<dd>Same as <cite>Decimal.to_sci</cite>, but wrap the string in a constructor.
<blockquote>
<div><div class="highlight-cpp notranslate"><div class="highlight"><pre>Decimal(&quot;1.234E+100&quot;).repr() == &quot;Decimal(\&quot;1.234E+100\&quot;)&quot;
</pre></div>
</div>
</div></blockquote>
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6to_sciEb">
std::string <code class="descname">to_sci</code>(bool capitals = true) const </dt>
<dd>Return the scientific string representation of a Decimal. This operation
is not context sensitive. If <cite>capitals</cite> is <cite>false</cite>, the exponent character
is lower case, otherwise it is upper case.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6to_engEb">
std::string <code class="descname">to_eng</code>(bool capitals = true) const </dt>
<dd>Return the engineering string representation of a Decimal. This operation
is not context sensitive. If <cite>capitals</cite> is <cite>false</cite>, the exponent character
is lower case, otherwise it is upper case.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="inexact-string-conversion">
<h2>Inexact string conversion</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal6formatEPKcRK7Context">
std::string <code class="descname">format</code>(const char *fmt, const <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the string representation of a decimal according to format string <cite>fmt</cite>.
The format string syntax is the same as in Python PEP 3101 (See Standard Format
Specifiers) and is quite similar to the syntax used for floating point numbers
the C <code class="xref cpp cpp-func docutils literal notranslate">fprintf</code> function. The fill character may be a UTF-8 character,
the rest of the format string must be ASCII.
The function raises <cite>ValueError</cite> for an invalid format string or <cite>MallocError</cite>
in case of an allocation failure.
If the “n” format specifier is used, the function calls <code class="xref cpp cpp-func docutils literal notranslate">localeconv</code>.
Depending on the guarantees of the system’s <code class="xref cpp cpp-func docutils literal notranslate">localeconv</code>, this method
may require a lock.
All other format specifiers are thread-safe.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6formatERKNSt6stringERK7Context">
std::string <code class="descname">format</code>(const std::string &amp;s, const <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Same as above, using a string argument.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="streams">
<h2>Streams</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4N7decimallsERNSt7ostreamERK7Decimal">
friend std::ostream &amp;<code class="descname">operator&lt;&lt;</code>(std::ostream &amp;os, const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;self) </dt>
<dd>The conversion uses <cite>Decimal.to_sci</cite>.
</dd></dl>

</div></blockquote>
</div>
<div class="section" id="required-by-the-specification">
<h2>Required by the specification</h2>
<blockquote>
<div><dl class="function">
<dt id="_CPPv4NK7decimal11iscanonicalEv">
bool <code class="descname">iscanonical</code>() const </dt>
<dd>Return <cite>true</cite>. This function is required by the specification, and the
representation of Decimals is always canonical.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal9canonicalEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">canonical</code>() const </dt>
<dd>Return an exact copy of <cite>self</cite>. No context is used. Identical to the assignment operator.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal4copyEv">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">copy</code>() const </dt>
<dd>Return an exact copy of <cite>self</cite>. No context is used. Identical to the assignment operator.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal11logical_andERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">logical_and</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Digit-wise <cite>and</cite> of <cite>self</cite> and <cite>other</cite>. All digits must be 0 or 1.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal14logical_invertER7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">logical_invert</code>(<a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Invert the digits of <cite>self</cite>. All digits must be 0 or 1.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal10logical_orERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">logical_or</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Digit-wise <cite>or</cite> of <cite>self</cite> and <cite>other</cite>. All digits must be 0 or 1.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal11logical_xorERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">logical_xor</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Digit-wise <cite>xor</cite> of <cite>self</cite> and <cite>other</cite>. All digits must be 0 or 1.
</dd></dl>

<dl class="function">
<dt id="_CPPv4N7decimal5radixEv">
static int32_t <code class="descname">radix</code>() </dt>
<dd>Return 10.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6rotateERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">rotate</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the result of rotating the digits of the first operand by an amount
specified by the second operand. The second operand must be an integer in
the range -precision through precision. The absolute value of the second
operand gives the number of places to rotate. If the second operand is
positive then rotation is to the left; otherwise rotation is to the right
The coefficient of the first operand is padded on the left with zeros to
length precision if necessary. The sign and exponent of the first operand are
unchanged.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal5shiftERK7DecimalR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">shift</code>(const <a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> &amp;other, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Return the result of shifting the digits of the <cite>self</cite> by an amount
specified by the <cite>other</cite>. <cite>other</cite> must be an integer in the range
<cite>-prec through prec</cite>. The absolute value of the second operand gives
the number of places to shift. If <cite>self</cite> is positive, then the shift
is to the left; otherwise the shift is to the right. Digits shifted
into the coefficient are zeros. The sign and exponent are unchanged.
</dd></dl>

<dl class="function">
<dt id="_CPPv4NK7decimal6shiftnEK7int64_tR7Context">
<a class="reference internal" href="#_CPPv4N7decimal7DecimalE" title="decimal::Decimal">Decimal</a> <code class="descname">shiftn</code>(const int64_t n, <a class="reference internal" href="context.html#_CPPv4N7decimal7ContextE" title="decimal::Context">Context</a> &amp;c = context) const </dt>
<dd>Like <cite>Decimal.shift</cite>, only that the number of places is specified by a
C integer type rather than a decimal. This function is not part of the
specification.
</dd></dl>

</div></blockquote>
</div>
</div>

</div>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="context.html" title="Context"
 >previous</a></li>
 <li><a href="http://www.bytereef.org/mpdecimal/index.html">project home</a></li>
 
 </ul>
 </div>
 <div class="footer" role="contentinfo">
 &#169; Copyright 2010-2020, Stefan Krah.
 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 2.4.4.
 </div>
 </body>
</html>

003 File Manager

Editing: decimal.html

Upload File

Create Folder