basis/math/constants/constants-docs.factor

   1 USING: help.markup help.syntax kernel ;
   2 IN: math.constants
   3
   4 ARTICLE: "math-constants" "Constants"
   5 "Standard mathematical constants:"
   6 { $subsection e }
   7 { $subsection euler }
   8 { $subsection phi }
   9 { $subsection pi }
  10 { $subsection epsilon } ;
  11
  12 ABOUT: "math-constants"
  13
  14 HELP: e
  15 { $values { "e" "base of natural logarithm" } } ;
  16
  17 HELP: euler
  18 { $values { "gamma" "Euler-Mascheroni constant" } }
  19 { $description "The Euler-Mascheroni constant, also called \"Euler's constant\" or \"the Euler constant\"." } ;
  20
  21 HELP: phi
  22 { $values { "phi" "golden ratio" } } ;
  23
  24 HELP: pi
  25 { $values { "pi" "circumference of circle with diameter 1" } } ;
  26
  27 HELP: epsilon
  28 { $values { "epsilon" "smallest floating point value you can add to 1 without underflow" } } ;