Skip to content

Commit

Permalink
Deploying to gh-pages from @ e16b617 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mfasi committed Jun 1, 2024
1 parent 2060d4f commit 3c23de7
Show file tree
Hide file tree
Showing 14 changed files with 238 additions and 8 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
.. _exhale_enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486:

Enum cpfloat_infinity_t
=======================

- Defined in :ref:`file_src_cpfloat_definitions.h`


Enum Documentation
------------------


.. doxygenenum:: cpfloat_infinity_t
:project: CPFloat
4 changes: 4 additions & 0 deletions _sources/cpfloat/file_src_cpfloat_definitions.h.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ This file includes all the external header files used by CPFloat, defines the en

- :ref:`exhale_enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847`,

- :ref:`exhale_enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486`,

- :ref:`exhale_enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113`,

- :ref:`exhale_enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3`,
Expand Down Expand Up @@ -94,6 +96,8 @@ Enums

- :ref:`exhale_enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847`

- :ref:`exhale_enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486`

- :ref:`exhale_enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113`

- :ref:`exhale_enum_cpfloat__definitions_8h_1a695c0a76ec919b7c08971122176a67b3`
Expand Down
19 changes: 18 additions & 1 deletion cpfloat/cpfloat_root.html
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
</li>
<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_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html">Enum cpfloat_infinity_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>
Expand Down Expand Up @@ -269,7 +270,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_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>
<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_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html#exhale-enum-cpfloat-definitions-8h-1a1e1dfbf3c8aa0ed8de0e433797cd5486">cpfloat_infinity_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>
Expand All @@ -296,6 +297,7 @@ <h3>Classes and Structs<a class="headerlink" href="#classes-and-structs" title="
<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#_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#_CPPv4N9optstruct8infinityE"><code class="docutils literal notranslate"><span class="pre">optstruct::infinity</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>
Expand Down Expand Up @@ -332,6 +334,21 @@ <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_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html">Enum cpfloat_infinity_t</a><ul>
<li class="toctree-l2"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html#enum-documentation">Enum Documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html#_CPPv418cpfloat_infinity_t"><code class="docutils literal notranslate"><span class="pre">cpfloat_infinity_t</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html#_CPPv4N18cpfloat_infinity_t14CPFLOAT_INF_NOE"><code class="docutils literal notranslate"><span class="pre">cpfloat_infinity_t::CPFLOAT_INF_NO</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html#_CPPv4N18cpfloat_infinity_t15CPFLOAT_INF_USEE"><code class="docutils literal notranslate"><span class="pre">cpfloat_infinity_t::CPFLOAT_INF_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_1a9f79e24cc89b42b57e660ceea5b6e113.html">Enum cpfloat_rounding_t</a><ul>
<li class="toctree-l2"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html#enum-documentation">Enum Documentation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html#_CPPv418cpfloat_rounding_t"><code class="docutils literal notranslate"><span class="pre">cpfloat_rounding_t</span></code></a><ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@
<li class="toctree-l3"><a class="reference internal" href="cpfloat_root.html#classes-and-structs">Classes and Structs</a></li>
<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_1a1e1dfbf3c8aa0ed8de0e433797cd5486.html">Enum cpfloat_infinity_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>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,173 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Enum cpfloat_infinity_t &mdash; CPFloat latest documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="../_static/collapsible-lists/css/tree_view.css?v=a885cde7" />


