Skip to content

Commit

Permalink
Update README [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
jatinchowdhury18 committed Jan 14, 2024
1 parent d0ebe22 commit f6b932f
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![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)


`math_approx` is a C++ library for math approximations.

Currently supported:
Expand All @@ -16,9 +17,6 @@ Currently supported:
- Wright-Omega function
- Dilogarithm function

Showing my work:
TODO

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

### Showing My Work

Since the approximations in this library are primarily based on
polynomial approximations, I've tried to provide the details
for how those polynomials were derived, by providing a zipped
folder containing the Mathematica notebooks that were used to
derive the polynomials. Since not everyone has access to
Mathematica, the folder also contains a PDF version of the
notebook. At the moment, I'm planning to upload an updated
copy of the zipped folder with each release of the library,
but if I can think of a better method of distribution, that
doesn't involve adding the notebook files to the repository
directly, I'll do that instead.

### Measuring Accuracy

This library uses three approaches for measuring accuracy:
Expand Down

0 comments on commit f6b932f

Please sign in to comment.