1 USING: help.markup help.syntax
2 kernel kernel.private prettyprint sequences.private sequences ;
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 } "."
12 ARTICLE: "arrays" "Arrays"
13 "The " { $vocab-link "arrays" } " vocabulary implements fixed-size mutable sequences which support the " { $link "sequence-protocol" } "."
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."
17 "Array literal syntax is documented in " { $link "syntax-arrays" } ". Resizable arrays also exist and are known as " { $link "vectors" } "."
19 "Arrays form a class of objects:"
24 "Creating new arrays:"
29 "Creating an array from several elements on the stack:"
37 { $subsections resize-array }
38 "The class of two-element arrays:"
40 "Arrays can be accessed without bounds checks in a pointer unsafe way."
41 { $subsections "arrays-unsafe" } ;
46 { $class-description "The class of fixed-length arrays. See " { $link "syntax-arrays" } " for syntax and " { $link "arrays" } " for general information." } ;
49 { $values { "n" "a non-negative integer" } { "elt" "an initial element" } { "array" "a new array" } }
50 { $description "Creates a new array with the given length and all elements initially set to " { $snippet "elt" } "." } ;
53 { $values { "seq" sequence } { "array" array } }
54 { $description "Outputs a freshly-allocated array with the same elements as a given sequence." } ;
57 { $values { "x" object } { "array" array } }
58 { $description "Create a new array with one element." } ;
60 { 1array 2array 3array 4array } related-words
63 { $values { "x" object } { "y" object } { "array" array } }
64 { $description "Create a new array with two elements, with " { $snippet "x" } " appearing first." } ;
67 { $values { "x" object } { "y" object } { "z" object } { "array" array } }
68 { $description "Create a new array with three elements, with " { $snippet "x" } " appearing first." } ;
71 { $values { "w" object } { "x" object } { "y" object } { "z" object } { "array" array } }
72 { $description "Create a new array with four elements, with " { $snippet "w" } " appearing first." } ;
75 { $values { "n" "a non-negative integer" } { "array" array } { "new-array" array } }
76 { $description "Resizes the array to have a length of " { $snippet "n" } " elements. When making the array shorter, this word may either create a new array or modify the existing array in place. When making the array longer, this word always allocates a new array, filling remaining space with " { $link f } "." }
77 { $side-effects "array" } ;
80 { $class-description "The class of two-element arrays, known as pairs." } ;