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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="Start" href="index.html">
<link rel="previous" href="Scanf.html">
<link rel="next" href="Set.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of extensions" rel=Appendix href="index_extensions.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Arg" rel="Chapter" href="Arg.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Bool" rel="Chapter" href="Bool.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Bytes" rel="Chapter" href="Bytes.html">
<link title="BytesLabels" rel="Chapter" href="BytesLabels.html">
<link title="Callback" rel="Chapter" href="Callback.html">
<link title="CamlinternalFormat" rel="Chapter" href="CamlinternalFormat.html">
<link title="CamlinternalFormatBasics" rel="Chapter" href="CamlinternalFormatBasics.html">
<link title="CamlinternalLazy" rel="Chapter" href="CamlinternalLazy.html">
<link title="CamlinternalMod" rel="Chapter" href="CamlinternalMod.html">
<link title="CamlinternalOO" rel="Chapter" href="CamlinternalOO.html">
<link title="Char" rel="Chapter" href="Char.html">
<link title="Complex" rel="Chapter" href="Complex.html">
<link title="Condition" rel="Chapter" href="Condition.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Ephemeron" rel="Chapter" href="Ephemeron.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Float" rel="Chapter" href="Float.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Fun" rel="Chapter" href="Fun.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.html">
<link title="Int" rel="Chapter" href="Int.html">
<link title="Int32" rel="Chapter" href="Int32.html">
<link title="Int64" rel="Chapter" href="Int64.html">
<link title="Lazy" rel="Chapter" href="Lazy.html">
<link title="Lexing" rel="Chapter" href="Lexing.html">
<link title="List" rel="Chapter" href="List.html">
<link title="ListLabels" rel="Chapter" href="ListLabels.html">
<link title="Map" rel="Chapter" href="Map.html">
<link title="Marshal" rel="Chapter" href="Marshal.html">
<link title="MoreLabels" rel="Chapter" href="MoreLabels.html">
<link title="Mutex" rel="Chapter" href="Mutex.html">
<link title="Nativeint" rel="Chapter" href="Nativeint.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Ocaml_operators" rel="Chapter" href="Ocaml_operators.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Option" rel="Chapter" href="Option.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Printexc" rel="Chapter" href="Printexc.html">
<link title="Printf" rel="Chapter" href="Printf.html">
<link title="Queue" rel="Chapter" href="Queue.html">
<link title="Random" rel="Chapter" href="Random.html">
<link title="Result" rel="Chapter" href="Result.html">
<link title="Scanf" rel="Chapter" href="Scanf.html">
<link title="Seq" rel="Chapter" href="Seq.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Spacetime" rel="Chapter" href="Spacetime.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.html">
<link title="Stdlib" rel="Chapter" href="Stdlib.html">
<link title="Str" rel="Chapter" href="Str.html">
<link title="Stream" rel="Chapter" href="Stream.html">
<link title="String" rel="Chapter" href="String.html">
<link title="StringLabels" rel="Chapter" href="StringLabels.html">
<link title="Sys" rel="Chapter" href="Sys.html">
<link title="Thread" rel="Chapter" href="Thread.html">
<link title="ThreadUnix" rel="Chapter" href="ThreadUnix.html">
<link title="Uchar" rel="Chapter" href="Uchar.html">
<link title="Unit" rel="Chapter" href="Unit.html">
<link title="Unix" rel="Chapter" href="Unix.html">
<link title="UnixLabels" rel="Chapter" href="UnixLabels.html">
<link title="Weak" rel="Chapter" href="Weak.html"><title>Seq</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Scanf.html" title="Scanf">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Set.html" title="Set">Next</a>
</div>
<h1>Module <a href="type_Seq.html">Seq</a></h1>
<pre><span id="MODULESeq"><span class="keyword">module</span> Seq</span>: <code class="code"><span class="keyword">sig</span></code> <a href="Seq.html">..</a> <code class="code"><span class="keyword">end</span></code></pre><div class="info module top">
<div class="info-desc">
<h2 id="1_FunctionalIterators">Functional Iterators</h2></div>
</div>
<hr width="100%">
<p>The type <code class="code"><span class="keywordsign">'</span>a t</code> is a <b>delayed list</b>, i.e. a list where some evaluation
is needed to access the next element. This makes it possible to build
infinite sequences, to build sequences as we traverse them, and to transform
them in a lazy fashion rather than upfront.</p>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> = <code class="type">unit -> 'a <a href="Seq.html#TYPEnode">node</a></code> </pre>
<div class="info ">
<div class="info-desc">
<p>The type of delayed lists containing elements of type <code class="code"><span class="keywordsign">'</span>a</code>.
Note that the concrete list node <code class="code"><span class="keywordsign">'</span>a node</code> is delayed under a closure,
not a <code class="code"><span class="keyword">lazy</span></code> block, which means it might be recomputed every time
we access it.</p>
</div>
</div>
<pre><code><span id="TYPEnode"><span class="keyword">type</span> <code class="type">'a</code> node</span> = </code></pre><table class="typetable">
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnode.Nil"><span class="constructor">Nil</span></span></code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code><span class="keyword">|</span></code></td>
<td align="left" valign="top" >
<code><span id="TYPEELTnode.Cons"><span class="constructor">Cons</span></span> <span class="keyword">of</span> <code class="type">'a * 'a <a href="Seq.html#TYPEt">t</a></code></code></td>
</tr></table>
<div class="info ">
<div class="info-desc">
<p>A fully-evaluated list node, either empty or containing an element
and a delayed tail.</p>
</div>
</div>
<pre><span id="VALempty"><span class="keyword">val</span> empty</span> : <code class="type">'a <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>The empty sequence, containing no elements.</p>
</div>
</div>
<pre><span id="VALreturn"><span class="keyword">val</span> return</span> : <code class="type">'a -> 'a <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>The singleton sequence containing only the given element.</p>
</div>
</div>
<pre><span id="VALcons"><span class="keyword">val</span> cons</span> : <code class="type">'a -> 'a <a href="Seq.html#TYPEt">t</a> -> 'a <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">cons x xs</code> is the sequence containing the element <code class="code">x</code> followed by
the sequence <code class="code">xs</code></p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 4.11</li>
</ul>
</div>
<pre><span id="VALappend"><span class="keyword">val</span> append</span> : <code class="type">'a <a href="Seq.html#TYPEt">t</a> -> 'a <a href="Seq.html#TYPEt">t</a> -> 'a <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">append xs ys</code> is the sequence <code class="code">xs</code> followed by the sequence <code class="code">ys</code></p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 4.11</li>
</ul>
</div>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">('a -> 'b) -> 'a <a href="Seq.html#TYPEt">t</a> -> 'b <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">map f seq</code> returns a new sequence whose elements are the elements of
<code class="code">seq</code>, transformed by <code class="code">f</code>.
This transformation is lazy, it only applies when the result is traversed.</p>
<p>If <code class="code">seq = [1;2;3]</code>, then <code class="code">map f seq = [f 1; f 2; f 3]</code>.</p>
</div>
</div>
<pre><span id="VALfilter"><span class="keyword">val</span> filter</span> : <code class="type">('a -> bool) -> 'a <a href="Seq.html#TYPEt">t</a> -> 'a <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>Remove from the sequence the elements that do not satisfy the
given predicate.
This transformation is lazy, it only applies when the result is
traversed.</p>
</div>
</div>
<pre><span id="VALfilter_map"><span class="keyword">val</span> filter_map</span> : <code class="type">('a -> 'b option) -> 'a <a href="Seq.html#TYPEt">t</a> -> 'b <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>Apply the function to every element; if <code class="code">f x = <span class="constructor">None</span></code> then <code class="code">x</code> is dropped;
if <code class="code">f x = <span class="constructor">Some</span> y</code> then <code class="code">y</code> is returned.
This transformation is lazy, it only applies when the result is
traversed.</p>
</div>
</div>
<pre><span id="VALflat_map"><span class="keyword">val</span> flat_map</span> : <code class="type">('a -> 'b <a href="Seq.html#TYPEt">t</a>) -> 'a <a href="Seq.html#TYPEt">t</a> -> 'b <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>Map each element to a subsequence, then return each element of this
sub-sequence in turn.
This transformation is lazy, it only applies when the result is
traversed.</p>
</div>
</div>
<pre><span id="VALfold_left"><span class="keyword">val</span> fold_left</span> : <code class="type">('a -> 'b -> 'a) -> 'a -> 'b <a href="Seq.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
<div class="info-desc">
<p>Traverse the sequence from left to right, combining each element with the
accumulator using the given function.
The traversal happens immediately and will not terminate on infinite
sequences.</p>
<p>Also see <a href="List.html#VALfold_left"><code class="code"><span class="constructor">List</span>.fold_left</code></a></p>
</div>
</div>
<pre><span id="VALiter"><span class="keyword">val</span> iter</span> : <code class="type">('a -> unit) -> 'a <a href="Seq.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="info-desc">
<p>Iterate on the sequence, calling the (imperative) function on every element.
The traversal happens immediately and will not terminate on infinite
sequences.</p>
</div>
</div>
<pre><span id="VALunfold"><span class="keyword">val</span> unfold</span> : <code class="type">('b -> ('a * 'b) option) -> 'b -> 'a <a href="Seq.html#TYPEt">t</a></code></pre><div class="info ">
<div class="info-desc">
<p>Build a sequence from a step function and an initial value.
<code class="code">unfold f u</code> returns <code class="code">empty</code> if <code class="code">f u</code> returns <code class="code"><span class="constructor">None</span></code>,
or <code class="code"><span class="keyword">fun</span> () <span class="keywordsign">-></span> <span class="constructor">Cons</span> (x, unfold f y)</code> if <code class="code">f u</code> returns <code class="code"><span class="constructor">Some</span> (x, y)</code>.</p>
<p>For example, <code class="code">unfold (<span class="keyword">function</span> [] <span class="keywordsign">-></span> <span class="constructor">None</span> <span class="keywordsign">|</span> h::t <span class="keywordsign">-></span> <span class="constructor">Some</span> (h,t)) l</code>
is equivalent to <code class="code"><span class="constructor">List</span>.to_seq l</code>.</p>
</div>
<ul class="info-attributes">
<li><b>Since</b> 4.11</li>
</ul>
</div>
</body></html>
|
