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

alien.complex: fix docs

db4
Slava Pestov 2011-10-10 21:58:49 -07:00
parent d834d9bfa4
commit 84fda0bb05
2 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
basis/alien/c-types/c-types-docs.factor
View File

@ -1,6 +1,6 @@
USING: alien alien.complex help.syntax help.markup libc kernel.private USING: alien help.syntax help.markup libc kernel.private
byte-arrays strings hashtables alien.syntax alien.strings sequences byte-arrays strings hashtables alien.syntax alien.strings
io.encodings.string debugger destructors vocabs.loader sequences io.encodings.string debugger destructors vocabs.loader
classes.struct math kernel ; classes.struct math kernel ;
QUALIFIED: math QUALIFIED: math
QUALIFIED: sequences QUALIFIED: sequences
@ -76,10 +76,6 @@ HELP: float
{ $description "This C type represents a single-precision IEEE 754 floating-point type. Input values will be converted to Factor " { $link math:float } "s and demoted to single-precision; output values will be returned as Factor " { $link math:float } "s." } ; { $description "This C type represents a single-precision IEEE 754 floating-point type. Input values will be converted to Factor " { $link math:float } "s and demoted to single-precision; output values will be returned as Factor " { $link math:float } "s." } ;
HELP: double HELP: double
{ $description "This C type represents a double-precision IEEE 754 floating-point type. Input values will be converted to Factor " { $link math:float } "s; output values will be returned as Factor " { $link math:float } "s." } ; { $description "This C type represents a double-precision IEEE 754 floating-point type. Input values will be converted to Factor " { $link math:float } "s; output values will be returned as Factor " { $link math:float } "s." } ;
HELP: complex-float
{ $description "This C type represents a single-precision IEEE 754 floating-point complex type. Input values will be converted from Factor " { $link math:complex } " objects into a single-precision complex float type; output values will be returned as Factor " { $link math:complex } " objects." } ;
HELP: complex-double
{ $description "This C type represents a double-precision IEEE 754 floating-point complex type. Input values will be converted from Factor " { $link math:complex } " objects into a double-precision complex float type; output values will be returned as Factor " { $link math:complex } " objects." } ;
HELP: pointer: HELP: pointer:
{ $syntax "pointer: c-type" } { $syntax "pointer: c-type" }
@ -125,11 +121,8 @@ ARTICLE: "c-types.primitives" "Primitive C types"
{ { $link float } { "single-precision float (not the same as Factor's " { $link math:float } " class!)" } } { { $link float } { "single-precision float (not the same as Factor's " { $link math:float } " class!)" } }
{ { $link double } { "double-precision float (the same format as Factor's " { $link math:float } " objects)" } } { { $link double } { "double-precision float (the same format as Factor's " { $link math:float } " objects)" } }
} }
"The following C99 complex number types are defined in the " { $vocab-link "alien.complex" } " vocabulary:" "C99 complex number types are defined in the " { $vocab-link "alien.complex" } " vocabulary."
{ $table $nl
{ { $link complex-float } { "C99 or Fortran " { $snippet "complex float" } " type, converted to and from Factor " { $link math:complex } " values" } }
{ { $link complex-double } { "C99 or Fortran " { $snippet "complex double" } " type, converted to and from Factor " { $link math:complex } " values" } }
}
"When making alien calls, Factor numbers are converted to and from the above types in a canonical way. Converting a Factor number to a C value may result in a loss of precision." ; "When making alien calls, Factor numbers are converted to and from the above types in a canonical way. Converting a Factor number to a C value may result in a loss of precision." ;
ARTICLE: "c-types.pointers" "Pointer and array types" ARTICLE: "c-types.pointers" "Pointer and array types"

14
basis/alien/complex/complex-docs.factor Normal file
View File

@ -0,0 +1,14 @@
USING: help.markup help.syntax math ;
IN: alien.complex
HELP: complex-float
{ $description "This C type represents a single-precision IEEE 754 floating-point complex type. Input values will be converted from Factor " { $link complex } " objects into a single-precision complex float type; output values will be returned as Factor " { $link complex } " objects." } ;
HELP: complex-double
{ $description "This C type represents a double-precision IEEE 754 floating-point complex type. Input values will be converted from Factor " { $link complex } " objects into a double-precision complex float type; output values will be returned as Factor " { $link complex } " objects." } ;
ARTICLE: "alien.complex" "C99 complex number types"
"The following C99 complex number types are defined in the " { $vocab-link "alien.complex" } " vocabulary:"
{ $table
{ { $link complex-float } { "C99 or Fortran " { $snippet "complex float" } " type, converted to and from Factor " { $link complex } " values" } }
{ { $link complex-double } { "C99 or Fortran " { $snippet "complex double" } " type, converted to and from Factor " { $link complex } " values" } }
} ;