File Manager

003 File Manager

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

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

📁 ..
📄 README.txt(88 B)
📁 _static
📄 arithmetic.html(109.46 KB)
📄 assign-convert.html(56.83 KB)
📄 attributes.html(24.85 KB)
📄 context.html(37.84 KB)
📄 decimals.html(8.45 KB)
📄 functions.html(58.37 KB)
📄 index.html(16.95 KB)
📄 memory.html(15.59 KB)
📄 objects.inv(1.83 KB)
📄 search.html(2.76 KB)
📄 searchindex.js(30.97 KB)
📄 various.html(40.5 KB)

Editing: various.html

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

<title>Various Functions &#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="next" title="Advanced Memory Handling" href="memory.html" />
 <link rel="prev" title="Arithmetic Functions" href="arithmetic.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="memory.html" title="Advanced Memory Handling"
 accesskey="N">next</a></li>
 <li class="right" >
 <a href="arithmetic.html" title="Arithmetic Functions"
 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="#">Various Functions</a><ul>
<li><a class="reference internal" href="#applying-the-context">Applying the Context</a><ul>
<li><a class="reference internal" href="#finalize">finalize</a></li>
</ul>
</li>
<li><a class="reference internal" href="#nan-handling">NaN Handling</a><ul>
<li><a class="reference internal" href="#check-nan">check-nan</a></li>
<li><a class="reference internal" href="#check-nans">check-nans</a></li>
</ul>
</li>
<li><a class="reference internal" href="#shifting-and-rotating">Shifting and Rotating</a><ul>
<li><a class="reference internal" href="#shift">shift</a></li>
<li><a class="reference internal" href="#shiftn">shiftn</a></li>
<li><a class="reference internal" href="#shiftl">shiftl</a></li>
<li><a class="reference internal" href="#shiftr">shiftr</a></li>
<li><a class="reference internal" href="#shiftr-inplace">shiftr-inplace</a></li>
<li><a class="reference internal" href="#rotate">rotate</a></li>
</ul>
</li>
<li><a class="reference internal" href="#logical-operations">Logical Operations</a><ul>
<li><a class="reference internal" href="#and">and</a></li>
<li><a class="reference internal" href="#or">or</a></li>
<li><a class="reference internal" href="#xor">xor</a></li>
<li><a class="reference internal" href="#invert">invert</a></li>
</ul>
</li>
<li><a class="reference internal" href="#base-conversions">Base Conversions</a><ul>
<li><a class="reference internal" href="#importing">Importing</a></li>
<li><a class="reference internal" href="#exporting">Exporting</a></li>
</ul>
</li>
<li><a class="reference internal" href="#required-functions">Required Functions</a></li>
<li><a class="reference internal" href="#library-version">Library version</a></li>
</ul>
</li>
</ul>

<h4>Previous topic</h4>
 <a href="arithmetic.html"
 title="previous chapter">Arithmetic Functions</a>
 <h4>Next topic</h4>
 <a href="memory.html"
 title="next chapter">Advanced Memory Handling</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="various-functions">
<h1>Various Functions</h1>
<div class="section" id="applying-the-context">
<h2>Applying the Context</h2>
<div class="section" id="finalize">
<h3>finalize</h3>
<div class="highlight-c notranslate" id="std:topic-mpd_finalize"><div class="highlight"><pre>void mpd_qfinalize(mpd_t *result, const mpd_context_t *ctx,
 uint32_t *status);
void mpd_finalize(mpd_t *result, mpd_context_t *ctx);
</pre></div>
</div>
Apply ctx to result. This function performs checks the exponent limits
and performs rounding. The following conditions can occur:
<code class="xref c c-macro docutils literal notranslate">MPD_Clamped</code>, <code class="xref c c-macro docutils literal notranslate">MPD_Inexact</code>, <code class="xref c c-macro docutils literal notranslate">MPD_Overflow</code>,
<code class="xref c c-macro docutils literal notranslate">MPD_Rounded</code>, <code class="xref c c-macro docutils literal notranslate">MPD_Subnormal</code>, <code class="xref c c-macro docutils literal notranslate">MPD_Underflow</code>
</div>
</div>
<div class="section" id="nan-handling">
<h2>NaN Handling</h2>
These functions are convenience functions that take care of the elaborate
NaN handling rules. They are meant to be used at the beginning of composite
functions.
<div class="section" id="check-nan">
<h3>check-nan</h3>
<div class="highlight-c notranslate" id="std:topic-mpd_check_nan"><div class="highlight"><pre>int mpd_qcheck_nan(mpd_t *result, const mpd_t *a, const mpd_context_t *ctx,
 uint32_t *status);
