Skip to content

Commit

Permalink
Update Sphinx documentation, commit 6355a10 [skip ci].
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Jul 30, 2024
1 parent d8696db commit f6ba744
Show file tree
Hide file tree
Showing 7 changed files with 32 additions and 32 deletions.
2 changes: 1 addition & 1 deletion definitions.html
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ <h1>Macros and definitions<a class="headerlink" href="#macros-and-definitions" t
<dl class="c macro">
<dt class="sig sig-object c" id="c.HEYOKA_WITH_REAL">
<span class="sig-name descname"><span class="n"><span class="pre">HEYOKA_WITH_REAL</span></span></span><a class="headerlink" href="#c.HEYOKA_WITH_REAL" title="Link to this definition">#</a><br /></dt>
<dd><p>These names are defined if heyoka was built with support for, respectively, the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">real128</span></code></a> and <a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">real</span></code></a> classes from
<dd><p>These names are defined if heyoka was built with support for, respectively, the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">real128</span></code></a> and <a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">real</span></code></a> classes from
the mp++ library (see the <a class="reference internal" href="install.html#installation"><span class="std std-ref">installation instructions</span></a>).</p>
</dd></dl>

Expand Down
6 changes: 3 additions & 3 deletions expression.html
Original file line number Diff line number Diff line change
Expand Up @@ -507,9 +507,9 @@ <h2>The <a class="reference internal" href="#_CPPv4N6heyoka10expressionE" title=
<dt class="sig sig-object cpp" id="_CPPv4N6heyoka10expression10expressionEe">
<span id="_CPPv3N6heyoka10expression10expressionEe"></span><span id="_CPPv2N6heyoka10expression10expressionEe"></span><span id="heyoka::expression::expression__l-double"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expression</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">long</span></span><span class="w"> </span><span class="kt"><span class="pre">double</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N6heyoka10expression10expressionEe" title="Link to this definition">#</a><br /></dt>
<dt class="sig sig-object cpp" id="_CPPv4N6heyoka10expression10expressionEN4mppp7real128E">
<span id="_CPPv3N6heyoka10expression10expressionEN4mppp7real128E"></span><span id="_CPPv2N6heyoka10expression10expressionEN4mppp7real128E"></span><span id="heyoka::expression::expression__mppp::real128"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expression</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">mppp</span></span><span class="p"><span class="pre">::</span></span><a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.2)"><span class="n"><span class="pre">real128</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N6heyoka10expression10expressionEN4mppp7real128E" title="Link to this definition">#</a><br /></dt>
<span id="_CPPv3N6heyoka10expression10expressionEN4mppp7real128E"></span><span id="_CPPv2N6heyoka10expression10expressionEN4mppp7real128E"></span><span id="heyoka::expression::expression__mppp::real128"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expression</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">mppp</span></span><span class="p"><span class="pre">::</span></span><a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.3)"><span class="n"><span class="pre">real128</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">noexcept</span></span><a class="headerlink" href="#_CPPv4N6heyoka10expression10expressionEN4mppp7real128E" title="Link to this definition">#</a><br /></dt>
<dt class="sig sig-object cpp" id="_CPPv4N6heyoka10expression10expressionEN4mppp4realE">
<span id="_CPPv3N6heyoka10expression10expressionEN4mppp4realE"></span><span id="_CPPv2N6heyoka10expression10expressionEN4mppp4realE"></span><span id="heyoka::expression::expression__mppp::real"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expression</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">mppp</span></span><span class="p"><span class="pre">::</span></span><a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.2)"><span class="n"><span class="pre">real</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6heyoka10expression10expressionEN4mppp4realE" title="Link to this definition">#</a><br /></dt>
<span id="_CPPv3N6heyoka10expression10expressionEN4mppp4realE"></span><span id="_CPPv2N6heyoka10expression10expressionEN4mppp4realE"></span><span id="heyoka::expression::expression__mppp::real"></span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">expression</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">mppp</span></span><span class="p"><span class="pre">::</span></span><a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.3)"><span class="n"><span class="pre">real</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">x</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N6heyoka10expression10expressionEN4mppp4realE" title="Link to this definition">#</a><br /></dt>
<dd><p>Constructors from floating-point objects.</p>
<p>These constructors initialise the expression to a floating-point <a class="reference internal" href="number.html#api-number"><span class="std std-ref">number</span></a> with the input value <em>x</em>.
Expressions can be constructed from objects of any floating-point type supported by <a class="reference internal" href="number.html#api-number"><span class="std std-ref">number</span></a>.</p>
Expand All @@ -518,7 +518,7 @@ <h2>The <a class="reference internal" href="#_CPPv4N6heyoka10expressionE" title=
<dd class="field-odd"><p><strong>x</strong> – the construction argument.</p>
</dd>
<dt class="field-even">Exception<span class="colon">:</span></dt>
<dd class="field-even"><p>any exception raised by the copy constructor of <a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real</span></code></a>.</p>
<dd class="field-even"><p>any exception raised by the copy constructor of <a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real</span></code></a>.</p>
</dd>
</dl>
</dd></dl>
Expand Down
12 changes: 6 additions & 6 deletions install.html
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Link to this h
supporting the non-standard <code class="docutils literal notranslate"><span class="pre">__float128</span></code> type. heyoka requires
an mp++ installation with support for Boost.serialization and for the
{fmt} library
(see the <a class="reference external" href="https://bluescarni.github.io/mppp/installation.html#installation" title="(in mp++ v1.0.2)"><span class="xref std std-ref">mp++ installation instructions</span></a>).
(see the <a class="reference external" href="https://bluescarni.github.io/mppp/installation.html#installation" title="(in mp++ v1.0.3)"><span class="xref std std-ref">mp++ installation instructions</span></a>).
heyoka currently requires mp++ 1.x;</p></li>
<li><p>the <a class="reference external" href="https://sleef.org/">SLEEF</a> vectorized math library (improves the performance
of integrations in batch mode),</p></li>
Expand Down Expand Up @@ -494,12 +494,12 @@ <h4>128-bit precision<a class="headerlink" href="#id2" title="Link to this headi
<li><p>the nonstandard <code class="docutils literal notranslate"><span class="pre">__float128</span></code> floating-point type is
available and supported, and</p></li>
<li><p>an installation of the <a class="reference external" href="https://bluescarni.github.io/mppp/">mp++</a> library with support
for the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a> class is available (see the <a class="reference external" href="https://bluescarni.github.io/mppp/installation.html#installation" title="(in mp++ v1.0.2)"><span class="xref std std-ref">mp++ installation instructions</span></a>),
for the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a> class is available (see the <a class="reference external" href="https://bluescarni.github.io/mppp/installation.html#installation" title="(in mp++ v1.0.3)"><span class="xref std std-ref">mp++ installation instructions</span></a>),
and</p></li>
<li><p>heyoka is compiled with the <code class="docutils literal notranslate"><span class="pre">HEYOKA_WITH_MPPP</span></code> option enabled (see <a class="reference internal" href="#installation-from-source"><span class="std std-ref">below</span></a>).</p></li>
</ul>
<p>If these conditions are satisfied, then quadruple-precision computations are supported in heyoka
via the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a> type.</p>
via the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a> type.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The non-IEEE <code class="docutils literal notranslate"><span class="pre">long</span> <span class="pre">double</span></code> type available on some PowerPC platforms
Expand All @@ -512,7 +512,7 @@ <h4>Arbitrary-precision<a class="headerlink" href="#arbitrary-precision" title="
<p>Arbitrary-precision integrations are supported on all platforms, provided that heyoka
is compiled with the <code class="docutils literal notranslate"><span class="pre">HEYOKA_WITH_MPPP</span></code> option enabled (see <a class="reference internal" href="#installation-from-source"><span class="std std-ref">below</span></a>)
and that the mp++ library is compiled with the <code class="docutils literal notranslate"><span class="pre">MPPP_WITH_MPFR</span></code> option enabled
(see the <a class="reference external" href="https://bluescarni.github.io/mppp/installation.html#installation" title="(in mp++ v1.0.2)"><span class="xref std std-ref">mp++ installation instructions</span></a>).</p>
(see the <a class="reference external" href="https://bluescarni.github.io/mppp/installation.html#installation" title="(in mp++ v1.0.3)"><span class="xref std std-ref">mp++ installation instructions</span></a>).</p>
</section>
</section>
</section>
Expand Down Expand Up @@ -669,9 +669,9 @@ <h2>Including heyoka in your project via CMake<a class="headerlink" href="#inclu
<li><p><code class="docutils literal notranslate"><span class="pre">heyoka_WITH_SLEEF</span></code> if SLEEF support was enabled,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">heyoka_WITH_MPPP</span></code> if mp++ support was enabled,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">heyoka_WITH_REAL128</span></code> (new in version 0.19) if quadruple-precision
computations via the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a> type are supported,</p></li>
computations via the <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a> type are supported,</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">heyoka_WITH_REAL</span></code> (new in version 0.20) if arbitrary-precision
computations via the <a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real</span></code></a> type are supported.</p></li>
computations via the <a class="reference external" href="https://bluescarni.github.io/mppp/real.html#_CPPv4N4mppp4realE" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real</span></code></a> type are supported.</p></li>
</ul>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 0.17.0.</span></p>
Expand Down
2 changes: 1 addition & 1 deletion known_issues.html
Original file line number Diff line number Diff line change
Expand Up @@ -428,7 +428,7 @@ <h1>Unsolved<a class="headerlink" href="#unsolved" title="Link to this heading">
<li><p>you are on an Intel x86 platform where <code class="docutils literal notranslate"><span class="pre">long</span> <span class="pre">double</span></code> corresponds
to the extended-precision 80-bit x86 floating-point type,</p></li>
<li><p>heyoka was compiled with support for quadruple-precision computations
via <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.2)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a>,</p></li>
via <a class="reference external" href="https://bluescarni.github.io/mppp/real128.html#_CPPv4N4mppp7real128E" title="(in mp++ v1.0.3)"><code class="xref cpp cpp-class docutils literal notranslate"><span class="pre">mppp::real128</span></code></a>,</p></li>
<li><p>JIT-compiled code using <strong>both</strong> 80-bit and quadruple-precision datatypes
was executed,</p></li>
<li><p>the <code class="docutils literal notranslate"><span class="pre">fast_math</span></code> flag was enabled during JIT compilation.</p></li>
Expand Down
Loading

0 comments on commit f6ba744

Please sign in to comment.