Deploying to gh-pages from @ 40c56b0 🚀

north-numerical-computing · May 30, 2024 · d7d79ca · d7d79ca
1 parent 3c9a0ce
commit d7d79ca
Show file tree

Hide file tree

Showing 13 changed files with 276 additions and 48 deletions.
diff --git a/...cpfloat/enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.rst.txt b/...cpfloat/enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.rst.txt
@@ -0,0 +1,14 @@
+.. _exhale_enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3:
+
+Enum cpfloat_saturation_t
+=========================
+
+- Defined in :ref:`file_src_cpfloat_definitions.h`
+
+
+Enum Documentation
+------------------
+
+
+.. doxygenenum:: cpfloat_saturation_t
+   :project: CPFloat
diff --git a/_sources/cpfloat/file_src_cpfloat_definitions.h.rst.txt b/_sources/cpfloat/file_src_cpfloat_definitions.h.rst.txt
@@ -31,14 +31,16 @@ This file includes all the external header files used by CPFloat, defines the en
 
 
 
-- :ref:`exhale_enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573`,
-
 - :ref:`exhale_enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847`,
 
 - :ref:`exhale_enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113`,
 
+- :ref:`exhale_enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3`,
+
 - :ref:`exhale_enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91`,
 
+- :ref:`exhale_enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573`,
+
 
 
 and the structured data type :ref:`exhale_struct_structoptstruct`. It is not necessary to include this file in order to use CPFloat, as it is already included by :ref:`file_src_cpfloat_binary32.h` and by :ref:`file_src_cpfloat_binary64.h`. 
@@ -94,6 +96,8 @@ Enums
 
 - :ref:`exhale_enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113`
 
+- :ref:`exhale_enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3`
+
 - :ref:`exhale_enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91`
 
 - :ref:`exhale_enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573`

diff --git a/cpfloat/cpfloat_root.html b/cpfloat/cpfloat_root.html
@@ -74,6 +74,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#enums">Enums</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847.html">Enum cpfloat_explim_t</a></li>
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html">Enum cpfloat_rounding_t</a></li>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html">Enum cpfloat_saturation_t</a></li>
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html">Enum cpfloat_softerr_t</a></li>
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573.html">Enum cpfloat_subnormal_t</a></li>
 </ul>
@@ -268,7 +269,7 @@ <h2>Class Hierarchy<a class="headerlink" href="#class-hierarchy" title="Link to
 <ul class="treeView" id="class-treeView">
   <li>
     <ul class="collapsibleList">
-      <li>Struct <a href="structoptstruct.html#exhale-struct-structoptstruct">optstruct</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847.html#exhale-enum-cpfloat-definitions-8h-1a9d6b6ecb3dadc890bbb77bd737507847">cpfloat_explim_t</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html#exhale-enum-cpfloat-definitions-8h-1a9f79e24cc89b42b57e660ceea5b6e113">cpfloat_rounding_t</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#exhale-enum-cpfloat-definitions-8h-1af95a89ad20a60b1697bec7d008d39a91">cpfloat_softerr_t</a></li><li class="lastChild">Enum <a href="enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573.html#exhale-enum-cpfloat-definitions-8h-1a19fe474041e378986b36e30c95900573">cpfloat_subnormal_t</a></li>
+      <li>Struct <a href="structoptstruct.html#exhale-struct-structoptstruct">optstruct</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847.html#exhale-enum-cpfloat-definitions-8h-1a9d6b6ecb3dadc890bbb77bd737507847">cpfloat_explim_t</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html#exhale-enum-cpfloat-definitions-8h-1a9f79e24cc89b42b57e660ceea5b6e113">cpfloat_rounding_t</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html#exhale-enum-cpfloat-definitions-8h-1a695c0a76ec919b7c08971122176a67b3">cpfloat_saturation_t</a></li><li>Enum <a href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#exhale-enum-cpfloat-definitions-8h-1af95a89ad20a60b1697bec7d008d39a91">cpfloat_softerr_t</a></li><li class="lastChild">Enum <a href="enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573.html#exhale-enum-cpfloat-definitions-8h-1a19fe474041e378986b36e30c95900573">cpfloat_subnormal_t</a></li>
     </ul>
   </li><!-- only tree view element -->
 </ul><!-- /treeView class-treeView --></section>
