Skip to content

Commit f6b932f

Browse files
Update README [ci skip]
1 parent d0ebe22 commit f6b932f

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![Test](https://github.com/Chowdhury-DSP/math_approx/actions/workflows/run_tests.yml/badge.svg)](https://github.com/Chowdhury-DSP/math_approx/actions/workflows/run_tests.yml)
44

5+
56
`math_approx` is a C++ library for math approximations.
67

78
Currently supported:
@@ -16,9 +17,6 @@ Currently supported:
1617
- Wright-Omega function
1718
- Dilogarithm function
1819

19-
Showing my work:
20-
TODO
21-
2220
At the moment, most of these implementations have been "good enough"
2321
for my own use cases (both in terms of performance and accuracy). That
2422
said, I definitely believe that it's possible to achieve better results
@@ -39,6 +37,20 @@ arguments which control the "order" of the approximation. The
3937
the approximation. In general, higher-order approximations will
4038
achieve greater accuracy, while taking longer to compute.
4139

40+
### Showing My Work
41+
42+
Since the approximations in this library are primarily based on
43+
polynomial approximations, I've tried to provide the details
44+
for how those polynomials were derived, by providing a zipped
45+
folder containing the Mathematica notebooks that were used to
46+
derive the polynomials. Since not everyone has access to
47+
Mathematica, the folder also contains a PDF version of the
48+
notebook. At the moment, I'm planning to upload an updated
49+
copy of the zipped folder with each release of the library,
50+
but if I can think of a better method of distribution, that
51+
doesn't involve adding the notebook files to the repository
52+
directly, I'll do that instead.
53+
4254
### Measuring Accuracy
4355

4456
This library uses three approaches for measuring accuracy:

0 commit comments

Comments
 (0)