int mpd_check_nan(mpd_t *result, const mpd_t *a, mpd_context_t *ctx);
</pre></div>
</div>
If a is NaN or sNaN, set result to qNaN, copy any payload, apply ctx
to the payload and return 1. If a is sNaN, additionally set
<code class="xref c c-macro docutils literal notranslate">MPD_Invalid_operation</code>.
Otherwise, result is undefined and the return value is 0.
</div>
<div class="section" id="check-nans">
<h3>check-nans</h3>
<div class="highlight-c notranslate" id="std:topic-mpd_check_nans"><div class="highlight"><pre>int mpd_qcheck_nans(mpd_t *result, const mpd_t *a, const mpd_t *b,
 const mpd_context_t *ctx, uint32_t *status);
int mpd_check_nans(mpd_t *result, const mpd_t *a, const mpd_t *b,
 mpd_context_t *ctx);
</pre></div>
</div>
If either operand is NaN or sNaN, apply the precedence rules, set result
to qNaN, copy any payload, apply ctx to the payload and return 1. If
one of the operands is sNaN, additionally set <code class="xref c c-macro docutils literal notranslate">MPD_Invalid_operation</code>.
Otherwise, result is undefined and the return value is 0.
</div>
</div>
<div class="section" id="shifting-and-rotating">
<h2>Shifting and Rotating</h2>
<div class="section" id="shift">
<h3>shift</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>void mpd_qshift(mpd_t *result, const mpd_t *a, const mpd_t *b,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_shift(mpd_t *result, const mpd_t *a, const mpd_t *b,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to a shifted by b places. b must be in the range
[-prec, prec]. A negative b indicates a right shift, a positive
b a left shift. Digits that do not fit are discarded.
</div>
<div class="section" id="shiftn">
<h3>shiftn</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>void mpd_qshiftn(mpd_t *result, const mpd_t *a, mpd_ssize_t n,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_shiftn(mpd_t *result, const mpd_t *a, mpd_ssize_t n,
 mpd_context_t *ctx);
</pre></div>
</div>
Like <code class="xref c c-func docutils literal notranslate">mpd_qshift</code>, 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.
</div>
<div class="section" id="shiftl">
<h3>shiftl</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>int mpd_qshiftl(mpd_t *result, const mpd_t *a, mpd_ssize_t n,
 uint32_t *status);
void mpd_shiftl(mpd_t *result, const mpd_t *a, mpd_ssize_t n,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to a, shifted by n places to the left. a must not be
a special number. Digits are never discarded, so the coefficient of
result might exceed prec. Return 1 on success. On failure, return 0
and add <code class="xref c c-macro docutils literal notranslate">MPD_Malloc_error</code> to status.
This function is not part of the specification.
</div>
<div class="section" id="shiftr">
<h3>shiftr</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>mpd_uint_t mpd_qshiftr(mpd_t *result, const mpd_t *a, mpd_ssize_t n,
 uint32_t *status);
mpd_uint_t mpd_shiftr(mpd_t *result, const mpd_t *a, mpd_ssize_t n,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to a, shifted by n places to the right. a must not be
a special number. On success, return the digit relevant for rounding.
On failure, return <code class="xref c c-macro docutils literal notranslate">MPD_UINT_MAX</code> and add <code class="xref c c-macro docutils literal notranslate">MPD_Malloc_error</code>
to status.
This function is not part of the specification.
</div>
<div class="section" id="shiftr-inplace">
<h3>shiftr-inplace</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>mpd_uint_t mpd_qshiftr_inplace(mpd_t *result, mpd_ssize_t n)
</pre></div>
</div>
Like <code class="xref c c-func docutils literal notranslate">mpd_qshiftr</code>, but shifts result in place. result
must not be a special number. This function cannot fail.
</div>
<div class="section" id="rotate">
<h3>rotate</h3>
<div class="highlight-c notranslate" id="std:topic-mpd_rotate"><div class="highlight"><pre>void mpd_qrotate(mpd_t *result, const mpd_t *a, const mpd_t *b,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_rotate(mpd_t *result, const mpd_t *a, const mpd_t *b,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to a rotated by b places. b must be in the range [-prec, prec].
A negative b indicates a right rotation, a positive b a left rotation.
</div>
</div>
<div class="section" id="logical-operations">
<h2>Logical Operations</h2>
Logical operands are finite numbers with a sign of 0, an exponent of 0 and
a coefficient consisting only of ones and zeros.
<div class="section" id="and">
<h3>and</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>void mpd_qand(mpd_t *result, const mpd_t *a, const mpd_t *b,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_and(mpd_t *result, const mpd_t *a, const mpd_t *b,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to the digit-wise logical and of a and b.
</div>
<div class="section" id="or">
<h3>or</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>void mpd_qor(mpd_t *result, const mpd_t *a, const mpd_t *b,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_or(mpd_t *result, const mpd_t *a, const mpd_t *b,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to the digit-wise logical or of a and b.
</div>
<div class="section" id="xor">
<h3>xor</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>void mpd_qxor(mpd_t *result, const mpd_t *a, const mpd_t *b,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_xor(mpd_t *result, const mpd_t *a, const mpd_t *b,
 mpd_context_t *ctx);
</pre></div>
</div>
Set result to the digit-wise logical xor of a and b.
</div>
<div class="section" id="invert">
<h3>invert</h3>
<div class="highlight-c notranslate"><div class="highlight"><pre>void mpd_qinvert(mpd_t *result, const mpd_t *a, const mpd_context_t *ctx,
 uint32_t *status);
void mpd_invert(mpd_t *result, const mpd_t *a, mpd_context_t *ctx);
</pre></div>
</div>
Set result to the digit-wise logical inversion of a.
</div>
</div>
<div class="section" id="base-conversions">
<h2>Base Conversions</h2>
Functions for converting decimals to multi-precision integers and vice
versa. Decimals that are exported must be integers.
<div class="section" id="importing">
<h3>Importing</h3>
<div class="highlight-c notranslate" id="std:topic-mpd_import_u16"><div class="highlight"><pre>void mpd_qimport_u16(mpd_t *result, const uint16_t *srcdata,
 size_t srclen, uint8_t srcsign, uint32_t srcbase,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_import_u16(mpd_t *result, const uint16_t *srcdata,
 size_t srclen, uint8_t srcsign, uint32_t srcbase,
 mpd_context_t *ctx);
</pre></div>
</div>
Convert a multi-precision integer at srcdata with base srcbase to a
decimal. The least significant word is srcdata[0].
srcsign is <code class="xref c c-macro docutils literal notranslate">MPD_POS</code> for positive and <code class="xref c c-macro docutils literal notranslate">MPD_NEG</code> for
negative, srclen the length of srcdata.
Valid bases are in the range 2 &lt;= srcbase &lt;= <code class="xref c c-macro docutils literal notranslate">UINT16_MAX</code> + 1.
<div class="highlight-c notranslate" id="std:topic-mpd_import_u32"><div class="highlight"><pre>void mpd_qimport_u32(mpd_t *result, const uint32_t *srcdata,
 size_t srclen, uint8_t srcsign, uint32_t srcbase,
 const mpd_context_t *ctx, uint32_t *status);
void mpd_import_u32(mpd_t *result, const uint32_t *srcdata,
 size_t srclen, uint8_t srcsign, uint32_t base,
 mpd_context_t *ctx);
</pre></div>
</div>
Convert a multi-precision integer at srcdata with base srcbase to a
decimal. The least significant word is srcdata[0].
srcsign is <code class="xref c c-macro docutils literal notranslate">MPD_POS</code> for positive and <code class="xref c c-macro docutils literal notranslate">MPD_NEG</code> for
negative, srclen the length of srcdata.
Valid bases are in the range 2 &lt;= srcbase &lt;= <code class="xref c c-macro docutils literal notranslate">UINT32_MAX</code>.
</div>
<div class="section" id="exporting">
<h3>Exporting</h3>
<div class="highlight-c notranslate" id="std:topic-mpd_sizeinbase"><div class="highlight"><pre>mpd_sizeinbase(const mpd_t *a, uint32_t base);
</pre></div>
</div>
Return the number of words needed to represent a decimal when converted
to base. The decimal must be an integer, results are undefined for
non-integers.
<div class="highlight-c notranslate" id="std:topic-mpd_export_u16"><div class="highlight"><pre>size_t mpd_qexport_u16(uint16_t **rdata, size_t rlen, uint32_t rbase,
 const mpd_t *src, uint32_t *status);
size_t mpd_export_u16(uint16_t **rdata, size_t rlen, uint32_t rbase,
 const mpd_t *src, mpd_context_t *ctx);
</pre></div>
</div>
Set *rdata to src, converted to a representation in base rbase.
The least significant word of the result is rdata[0]. src must be
an integer.
If rdata is NULL, space is allocated by the function and rlen is
irrelevant. In case of an error the allocated storage is freed and
rdata is set back to NULL.
If rdata is non-NULL, it MUST be allocated by one of libmpdec’s
allocation functions and rlen MUST be correct. If necessary, the
function will resize rdata. Resizing is slow and should not occur
if rlen has been obtained by a call to <code class="xref c c-func docutils literal notranslate">mpd_sizeinbase</code>.
In case of an error the caller must free rdata.
Return value: In case of success, the length of the multi-precision integer
in the new base, <code class="xref c c-macro docutils literal notranslate">SIZE_MAX</code> otherwise.
Valid bases are in the range 2 &lt;= rbase &lt;= <code class="xref c c-macro docutils literal notranslate">UINT16_MAX</code> + 1.
<div class="versionchanged">
Changed in version 2.4.0: rdata is now resized if necessary.
</div>
<div class="highlight-c notranslate" id="std:topic-mpd_export_u32"><div class="highlight"><pre>size_t mpd_qexport_u32(uint32_t *rdata, size_t rlen, uint32_t rbase,
 const mpd_t *src, uint32_t *status);
size_t mpd_export_u32(uint32_t *rdata, size_t rlen, uint32_t rbase,
 const mpd_t *src, mpd_context_t *ctx);
</pre></div>
</div>
Set *rdata to src, converted to a representation in base rbase.
The least significant word of the result is rdata[0]. src must be
an integer.
If rdata is NULL, space is allocated by the function and rlen is
irrelevant. In case of an error the allocated storage is freed and
rdata is set back to NULL.
If rdata is non-NULL, it MUST be allocated by one of libmpdec’s
allocation functions and rlen MUST be correct. If necessary, the
function will resize rdata. Resizing is slow and should not occur if
rlen has been obtained by a call to <code class="xref c c-func docutils literal notranslate">mpd_sizeinbase</code>. In case
of an error the caller must free rdata.
Return value: In case of success, the length of the multi-precision integer
in the new base, <code class="xref c c-macro docutils literal notranslate">SIZE_MAX</code> otherwise.
Valid bases are in the range 2 &lt;= rbase &lt;= <code class="xref c c-macro docutils literal notranslate">UINT32_MAX</code>.
<div class="versionchanged">
Changed in version 2.4.0: rdata is now resized if necessary.
</div>
</div>
</div>
<div class="section" id="required-functions">
<h2>Required Functions</h2>
The functions in this section are not needed for this implementation.
They are provided for full compliance with the specification.
<div class="highlight-c notranslate" id="std:topic-mpd_canonical"><div class="highlight"><pre>void mpd_canonical(mpd_t *result, const mpd_t *a, mpd_context_t *ctx);
</pre></div>
</div>
Same as <code class="xref c c-func docutils literal notranslate">mpd_copy</code>.
<div class="highlight-c notranslate" id="std:topic-mpd_iscanonical"><div class="highlight"><pre>int mpd_iscanonical(const mpd_t *dec);
</pre></div>
</div>
Return 1, for compatibility with the standard.
<div class="highlight-c notranslate" id="std:topic-mpd_radix"><div class="highlight"><pre>long mpd_radix(void);
</pre></div>
</div>
Return 10.
</div>
<div class="section" id="library-version">
<h2>Library version</h2>
<div class="highlight-c notranslate" id="std:topic-mpd_version"><div class="highlight"><pre>/* Macros defining the components of the version as integers. */
MPD_MAJOR_VERSION
MPD_MINOR_VERSION
MPD_MICRO_VERSION

/* Macro defining the complete version as a string. */
MPD_VERSION

const char *mpd_version(void);
</pre></div>
</div>
Library version information. <code class="xref c c-func docutils literal notranslate">mpd_version</code> returns the MPD_VERSION macro
from the header that the library was compiled with.
<div class="versionadded">
New in version 2.4.0.
</div>
</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="memory.html" title="Advanced Memory Handling"
 >next</a></li>
 <li class="right" >
 <a href="arithmetic.html" title="Arithmetic Functions"
 >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: various.html

Upload File

Create Folder