From b03eaf3c32885517c23c691353c3bbb2c7a245a1 Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Tue, 15 Sep 2009 15:42:46 -0500 Subject: [PATCH] math: minor doc fixes --- basis/math/functions/functions-docs.factor | 1 + basis/math/libm/libm-docs.factor | 7 ++++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/basis/math/functions/functions-docs.factor b/basis/math/functions/functions-docs.factor index d61ad9a14a..fb392191d4 100644 --- a/basis/math/functions/functions-docs.factor +++ b/basis/math/functions/functions-docs.factor @@ -48,6 +48,7 @@ ARTICLE: "power-functions" "Powers and logarithms" { $subsection exp } { $subsection cis } { $subsection log } +"Other logarithms:" { $subsection log1+ } { $subsection log10 } "Raising a number to a power:" diff --git a/basis/math/libm/libm-docs.factor b/basis/math/libm/libm-docs.factor index abbb6f1289..64f6026f0b 100644 --- a/basis/math/libm/libm-docs.factor +++ b/basis/math/libm/libm-docs.factor @@ -6,7 +6,7 @@ ARTICLE: "math.libm" "C standard library math functions" { $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:" { $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:" { $subsection fcos } { $subsection fsin } @@ -20,6 +20,7 @@ ARTICLE: "math.libm" "C standard library math functions" "Exponentials and logarithms:" { $subsection fexp } { $subsection flog } +{ $subsection flog10 } "Powers:" { $subsection fpow } { $subsection fsqrt } ; @@ -66,6 +67,10 @@ HELP: flog { $values { "x" real } { "y" real } } { $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 { $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." } ;