1Int64(3)                         OCaml library                        Int64(3)
2
3
4

NAME

6       Int64 - 64-bit integers.
7

Module

9       Module   Int64
10

Documentation

12       Module Int64
13        : sig end
14
15
16       64-bit integers.
17
18       This  module provides operations on the type int64 of signed 64-bit in‐
19       tegers.  Unlike the built-in int type, the type int64 is guaranteed  to
20       be  exactly  64-bit  wide  on all platforms.  All arithmetic operations
21       over int64 are taken modulo 2^64
22
23       Performance notice: values of type int64 occupy more memory space  than
24       values  of  type int , and arithmetic operations on int64 are generally
25       slower than those on int .  Use int64 only  when  the  application  re‐
26       quires exact 64-bit arithmetic.
27
28       Literals for 64-bit integers are suffixed by L:
29             let zero: int64 = 0L
30             let one: int64 = 1L
31             let m_one: int64 = -1L
32
33
34
35
36
37
38
39       val zero : int64
40
41       The 64-bit integer 0.
42
43
44
45       val one : int64
46
47       The 64-bit integer 1.
48
49
50
51       val minus_one : int64
52
53       The 64-bit integer -1.
54
55
56
57       val neg : int64 -> int64
58
59       Unary negation.
60
61
62
63       val add : int64 -> int64 -> int64
64
65       Addition.
66
67
68
69       val sub : int64 -> int64 -> int64
70
71       Subtraction.
72
73
74
75       val mul : int64 -> int64 -> int64
76
77       Multiplication.
78
79
80
81       val div : int64 -> int64 -> int64
82
83       Integer division.
84
85
86       Raises  Division_by_zero if the second argument is zero.  This division
87       rounds the real quotient of its arguments towards  zero,  as  specified
88       for (/) .
89
90
91
92       val unsigned_div : int64 -> int64 -> int64
93
94       Same as Int64.div , except that arguments and result are interpreted as
95       unsigned 64-bit integers.
96
97
98       Since 4.08.0
99
100
101
102       val rem : int64 -> int64 -> int64
103
104       Integer remainder.  If y is not zero, the result of Int64.rem x y  sat‐
105       isfies the following property: x = Int64.add (Int64.mul (Int64.div x y)
106       y) (Int64.rem x y) .  If y = 0 , Int64.rem x y raises  Division_by_zero
107       .
108
109
110
111       val unsigned_rem : int64 -> int64 -> int64
112
113       Same as Int64.rem , except that arguments and result are interpreted as
114       unsigned 64-bit integers.
115
116
117       Since 4.08.0
118
119
120
121       val succ : int64 -> int64
122
123       Successor.  Int64.succ x is Int64.add x Int64.one .
124
125
126
127       val pred : int64 -> int64
128
129       Predecessor.  Int64.pred x is Int64.sub x Int64.one .
130
131
132
133       val abs : int64 -> int64
134
135       Return the absolute value of its argument.
136
137
138
139       val max_int : int64
140
141       The greatest representable 64-bit integer, 2^63 - 1.
142
143
144
145       val min_int : int64
146
147       The smallest representable 64-bit integer, -2^63.
148
149
150
151       val logand : int64 -> int64 -> int64
152
153       Bitwise logical and.
154
155
156
157       val logor : int64 -> int64 -> int64
158
159       Bitwise logical or.
160
161
162
163       val logxor : int64 -> int64 -> int64
164
165       Bitwise logical exclusive or.
166
167
168
169       val lognot : int64 -> int64
170
171       Bitwise logical negation.
172
173
174
175       val shift_left : int64 -> int -> int64
176
177
178       Int64.shift_left x y shifts x to the left by y bits.  The result is un‐
179       specified if y < 0 or y >= 64 .
180
181
182
183       val shift_right : int64 -> int -> int64
184
185
186       Int64.shift_right  x  y  shifts  x  to the right by y bits.  This is an
187       arithmetic shift: the sign bit of x is replicated and inserted  in  the
188       vacated bits.  The result is unspecified if y < 0 or y >= 64 .
189
190
191
192       val shift_right_logical : int64 -> int -> int64
193
194
195       Int64.shift_right_logical x y shifts x to the right by y bits.  This is
196       a logical shift: zeroes are inserted in the vacated bits regardless  of
197       the sign of x .  The result is unspecified if y < 0 or y >= 64 .
198
199
200
201       val of_int : int -> int64
202
203       Convert  the  given integer (type int ) to a 64-bit integer (type int64
204       ).
205
206
207
208       val to_int : int64 -> int
209
210       Convert the given 64-bit integer (type int64 ) to an integer (type  int
211       ).   On 64-bit platforms, the 64-bit integer is taken modulo 2^63, i.e.
212       the high-order bit is lost during the conversion.  On 32-bit platforms,
213       the  64-bit integer is taken modulo 2^31, i.e. the top 33 bits are lost
214       during the conversion.
215
216
217
218       val unsigned_to_int : int64 -> int option
219
220       Same as Int64.to_int , but interprets the argument as an unsigned inte‐
221       ger.   Returns  None  if  the unsigned value of the argument cannot fit
222       into an int .
223
224
225       Since 4.08.0
226
227
228
229       val of_float : float -> int64
230
231       Convert the given floating-point number to a 64-bit integer, discarding
232       the fractional part (truncate towards 0).  The result of the conversion
233       is undefined if, after truncation, the number is outside  the  range  [
234       Int64.min_int , Int64.max_int ].
235
236
237
238       val to_float : int64 -> float
239
240       Convert the given 64-bit integer to a floating-point number.
241
242
243
244       val of_int32 : int32 -> int64
245
246       Convert  the  given  32-bit  integer  (type int32 ) to a 64-bit integer
247       (type int64 ).
248
249
250
251       val to_int32 : int64 -> int32
252
253       Convert the given 64-bit integer (type int64  )  to  a  32-bit  integer
254       (type int32 ). The 64-bit integer is taken modulo 2^32, i.e. the top 32
255       bits are lost during the conversion.
256
257
258
259       val of_nativeint : nativeint -> int64
260
261       Convert the given native integer (type nativeint ) to a 64-bit  integer
262       (type int64 ).
263
264
265
266       val to_nativeint : int64 -> nativeint
267
268       Convert the given 64-bit integer (type int64 ) to a native integer.  On
269       32-bit platforms, the 64-bit integer is taken modulo 2^32.   On  64-bit
270       platforms, the conversion is exact.
271
272
273
274       val of_string : string -> int64
275
276       Convert  the  given  string to a 64-bit integer.  The string is read in
277       decimal (by default, or if the string begins with 0u ) or in  hexadeci‐
278       mal,  octal  or  binary if the string begins with 0x , 0o or 0b respec‐
279       tively.
280
281       The 0u prefix reads the input as an unsigned integer in the  range  [0,
282       2*Int64.max_int+1]  .   If  the  input exceeds Int64.max_int it is con‐
283       verted to the signed integer Int64.min_int + input - Int64.max_int -  1
284       .
285
286       The  _  (underscore) character can appear anywhere in the string and is
287       ignored.
288
289
290       Raises Failure if the given string is not a valid representation of  an
291       integer,  or  if  the integer represented exceeds the range of integers
292       representable in type int64 .
293
294
295
296       val of_string_opt : string -> int64 option
297
298       Same as of_string , but return None instead of raising.
299
300
301       Since 4.05
302
303
304
305       val to_string : int64 -> string
306
307       Return the string representation of its argument, in decimal.
308
309
310
311       val bits_of_float : float -> int64
312
313       Return the internal representation of the given float according to  the
314       IEEE  754 floating-point 'double format' bit layout.  Bit 63 of the re‐
315       sult represents the sign of the float; bits 62 to 52 represent the (bi‐
316       ased) exponent; bits 51 to 0 represent the mantissa.
317
318
319
320       val float_of_bits : int64 -> float
321
322       Return the floating-point number whose internal representation, accord‐
323       ing to the IEEE 754 floating-point 'double format' bit layout,  is  the
324       given int64 .
325
326
327       type t = int64
328
329
330       An alias for the type of 64-bit integers.
331
332
333
334       val compare : t -> t -> int
335
336       The  comparison  function for 64-bit integers, with the same specifica‐
337       tion as compare .  Along with the type t , this function compare allows
338       the  module Int64 to be passed as argument to the functors Set.Make and
339       Map.Make .
340
341
342
343       val unsigned_compare : t -> t -> int
344
345       Same as Int64.compare , except that arguments are  interpreted  as  un‐
346       signed 64-bit integers.
347
348
349       Since 4.08.0
350
351
352
353       val equal : t -> t -> bool
354
355       The equal function for int64s.
356
357
358       Since 4.03.0
359
360
361
362
363
364OCamldoc                          2021-01-26                          Int64(3)