]> gitweb.factorcode.org Git - factor.git/commitdiff
More minor documentation tweaks
authorSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Sun, 30 Aug 2009 11:32:20 +0000 (06:32 -0500)
committerSlava Pestov <slava@slava-pestovs-macbook-pro.local>
Sun, 30 Aug 2009 11:32:20 +0000 (06:32 -0500)
basis/help/handbook/handbook.factor
basis/math/bits/bits-docs.factor
basis/math/complex/complex.factor
basis/math/libm/libm-docs.factor
core/math/math-docs.factor

index 5db362d9bc3e328a8391b2dd7710ebe06b00f683..3effd5931e8fb874dc64a3c8fa0f387db6984df4 100644 (file)
@@ -106,10 +106,7 @@ ARTICLE: "numbers" "Numbers"
 { $subsection "complex-numbers" }
 "Advanced features:"
 { $subsection "math-vectors" }
-{ $subsection "math-intervals" }
-{ $subsection "math-bitfields" }
-"Implementation:"
-{ $subsection "math.libm" } ;
+{ $subsection "math-intervals" } ;
 
 USE: io.buffers
 
index 36043a55766057c5f22d55e9d0f46558eba9ec6a..9e698239060b33c815780b000cc17915fa04dc41 100644 (file)
@@ -6,6 +6,7 @@ IN: math.bits
 ABOUT: "math.bits"
 
 ARTICLE: "math.bits" "Number bits virtual sequence"
+"The " { $vocab-link "math.bits" } " vocabulary implements a virtual sequence which presents an integer as a sequence of bits, with the first element of the sequence being the least significant bit of the integer."
 { $subsection bits }
 { $subsection <bits> }
 { $subsection make-bits } ;
index ce94dfaca886a0c4e87699bc6c7defee2c2a747e..c432089f4d944afe6579c2e6dcbf02d4daf79ec5 100644 (file)
@@ -1,8 +1,7 @@
 ! Copyright (C) 2006, 2009 Slava Pestov.
 ! See http://factorcode.org/license.txt for BSD license.
 USING: accessors kernel kernel.private math math.private
-math.libm math.functions arrays math.functions.private sequences
-parser ;
+math.functions arrays math.functions.private sequences parser ;
 IN: math.complex.private
 
 M: real real-part ; inline
@@ -26,8 +25,8 @@ M: complex * [ *re - ] [ *im + ] 2bi rect> ; inline
 M: complex / [ / ] complex/ ; inline
 M: complex /f [ /f ] complex/ ; inline
 M: complex /i [ /i ] complex/ ; inline
-M: complex abs absq >float fsqrt ; inline
-M: complex sqrt >polar [ fsqrt ] [ 2.0 / ] bi* polar> ; inline
+M: complex abs absq sqrt ; inline
+M: complex sqrt >polar [ sqrt ] [ 2.0 / ] bi* polar> ; inline
 
 IN: syntax
 
index a890a59c19daecefce02bfc1452a48a61110e030..abbb6f1289521195c518d7fcf966da94d4d15442 100644 (file)
@@ -3,10 +3,10 @@ IN: math.libm
 
 ARTICLE: "math.libm" "C standard library math functions"
 "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."
-$nl
-"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 acos ." "C{ 0.0 1.316957896924817 }" }
-{ $unchecked-example "USE: math.libm" "2 facos ." "0/0." }
+{ $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." } }
 "Trigonometric functions:"
 { $subsection fcos }
 { $subsection fsin }
index 853aca5969d3516b6a0207dfd4bf2999833091ac..ab2a5ab8be03ee4e718f39ce16e6c614969edd8c 100644 (file)
@@ -420,6 +420,7 @@ ARTICLE: "bitwise-arithmetic" "Bitwise arithmetic"
 { $subsection 2/ }
 { $subsection 2^ }
 { $subsection bit? }
+"Advanced topics:"
 { $subsection "math.bitwise" }
 { $subsection "math.bits" }
 { $see-also "booleans" } ;