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
|
<!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="Stdlib.Hashtbl.html">
<link rel="next" href="Stdlib.Int32.html">
<link rel="Up" href="Stdlib.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"><link title="Integers" rel="Section" href="#ints">
<link title="Predicates and comparisons" rel="Section" href="#preds">
<link title="Converting" rel="Section" href="#convert">
<title>Stdlib.Int</title>
</head>
<body>
<div class="navbar"><a class="pre" href="Stdlib.Hashtbl.html" title="Stdlib.Hashtbl">Previous</a>
<a class="up" href="Stdlib.html" title="Stdlib">Up</a>
<a class="post" href="Stdlib.Int32.html" title="Stdlib.Int32">Next</a>
</div>
<h1>Module <a href="type_Stdlib.Int.html">Stdlib.Int</a></h1>
<pre><span id="MODULEInt"><span class="keyword">module</span> Int</span>: <code class="type"><a href="Int.html">Int</a></code></pre><hr width="100%">
<h2 id="ints">Integers</h2>
<pre><span id="TYPEt"><span class="keyword">type</span> <code class="type"></code>t</span> = <code class="type">int</code> </pre>
<div class="info ">
<div class="info-desc">
<p>The type for integer values.</p>
</div>
</div>
<pre><span id="VALzero"><span class="keyword">val</span> zero</span> : <code class="type">int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">zero</code> is the integer <code class="code">0</code>.</p>
</div>
</div>
<pre><span id="VALone"><span class="keyword">val</span> one</span> : <code class="type">int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">one</code> is the integer <code class="code">1</code>.</p>
</div>
</div>
<pre><span id="VALminus_one"><span class="keyword">val</span> minus_one</span> : <code class="type">int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">minus_one</code> is the integer <code class="code">-1</code>.</p>
</div>
</div>
<pre><span id="VALneg"><span class="keyword">val</span> neg</span> : <code class="type">int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">neg x</code> is <code class="code"><span class="keywordsign">~-</span>x</code>.</p>
</div>
</div>
<pre><span id="VALadd"><span class="keyword">val</span> add</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">add x y</code> is the addition <code class="code">x + y</code>.</p>
</div>
</div>
<pre><span id="VALsub"><span class="keyword">val</span> sub</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">sub x y</code> is the subtraction <code class="code">x - y</code>.</p>
</div>
</div>
<pre><span id="VALmul"><span class="keyword">val</span> mul</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">mul x y</code> is the multiplication <code class="code">x * y</code>.</p>
</div>
</div>
<pre><span id="VALdiv"><span class="keyword">val</span> div</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">div x y</code> is the division <code class="code">x / y</code>. See <a href="Stdlib.html#VAL(/)"><code class="code">(/)</code></a> for details.</p>
</div>
</div>
<pre><span id="VALrem"><span class="keyword">val</span> rem</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">rem x y</code> is the remainder <code class="code">x <span class="keyword">mod</span> y</code>. See <a href="Stdlib.html#VAL(mod)"><code class="code">(<span class="keyword">mod</span>)</code></a> for details.</p>
</div>
</div>
<pre><span id="VALsucc"><span class="keyword">val</span> succ</span> : <code class="type">int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">succ x</code> is <code class="code">add x 1</code>.</p>
</div>
</div>
<pre><span id="VALpred"><span class="keyword">val</span> pred</span> : <code class="type">int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">pred x</code> is <code class="code">sub x 1</code>.</p>
</div>
</div>
<pre><span id="VALabs"><span class="keyword">val</span> abs</span> : <code class="type">int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">abs x</code> is the absolute value of <code class="code">x</code>. That is <code class="code">x</code> if <code class="code">x</code> is positive
and <code class="code">neg x</code> if <code class="code">x</code> is negative. <b>Warning.</b> This may be negative if
the argument is <a href="Int.html#VALmin_int"><code class="code"><span class="constructor">Int</span>.min_int</code></a>.</p>
</div>
</div>
<pre><span id="VALmax_int"><span class="keyword">val</span> max_int</span> : <code class="type">int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">max_int</code> is the greatest representable integer,
<code class="code">2{^[<span class="constructor">Sys</span>.int_size - 1]} - 1</code>.</p>
</div>
</div>
<pre><span id="VALmin_int"><span class="keyword">val</span> min_int</span> : <code class="type">int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">min_int</code> is the smallest representable integer,
<code class="code">-2{^[<span class="constructor">Sys</span>.int_size - 1]}</code>.</p>
</div>
</div>
<pre><span id="VALlogand"><span class="keyword">val</span> logand</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">logand x y</code> is the bitwise logical and of <code class="code">x</code> and <code class="code">y</code>.</p>
</div>
</div>
<pre><span id="VALlogor"><span class="keyword">val</span> logor</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">logor x y</code> is the bitwise logical or of <code class="code">x</code> and <code class="code">y</code>.</p>
</div>
</div>
<pre><span id="VALlogxor"><span class="keyword">val</span> logxor</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">logxor x y</code> is the bitwise logical exclusive or of <code class="code">x</code> and <code class="code">y</code>.</p>
</div>
</div>
<pre><span id="VALlognot"><span class="keyword">val</span> lognot</span> : <code class="type">int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">lognot x</code> is the bitwise logical negation of <code class="code">x</code>.</p>
</div>
</div>
<pre><span id="VALshift_left"><span class="keyword">val</span> shift_left</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">shift_left x n</code> shifts <code class="code">x</code> to the left by <code class="code">n</code> bits. The result
is unspecified if <code class="code">n < 0</code> or <code class="code">n > </code><a href="Sys.html#VALint_size"><code class="code"><span class="constructor">Sys</span>.int_size</code></a>.</p>
</div>
</div>
<pre><span id="VALshift_right"><span class="keyword">val</span> shift_right</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">shift_right x n</code> shifts <code class="code">x</code> to the right by <code class="code">n</code> bits. This is an
arithmetic shift: the sign bit of <code class="code">x</code> is replicated and inserted
in the vacated bits. The result is unspecified if <code class="code">n < 0</code> or
<code class="code">n > </code><a href="Sys.html#VALint_size"><code class="code"><span class="constructor">Sys</span>.int_size</code></a>.</p>
</div>
</div>
<pre><span id="VALshift_right_logical"><span class="keyword">val</span> shift_right_logical</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">shift_right x n</code> shifts <code class="code">x</code> to the right by <code class="code">n</code> bits. This is a
logical shift: zeroes are inserted in the vacated bits regardless
of the sign of <code class="code">x</code>. The result is unspecified if <code class="code">n < 0</code> or
<code class="code">n > </code><a href="Sys.html#VALint_size"><code class="code"><span class="constructor">Sys</span>.int_size</code></a>.</p>
</div>
</div>
<h2 id="preds">Predicates and comparisons</h2>
<pre><span id="VALequal"><span class="keyword">val</span> equal</span> : <code class="type">int -> int -> bool</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">equal x y</code> is <code class="code"><span class="keyword">true</span></code> iff <code class="code">x = y</code>.</p>
</div>
</div>
<pre><span id="VALcompare"><span class="keyword">val</span> compare</span> : <code class="type">int -> int -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">compare x y</code> is <a href="Stdlib.html#VALcompare"><code class="code">compare</code></a><code class="code"> x y</code> but more efficient.</p>
</div>
</div>
<h2 id="convert">Converting</h2>
<pre><span id="VALto_float"><span class="keyword">val</span> to_float</span> : <code class="type">int -> float</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">to_float x</code> is <code class="code">x</code> as a floating point number.</p>
</div>
</div>
<pre><span id="VALof_float"><span class="keyword">val</span> of_float</span> : <code class="type">float -> int</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">of_float x</code> truncates <code class="code">x</code> to an integer. The result is
unspecified if the argument is <code class="code">nan</code> or falls outside the range of
representable integers.</p>
</div>
</div>
<pre><span id="VALto_string"><span class="keyword">val</span> to_string</span> : <code class="type">int -> string</code></pre><div class="info ">
<div class="info-desc">
<p><code class="code">to_string x</code> is the written representation of <code class="code">x</code> in decimal.</p>
</div>
</div>
</body></html>
|
