1Int64(3)                           OCamldoc                           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
29
30
31
32
33       val zero : int64
34
35       The 64-bit integer 0.
36
37
38
39       val one : int64
40
41       The 64-bit integer 1.
42
43
44
45       val minus_one : int64
46
47       The 64-bit integer -1.
48
49
50
51       val neg : int64 -> int64
52
53       Unary negation.
54
55
56
57       val add : int64 -> int64 -> int64
58
59       Addition.
60
61
62
63       val sub : int64 -> int64 -> int64
64
65       Subtraction.
66
67
68
69       val mul : int64 -> int64 -> int64
70
71       Multiplication.
72
73
74
75       val div : int64 -> int64 -> int64
76
77       Integer  division.   Raise  Division_by_zero  if the second argument is
78       zero.  This division rounds the real quotient of its arguments  towards
79       zero, as specified for Pervasives.(/) .
80
81
82
83       val rem : int64 -> int64 -> int64
84
85       Integer  remainder.  If y is not zero, the result of Int64.rem x y sat‐
86       isfies the following property: x = Int64.add (Int64.mul (Int64.div x y)
87       y)  (Int64.rem x y) .  If y = 0 , Int64.rem x y raises Division_by_zero
88       .
89
90
91
92       val succ : int64 -> int64
93
94       Successor.  Int64.succ x is Int64.add x Int64.one .
95
96
97
98       val pred : int64 -> int64
99
100       Predecessor.  Int64.pred x is Int64.sub x Int64.one .
101
102
103
104       val abs : int64 -> int64
105
106       Return the absolute value of its argument.
107
108
109
110       val max_int : int64
111
112       The greatest representable 64-bit integer, 2^{63 - 1.
113
114
115
116       val min_int : int64
117
118       The smallest representable 64-bit integer, -2^{63.
119
120
121
122       val logand : int64 -> int64 -> int64
123
124       Bitwise logical and.
125
126
127
128       val logor : int64 -> int64 -> int64
129
130       Bitwise logical or.
131
132
133
134       val logxor : int64 -> int64 -> int64
135
136       Bitwise logical exclusive or.
137
138
139
140       val lognot : int64 -> int64
141
142       Bitwise logical negation
143
144
145
146       val shift_left : int64 -> int -> int64
147
148
149       Int64.shift_left x y shifts x to the left by y  bits.   The  result  is
150       unspecified if y < 0 or y >= 64 .
151
152
153
154       val shift_right : int64 -> int -> int64
155
156
157       Int64.shift_right  x  y  shifts  x  to the right by y bits.  This is an
158       arithmetic shift: the sign bit of x is replicated and inserted  in  the
159       vacated bits.  The result is unspecified if y < 0 or y >= 64 .
160
161
162
163       val shift_right_logical : int64 -> int -> int64
164
165
166       Int64.shift_right_logical x y shifts x to the right by y bits.  This is
167       a logical shift: zeroes are inserted in the vacated bits regardless  of
168       the sign of x .  The result is unspecified if y < 0 or y >= 64 .
169
170
171
172       val of_int : int -> int64
173
174       Convert  the  given integer (type int ) to a 64-bit integer (type int64
175       ).
176
177
178
179       val to_int : int64 -> int
180
181       Convert the given 64-bit integer (type int64 ) to an integer (type  int
182       ).  On 64-bit platforms, the 64-bit integer is taken modulo 2^{63, i.e.
183       the high-order bit is lost during the conversion.  On 32-bit platforms,
184       the 64-bit integer is taken modulo 2^{31, i.e. the top 33 bits are lost
185       during the conversion.
186
187
188
189       val of_float : float -> int64
190
191       Convert the given floating-point number to a 64-bit integer, discarding
192       the fractional part (truncate towards 0).  The result of the conversion
193       is undefined if, after truncation, the number is outside  the  range  [
194       Int64.min_int , Int64.max_int ].
195
196
197
198       val to_float : int64 -> float
199
200       Convert the given 64-bit integer to a floating-point number.
201
202
203
204       val of_int32 : int32 -> int64
205
206       Convert  the  given  32-bit  integer  (type int32 ) to a 64-bit integer
207       (type int64 ).
208
209
210
211       val to_int32 : int64 -> int32
212
213       Convert the given 64-bit integer (type int64  )  to  a  32-bit  integer
214       (type  int32  ). The 64-bit integer is taken modulo 2^{32, i.e. the top
215       32 bits are lost during the conversion.
216
217
218
219       val of_nativeint : nativeint -> int64
220
221       Convert the given native integer (type nativeint ) to a 64-bit  integer
222       (type int64 ).
223
224
225
226       val to_nativeint : int64 -> nativeint
227
228       Convert the given 64-bit integer (type int64 ) to a native integer.  On
229       32-bit platforms, the 64-bit integer is taken modulo 2^{32.  On  64-bit
230       platforms, the conversion is exact.
231
232
233
234       val of_string : string -> int64
235
236       Convert  the  given  string to a 64-bit integer.  The string is read in
237       decimal (by default) or in hexadecimal, octal or binary if  the  string
238       begins with 0x , 0o or 0b respectively.  Raise Failure int_of_string if
239       the given string is not a valid representation of an integer, or if the
240       integer represented exceeds the range of integers representable in type
241       int64 .
242
243
244
245       val of_string_opt : string -> int64 option
246
247       Same as of_string , but return None instead of raising.
248
249
250       Since 4.05
251
252
253
254       val to_string : int64 -> string
255
256       Return the string representation of its argument, in decimal.
257
258
259
260       val bits_of_float : float -> int64
261
262       Return the internal representation of the given float according to  the
263       IEEE  754  floating-point  'double  format'  bit layout.  Bit 63 of the
264       result represents the sign of the float; bits 62 to  52  represent  the
265       (biased) exponent; bits 51 to 0 represent the mantissa.
266
267
268
269       val float_of_bits : int64 -> float
270
271       Return the floating-point number whose internal representation, accord‐
272       ing to the IEEE 754 floating-point 'double format' bit layout,  is  the
273       given int64 .
274
275
276       type t = int64
277
278
279       An alias for the type of 64-bit integers.
280
281
282
283       val compare : t -> t -> int
284
285       The  comparison  function for 64-bit integers, with the same specifica‐
286       tion as Pervasives.compare .  Along with the type  t  ,  this  function
287       compare  allows  the module Int64 to be passed as argument to the func‐
288       tors Set.Make and Map.Make .
289
290
291
292       val equal : t -> t -> bool
293
294       The equal function for int64s.
295
296
297       Since 4.03.0
298
299
300
301
302
3032018-04-14                          source:                           Int64(3)