Skip to content

Commit

Permalink
Deploying to gh-pages from @ 4aaf3de 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mfasi committed Jun 1, 2024
1 parent a0318d8 commit cfdbf02
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ <h2>Enum Documentation<a class="headerlink" href="#enum-documentation" title="Li
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N19cpfloat_subnormal_t16CPFLOAT_SUBN_RNDE">
<span id="_CPPv3N19cpfloat_subnormal_t16CPFLOAT_SUBN_RNDE"></span><span id="_CPPv2N19cpfloat_subnormal_t16CPFLOAT_SUBN_RNDE"></span><span class="target" id="cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573a7c6eebddf911f0d2986c019aecee4b5f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">CPFLOAT_SUBN_RND</span></span></span><a class="headerlink" href="#_CPPv4N19cpfloat_subnormal_t16CPFLOAT_SUBN_RNDE" title="Link to this definition"></a><br /></dt>
<dd><p>Round subnormal numbers using current rounding mode. </p>
<dd><p>Round subnormal numbers according to the current rounding mode. </p>
</dd></dl>

<dl class="cpp enumerator">
Expand Down
6 changes: 3 additions & 3 deletions cpfloat/structoptstruct.html
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ <h2>Struct Documentation<a class="headerlink" href="#struct-documentation" title
<span id="_CPPv3N9optstruct9precisionE"></span><span id="_CPPv2N9optstruct9precisionE"></span><span id="optstruct::precision__cpfloat_precision_t"></span><span class="target" id="structoptstruct_1a0996c74eb25145966e95fd7ac42296f2"></span><a class="reference internal" href="typedef_cpfloat__definitions_8h_1aa6d0354f2ee724040f2d558538cc8d33.html#_CPPv419cpfloat_precision_t" title="cpfloat_precision_t"><span class="n"><span class="pre">cpfloat_precision_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">precision</span></span></span><a class="headerlink" href="#_CPPv4N9optstruct9precisionE" title="Link to this definition"></a><br /></dt>
<dd><p>Bits of precision of target format. </p>
<p>The maximum values allowed are 24 and 53 if the storage format is <code class="docutils literal notranslate"><span class="pre">float</span></code> or <code class="docutils literal notranslate"><span class="pre">double</span></code>, respectively.</p>
<p>For compatibility with the MATLAB function <code class="docutils literal notranslate"><span class="pre">chop</span></code>, in the MEX interface the number of digits of precision for <code class="docutils literal notranslate"><span class="pre">float</span></code> and <code class="docutils literal notranslate"><span class="pre">double</span></code> cannot exceed 11 and 25, respectively, when using stochastic rounding, and cannot exceed 23 and 52, respectively, for other rounding modes. The C implementation does not have any such restrictions, but note that using larger values can cause double rounding.</p>
<p>For compatibility with the MATLAB function <code class="docutils literal notranslate"><span class="pre">chop</span></code>, in the MEX interface the number of digits of precision for <code class="docutils literal notranslate"><span class="pre">float</span></code> and <code class="docutils literal notranslate"><span class="pre">double</span></code> cannot exceed 11 and 25, respectively, when using stochastic rounding, and cannot exceed 23 and 52, respectively, for other rounding modes. The C implementation does not have any such restrictions, but using larger values can cause double rounding.</p>
<p>The validation functions cpfloatf_validate_optstruct() and cpfloat_validate_optstruct() return an error code if the required number of digits is larger than the maximum allowed by the storage format, and a warning code if the required number of digits is above the maximum allowed by the MEX interface. </p>
</dd></dl>

Expand Down Expand Up @@ -196,14 +196,14 @@ <h2>Struct Documentation<a class="headerlink" href="#struct-documentation" title
<dt class="sig sig-object cpp" id="_CPPv4N9optstruct10saturationE">
<span id="_CPPv3N9optstruct10saturationE"></span><span id="_CPPv2N9optstruct10saturationE"></span><span id="optstruct::saturation__cpfloat_saturation_t"></span><span class="target" id="structoptstruct_1a40aa4925fda0a07a39434ce48c94b25d"></span><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html#_CPPv420cpfloat_saturation_t" title="cpfloat_saturation_t"><span class="n"><span class="pre">cpfloat_saturation_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">saturation</span></span></span><a class="headerlink" href="#_CPPv4N9optstruct10saturationE" title="Link to this definition"></a><br /></dt>
<dd><p>Support for saturation arithmetic in target format. </p>
<p>If this field is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SAT_USE</span></code>, numbers too large to be represented in the target format are clamped to the largest floating-point number of appropriate sign. I this field is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SAT_NO</span></code>, numbers that are too large to be represented are rounded to the largest normal value of appropriate sign or to the infinity of appropriate sign using the current rounding mode. </p>
<p>If this field is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SAT_USE</span></code>, numbers too large to be represented in the target format are clamped to the largest floating-point number of appropriate sign. I this field is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SAT_NO</span></code>, numbers that are too large to be represented are rounded to either the largest normal value of appropriate sign or the closest infinity according to the current rounding mode. </p>
</dd></dl>

<dl class="cpp var">
<dt class="sig sig-object cpp" id="_CPPv4N9optstruct9subnormalE">
<span id="_CPPv3N9optstruct9subnormalE"></span><span id="_CPPv2N9optstruct9subnormalE"></span><span id="optstruct::subnormal__cpfloat_subnormal_t"></span><span class="target" id="structoptstruct_1a93f5ef6c600b8068ca6adc1c3f6cf24e"></span><a class="reference internal" href="enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573.html#_CPPv419cpfloat_subnormal_t" title="cpfloat_subnormal_t"><span class="n"><span class="pre">cpfloat_subnormal_t</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">subnormal</span></span></span><a class="headerlink" href="#_CPPv4N9optstruct9subnormalE" title="Link to this definition"></a><br /></dt>
<dd><p>Support for subnormal numbers in target format. </p>
<p>Subnormal numbers are supported if this field is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SUBN_USE</span></code> and rounded to a normal number using the current rounding mode if it is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SUBN_RND</span></code>. </p>
<p>Subnormal numbers are supported if this field is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SUBN_USE</span></code> and rounded to a normal number according to the current rounding mode if it is set to <code class="docutils literal notranslate"><span class="pre">CPFLOAT_SUBN_RND</span></code>. </p>
</dd></dl>

<dl class="cpp var">
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

0 comments on commit cfdbf02

Please sign in to comment.