Update changelog and docs for single-precision support.

bluescarni · Nov 20, 2023 · 4ce3afb · 4ce3afb
1 parent 1c4dc37
commit 4ce3afb
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -40,7 +40,7 @@ heyoka is a C++ library for the integration of ordinary differential equations
 (ODEs) via Taylor's method, based on automatic differentiation techniques and aggressive just-in-time
 compilation via [LLVM](https://llvm.org/). Notable features include:
 
-* support for double-precision, extended-precision (80-bit and 128-bit),
+* support for single-precision, double-precision, extended-precision (80-bit and 128-bit),
   and arbitrary-precision floating-point types,
 * the ability to maintain machine precision accuracy over
   tens of billions of timesteps,

diff --git a/doc/changelog.rst b/doc/changelog.rst
@@ -7,6 +7,8 @@ Changelog
 New
 ~~~
 
+- Add support for single-precision computations
+  (`#363 <https://github.com/bluescarni/heyoka/pull/363>`__).
 - Add model implementing the ELP2000 analytical lunar theory
   (`#362 <https://github.com/bluescarni/heyoka/pull/362>`__).
 

diff --git a/doc/index.rst b/doc/index.rst
@@ -17,7 +17,7 @@ heyoka is a C++ library for the integration of ordinary differential equations
 on automatic differentiation techniques and aggressive just-in-time
 compilation via `LLVM <https://llvm.org/>`__. Notable features include:
 
-* support for double-precision, extended-precision (80-bit and 128-bit),
+* support for single-precision, double-precision, extended-precision (80-bit and 128-bit),
   and arbitrary-precision floating-point types,
 * the ability to maintain machine precision accuracy over
   tens of billions of timesteps,

diff --git a/doc/install.rst b/doc/install.rst
@@ -64,7 +64,8 @@ installing from source (the minimum required version is 3.18).
 Support for extended precision
 ``````````````````````````````
 
-Whereas in heyoka double-precision computations are always supported, support for extended-precision
+Whereas in heyoka single-precision and double-precision computations are always supported via the
+``float`` and ``double`` types respectively, support for extended-precision
 computations varies depending on the software/hardware platform.
 
 80-bit precision
@@ -81,7 +82,7 @@ heyoka (and all its dependencies) have been compiled with a compiler supporting
 ^^^^^^^^^^^^^^^^^
 
 On platforms where ``long double`` is a quadruple-precision floating-point datatype (e.g., 64-bit ARM),
-quadruple-precision integrations are always supported. Otherwise,
+quadruple-precision integrations are always supported via ``long double``. Otherwise,
 on platforms such as x86-64, quadruple-precision computations are supported if:
 
 * the nonstandard ``__float128`` floating-point type is

diff --git a/doc/tut_extended_precision.rst b/doc/tut_extended_precision.rst
@@ -4,7 +4,7 @@ Computations in extended precision
 ==================================
 
 As hinted in the :ref:`installation instructions <ep_support>`, heyoka supports computations
-not only in double precision, but also in extended precision. Specifically, heyoka currently supports:
+not only in single and double precision, but also in extended precision. Specifically, heyoka currently supports:
 
 * the 80-bit IEEE `extended-precision format <https://en.wikipedia.org/wiki/Extended_precision>`__ (~21 decimal digits),
 * the 128-bit IEEE `quadruple-precision format <https://en.wikipedia.org/wiki/Quadruple-precision_floating-point_format>`__ (~36 decimal digits).