1Int64(3) OCaml library Int64(3)
2
6 Int64 - 64-bit integers.
7
9 Module Int64
10
12 Module Int64
13 : sig end
14 64-bit integers.
17 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 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 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 val zero : int64
40 The 64-bit integer 0.
42 val one : int64
46 The 64-bit integer 1.
48 val minus_one : int64
52 The 64-bit integer -1.
54 val neg : int64 -> int64
58 Unary negation.
60 val add : int64 -> int64 -> int64
64 Addition.
66 val sub : int64 -> int64 -> int64
70 Subtraction.
72 val mul : int64 -> int64 -> int64
76 Multiplication.
78 val div : int64 -> int64 -> int64
82 Integer division.
84 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 val unsigned_div : int64 -> int64 -> int64
93 Same as Int64.div , except that arguments and result are interpreted as
95 unsigned 64-bit integers.
96 Since 4.08.0
99 val rem : int64 -> int64 -> int64
103 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 val unsigned_rem : int64 -> int64 -> int64
112 Same as Int64.rem , except that arguments and result are interpreted as
114 unsigned 64-bit integers.
115 Since 4.08.0
118 val succ : int64 -> int64
122 Successor. Int64.succ x is Int64.add x Int64.one .
124 val pred : int64 -> int64
128 Predecessor. Int64.pred x is Int64.sub x Int64.one .
130 val abs : int64 -> int64
134 Return the absolute value of its argument.
136 val max_int : int64
140 The greatest representable 64-bit integer, 2^63 - 1.
142 val min_int : int64
146 The smallest representable 64-bit integer, -2^63.
148 val logand : int64 -> int64 -> int64
152 Bitwise logical and.
154 val logor : int64 -> int64 -> int64
158 Bitwise logical or.
160 val logxor : int64 -> int64 -> int64
164 Bitwise logical exclusive or.
166 val lognot : int64 -> int64
170 Bitwise logical negation.
172 val shift_left : int64 -> int -> int64
176 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 val shift_right : int64 -> int -> int64
184 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 val shift_right_logical : int64 -> int -> int64
193 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 val of_int : int -> int64
202 Convert the given integer (type int ) to a 64-bit integer (type int64
204 ).
205 val to_int : int64 -> int
209 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 val unsigned_to_int : int64 -> int option
219 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 Since 4.08.0
226 val of_float : float -> int64
230 Convert the given floating-point number to a 64-bit integer, discarding
232 the fractional part (truncate towards 0). If the truncated float‐
233 ing-point number is outside the range [ Int64.min_int , Int64.max_int
234 ], no exception is raised, and an unspecified, platform-dependent inte‐
235 ger is returned.
236 val to_float : int64 -> float
240 Convert the given 64-bit integer to a floating-point number.
242 val of_int32 : int32 -> int64
246 Convert the given 32-bit integer (type int32 ) to a 64-bit integer
248 (type int64 ).
249 val to_int32 : int64 -> int32
253 Convert the given 64-bit integer (type int64 ) to a 32-bit integer
255 (type int32 ). The 64-bit integer is taken modulo 2^32, i.e. the top 32
256 bits are lost during the conversion.
257 val of_nativeint : nativeint -> int64
261 Convert the given native integer (type nativeint ) to a 64-bit integer
263 (type int64 ).
264 val to_nativeint : int64 -> nativeint
268 Convert the given 64-bit integer (type int64 ) to a native integer. On
270 32-bit platforms, the 64-bit integer is taken modulo 2^32. On 64-bit
271 platforms, the conversion is exact.
272 val of_string : string -> int64
276 Convert the given string to a 64-bit integer. The string is read in
278 decimal (by default, or if the string begins with 0u ) or in hexadeci‐
279 mal, octal or binary if the string begins with 0x , 0o or 0b respec‐
280 tively.
281 The 0u prefix reads the input as an unsigned integer in the range [0,
283 2*Int64.max_int+1] . If the input exceeds Int64.max_int it is con‐
284 verted to the signed integer Int64.min_int + input - Int64.max_int - 1
285 .
286 The _ (underscore) character can appear anywhere in the string and is
288 ignored.
289 Raises Failure if the given string is not a valid representation of an
292 integer, or if the integer represented exceeds the range of integers
293 representable in type int64 .
294 val of_string_opt : string -> int64 option
298 Same as of_string , but return None instead of raising.
300 Since 4.05
303 val to_string : int64 -> string
307 Return the string representation of its argument, in decimal.
309 val bits_of_float : float -> int64
313 Return the internal representation of the given float according to the
315 IEEE 754 floating-point 'double format' bit layout. Bit 63 of the re‐
316 sult represents the sign of the float; bits 62 to 52 represent the (bi‐
317 ased) exponent; bits 51 to 0 represent the mantissa.
318 val float_of_bits : int64 -> float
322 Return the floating-point number whose internal representation, accord‐
324 ing to the IEEE 754 floating-point 'double format' bit layout, is the
325 given int64 .
326 type t = int64
329 An alias for the type of 64-bit integers.
332 val compare : t -> t -> int
336 The comparison function for 64-bit integers, with the same specifica‐
338 tion as compare . Along with the type t , this function compare allows
339 the module Int64 to be passed as argument to the functors Set.Make and
340 Map.Make .
341 val unsigned_compare : t -> t -> int
345 Same as Int64.compare , except that arguments are interpreted as un‐
347 signed 64-bit integers.
348 Since 4.08.0
351 val equal : t -> t -> bool
355 The equal function for int64s.
357 Since 4.03.0
360 val min : t -> t -> t
364 Return the smaller of the two arguments.
366 Since 4.13.0
369 val max : t -> t -> t
373 Return the greater of the two arguments.
375 Since 4.13.0
378OCamldoc 2022-07-22 Int64(3)