Skip to content

Commit 3f9f498

Browse files
committed
minor doc update [ci skip]
1 parent a167868 commit 3f9f498

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -120,14 +120,16 @@ You can test the library online using an interactive Jupyter notebook:
120120

121121
## General Syntax
122122

123-
GCE-Math functions are written as C++ templates with `constexpr` specifiers, the format of which might appear confusing to users unfamiliar with template-based programming. As an example, the [Gaussian error function](https://en.wikipedia.org/wiki/Error_function) (`erf`) is defined as:
123+
GCE-Math functions are written as C++ templates with `constexpr` specifiers, the format of which might appear confusing to users unfamiliar with template-based programming.
124+
125+
For example, the [Gaussian error function](https://en.wikipedia.org/wiki/Error_function) (`erf`) is defined as:
124126
```cpp
125127
template<typename T>
126128
constexpr
127129
return_t<T>
128130
erf(const T x) noexcept;
129131
```
130-
where a set of internal templated `constexpr` functions will implement a continued fraction expansion to return a value of type `return_t<T>`. This output type ('`return_t<T>`') is generally determined by the input type, e.g., `int`, `float`, `double`, `long double`, etc. When `T` is an intergral type, the output will be upgraded to `return_t<T> = double`, otherwise `return_t<T> = T`. For types not covered by `std::is_integral`, recasts should be used.
132+
A set of internal templated `constexpr` functions will implement a continued fraction expansion and return a value of type `return_t<T>`. The output type ('`return_t<T>`') is generally determined by the input type, e.g., `int`, `float`, `double`, `long double`, etc.; when `T` is an intergral type, the output will be upgraded to `return_t<T> = double`, otherwise `return_t<T> = T`. For types not covered by `std::is_integral`, recasts should be used.
131133
132134
## Examples
133135
@@ -193,5 +195,4 @@ main: # @main
193195

194196
## Related libraries
195197

196-
For a library built on GCEM's compile-time functionality, see [StatsLib](https://github.com/kthohr/stats).
197-
198+
* [StatsLib](https://github.com/kthohr/stats) is built on GCEM's compile-time functionality.

docs/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ The library is actively maintained, and is still being extended. A list of featu
4545
General Syntax
4646
--------------
4747

48-
GCE-Math functions are written as C++ templates with ``constexpr`` specifiers. As an example, the `Gaussian error function <https://en.wikipedia.org/wiki/Error_function>`_ (``erf``) is defined as:
48+
GCE-Math functions are written as C++ templates with ``constexpr`` specifiers. For example, the `Gaussian error function <https://en.wikipedia.org/wiki/Error_function>`_ (``erf``) is defined as:
4949

5050
.. code:: cpp
5151
@@ -54,7 +54,7 @@ GCE-Math functions are written as C++ templates with ``constexpr`` specifiers. A
5454
return_t<T>
5555
erf(const T x) noexcept;
5656
57-
where a set of internal templated ``constexpr`` functions will implement a continued fraction expansion to return a value of type ``return_t<T>``. This output type ('``return_t<T>``') is generally determined by the input type, e.g., ``int``, ``float``, ``double``, ``long double``, etc. When ``T`` is an intergral type, the output will be upgraded to ``return_t<T> = double``, otherwise ``return_t<T> = T``. For types not covered by ``std::is_integral``, recasts should be used.
57+
A set of internal templated ``constexpr`` functions will implement a continued fraction expansion and return a value of type ``return_t<T>``. The output type ('``return_t<T>``') is generally determined by the input type, e.g., ``int``, ``float``, ``double``, ``long double``, etc; when ``T`` is an intergral type, the output will be upgraded to ``return_t<T> = double``, otherwise ``return_t<T> = T``. For types not covered by ``std::is_integral``, recasts should be used.
5858

5959

6060
Contents

0 commit comments

Comments
 (0)