<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=c6e86fd7"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/collapsible-lists/js/CollapsibleLists.compressed.js?v=73120307"></script>
<script src="../_static/collapsible-lists/js/apply-collapsible-lists.js?v=660e4f45"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Enum cpfloat_rounding_t" href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html" />
<link rel="prev" title="Enum cpfloat_explim_t" href="enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="icon icon-home">
CPFloat
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../index.html">CPFloat documentation</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../readme.html">CPFloat: Custom-Precision Floating-Point numbers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#dependencies">Dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#developer-dependencies">Developer dependencies</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#installation">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#using-cpfloat">Using CPFloat</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#code-validation">Code validation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#references">References</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#acknowledgements">Acknowledgements</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html#id10">Licensing information</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="cpfloat_root.html">CPFloat API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="cpfloat_root.html#class-hierarchy">Class Hierarchy</a></li>
<li class="toctree-l2"><a class="reference internal" href="cpfloat_root.html#file-hierarchy">File Hierarchy</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="cpfloat_root.html#full-api">Full API</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="cpfloat_root.html#classes-and-structs">Classes and Structs</a></li>
<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 current"><a class="current reference internal" href="#">Enum cpfloat_infinity_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>
</li>
<li class="toctree-l3"><a class="reference internal" href="cpfloat_root.html#functions">Functions</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpfloat_root.html#defines">Defines</a></li>
<li class="toctree-l3"><a class="reference internal" href="cpfloat_root.html#typedefs">Typedefs</a></li>
</ul>
</li>
</ul>
</li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">CPFloat</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="cpfloat_root.html">CPFloat API</a></li>
<li class="breadcrumb-item active">Enum cpfloat_infinity_t</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/cpfloat/enum_cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="enum-cpfloat-infinity-t">
<span id="exhale-enum-cpfloat-definitions-8h-1a1e1dfbf3c8aa0ed8de0e433797cd5486"></span><h1>Enum cpfloat_infinity_t<a class="headerlink" href="#enum-cpfloat-infinity-t" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p>Defined in <a class="reference internal" href="file_src_cpfloat_definitions.h.html#file-src-cpfloat-definitions-h"><span class="std std-ref">File cpfloat_definitions.h</span></a></p></li>
</ul>
<section id="enum-documentation">
<h2>Enum Documentation<a class="headerlink" href="#enum-documentation" title="Link to this heading"></a></h2>
<dl class="cpp enum">
<dt class="sig sig-object cpp" id="_CPPv418cpfloat_infinity_t">
<span id="_CPPv318cpfloat_infinity_t"></span><span id="_CPPv218cpfloat_infinity_t"></span><span class="target" id="cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">cpfloat_infinity_t</span></span></span><a class="headerlink" href="#_CPPv418cpfloat_infinity_t" title="Link to this definition"></a><br /></dt>
<dd><p>Infinity support modes available in CPFloat. </p>
<p><em>Values:</em></p>
<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18cpfloat_infinity_t14CPFLOAT_INF_NOE">
<span id="_CPPv3N18cpfloat_infinity_t14CPFLOAT_INF_NOE"></span><span id="_CPPv2N18cpfloat_infinity_t14CPFLOAT_INF_NOE"></span><span class="target" id="cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486a846d5c8c5e7bbce440a5ed39a9f6e029"></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_INF_NO</span></span></span><a class="headerlink" href="#_CPPv4N18cpfloat_infinity_t14CPFLOAT_INF_NOE" title="Link to this definition"></a><br /></dt>
<dd><p>Use infinities in target format. </p>
</dd></dl>

<dl class="cpp enumerator">
<dt class="sig sig-object cpp" id="_CPPv4N18cpfloat_infinity_t15CPFLOAT_INF_USEE">
<span id="_CPPv3N18cpfloat_infinity_t15CPFLOAT_INF_USEE"></span><span id="_CPPv2N18cpfloat_infinity_t15CPFLOAT_INF_USEE"></span><span class="target" id="cpfloat__definitions_8h_1a1e1dfbf3c8aa0ed8de0e433797cd5486afccea455ff3da66cf6d973dfc61a8804"></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_INF_USE</span></span></span><a class="headerlink" href="#_CPPv4N18cpfloat_infinity_t15CPFLOAT_INF_USEE" title="Link to this definition"></a><br /></dt>
<dd><p>Replace infinities with NaNs in target format. </p>
</dd></dl>

</dd></dl>

</section>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="enum_cpfloat__definitions_8h_1a9d6b6ecb3dadc890bbb77bd737507847.html" class="btn btn-neutral float-left" title="Enum cpfloat_explim_t" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="enum_cpfloat__definitions_8h_1a9f79e24cc89b42b57e660ceea5b6e113.html" class="btn btn-neutral float-right" title="Enum cpfloat_rounding_t" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2020, Massimiliano Fasi and Mantas Mikaitis.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit 3c23de7

Please sign in to comment.