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
|
<!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="Mutex.html">
<link rel="next" href="Num.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>Nativeint</title>
</head>
<body>
<div class="navbar"><a href="Mutex.html">Previous</a>
<a href="index.html">Up</a>
<a href="Num.html">Next</a>
</div>
<center><h1>Module <a href="type_Nativeint.html">Nativeint</a></h1></center>
<br>
<pre><span class="keyword">module</span> Nativeint: <code class="code"><span class="keyword">sig</span></code> <a href="Nativeint.html">..</a> <code class="code"><span class="keyword">end</span></code></pre>Processor-native integers.
<p>
This module provides operations on the type <code class="code">nativeint</code> of
signed 32-bit integers (on 32-bit platforms) or
signed 64-bit integers (on 64-bit platforms).
This integer type has exactly the same width as that of a <code class="code">long</code>
integer type in the C compiler. All arithmetic operations over
<code class="code">nativeint</code> are taken modulo 2<sup class="superscript">32</sup> or 2<sup class="superscript">64</sup> depending
on the word size of the architecture.
<p>
Performance notice: values of type <code class="code">nativeint</code> occupy more memory
space than values of type <code class="code">int</code>, and arithmetic operations on
<code class="code">nativeint</code> are generally slower than those on <code class="code">int</code>. Use <code class="code">nativeint</code>
only when the application requires the extra bit of precision
over the <code class="code">int</code> type.<br>
<hr width="100%">
<pre><span class="keyword">val</span> <a name="VALzero"></a>zero : <code class="type">nativeint</code></pre><div class="info">
The native integer 0.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALone"></a>one : <code class="type">nativeint</code></pre><div class="info">
The native integer 1.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALminus_one"></a>minus_one : <code class="type">nativeint</code></pre><div class="info">
The native integer -1.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALneg"></a>neg : <code class="type">nativeint -> nativeint</code></pre><div class="info">
Unary negation.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALadd"></a>add : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Addition.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsub"></a>sub : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Subtraction.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmul"></a>mul : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Multiplication.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALdiv"></a>div : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Integer division. Raise <code class="code"><span class="constructor">Division_by_zero</span></code> if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for <a href="Pervasives.html#VAL(/)"><code class="code">(/)</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrem"></a>rem : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Integer remainder. If <code class="code">y</code> is not zero, the result
of <code class="code"><span class="constructor">Nativeint</span>.rem x y</code> satisfies the following properties:
<code class="code"><span class="constructor">Nativeint</span>.zero <= <span class="constructor">Nativeint</span>.rem x y < <span class="constructor">Nativeint</span>.abs y</code> and
<code class="code">x = <span class="constructor">Nativeint</span>.add (<span class="constructor">Nativeint</span>.mul (<span class="constructor">Nativeint</span>.div x y) y) (<span class="constructor">Nativeint</span>.rem x y)</code>.
If <code class="code">y = 0</code>, <code class="code"><span class="constructor">Nativeint</span>.rem x y</code> raises <code class="code"><span class="constructor">Division_by_zero</span></code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsucc"></a>succ : <code class="type">nativeint -> nativeint</code></pre><div class="info">
Successor.
<code class="code"><span class="constructor">Nativeint</span>.succ x</code> is <code class="code"><span class="constructor">Nativeint</span>.add x <span class="constructor">Nativeint</span>.one</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALpred"></a>pred : <code class="type">nativeint -> nativeint</code></pre><div class="info">
Predecessor.
<code class="code"><span class="constructor">Nativeint</span>.pred x</code> is <code class="code"><span class="constructor">Nativeint</span>.sub x <span class="constructor">Nativeint</span>.one</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALabs"></a>abs : <code class="type">nativeint -> nativeint</code></pre><div class="info">
Return the absolute value of its argument.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALsize"></a>size : <code class="type">int</code></pre><div class="info">
The size in bits of a native integer. This is equal to <code class="code">32</code>
on a 32-bit platform and to <code class="code">64</code> on a 64-bit platform.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmax_int"></a>max_int : <code class="type">nativeint</code></pre><div class="info">
The greatest representable native integer,
either 2<sup class="superscript">31</sup> - 1 on a 32-bit platform,
or 2<sup class="superscript">63</sup> - 1 on a 64-bit platform.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALmin_int"></a>min_int : <code class="type">nativeint</code></pre><div class="info">
The greatest representable native integer,
either -2<sup class="superscript">31</sup> on a 32-bit platform,
or -2<sup class="superscript">63</sup> on a 64-bit platform.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlogand"></a>logand : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Bitwise logical and.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlogor"></a>logor : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Bitwise logical or.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlogxor"></a>logxor : <code class="type">nativeint -> nativeint -> nativeint</code></pre><div class="info">
Bitwise logical exclusive or.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALlognot"></a>lognot : <code class="type">nativeint -> nativeint</code></pre><div class="info">
Bitwise logical negation<br>
</div>
<pre><span class="keyword">val</span> <a name="VALshift_left"></a>shift_left : <code class="type">nativeint -> int -> nativeint</code></pre><div class="info">
<code class="code"><span class="constructor">Nativeint</span>.shift_left x y</code> shifts <code class="code">x</code> to the left by <code class="code">y</code> bits.
The result is unspecified if <code class="code">y < 0</code> or <code class="code">y >= bitsize</code>,
where <code class="code">bitsize</code> is <code class="code">32</code> on a 32-bit platform and
<code class="code">64</code> on a 64-bit platform.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALshift_right"></a>shift_right : <code class="type">nativeint -> int -> nativeint</code></pre><div class="info">
<code class="code"><span class="constructor">Nativeint</span>.shift_right x y</code> shifts <code class="code">x</code> to the right by <code class="code">y</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">y < 0</code> or <code class="code">y >= bitsize</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALshift_right_logical"></a>shift_right_logical : <code class="type">nativeint -> int -> nativeint</code></pre><div class="info">
<code class="code"><span class="constructor">Nativeint</span>.shift_right_logical x y</code> shifts <code class="code">x</code> to the right
by <code class="code">y</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">y < 0</code> or <code class="code">y >= bitsize</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALof_int"></a>of_int : <code class="type">int -> nativeint</code></pre><div class="info">
Convert the given integer (type <code class="code">int</code>) to a native integer
(type <code class="code">nativeint</code>).<br>
</div>
<pre><span class="keyword">val</span> <a name="VALto_int"></a>to_int : <code class="type">nativeint -> int</code></pre><div class="info">
Convert the given native integer (type <code class="code">nativeint</code>) to an
integer (type <code class="code">int</code>). The high-order bit is lost during
the conversion.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALof_float"></a>of_float : <code class="type">float -> nativeint</code></pre><div class="info">
Convert the given floating-point number to a native integer,
discarding the fractional part (truncate towards 0).
The result of the conversion is undefined if, after truncation,
the number is outside the range
[<a href="Nativeint.html#VALmin_int"><code class="code"><span class="constructor">Nativeint</span>.min_int</code></a>, <a href="Nativeint.html#VALmax_int"><code class="code"><span class="constructor">Nativeint</span>.max_int</code></a>].<br>
</div>
<pre><span class="keyword">val</span> <a name="VALto_float"></a>to_float : <code class="type">nativeint -> float</code></pre><div class="info">
Convert the given native integer to a floating-point number.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALof_int32"></a>of_int32 : <code class="type">int32 -> nativeint</code></pre><div class="info">
Convert the given 32-bit integer (type <code class="code">int32</code>)
to a native integer.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALto_int32"></a>to_int32 : <code class="type">nativeint -> int32</code></pre><div class="info">
Convert the given native integer to a
32-bit integer (type <code class="code">int32</code>). On 64-bit platforms,
the 64-bit native integer is taken modulo 2<sup class="superscript">32</sup>,
i.e. the top 32 bits are lost. On 32-bit platforms,
the conversion is exact.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALof_string"></a>of_string : <code class="type">string -> nativeint</code></pre><div class="info">
Convert the given string to a native integer.
The string is read in decimal (by default) or in hexadecimal,
octal or binary if the string begins with <code class="code">0x</code>, <code class="code">0o</code> or <code class="code">0b</code>
respectively.
Raise <code class="code"><span class="constructor">Failure</span> <span class="string">"int_of_string"</span></code> if the given string is not
a valid representation of an integer, or if the integer represented
exceeds the range of integers representable in type <code class="code">nativeint</code>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALto_string"></a>to_string : <code class="type">nativeint -> string</code></pre><div class="info">
Return the string representation of its argument, in decimal.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEt"></a><code class="type"></code>t = <code class="type">nativeint</code> </pre>
<div class="info">
An alias for the type of native integers.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALcompare"></a>compare : <code class="type"><a href="Nativeint.html#TYPEt">t</a> -> <a href="Nativeint.html#TYPEt">t</a> -> int</code></pre><div class="info">
The comparison function for native integers, with the same specification as
<a href="Pervasives.html#VALcompare"><code class="code">compare</code></a>. Along with the type <code class="code">t</code>, this function <code class="code">compare</code>
allows the module <code class="code"><span class="constructor">Nativeint</span></code> to be passed as argument to the functors
<a href="Set.Make.html"><code class="code"><span class="constructor">Set</span>.<span class="constructor">Make</span></code></a> and <a href="Map.Make.html"><code class="code"><span class="constructor">Map</span>.<span class="constructor">Make</span></code></a>.<br>
</div>
</body></html>
|
