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