basis/specialized-arrays/specialized-arrays-docs.factor

   1 USING: help.markup help.syntax byte-arrays alien ;
   2 IN: specialized-arrays
   3
   4 HELP: SPECIALIZED-ARRAY:
   5 { $syntax "SPECIALIZED-ARRAY: type" }
   6 { $values { "type" "a C type" } }
   7 { $description "Brings a specialized array for holding values of " { $snippet "type" } " into the vocabulary search path. The generated words are documented in " { $link "specialized-array-words" } "." } ;
   8
   9 ARTICLE: "specialized-array-words" "Specialized array words"
  10 "The " { $link POSTPONE: SPECIALIZED-ARRAY: } " parsing word generates the specialized array type if it hasn't been generated already, and adds the following words to the vocabulary search path, where " { $snippet "T" } " is the C type in question:"
  11 { $table
  12     { { $snippet "T-array" } { "The class of arrays with elements of type " { $snippet "T" } } }
  13     { { $snippet "<T-array>" } { "Constructor for arrays with elements of type " { $snippet "T" } "; stack effect " { $snippet "( len -- array )" } } }
  14     { { $snippet "(T-array)" } { "Constructor for arrays with elements of type " { $snippet "T" } ", where the initial contents are uninitialized; stack effect " { $snippet "( len -- array )" } } }
  15     { { $snippet "malloc-T-array" } { "Constructor for arrays with elements of type " { $snippet "T" } " backed by newly-allocated unmanaged memory; stack effect " { $snippet "( alien len -- array )" } } }
  16     { { $snippet "<direct-T-array>" } { "Constructor for arrays with elements of type " { $snippet "T" } " backed by raw memory; stack effect " { $snippet "( alien len -- array )" } } }
  17     { { $snippet "byte-array>T-array" } { "Converts a byte array into a specialized array by interpreting the bytes in as machine-specific values. Code which uses this word is unportable" } }
  18     { { $snippet ">T-array" } { "Converts a sequence into a specialized array of type " { $snippet "T" } "; stack effect " { $snippet "( seq -- array )" } } }
  19     { { $snippet "T-array{" } { "Literal syntax, consists of a series of values terminated by " { $snippet "}" } } }
  20 }
  21 "Behind the scenes, these words are placed in a vocabulary named " { $snippet "specialized-arrays.instances.T" } ", however this vocabulary should not be placed in a " { $link POSTPONE: USING: } " form directly. Instead, always use " { $link POSTPONE: SPECIALIZED-ARRAY: } ". This ensures that the vocabulary can get generated the first time it is needed." ;
  22
  23 ARTICLE: "specialized-array-c" "Passing specialized arrays to C functions"
  24 "Each specialized array has a " { $slot "underlying" } " slot holding a " { $link byte-array } " with the raw data. Passing a specialized array as a parameter to a C function call will automatically extract the underlying data. To get at the underlying data directly, call the " { $link >c-ptr } " word on a specialized array." ;
  25
  26 ARTICLE: "specialized-array-math" "Vector arithmetic with specialized arrays"
  27 "Each specialized array with a numeric type generates specialized versions of the " { $link "math-vectors" } " words. The compiler substitutes calls for these words if it can statically determine input types. The " { $snippet "optimized." } " word in the " { $vocab-link "compiler.tree.debugger" } " vocabulary can be used to determine if this optimization is being performed for a particular piece of code." ;
  28
  29 ARTICLE: "specialized-array-examples" "Specialized array examples"
  30 "Let's import specialized float arrays:"
  31 { $code "USING: specialized-arrays math.constants math.functions ;" "SPECIALIZED-ARRAY: float" }
  32 "Creating a float array with 3 elements:"
  33 { $code "1.0 [ sin ] [ cos ] [ tan ] tri float-array{ } 3sequence ." }
  34 "Create a float array and sum the elements:"
  35 { $code
  36     "1000 iota [ 1000 /f pi * sin ] float-array{ } map-as"
  37     "0.0 [ + ] reduce ."
  38 } ;
  39
  40 ARTICLE: "specialized-arrays" "Specialized arrays"
  41 "The " { $vocab-link "specialized-arrays" } " vocabulary implements fixed-length sequence types for storing machine values in a space-efficient manner without boxing."
  42 $nl
  43 "A specialized array type needs to be generated for each element type. This is done with a parsing word:"
  44 { $subsection POSTPONE: SPECIALIZED-ARRAY: }
  45 "This parsing word adds new words to the search path:"
  46 { $subsection "specialized-array-words" }
  47 { $subsection "specialized-array-c" }
  48 { $subsection "specialized-array-math" }
  49 { $subsection "specialized-array-examples" }
  50 "The " { $vocab-link "specialized-vectors" } " vocabulary provides a resizable version of this abstraction." ;
  51
  52 ABOUT: "specialized-arrays"