steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

math: minor doc fixes

Slava Pestov 2009-09-15 15:42:46 -05:00
parent cc93fc69ff
commit ef353b5eff
2 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
basis/math/functions/functions-docs.factor
View File

@ -48,6 +48,7 @@ ARTICLE: "power-functions" "Powers and logarithms"
{ $subsection exp } { $subsection exp }
{ $subsection cis } { $subsection cis }
{ $subsection log } { $subsection log }
"Other logarithms:"
{ $subsection log1+ } { $subsection log1+ }
{ $subsection log10 } { $subsection log10 }
"Raising a number to a power:" "Raising a number to a power:"

7
basis/math/libm/libm-docs.factor
View File

@ -6,7 +6,7 @@ ARTICLE: "math.libm" "C standard library math functions"
{ $warning { $warning
"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:" "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:"
{ $example "USE: math.functions" "2.0 acos ." "C{ 0.0 1.316957896924817 }" } { $example "USE: math.functions" "2.0 acos ." "C{ 0.0 1.316957896924817 }" }
{ $unchecked-example "USE: math.libm" "2 facos ." "0/0." } } { $unchecked-example "USE: math.libm" "2.0 facos ." "0/0." } }
"Trigonometric functions:" "Trigonometric functions:"
{ $subsection fcos } { $subsection fcos }
{ $subsection fsin } { $subsection fsin }
@ -20,6 +20,7 @@ ARTICLE: "math.libm" "C standard library math functions"
"Exponentials and logarithms:" "Exponentials and logarithms:"
{ $subsection fexp } { $subsection fexp }
{ $subsection flog } { $subsection flog }
{ $subsection flog10 }
"Powers:" "Powers:"
{ $subsection fpow } { $subsection fpow }
{ $subsection fsqrt } ; { $subsection fsqrt } ;
@ -66,6 +67,10 @@ HELP: flog
{ $values { "x" real } { "y" real } } { $values { "x" real } { "y" real } }
{ $description "Calls the natural logarithm function from the C standard library. User code should call " { $link log } " instead." } ; { $description "Calls the natural logarithm function from the C standard library. User code should call " { $link log } " instead." } ;
HELP: flog10
{ $values { "x" real } { "y" real } }
{ $description "Calls the base 10 logarithm function from the C standard library. User code should call " { $link log10 } " instead." } ;
HELP: fpow HELP: fpow
{ $values { "x" real } { "y" real } { "z" real } } { $values { "x" real } { "y" real } { "z" real } }
{ $description "Calls the power function (" { $snippet "z=x^y" } ") from the C standard library. User code should call " { $link ^ } " instead." } ; { $description "Calls the power function (" { $snippet "z=x^y" } ") from the C standard library. User code should call " { $link ^ } " instead." } ;