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

NAME

6       Stdlib.Int64 - no description
7

Module

9       Module   Stdlib.Int64
10

Documentation

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