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
|
<!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">
<link rel="Start" href="index.html">
<link rel="previous" href="Printf.html">
<link rel="next" href="Random.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.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="Arith_status" rel="Chapter" href="Arith_status.html">
<link title="Array" rel="Chapter" href="Array.html">
<link title="ArrayLabels" rel="Chapter" href="ArrayLabels.html">
<link title="Big_int" rel="Chapter" href="Big_int.html">
<link title="Bigarray" rel="Chapter" href="Bigarray.html">
<link title="Buffer" rel="Chapter" href="Buffer.html">
<link title="Callback" rel="Chapter" href="Callback.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="Dbm" rel="Chapter" href="Dbm.html">
<link title="Digest" rel="Chapter" href="Digest.html">
<link title="Dynlink" rel="Chapter" href="Dynlink.html">
<link title="Event" rel="Chapter" href="Event.html">
<link title="Filename" rel="Chapter" href="Filename.html">
<link title="Format" rel="Chapter" href="Format.html">
<link title="Gc" rel="Chapter" href="Gc.html">
<link title="Genlex" rel="Chapter" href="Genlex.html">
<link title="Graphics" rel="Chapter" href="Graphics.html">
<link title="GraphicsX11" rel="Chapter" href="GraphicsX11.html">
<link title="Hashtbl" rel="Chapter" href="Hashtbl.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="Num" rel="Chapter" href="Num.html">
<link title="Obj" rel="Chapter" href="Obj.html">
<link title="Oo" rel="Chapter" href="Oo.html">
<link title="Parsing" rel="Chapter" href="Parsing.html">
<link title="Pervasives" rel="Chapter" href="Pervasives.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="Scanf" rel="Chapter" href="Scanf.html">
<link title="Set" rel="Chapter" href="Set.html">
<link title="Sort" rel="Chapter" href="Sort.html">
<link title="Stack" rel="Chapter" href="Stack.html">
<link title="StdLabels" rel="Chapter" href="StdLabels.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="Tk" rel="Chapter" href="Tk.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>Queue</title>
</head>
<body>
<div class="navbar"><a href="Printf.html">Previous</a>
<a href="index.html">Up</a>
<a href="Random.html">Next</a>
</div>
<center><h1>Module <a href="type_Queue.html">Queue</a></h1></center>
<br>
<pre><span class="keyword">module</span> Queue: <code class="code"><span class="keyword">sig</span></code> <a href="Queue.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>First-in first-out queues.
<p>
This module implements queues (FIFOs), with in-place modification.<br>
<hr width="100%">
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type">'a</code> t </pre>
<div class="info">
The type of queues containing elements of type <code class="code"><span class="keywordsign">'</span>a</code>.<br>
</div>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONEmpty"></a>Empty</pre>
<div class="info">
Raised when <a href="Queue.html#VALtake"><code class="code"><span class="constructor">Queue</span>.take</code></a> or <a href="Queue.html#VALpeek"><code class="code"><span class="constructor">Queue</span>.peek</code></a> is applied to an empty queue.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcreate"></a>create : <code class="type">unit -> 'a <a href="Queue.html#TYPEt">t</a></code></pre><div class="info">
Return a new queue, initially empty.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALadd"></a>add : <code class="type">'a -> 'a <a href="Queue.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">add x q</code> adds the element <code class="code">x</code> at the end of the queue <code class="code">q</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALpush"></a>push : <code class="type">'a -> 'a <a href="Queue.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">push</code> is a synonym for <code class="code">add</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtake"></a>take : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">take q</code> removes and returns the first element in queue <code class="code">q</code>,
or raises <code class="code"><span class="constructor">Empty</span></code> if the queue is empty.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALpop"></a>pop : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">pop</code> is a synonym for <code class="code">take</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALpeek"></a>peek : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">peek q</code> returns the first element in queue <code class="code">q</code>, without removing
it from the queue, or raises <code class="code"><span class="constructor">Empty</span></code> if the queue is empty.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtop"></a>top : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">top</code> is a synonym for <code class="code">peek</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALclear"></a>clear : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> unit</code></pre><div class="info">
Discard all elements from a queue.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcopy"></a>copy : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> 'a <a href="Queue.html#TYPEt">t</a></code></pre><div class="info">
Return a copy of the given queue.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALis_empty"></a>is_empty : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> bool</code></pre><div class="info">
Return <code class="code"><span class="keyword">true</span></code> if the given queue is empty, <code class="code"><span class="keyword">false</span></code> otherwise.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlength"></a>length : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> int</code></pre><div class="info">
Return the number of elements in a queue.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALiter"></a>iter : <code class="type">('a -> unit) -> 'a <a href="Queue.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<code class="code">iter f q</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>
<pre><span class="keyword">val</span> <a name="VALfold"></a>fold : <code class="type">('a -> 'b -> 'a) -> 'a -> 'b <a href="Queue.html#TYPEt">t</a> -> 'a</code></pre><div class="info">
<code class="code">fold f accu q</code> is equivalent to <code class="code"><span class="constructor">List</span>.fold_left f accu l</code>,
where <code class="code">l</code> is the list of <code class="code">q</code>'s elements. The queue remains
unchanged.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALtransfer"></a>transfer : <code class="type">'a <a href="Queue.html#TYPEt">t</a> -> 'a <a href="Queue.html#TYPEt">t</a> -> unit</code></pre><div class="info">
<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">iter (<span class="keyword">fun</span> x <span class="keywordsign">-></span> add x q2) q1; clear q1</code>, but runs
in constant time.<br>
</div>
</body></html>
|
