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

Docs: generic.math and layouts

db4
Björn Lindqvist 2014-05-03 16:29:35 +02:00 committed by John Benediktsson
parent 669bb0a77e
commit 3cd3ea35db
2 changed files with 16 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
core/generic/math/math-docs.factor
View File

@ -2,6 +2,17 @@ USING: kernel generic help.markup help.syntax math classes
sequences quotations generic.math.private ;
IN: generic.math
HELP: math-class-max
{ $values { "class1" class } { "class2" class } }
{ $description "Evaluates which math class is the largest." }
{ $examples
{ $example
"USING: generic.math math kernel prettyprint ;"
"integer float math-class-max ."
"float"
}
} ;
HELP: math-upgrade
{ $values { "class1" class } { "class2" class } { "quot" { $quotation "( n n -- n n )" } } }
{ $description "Outputs a quotation for upgrading numberical types. It takes two numbers on the stack, an instance of " { $snippet "class1" } ", and an instance of " { $snippet "class2" } ", and converts the one with the lower priority to the higher priority type." }
@ -39,5 +50,3 @@ $nl
HELP: math-generic
{ $class-description "The class of generic words using " { $link math-combination } "." } ;

7
core/layouts/layouts-docs.factor
View File

@ -39,11 +39,11 @@ HELP: bootstrap-first-bignum
{ $description "Outputs the value for the target architecture when bootstrapping." } ;
HELP: bootstrap-most-positive-fixnum
{ $values { "n" "largest positive integer representable by a fixnum" } }
{ $values { "n" "largest positive integer representable by a fixnum" } }
{ $description "Outputs the value for the target architecture when bootstrapping." } ;
HELP: bootstrap-most-negative-fixnum
{ $values { "n" "smallest negative integer representable by a fixnum" } }
{ $values { "n" "smallest negative integer representable by a fixnum" } }
{ $description "Outputs the value for the target architecture when bootstrapping." } ;
HELP: cell
@ -70,6 +70,9 @@ HELP: bootstrap-cell-bits
{ $values { "n" integer } }
{ $description "Outputs the number of bits in one cell in the target image (if bootstrapping) or the current CPU architecture (otherwise)." } ;
HELP: immediate
{ $class-description "Union class of all values that the Factor VM can store immediately, all others are stored as references (pointer) to them." } ;
ARTICLE: "layouts-types" "Type numbers"
"Corresponding to every built-in class is a built-in type number. An object can be asked for its built-in type number:"
{ $subsections tag }