basis/math/libm/libm-docs.factor

   1 USING: help.markup help.syntax math.functions math ;
   2 IN: math.libm
   3
   4 ARTICLE: "math.libm" "C standard library math functions"
   5 "The words in the " { $vocab-link "math.libm" } " vocabulary call C standard library math functions. They are used to implement words in the " { $vocab-link "math.functions" } " vocabulary."
   6 { $warning
   7 "These functions are unsafe. The compiler special-cases them to operate on floats only. They can be called directly, however there is little reason to do so, since they only implement real-valued functions, and in some cases place restrictions on the domain:"
   8 { $example "USE: math.functions" "2.0 acos ." "C{ 0.0 1.316957896924817 }" }
   9 { $unchecked-example "USE: math.libm" "2.0 facos ." "0/0." } }
  10 "Trigonometric functions:"
  11 { $subsections
  12     fcos
  13     fsin
  14     facos
  15     fasin
  16     fatan
  17     fatan2
  18 }
  19 "Hyperbolic functions:"
  20 { $subsections
  21     fcosh
  22     fsinh
  23 }
  24 "Exponentials and logarithms:"
  25 { $subsections
  26     fexp
  27     flog
  28     flog10
  29 }
  30 "Powers:"
  31 { $subsections
  32     fpow
  33     fsqrt
  34 } ;
  35
  36 ABOUT: "math.libm"
  37
  38 HELP: facos
  39 { $values { "x" real } { "double" real } }
  40 { $description "Calls the inverse trigonometric cosine function from the C standard library. User code should call " { $link acos } " instead." } ;
  41
  42 HELP: fasin
  43 { $values { "x" real } { "double" real } }
  44 { $description "Calls the inverse trigonometric sine function from the C standard library. User code should call " { $link asin } " instead." } ;
  45
  46 HELP: fatan
  47 { $values { "x" real } { "double" real } }
  48 { $description "Calls the inverse trigonometric tangent function from the C standard library. User code should call " { $link atan } " instead." } ;
  49
  50 HELP: fatan2
  51 { $values { "x" real } { "y" real } { "double" real } }
  52 { $description "Calls the two-parameter inverse trigonometric tangent function from the C standard library. User code should call " { $link arg } " instead." } ;
  53
  54 HELP: fcos
  55 { $values { "x" real } { "double" real } }
  56 { $description "Calls the trigonometric cosine function from the C standard library. User code should call " { $link cos } " instead." } ;
  57
  58 HELP: fsin
  59 { $values { "x" real } { "double" real } }
  60 { $description "Calls the trigonometric sine function from the C standard library. User code should call " { $link sin } " instead." } ;
  61
  62 HELP: fcosh
  63 { $values { "x" real } { "double" real } }
  64 { $description "Calls the hyperbolic cosine function from the C standard library. User code should call " { $link cosh } " instead." } ;
  65
  66 HELP: fsinh
  67 { $values { "x" real } { "double" real } }
  68 { $description "Calls the hyperbolic sine function from the C standard library. User code should call " { $link sinh } " instead." } ;
  69
  70 HELP: fexp
  71 { $values { "x" real } { "double" real } }
  72 { $description "Calls the exponential function (" { $snippet "y=e^x" } ") from the C standard library. User code should call " { $link e^ } " instead." } ;
  73
  74 HELP: flog
  75 { $values { "x" real } { "double" real } }
  76 { $description "Calls the natural logarithm function from the C standard library. User code should call " { $link log } " instead." } ;
  77
  78 HELP: flog10
  79 { $values { "x" real } { "double" real } }
  80 { $description "Calls the base 10 logarithm function from the C standard library. User code should call " { $link log10 } " instead." } ;
  81
  82 HELP: fpow
  83 { $values { "x" real } { "y" real } { "double" real } }
  84 { $description "Calls the power function (" { $snippet "z=x^y" } ") from the C standard library. User code should call " { $link ^ } " instead." } ;
  85
  86 HELP: fsqrt
  87 { $values { "x" real } { "double" real } }
  88 { $description "Calls the square root function from the C standard library. User code should call " { $link sqrt } " instead." } ;