1 USING: help.syntax help.markup kernel sequences quotations
\r
2 math arrays combinators ;
\r
6 { $values { "n" integer } { "seq" "an exemplar" } }
\r
7 { $description "A generalization of " { $link 2sequence } ", "
\r
8 { $link 3sequence } ", and " { $link 4sequence } " "
\r
9 "that constructs a sequence from the top " { $snippet "n" } " elements of the stack."
\r
12 { $example "USING: generalizations prettyprint ;" "CHAR: f CHAR: i CHAR: s CHAR: h 4 \"\" nsequence ." "\"fish\"" }
\r
16 { $values { "n" integer } }
\r
17 { $description "A generalization of " { $link 1array } ", "
\r
18 { $link 2array } ", " { $link 3array } " and " { $link 4array } " "
\r
19 "that constructs an array from the top " { $snippet "n" } " elements of the stack."
\r
22 "Some core words expressed in terms of " { $link narray } ":"
\r
24 { { $link 1array } { $snippet "1 narray" } }
\r
25 { { $link 2array } { $snippet "2 narray" } }
\r
26 { { $link 3array } { $snippet "3 narray" } }
\r
27 { { $link 4array } { $snippet "4 narray" } }
\r
31 { nsequence narray } related-words
\r
34 { $values { "n" integer } }
\r
35 { $description "Adds the top " { $snippet "n" } " stack values." } ;
\r
38 { $values { "n" integer } }
\r
39 { $description "A generalization of " { $link first } ", "
\r
40 { $link first2 } ", " { $link first3 } " and " { $link first4 } " "
\r
41 "that pushes the first " { $snippet "n" } " elements of a sequence on the stack."
\r
44 "Some core words expressed in terms of " { $link firstn } ":"
\r
46 { { $link first } { $snippet "1 firstn" } }
\r
47 { { $link first2 } { $snippet "2 firstn" } }
\r
48 { { $link first3 } { $snippet "3 firstn" } }
\r
49 { { $link first4 } { $snippet "4 firstn" } }
\r
54 { $values { "n" integer } }
\r
55 { $description "A generalization of " { $link dup } ", "
\r
56 { $link over } " and " { $link pick } " that can work "
\r
57 "for any stack depth. The nth item down the stack will be copied and "
\r
58 "placed on the top of the stack."
\r
61 { $example "USING: kernel prettyprint generalizations ;" "1 2 3 4 4 npick 5 narray ." "{ 1 2 3 4 1 }" }
\r
62 "Some core words expressed in terms of " { $link npick } ":"
\r
64 { { $link dup } { $snippet "1 npick" } }
\r
65 { { $link over } { $snippet "2 npick" } }
\r
66 { { $link pick } { $snippet "3 npick" } }
\r
71 { $values { "n" integer } }
\r
72 { $description "A generalization of " { $link dup } ", "
\r
73 { $link 2dup } " and " { $link 3dup } " that can work "
\r
74 "for any number of items. The n topmost items on the stack will be copied and "
\r
75 "placed on the top of the stack."
\r
78 { $example "USING: prettyprint generalizations kernel ;" "1 2 3 4 4 ndup 8 narray ." "{ 1 2 3 4 1 2 3 4 }" }
\r
79 "Some core words expressed in terms of " { $link ndup } ":"
\r
81 { { $link dup } { $snippet "1 ndup" } }
\r
82 { { $link 2dup } { $snippet "2 ndup" } }
\r
83 { { $link 3dup } { $snippet "3 ndup" } }
\r
88 { $values { "n" integer } }
\r
89 { $description "A generalization of " { $link nip } " and " { $link 2nip }
\r
91 "for any number of items."
\r
94 { $example "USING: prettyprint generalizations kernel ;" "1 2 3 4 3 nnip ." "4" }
\r
95 "Some core words expressed in terms of " { $link nnip } ":"
\r
97 { { $link nip } { $snippet "1 nnip" } }
\r
98 { { $link 2nip } { $snippet "2 nnip" } }
\r
103 { $values { "n" integer } }
\r
104 { $description "A generalization of " { $link drop }
\r
106 "for any number of items."
\r
109 { $example "USING: prettyprint generalizations kernel ;" "1 2 3 4 3 ndrop ." "1" }
\r
110 "Some core words expressed in terms of " { $link ndrop } ":"
\r
112 { { $link drop } { $snippet "1 ndrop" } }
\r
113 { { $link 2drop } { $snippet "2 ndrop" } }
\r
114 { { $link 3drop } { $snippet "3 ndrop" } }
\r
119 { $values { "n" integer } }
\r
120 { $description "A generalization of " { $link rot } " that works for any "
\r
121 "number of items on the stack. "
\r
124 { $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 4 4 nrot 4array ." "{ 2 3 4 1 }" }
\r
125 "Some core words expressed in terms of " { $link nrot } ":"
\r
127 { { $link swap } { $snippet "1 nrot" } }
\r
128 { { $link rot } { $snippet "2 nrot" } }
\r
133 { $values { "n" integer } }
\r
134 { $description "A generalization of " { $link -rot } " that works for any "
\r
135 "number of items on the stack. "
\r
138 { $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 4 4 -nrot 4array ." "{ 4 1 2 3 }" }
\r
139 "Some core words expressed in terms of " { $link -nrot } ":"
\r
141 { { $link swap } { $snippet "1 -nrot" } }
\r
142 { { $link -rot } { $snippet "2 -nrot" } }
\r
147 { $values { "quot" quotation } { "n" integer } }
\r
148 { $description "A generalization of " { $link dip } " that can work "
\r
149 "for any stack depth. The quotation will be called with a stack that "
\r
150 "has 'n' items removed first. The 'n' items are then put back on the "
\r
151 "stack. The quotation can consume and produce any number of items."
\r
154 { $example "USING: arrays generalizations kernel prettyprint ;" "1 2 [ dup ] 1 ndip 3array ." "{ 1 1 2 }" }
\r
155 { $example "USING: arrays generalizations kernel prettyprint ;" "1 2 3 [ drop ] 2 ndip 2array ." "{ 2 3 }" }
\r
156 "Some core words expressed in terms of " { $link ndip } ":"
\r
158 { { $link dip } { $snippet "1 ndip" } }
\r
159 { { $link 2dip } { $snippet "2 ndip" } }
\r
160 { { $link 3dip } { $snippet "3 ndip" } }
\r
165 { $values { "quot" quotation } { "n" integer } }
\r
166 { $description "A generalization of " { $link keep } " that can work "
\r
167 "for any stack depth. The first " { $snippet "n" } " items after the quotation will be "
\r
168 "saved, the quotation called, and the items restored."
\r
171 { $example "USING: generalizations kernel prettyprint ;" "1 2 3 4 5 [ drop drop drop drop drop 99 ] 5 nkeep 6 narray ." "{ 99 1 2 3 4 5 }" }
\r
172 "Some core words expressed in terms of " { $link nkeep } ":"
\r
174 { { $link keep } { $snippet "1 nkeep" } }
\r
175 { { $link 2keep } { $snippet "2 nkeep" } }
\r
176 { { $link 3keep } { $snippet "3 nkeep" } }
\r
181 { $values { "quot" quotation } { "n" integer } }
\r
182 { $description "A generalization of " { $link curry } " that can work for any stack depth."
\r
185 "Some core words expressed in terms of " { $link ncurry } ":"
\r
187 { { $link curry } { $snippet "1 ncurry" } }
\r
188 { { $link 2curry } { $snippet "2 ncurry" } }
\r
189 { { $link 3curry } { $snippet "3 ncurry" } }
\r
194 { $values { "quot" quotation } { "n" integer } }
\r
195 { $description "A generalization of " { $link with } " that can work for any stack depth."
\r
198 "Some core words expressed in terms of " { $link nwith } ":"
\r
200 { { $link with } { $snippet "1 nwith" } }
\r
205 { $values { "quot" quotation } { "n" integer } }
\r
206 { $description "A generalization of " { $link bi@ } " and " { $link tri@ } " that can work for any stack depth."
\r
209 "Some core words expressed in terms of " { $link napply } ":"
\r
211 { { $link call } { $snippet "1 napply" } }
\r
212 { { $link bi@ } { $snippet "2 napply" } }
\r
213 { { $link tri@ } { $snippet "3 napply" } }
\r
218 { $values { "quots" "a sequence of quotations" } { "n" integer } }
\r
219 { $description "A generalization of " { $link cleave } " and " { $link 2cleave } " that can work for any quotation arity."
\r
222 "Some core words expressed in terms of " { $link ncleave } ":"
\r
224 { { $link cleave } { $snippet "1 ncleave" } }
\r
225 { { $link 2cleave } { $snippet "2 ncleave" } }
\r
230 { $values { "quots" "a sequence of quotations" } { "n" integer } }
\r
231 { $description "A generalization of " { $link spread } " that can work for any quotation arity."
\r
235 { $values { "m" integer } { "n" integer } }
\r
236 { $description "Swaps the top " { $snippet "m" } " stack elements with the " { $snippet "n" } " elements directly underneath." }
\r
238 "Some core words expressed in terms of " { $link mnswap } ":"
\r
240 { { $link swap } { $snippet "1 1 mnswap" } }
\r
241 { { $link rot } { $snippet "2 1 mnswap" } }
\r
242 { { $link -rot } { $snippet "1 2 mnswap" } }
\r
247 { $values { "n" integer } }
\r
248 { $description "Copies the top " { $snippet "n" } " stack elements underneath each one of the " { $snippet "n" } " elements below." }
\r
251 "USING: arrays kernel generalizations prettyprint ;"
\r
252 "\"e1\" \"e2\" \"o1\" \"o2\" 2 nweave [ 3array ] 3dip 3array 2array ."
\r
253 "{ { \"e1\" \"o1\" \"o2\" } { \"e2\" \"o1\" \"o2\" } }"
\r
259 { "n" integer } { "quot" quotation }
\r
260 { "quot'" quotation }
\r
263 { $example "USING: generalizations prettyprint math ;"
\r
268 { $description "Construct a quotation containing the contents of " { $snippet "seq" } " repeated " { $snippet "n"} " times." } ;
\r
275 { $description "Outputs a new sequence consisting of the elements of the top " { $snippet "n" } " sequences from the datastack in turn." }
\r
276 { $errors "Throws an error if any of the sequences contain elements that are not permitted in the sequence type of the first sequence." }
\r
278 { $example "USING: generalizations prettyprint math ;"
\r
279 "{ 1 2 } { 3 4 } { 5 6 } { 7 8 } 4 nappend ."
\r
280 "{ 1 2 3 4 5 6 7 8 }"
\r
286 { "n" integer } { "exemplar" sequence }
\r
289 { $description "Outputs a new sequence of type " { $snippet "exemplar" } " consisting of the elements of the top " { $snippet "n" } " sequences from the datastack in turn." }
\r
290 { $errors "Throws an error if any of the sequences contain elements that are not permitted in the sequence type of the first sequence." }
\r
292 { $example "USING: generalizations prettyprint math ;"
\r
293 "{ 1 2 } { 3 4 } { 5 6 } { 7 8 } 4 V{ } nappend-as ."
\r
294 "V{ 1 2 3 4 5 6 7 8 }"
\r
298 { nappend nappend-as } related-words
\r
304 { $description "A generalization of " { $link tuck } " that can work for any stack depth. The top item will be copied and placed " { $snippet "n" } " items down on the stack." } ;
\r
306 ARTICLE: "sequence-generalizations" "Generalized sequence operations"
\r
307 { $subsection narray }
\r
308 { $subsection nsequence }
\r
309 { $subsection firstn }
\r
310 { $subsection nappend }
\r
311 { $subsection nappend-as } ;
\r
313 ARTICLE: "shuffle-generalizations" "Generalized shuffle words"
\r
314 { $subsection ndup }
\r
315 { $subsection npick }
\r
316 { $subsection nrot }
\r
317 { $subsection -nrot }
\r
318 { $subsection nnip }
\r
319 { $subsection ndrop }
\r
320 { $subsection ntuck }
\r
321 { $subsection mnswap }
\r
322 { $subsection nweave } ;
\r
324 ARTICLE: "combinator-generalizations" "Generalized combinators"
\r
325 { $subsection ndip }
\r
326 { $subsection nkeep }
\r
327 { $subsection napply }
\r
328 { $subsection ncleave }
\r
329 { $subsection nspread } ;
\r
331 ARTICLE: "other-generalizations" "Additional generalizations"
\r
332 { $subsection ncurry }
\r
333 { $subsection nwith }
\r
334 { $subsection nsum } ;
\r
336 ARTICLE: "generalizations" "Generalized shuffle words and combinators"
\r
337 "The " { $vocab-link "generalizations" } " vocabulary defines a number of stack shuffling words and combinators for use in "
\r
338 "macros where the arity of the input quotations depends on an "
\r
340 { $subsection "sequence-generalizations" }
\r
341 { $subsection "shuffle-generalizations" }
\r
342 { $subsection "combinator-generalizations" }
\r
343 { $subsection "other-generalizations" } ;
\r
345 ABOUT: "generalizations"
\r