@@ -292,11 +293,12 @@ <h3>Classes and Structs<a class="headerlink" href="#classes-and-structs" title="
 <li class="toctree-l3"><a class="reference internal" href="structoptstruct.html#_CPPv49optstruct"><code class="docutils literal notranslate"><span class="pre">optstruct</span></code></a><ul>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct6formatE"><code class="docutils literal notranslate"><span class="pre">optstruct::format</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct9precisionE"><code class="docutils literal notranslate"><span class="pre">optstruct::precision</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct4emaxE"><code class="docutils literal notranslate"><span class="pre">optstruct::emax</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct4eminE"><code class="docutils literal notranslate"><span class="pre">optstruct::emin</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct9subnormalE"><code class="docutils literal notranslate"><span class="pre">optstruct::subnormal</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct4emaxE"><code class="docutils literal notranslate"><span class="pre">optstruct::emax</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct6explimE"><code class="docutils literal notranslate"><span class="pre">optstruct::explim</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct5roundE"><code class="docutils literal notranslate"><span class="pre">optstruct::round</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct10saturationE"><code class="docutils literal notranslate"><span class="pre">optstruct::saturation</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct9subnormalE"><code class="docutils literal notranslate"><span class="pre">optstruct::subnormal</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct4flipE"><code class="docutils literal notranslate"><span class="pre">optstruct::flip</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct1pE"><code class="docutils literal notranslate"><span class="pre">optstruct::p</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="structoptstruct.html#_CPPv4N9optstruct7bitseedE"><code class="docutils literal notranslate"><span class="pre">optstruct::bitseed</span></code></a></li>
@@ -353,12 +355,27 @@ <h3>Enums<a class="headerlink" href="#enums" title="Link to this heading"></a
 </div>
 <div class="toctree-wrapper compound">
 <ul>
+<li class="toctree-l1"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html">Enum cpfloat_saturation_t</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html#enum-documentation">Enum Documentation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html#_CPPv420cpfloat_saturation_t"><code class="docutils literal notranslate"><span class="pre">cpfloat_saturation_t</span></code></a><ul>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html#_CPPv4N20cpfloat_saturation_t14CPFLOAT_SAT_NOE"><code class="docutils literal notranslate"><span class="pre">cpfloat_saturation_t::CPFLOAT_SAT_NO</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html#_CPPv4N20cpfloat_saturation_t15CPFLOAT_SAT_USEE"><code class="docutils literal notranslate"><span class="pre">cpfloat_saturation_t::CPFLOAT_SAT_USE</span></code></a></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="toctree-wrapper compound">
+<ul>
 <li class="toctree-l1"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html">Enum cpfloat_softerr_t</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#enum-documentation">Enum Documentation</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv417cpfloat_softerr_t"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t</span></code></a><ul>
-<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv4N17cpfloat_softerr_t18CPFLOAT_NO_SOFTERRE"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t::CPFLOAT_NO_SOFTERR</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv4N17cpfloat_softerr_t20CPFLOAT_FRAC_SOFTERRE"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t::CPFLOAT_FRAC_SOFTERR</span></code></a></li>
-<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv4N17cpfloat_softerr_t18CPFLOAT_FP_SOFTERRE"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t::CPFLOAT_FP_SOFTERR</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv4N17cpfloat_softerr_t18CPFLOAT_SOFTERR_NOE"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t::CPFLOAT_SOFTERR_NO</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv4N17cpfloat_softerr_t20CPFLOAT_SOFTERR_FRACE"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t::CPFLOAT_SOFTERR_FRAC</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html#_CPPv4N17cpfloat_softerr_t18CPFLOAT_SOFTERR_FPE"><code class="docutils literal notranslate"><span class="pre">cpfloat_softerr_t::CPFLOAT_SOFTERR_FP</span></code></a></li>
 </ul>
 </li>
 </ul>

diff --git a/cpfloat/enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573.html b/cpfloat/enum_cpfloat__definitions_8h_1a19fe474041e378986b36e30c95900573.html
@@ -70,6 +70,7 @@
 <li class="toctree-l3 current"><a class="reference internal" href="cpfloat_root.html#enums">Enums</a><ul class="current">
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847.html">Enum cpfloat_explim_t</a></li>
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html">Enum cpfloat_rounding_t</a></li>
+<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3.html">Enum cpfloat_saturation_t</a></li>
 <li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1af95a89ad20a60b1697bec7d008d39a91.html">Enum cpfloat_softerr_t</a></li>
 <li class="toctree-l4 current"><a class="current reference internal" href="#">Enum cpfloat_subnormal_t</a></li>
 </ul>