Skip to content

Commit

Permalink
Update Sphinx documentation, commit 4ccf2ce [skip ci].
Browse files Browse the repository at this point in the history
  • Loading branch information
bluescarni committed Nov 27, 2023
1 parent 82237db commit b75f4da
Show file tree
Hide file tree
Showing 8 changed files with 43 additions and 29 deletions.
7 changes: 7 additions & 0 deletions _sources/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Changelog
New
~~~

- Add the step callback (batch) set classes to compose
step callbacks
(`#366 <https://github.com/bluescarni/heyoka/pull/366>`__).
- Add support for single-precision computations
(`#363 <https://github.com/bluescarni/heyoka/pull/363>`__).
- Add model implementing the ELP2000 analytical lunar theory
Expand All @@ -15,6 +18,10 @@ New
Changes
~~~~~~~

- Initialising a step callback or a callable from an empty
function object (e.g., a null pointer, an empty ``std::function``, etc.)
now results in an empty object
(`#366 <https://github.com/bluescarni/heyoka/pull/366>`__).
- Improve performance when creating symbolic expressions for
large sums and products
(`#362 <https://github.com/bluescarni/heyoka/pull/362>`__).
Expand Down
7 changes: 7 additions & 0 deletions changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,9 @@ <h2>3.2.0 (unreleased)<a class="headerlink" href="#unreleased" title="Permalink
<section id="new">
<h3>New<a class="headerlink" href="#new" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p>Add the step callback (batch) set classes to compose
step callbacks
(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/366">#366</a>).</p></li>
<li><p>Add support for single-precision computations
(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/363">#363</a>).</p></li>
<li><p>Add model implementing the ELP2000 analytical lunar theory
Expand All @@ -554,6 +557,10 @@ <h3>New<a class="headerlink" href="#new" title="Permalink to this heading">#</a>
<section id="changes">
<h3>Changes<a class="headerlink" href="#changes" title="Permalink to this heading">#</a></h3>
<ul class="simple">
<li><p>Initialising a step callback or a callable from an empty
function object (e.g., a null pointer, an empty <code class="docutils literal notranslate"><span class="pre">std::function</span></code>, etc.)
now results in an empty object
(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/366">#366</a>).</p></li>
<li><p>Improve performance when creating symbolic expressions for
large sums and products
(<a class="reference external" href="https://github.com/bluescarni/heyoka/pull/362">#362</a>).</p></li>
Expand Down
2 changes: 1 addition & 1 deletion definitions.html
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,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="Permalink 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++ v0.27)"><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++ v0.27)"><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.0)"><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.0)"><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
12 changes: 6 additions & 6 deletions install.html
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ <h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to t
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++ v0.27)"><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.0)"><span class="xref std std-ref">mp++ installation instructions</span></a>).
The minimum required version of mp++ is 0.27;</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 @@ -479,12 +479,12 @@ <h4>128-bit precision<a class="headerlink" href="#id2" title="Permalink to this
<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++ v0.27)"><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++ v0.27)"><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.0)"><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.0)"><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++ v0.27)"><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.0)"><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 @@ -497,7 +497,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++ v0.27)"><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.0)"><span class="xref std std-ref">mp++ installation instructions</span></a>).</p>
</section>
</section>
</section>
Expand Down Expand Up @@ -646,9 +646,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++ v0.27)"><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.0)"><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++ v0.27)"><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.0)"><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">New in version 0.17.0.</span></p>
Expand Down
Loading

0 comments on commit b75f4da

Please sign in to comment.