core/arrays/arrays-docs.factor

   1 USING: help.markup help.syntax
   2 kernel kernel.private prettyprint sequences.private sequences ;
   3 IN: arrays
   4
   5 ARTICLE: "arrays-unsafe" "Unsafe array operations"
   6 "These two words are used internally by the Factor implementation. User code should never need to call them; instead use " { $link nth } " and " { $link set-nth } "."
   7 { $subsections
   8     array-nth
   9     set-array-nth
  10 } ;
  11
  12 ARTICLE: "arrays" "Arrays"
  13 "The " { $vocab-link "arrays" } " vocabulary implements fixed-size mutable sequences which support the " { $link "sequence-protocol" } "."
  14 $nl
  15 "The " { $vocab-link "arrays" } " vocabulary only includes words for creating new arrays. To access and modify array elements, use " { $link "sequences" } " in the " { $vocab-link "sequences" } " vocabulary."
  16 $nl
  17 "Array literal syntax is documented in " { $link "syntax-arrays" } ". Resizable arrays also exist and are known as " { $link "vectors" } "."
  18 $nl
  19 "Arrays form a class of objects:"
  20 { $subsections
  21     array
  22     array?
  23 }
  24 "Creating new arrays:"
  25 { $subsections
  26     >array
  27     <array>
  28 }
  29 "Creating an array from several elements on the stack:"
  30 { $subsections
  31     1array
  32     2array
  33     3array
  34     4array
  35 }
  36 "The class of two-element arrays:"
  37 { $subsections pair }
  38 "Arrays can be accessed without bounds checks in a pointer unsafe way."
  39 { $subsections "arrays-unsafe" } ;
  40
  41 ABOUT: "arrays"
  42
  43 HELP: array
  44 { $description "The class of fixed-length arrays. See " { $link "syntax-arrays" } " for syntax and " { $link "arrays" } " for general information." } ;
  45
  46 HELP: <array> ( n elt -- array )
  47 { $values { "n" "a non-negative integer" } { "elt" "an initial element" } { "array" "a new array" } }
  48 { $description "Creates a new array with the given length and all elements initially set to " { $snippet "elt" } "." } ;
  49
  50 HELP: >array
  51 { $values { "seq" "a sequence" } { "array" array } }
  52 { $description "Outputs a freshly-allocated array with the same elements as a given sequence." } ;
  53
  54 HELP: 1array
  55 { $values { "x" object } { "array" array } }
  56 { $description "Create a new array with one element." } ;
  57
  58 { 1array 2array 3array 4array } related-words
  59
  60 HELP: 2array
  61 { $values { "x" object } { "y" object } { "array" array } }
  62 { $description "Create a new array with two elements, with " { $snippet "x" } " appearing first." } ;
  63
  64 HELP: 3array
  65 { $values { "x" object } { "y" object } { "z" object } { "array" array } }
  66 { $description "Create a new array with three elements, with " { $snippet "x" } " appearing first." } ;
  67
  68 HELP: 4array
  69 { $values { "w" object } { "x" object } { "y" object } { "z" object } { "array" array } }
  70 { $description "Create a new array with four elements, with " { $snippet "w" } " appearing first." } ;
  71
  72 HELP: resize-array ( n array -- newarray )
  73 { $values { "n" "a non-negative integer" } { "array" array } { "newarray" "a new array" } }
  74 { $description "Creates a new array of " { $snippet "n" } " elements. The contents of the existing array are copied into the new array; if the new array is shorter, only an initial segment is copied, and if the new array is longer the remaining space is filled in with "{ $link f } "." } ;
  75
  76 HELP: pair
  77 { $class-description "The class of two-element arrays, known as pairs." } ;