all repos — min @ 59aefabd87e41e18141456e7c778a1f93d20d448

A small but practical concatenative programming language.

site/contents/reference-seq.md

 1
 2
 3
 4
 5
 6
 7
 8
 9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
-----
content-type: "page"
title: "seq Module"
-----
{@ _defs_.md || 0 @}

{#op||all?||{{q1}} {{q2}}||{{b}}||
Applies predicate {{q2}} to each element of {{q1}} and returns {{t}} if all elements of {{q1}} satisfy predicate {{q2}}, {{f}} otherwise. #}

{#op||any?||{{q1}} {{q2}}||{{b}}||
Applies predicate {{q2}} to each element of {{q1}} and returns {{t}} if at least one element of {{q1}} satisfies predicate {{q2}}, {{f}} otherwise. #}

{#op||append||{{any}} {{q}}||({{a0p}} {{any}})||
Returns a new quotation containing the contents of {{q}} with {{any}} appended. #}

{#op||get||{{q}} {{i}}||{{any}}||
Returns the _n^th_ element of {{q}} (zero-based).#}

{#op||concat||{{q1}} {{q2}}||{{q3}}||
Concatenates {{q1}} with {{q2}}. #}

{#op||difference||{{q1}} {{q2}}||{{q3}}||
> Calculates the difference {{q3}} of {{q1}} and {{q2}}.
>
> > %sidebar%
> > Example
> > 
> > The following program leaves `(2)` on the stack:
> > 
> >     (1 2 "test") ("test" "a" true 1) seq.difference #}

{#op||drop||{{q1}} {{i}}||{{q2}}||
Returns a quotation {{q2}} containing the remaining elements after the first _n_ values of the input quotation {{q1}}, or an empty quotation if {{i}} is greater than the length of {{q1}}. #}

{#op||filter||{{q1}} {{q2}}||{{q3}}||
> Returns a new quotation {{q3}} containing all elements of {{q1}} that satisfy predicate {{q2}}.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `(2 6 8 12)` on the stack:
> > 
> >     (1 37 34 2 6 8 12 21) 
> >     (stackdup 20 < stack.swap even? and) seq.filter #}

{#op||find||{{q1}} {{q2}}||{{i}}||
> Returns the index of the first element within {{q1}} that satisfies predicate {{q2}}, or -1 if no element satisfies it.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `3` on the stack:
> > 
> >     (1 2 4 8 16) 
> >     (5 >) seq.find #}

{#op||first||{{q}}||{{any}}||
Returns the first element of {{q}}. #}

{#op||flatten||{{q1}}||{{q2}}||
> Flattens all quotations within {{q1}} and returns the resulting sequence {{q2}}.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `(1 2 3 4 5 6 7 8)` on the stack:
> > 
> >     (1 (2 3 4) 5 (6 7) 8) 
> >     seq.flatten #}

{#op||harvest||{{q1}}||{{q2}}||
> Creates a new quotation {{q2}} containing all elements of {{q1}} except for empty quotations.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `(1 2 3)` on the stack:
> > 
> >     (1 () () () 2 () 3) 
> >     seq.harvest #}

{#op||in?||{{q}} {{any}}||{{b}}||
Returns {{t}} if {{any}} is contained in {{q}}, {{f}} otherwise.#}

{#op||insert||{{q1}} {{any}} {{i}}||{{q2}}||
Inserts {{any}} as the value of the _n^th_ element {{q1}} (zero-based), and returns the modified copy of the quotation {{q2}}. #}

{#op||intersection||{{q1}} {{q2}}||{{q3}}||
> Calculates the intersection {{q3}} of {{q1}} and {{q2}}.
>
> > %sidebar%
> > Example
> > 
> > The following program leaves `(1 "test")` on the stack:
> > 
> >     (1 2 "test") ("test" "a" true 1) seq.intersection #}

{#op||last||{{q}}||{{any}}||
Returns the last element of {{q}}. #}

{#op||map||{{q1}} {{q2}}||{{q3}}||
Returns a new quotation {{q3}} obtained by applying {{q2}} to each element of {{q1}}.#}

{#op||map-reduce||{{q1}} {{q2}} {{q3}}||{{i}}||
> Applies {{q2}} (map) to each element of {{q1}} and then applies {{q3}} (reduce) to each successive element of {{q1}}. {{q1}} must have at least one element.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `35` on the stack:
> > 
> >     (1 3 5) 
> >     (stack.dup *) (+) seq.map-reduce #}

{#op||partition||{{q1}} {{q2}}||{{q3}} {{q4}}||
> Partitions {{q1}} into two quotations: {{q3}} contains all elements of {{q1}} that satisfy predicate {{q2}}, {{q4}} all the others.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `(1 3 5) (2 4 6)` on the stack:
> > 
> >     (1 2 3 4 5 6) 
> >     (odd?) seq.partition #}

{#op||one?||{{q1}} {{q2}}||{{b}}||
Applies predicate {{q2}} to each element of {{q1}} and returns {{t}} if only one element of {{q1}} satisfies predicate {{q2}}, {{f}} otherwise. #}

{#op||prepend||{{any}} {{q}}||({{any}} {{a0p}})||
Returns a new quotation containing the contents of {{q}} with {{any}} prepended. #}

{#op||quote-map||{{q1}}||{{q2}}||
Returns a new quotation {{q2}} obtained by quoting each element of {{q1}}.#}

{#op||raw-get||{{q}} {{i}}||{{rawval}}||
Returns the _n^th_ element of {{q}} (zero-based) wrapped in a {{rawval}}.#}

{#op||reduce||{{q1}} {{a1}} {{q2}}||{{a2}}||
> Combines each successive element of {{q1}} using {{q2}}. On the first iteration, the first two inputs processed by {{q2}} are {{a1}} and the first element of {{q1}}.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `120` on the stack:
> > 
> >     (1 2 3 4 5) 
> >     1 (*) seq.reduce #}

{#op||reject||{{q1}} {{q2}}||{{q3}}||
Returns a new quotatios {{q3}} including all elements of {{q1}} that do not satisfy predicate {{q2}} (i.e. the opposite of `filter`)#}

{#op||remove||{{q1}} {{i}}||{{q2}}||
Returns the _n^th_ element of {{q1}} (zero-based), and returns the modified copy of the quotation {{q2}}.#}

{#op||rest||{{q1}}||{{q2}}||
Returns a new quotation {{q2}} containing all elements of {{q1}} quotation except for the first. #}

{#op||reverse||{{q1}}||{{q2}}||
Returns a new quotation {{q2}} containing all elements of {{q1}} in reverse order. #}

{#op||set||{{q1}} {{any}} {{i}}||{{q2}}||
Sets the value of the _n^th_ element {{q1}} (zero-based) to {{any}}, and returns the modified copy of the quotation {{q2}}. #}

{#op||set-sym||{{q1}} {{sl}} {{i}}||{{q2}}||
Sets the value of the _n^th_ element {{q1}} (zero-based) to {{sl}} (treating it as a symbol), and returns the modified copy of the quotation {{q2}}. #}

{#op||shorten||{{q1}} {{i}}||{{q2}}||
Returns a quotation {{q2}} containing the first _n_ values of the input quotation {{q1}}. #}

{#op||size||{{q}}||{{i}}||
Returns the length of {{q}}.#}

{#op||slice||{{q1}} {{i1}} {{i2}}||{{q2}}||
> Creates a new quotation {{q2}} obtaining by selecting all elements of {{q1}} between indexes {{i1}} and {{i2}}.
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `(3 4 5)` on the stack:
> > 
> >     (1 2 3 4 5 6) 
> >     2 4 seq.slice #}

{#op||sort||{{q1}} {{q2}}||{{q3}}||
> Sorts all elements of {{q1}} according to predicate {{q2}}. 
> 
> > %sidebar%
> > Example
> > 
> > The following program leaves `(1 3 5 7 9 13 16)` on the stack:
> > 
> >     (1 9 5 13 16 3 7) '> seq.sort #}

{#op||symmetric-difference||{{q1}} {{q2}}||{{q3}}||
> Calculates the symmetric difference {{q3}} of {{q1}} and {{q2}}.
>
> > %sidebar%
> > Example
> > 
> > The following program leaves `(true "a" 2)` on the stack:
> > 
> >     (1 2 "test") ("test" "a" true 1) seq.symmetric-difference #}

{#op||take||{{q1}} {{i}}||{{q2}}||
Returns a quotation {{q2}} containing the first _n_ values of the input quotation {{q1}}, or {{q1}} itself if {{i}} is greater than the length of {{q1}}. #}

{#op||union||{{q1}} {{q2}}||{{q3}}||
> Calculates the union {{q3}} of {{q1}} and {{q2}}.
>
> > %sidebar%
> > Example
> > 
> > The following program leaves `(true 1 "test" "a" 2)` on the stack:
> > 
> >     (1 2 "test") ("test" "a" true 1) seq.union #}