1 USING: help.markup help.syntax sequences strings ;
4 ARTICLE: "grouping" "Groups and clumps"
5 "Splitting a sequence into disjoint, fixed-length subsequences:"
7 "A virtual sequence for splitting a sequence into disjoint, fixed-length subsequences:"
9 { $subsection <groups> }
10 { $subsection <sliced-groups> }
11 "Splitting a sequence into overlapping, fixed-length subsequences:"
13 "A virtual sequence for splitting a sequence into overlapping, fixed-length subsequences:"
14 { $subsection clumps }
15 { $subsection <clumps> }
16 { $subsection <sliced-clumps> }
17 "The difference can be summarized as the following:"
19 { "With groups, the subsequences form the original sequence when concatenated:"
20 { $unchecked-example "dup n groups concat sequence= ." "t" }
22 { "With clumps, collecting the first element of each subsequence but the last one, together with the last subseqence, yields the original sequence:"
23 { $unchecked-example "dup n clumps unclip-last [ [ first ] map ] dip append sequence= ." "t" }
26 "A combinator built using clumps:"
27 { $subsection monotonic? }
28 "Testing how elements are related:"
29 { $subsection all-eq? }
30 { $subsection all-equal? } ;
35 { $class-description "Instances are virtual sequences whose elements are disjoint fixed-length subsequences of an underlying sequence. Groups are mutable and resizable if the underlying sequence is mutable and resizable, respectively."
37 "New groups are created by calling " { $link <groups> } " and " { $link <sliced-groups> } "." } ;
40 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "array" "a sequence of sequences" } }
41 { $description "Splits the sequence into disjoint groups of " { $snippet "n" } " elements and collects the groups into a new array." }
42 { $notes "If the sequence length is not a multiple of " { $snippet "n" } ", the final subsequence in the list will be shorter than " { $snippet "n" } " elements." }
44 { $example "USING: grouping prettyprint ;" "{ 3 1 3 3 7 } 2 group ." "{ { 3 1 } { 3 3 } { 7 } }" }
48 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "groups" groups } }
49 { $description "Outputs a virtual sequence whose elements are disjoint subsequences of " { $snippet "n" } " elements from the underlying sequence." }
52 "USING: arrays kernel prettyprint sequences grouping ;"
53 "9 >array 3 <groups> dup reverse-here concat >array ." "{ 6 7 8 3 4 5 0 1 2 }"
56 "USING: kernel prettyprint sequences grouping ;"
57 "{ 1 2 3 4 5 6 } 3 <groups> first ."
63 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "groups" groups } }
64 { $description "Outputs a virtual sequence whose elements are slices of disjoint subsequences of " { $snippet "n" } " elements from the underlying sequence." }
67 "USING: arrays kernel prettyprint sequences grouping ;"
68 "9 >array 3 <sliced-groups>"
69 "dup [ reverse-here ] each concat >array ."
70 "{ 2 1 0 5 4 3 8 7 6 }"
73 "USING: kernel prettyprint sequences grouping ;"
74 "{ 1 2 3 4 5 6 } 3 <sliced-groups> second ."
75 "T{ slice { from 3 } { to 6 } { seq { 1 2 3 4 5 6 } } }"
80 { $class-description "Instances are virtual sequences whose elements are overlapping fixed-length subsequences o an underlying sequence. Clumps are mutable and resizable if the underlying sequence is mutable and resizable, respectively."
82 "New clumps are created by calling " { $link <clumps> } " and " { $link <sliced-clumps> } "." } ;
85 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "array" "a sequence of sequences" } }
86 { $description "Splits the sequence into overlapping clumps of " { $snippet "n" } " elements and collects the clumps into a new array." }
87 { $errors "Throws an error if " { $snippet "n" } " is smaller than the length of the sequence." }
89 { $example "USING: grouping prettyprint ;" "{ 3 1 3 3 7 } 2 clump ." "{ { 3 1 } { 1 3 } { 3 3 } { 3 7 } }" }
93 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "clumps" clumps } }
94 { $description "Outputs a virtual sequence whose elements are overlapping subsequences of " { $snippet "n" } " elements from the underlying sequence." }
98 "USING: grouping sequences math prettyprint kernel ;"
100 "CONSTANT: share-price { 13/50 51/100 13/50 1/10 4/5 17/20 33/50 3/25 19/100 3/100 }"
102 "share-price 4 <clumps> [ [ sum ] [ length ] bi / ] map ."
103 "{ 113/400 167/400 201/400 241/400 243/400 91/200 1/4 }"
106 "USING: kernel sequences grouping prettyprint ;"
107 "{ 1 2 3 4 5 6 } 3 <clumps> second ."
112 HELP: <sliced-clumps>
113 { $values { "seq" "a sequence" } { "n" "a non-negative integer" } { "clumps" clumps } }
114 { $description "Outputs a virtual sequence whose elements are overlapping slices of " { $snippet "n" } " elements from the underlying sequence." }
117 "USING: kernel sequences grouping prettyprint ;"
118 "{ 1 2 3 4 5 6 } 3 <sliced-clumps> second ."
119 "T{ slice { from 1 } { to 4 } { seq { 1 2 3 4 5 6 } } }"
123 { clumps groups } related-words
125 { clump group } related-words
127 { <clumps> <groups> } related-words
129 { <sliced-clumps> <sliced-groups> } related-words
132 { $values { "seq" sequence } { "quot" { $quotation "( elt elt -- ? )" } } { "?" "a boolean" } }
133 { $description "Applies the relation to successive pairs of elements in the sequence, testing for a truth value. The relation should be a transitive relation, such as a total order or an equality relation." }
135 "Testing if a sequence is non-decreasing:"
136 { $example "USING: grouping math prettyprint ;" "{ 1 1 2 } [ <= ] monotonic? ." "t" }
137 "Testing if a sequence is decreasing:"
138 { $example "USING: grouping math prettyprint ;" "{ 9 8 6 7 } [ < ] monotonic? ." "f" }
142 { $values { "seq" sequence } { "?" "a boolean" } }
143 { $description "Tests if all elements in the sequence are equal. Yields true with an empty sequence." } ;
146 { $values { "seq" sequence } { "?" "a boolean" } }
147 { $description "Tests if all elements in the sequence are the same identical object. Yields true with an empty sequence." } ;
149 { monotonic? all-eq? all-equal? } related-words