README

   1 == Installation ==
   2
   3 The GMP library is required. Type:
   4
   5   $ make
   6
   7 to compile.
   8
   9 Then try "pi 2000" to generate 2000 digits of pi using a continued
  10 fraction. It takes longer than I had hoped, but it's faster than
  11
  12   $ echo "scale = 2000; 4*a(1)" | bc -l
  13
  14 Also try "hakmem 1000" to compute 1000 digits of the example continued fraction
  15 constant from HAKMEM, which compares favourably with:
  16
  17   $ echo "scale=1000
  18           pi=4*a(1)
  19           x=2*sqrt(5)
  20           (sqrt(3/pi^2+e(1)))/((e(x)-1)/(e(x)+1)-s(69))" | bc -l
  21
  22 Unlike frac, bc can only output the final answer in one go after all
  23 calculations are complete.
  24
  25 There's no API documentation; see the source.
  26
  27 == Bugs and other issues ==
  28
  29 I intend to devote time to projects that operate on real numbers rather than
  30 study real numbers for its own sake. But perhaps then I'll find a perfect
  31 application for continued fractions, which will push me to fix deficiencies in
  32 this code:
  33
  34 - I want to replace the condition variable with a semaphore to silence Helgrind
  35   (whose documentation states that condition variables almost unconditionally
  36   and invariably raise false alarms).
  37
  38 - Computing the continued fraction expansion of pi from the Chudnovsky
  39   brothers' Ramanujan formula would be much faster. More constants could
  40   benefit from using efficiently computable sequences of narrower intervals
  41   for their continued fraction expansions.
  42
  43 - The API could use cosmetic surgery.
  44
  45 - The Makefile is fragile and annoying to maintain and use.
  46
  47 - The testing infrastructure needs upgrading.
  48
  49 - Much more, e.g. see TODOs sprinkled throughout the code.