epl692/pi
1
0
Fork 0
mirror of https://git.sdf.org/epl692/pi.git synced 2026-02-10 19:54:09 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README to describe Chudnovsky algorithm and threads note

Browse Source
This commit is contained in:
Eric Lynema
2025-12-28 00:47:54 -05:00
parent 6d183a5526
commit 3bea3d532a
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,10 +1,10 @@
# Pi Calculator
This is a multi-threaded Rust program that calculates the first n digits of Pi using the Bailey–Borwein–Plouffe (BBP) formula. It uses arbitrary-precision arithmetic (rug) and parallelism (rayon).
This is a multi-threaded Rust program that calculates the first n digits of Pi using the Chudnovsky algorithm with binary splitting. It uses arbitrary-precision arithmetic (rug) and parallelism (rayon).
## Improvements in this branch
* Parallelized BBP summation with rayon for better thread control and load balancing.
* Parallelized Chudnovsky binary-splitting with rayon for better thread control and load balancing.
* Safer argument validation and error handling (avoids unwraps on runtime errors).
* Optional output-to-file support.
* Added CI workflow to run formatting, clippy, tests and build on push/PR.
@@ -30,7 +30,7 @@ Arguments
Options
* `-t`, `--threads <THREADS>`: Number of threads to use (default 4).
* `-t`, `--threads <THREADS>`: Number of threads to use (default 4). Note: this implementation performs parallel binary splitting and the threads option is kept for compatibility but may be ignored.
* `-o`, `--output <FILE>`: Write output to FILE instead of stdout.
* `-h`, `--help`: Print help.
@@ -44,4 +44,4 @@ Calculate 1000 digits using 8 threads and write to a file:
Notes
For very large numbers of digits, using a decimal-friendly algorithm such as Chudnovsky (with binary splitting) will be far faster and more memory-efficient than BBP; consider switching to Chudnovsky for production-grade large computations.
This program uses the Chudnovsky algorithm (binary splitting), which is suitable for high-precision Pi computation. For extremely large computations, further optimizations (tuning precision, memory usage, or linking to specialized big-integer libraries) may be required.