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