forked from rescript-lang/rescript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathBelt_MutableQueue.html
294 lines (219 loc) · 15.1 KB
/
Belt_MutableQueue.html
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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
<!doctype html>
<html>
<head>
<link rel="stylesheet" href="../api_static/tomorrow-night.css">
<link rel="stylesheet" href="../api_static/style.css" type="text/css">
<script src="../api_static//highlight.pack.js"></script>
<script src="../api_static//script.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<meta charset="utf8">
<link rel="previous" href="Belt_MutableMapString.html"><link rel="next" href="Belt_MutableSet.html">
<title> Belt_MutableQueue </title></head>
<body>
<nav class="module-index"><ul><li><a href="Belt.html">Belt</a></li>
<li><a href="Belt_Array.html">Belt_Array</a></li>
<li><a href="Belt_Debug.html">Belt_Debug</a></li>
<li><a href="Belt_HashMap.html">Belt_HashMap</a></li>
<li><a href="Belt_HashMapInt.html">Belt_HashMapInt</a></li>
<li><a href="Belt_HashMapString.html">Belt_HashMapString</a></li>
<li><a href="Belt_HashSet.html">Belt_HashSet</a></li>
<li><a href="Belt_HashSetInt.html">Belt_HashSetInt</a></li>
<li><a href="Belt_HashSetString.html">Belt_HashSetString</a></li>
<li><a href="Belt_Id.html">Belt_Id</a></li>
<li><a href="Belt_List.html">Belt_List</a></li>
<li><a href="Belt_Map.html">Belt_Map</a></li>
<li><a href="Belt_MapDict.html">Belt_MapDict</a></li>
<li><a href="Belt_MapInt.html">Belt_MapInt</a></li>
<li><a href="Belt_MapString.html">Belt_MapString</a></li>
<li><a href="Belt_MutableMap.html">Belt_MutableMap</a></li>
<li><a href="Belt_MutableMapInt.html">Belt_MutableMapInt</a></li>
<li><a href="Belt_MutableMapString.html">Belt_MutableMapString</a></li>
<li><a href="Belt_MutableQueue.html">Belt_MutableQueue</a></li>
<li><a href="Belt_MutableSet.html">Belt_MutableSet</a></li>
<li><a href="Belt_MutableSetInt.html">Belt_MutableSetInt</a></li>
<li><a href="Belt_MutableSetString.html">Belt_MutableSetString</a></li>
<li><a href="Belt_MutableStack.html">Belt_MutableStack</a></li>
<li><a href="Belt_Option.html">Belt_Option</a></li>
<li><a href="Belt_Range.html">Belt_Range</a></li>
<li><a href="Belt_Result.html">Belt_Result</a></li>
<li><a href="Belt_Set.html">Belt_Set</a></li>
<li><a href="Belt_SetDict.html">Belt_SetDict</a></li>
<li><a href="Belt_SetInt.html">Belt_SetInt</a></li>
<li><a href="Belt_SetString.html">Belt_SetString</a></li>
<li><a href="Belt_SortArray.html">Belt_SortArray</a></li>
<li><a href="Belt_SortArrayInt.html">Belt_SortArrayInt</a></li>
<li><a href="Belt_SortArrayString.html">Belt_SortArrayString</a></li>
<li><a href="Belt_internalAVLset.html">Belt_internalAVLset</a></li>
<li><a href="Belt_internalAVLtree.html">Belt_internalAVLtree</a></li>
<li><a href="Belt_internalBuckets.html">Belt_internalBuckets</a></li>
<li><a href="Belt_internalBucketsType.html">Belt_internalBucketsType</a></li>
<li><a href="Belt_internalMapInt.html">Belt_internalMapInt</a></li>
<li><a href="Belt_internalMapString.html">Belt_internalMapString</a></li>
<li><a href="Belt_internalMutableAVLMap.html">Belt_internalMutableAVLMap</a></li>
<li><a href="Belt_internalSetBuckets.html">Belt_internalSetBuckets</a></li>
<li><a href="Belt_internalSetInt.html">Belt_internalSetInt</a></li>
<li><a href="Belt_internalSetString.html">Belt_internalSetString</a></li>
<li><a href="Dom.html">Dom</a></li>
<li><a href="Dom_storage.html">Dom_storage</a></li>
<li><a href="Js.html">Js</a></li>
<li><a href="Js_array.html">Js_array</a></li>
<li><a href="Js_cast.html">Js_cast</a></li>
<li><a href="Js_console.html">Js_console</a></li>
<li><a href="Js_date.html">Js_date</a></li>
<li><a href="Js_dict.html">Js_dict</a></li>
<li><a href="Js_exn.html">Js_exn</a></li>
<li><a href="Js_float.html">Js_float</a></li>
<li><a href="Js_global.html">Js_global</a></li>
<li><a href="Js_int.html">Js_int</a></li>
<li><a href="Js_json.html">Js_json</a></li>
<li><a href="Js_list.html">Js_list</a></li>
<li><a href="Js_mapperRt.html">Js_mapperRt</a></li>
<li><a href="Js_math.html">Js_math</a></li>
<li><a href="Js_null.html">Js_null</a></li>
<li><a href="Js_null_undefined.html">Js_null_undefined</a></li>
<li><a href="Js_obj.html">Js_obj</a></li>
<li><a href="Js_option.html">Js_option</a></li>
<li><a href="Js_promise.html">Js_promise</a></li>
<li><a href="Js_re.html">Js_re</a></li>
<li><a href="Js_result.html">Js_result</a></li>
<li><a href="Js_string.html">Js_string</a></li>
<li><a href="Js_typed_array.html">Js_typed_array</a></li>
<li><a href="Js_types.html">Js_types</a></li>
<li><a href="Js_undefined.html">Js_undefined</a></li>
<li><a href="Js_vector.html">Js_vector</a></li>
<li><a href="Node.html">Node</a></li>
<li><a href="Node_buffer.html">Node_buffer</a></li>
<li><a href="Node_child_process.html">Node_child_process</a></li>
<li><a href="Node_fs.html">Node_fs</a></li>
<li><a href="Node_module.html">Node_module</a></li>
<li><a href="Node_path.html">Node_path</a></li>
<li><a href="Node_process.html">Node_process</a></li></ul></nav>
<div class="navbar"><a class="pre" href="Belt_MutableMapString.html" title="Belt_MutableMapString">Previous</a>
<a class="up" href="index.html" title="Index">Up</a>
<a class="post" href="Belt_MutableSet.html" title="Belt_MutableSet">Next</a>
</div>
<h1>Module <a href="type_Belt_MutableQueue.html">Belt_MutableQueue</a></h1>
<pre><span class="keyword">module</span> Belt_MutableQueue: <code class="code">sig</code> <a href="Belt_MutableQueue.html">..</a> <code class="code">end</code></pre><div class="info module top">
<div class="not-examples">
First-in first-out queues.
<p>
This module implements queues (FIFOs), with in-place modification.<br>
</div>
</div>
<hr width="100%">
<div class="type-declaration">
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type">'a</code> t</span> </pre>
</div>
<div class="info ">
<div class="not-examples">
The type of queues containing elements of type <code class="code">'a</code>.<br>
</div>
</div>
<pre><span id="VALmake"><span class="keyword">val</span> make</span> : <code class="type">unit -> 'a <a href="Belt_MutableQueue.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<div class="tag"> <b>Returns</b> a new queue, initially empty.<br>
</div>
</div>
</div>
<pre><span id="VALclear"><span class="keyword">val</span> clear</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="not-examples">
Discard all elements from the queue.<br>
</div>
</div>
<pre><span id="VALisEmpty"><span class="keyword">val</span> isEmpty</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> bool</code></pre><div class="info ">
<div class="not-examples">
<div class="tag"> <b>Returns</b> <code class="code">true</code> if the given queue is empty, <code class="code">false</code> otherwise.<br>
</div>
</div>
</div>
<pre><span id="VALfromArray"><span class="keyword">val</span> fromArray</span> : <code class="type">'a array -> 'a <a href="Belt_MutableQueue.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">fromArray a</code> is equivalent to <code class="code">Array.forEach a (add q a)</code><br>
</div>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a -> unit</code></pre><div class="info ">
<div class="not-examples">
<code class="code">add q x</code> adds the element <code class="code">x</code> at the end of the queue <code class="code">q</code>.<br>
</div>
</div>
<pre><span id="VALpeek"><span class="keyword">val</span> peek</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">peekOpt q</code> returns the first element in queue <code class="code">q</code>, without removing
it from the queue.<br>
</div>
</div>
<pre><span id="VALpeekUndefined"><span class="keyword">val</span> peekUndefined</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">peekUndefined q</code> returns <code class="code">undefined</code> if not found<br>
</div>
</div>
<pre><span id="VALpeekExn"><span class="keyword">val</span> peekExn</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
<div class="not-examples">
<code class="code">peekExn q</code>
<p>
<b>raise</b> an exception if <code class="code">q</code> is empty<br>
</div>
</div>
<pre><span id="VALpop"><span class="keyword">val</span> pop</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a option</code></pre><div class="info ">
<div class="not-examples">
<code class="code">pop q</code> removes and returns the first element in queue <code class="code">q</code>.<br>
</div>
</div>
<pre><span id="VALpopUndefined"><span class="keyword">val</span> popUndefined</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a <a href="Js.html#TYPEundefined">Js.undefined</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">popUndefined q</code> removes and returns the first element in queue <code class="code">q</code>.
it will return undefined if it is already empty<br>
</div>
</div>
<pre><span id="VALpopExn"><span class="keyword">val</span> popExn</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a</code></pre><div class="info ">
<div class="not-examples">
<code class="code">popExn q</code>
<p>
<b>raise</b> an exception if <code class="code">q</code> is empty<br>
</div>
</div>
<pre><span id="VALcopy"><span class="keyword">val</span> copy</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a <a href="Belt_MutableQueue.html#TYPEt">t</a></code></pre><div class="info ">
<div class="not-examples">
<code class="code">copy q</code><br>
<div class="tag"> <b>Returns</b> a fresh queue<br>
</div>
</div>
</div>
<pre><span id="VALsize"><span class="keyword">val</span> size</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> int</code></pre><div class="info ">
<div class="not-examples">
<div class="tag"> <b>Returns</b> the number of elements in a queue.<br>
</div>
</div>
</div>
<pre><span id="VALmapU"><span class="keyword">val</span> mapU</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> ('a -> 'b [@bs]) -> 'b <a href="Belt_MutableQueue.html#TYPEt">t</a></code></pre>
<pre><span id="VALmap"><span class="keyword">val</span> map</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> ('a -> 'b) -> 'b <a href="Belt_MutableQueue.html#TYPEt">t</a></code></pre>
<pre><span id="VALforEachU"><span class="keyword">val</span> forEachU</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> ('a -> unit [@bs]) -> unit</code></pre>
<pre><span id="VALforEach"><span class="keyword">val</span> forEach</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> ('a -> unit) -> unit</code></pre><div class="info ">
<div class="not-examples">
<code class="code">forEach q f</code> applies <code class="code">f</code> in turn to all elements of <code class="code">q</code>,
from the least recently entered to the most recently entered.
The queue itself is unchanged.<br>
</div>
</div>
<pre><span id="VALreduceU"><span class="keyword">val</span> reduceU</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'b -> ('b -> 'a -> 'b [@bs]) -> 'b</code></pre>
<pre><span id="VALreduce"><span class="keyword">val</span> reduce</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'b -> ('b -> 'a -> 'b) -> 'b</code></pre><div class="info ">
<div class="not-examples">
<code class="code">reduce q accu f</code> is equivalent to <code class="code">List.reduce l accu f</code>,
where <code class="code">l</code> is the list of <code class="code">q</code>'s elements. The queue remains
unchanged.<br>
</div>
</div>
<pre><span id="VALtransfer"><span class="keyword">val</span> transfer</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> unit</code></pre><div class="info ">
<div class="not-examples">
<code class="code">transfer q1 q2</code> adds all of <code class="code">q1</code>'s elements at the end of
the queue <code class="code">q2</code>, then clears <code class="code">q1</code>. It is equivalent to the
sequence <code class="code">forEach (fun x -> add x q2) q1; clear q1</code>, but runs
in constant time.<br>
</div>
</div>
<pre><span id="VALtoArray"><span class="keyword">val</span> toArray</span> : <code class="type">'a <a href="Belt_MutableQueue.html#TYPEt">t</a> -> 'a array</code></pre><div class="info ">
<div class="not-examples">
First added will be in the beginning of the array<br>
</div>
</div>
</body></html>