package containers
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=1e7992cb2e59c0d2290d1b6c3a31531b3f310be6170b8ef3dde17ccd876b5b79
sha512=bb124e69ad0690f88393e18eee499be07761e767593558867aab32f643466b43258ced503170b154ca3b56dbd68987abd6d9438cf473707ec9866511589a5b84
doc/containers/CCInt64/index.html
Module CCInt64
Source
Helpers for 64-bit integers.
This module provides operations on the type int64 of signed 64-bit integers. Unlike the built-in int type, the type int64 is guaranteed to be exactly 64-bit wide on all platforms. All arithmetic operations over int64 are taken modulo 264.
Performance notice: values of type int64 occupy more memory space than values of type int, and arithmetic operations on int64 are generally slower than those on int. Use int64 only when the application requires exact 64-bit arithmetic.
The 64-bit integer 0.
The 64-bit integer 1.
The 64-bit integer -1.
Unary negation.
Addition.
Subtraction.
Multiplication.
Integer division.
Same as div
, except that arguments and result are interpreted as unsigned 64-bit integers.
Integer remainder. If y
is not zero, the result of Int64.rem x y
satisfies the following property: x = Int64.add (Int64.mul (Int64.div x y) y) (Int64.rem x y)
. If y = 0
, Int64.rem x y
raises Division_by_zero
.
Same as rem
, except that arguments and result are interpreted as unsigned 64-bit integers.
Successor. Int64.succ x
is Int64.add x Int64.one
.
Predecessor. Int64.pred x
is Int64.sub x Int64.one
.
abs x
is the absolute value of x
. On min_int
this is min_int
itself and thus remains negative.
The greatest representable 64-bit integer, 263 - 1.
The smallest representable 64-bit integer, -263.
Bitwise logical and.
Bitwise logical or.
Bitwise logical exclusive or.
Bitwise logical negation.
Int64.shift_left x y
shifts x
to the left by y
bits. The result is unspecified if y < 0
or y >= 64
.
Int64.shift_right x y
shifts x
to the right by y
bits. This is an arithmetic shift: the sign bit of x
is replicated and inserted in the vacated bits. The result is unspecified if y < 0
or y >= 64
.
Int64.shift_right_logical x y
shifts x
to the right by y
bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x
. The result is unspecified if y < 0
or y >= 64
.
Convert the given integer (type int
) to a 64-bit integer (type int64
).
Convert the given 64-bit integer (type int64
) to an integer (type int
). On 64-bit platforms, the 64-bit integer is taken modulo 263, i.e. the high-order bit is lost during the conversion. On 32-bit platforms, the 64-bit integer is taken modulo 231, i.e. the top 33 bits are lost during the conversion.
Same as to_int
, but interprets the argument as an unsigned integer. Returns None
if the unsigned value of the argument cannot fit into an int
.
Convert the given floating-point number to a 64-bit integer, discarding the fractional part (truncate towards 0). If the truncated floating-point number is outside the range [Int64.min_int
, Int64.max_int
], no exception is raised, and an unspecified, platform-dependent integer is returned.
Convert the given 64-bit integer to a floating-point number.
Convert the given 32-bit integer (type int32
) to a 64-bit integer (type int64
).
Convert the given 64-bit integer (type int64
) to a 32-bit integer (type int32
). The 64-bit integer is taken modulo 232, i.e. the top 32 bits are lost during the conversion.
Convert the given native integer (type nativeint
) to a 64-bit integer (type int64
).
Convert the given 64-bit integer (type int64
) to a native integer. On 32-bit platforms, the 64-bit integer is taken modulo 232. On 64-bit platforms, the conversion is exact.
Return the string representation of its argument, in decimal.
Return the internal representation of the given float according to the IEEE 754 floating-point 'double format' bit layout. Bit 63 of the result represents the sign of the float; bits 62 to 52 represent the (biased) exponent; bits 51 to 0 represent the mantissa.
Return the floating-point number whose internal representation, according to the IEEE 754 floating-point 'double format' bit layout, is the given int64
.
An alias for the type of 64-bit integers.
The comparison function for 64-bit integers, with the same specification as Stdlib.compare
. Along with the type t
, this function compare
allows the module Int64
to be passed as argument to the functors Set.Make
and Map.Make
.
Same as compare
, except that arguments are interpreted as unsigned 64-bit integers.
A seeded hash function for 64-bit ints, with the same output value as Hashtbl.seeded_hash
. This function allows this module to be passed as argument to the functor Hashtbl.MakeSeeded
.
sign x
return 0
if x = 0
, -1
if x < 0
and 1
if x > 0
. Same as compare x zero
.
pow base exponent
returns base
raised to the power of exponent
. pow x y = x^y
for positive integers x
and y
. Raises Invalid_argument
if x = y = 0
or y
< 0.
floor_div x n
is integer division rounding towards negative infinity. It satisfies x = m * floor_div x n + rem x n
.
range_by ~step i j
iterates on integers from i
to j
included, where the difference between successive elements is step
. Use a negative step
for a decreasing list.
range i j
iterates on integers from i
to j
included . It works both for decreasing and increasing ranges.
range' i j
is like range
but the second bound j
is excluded. For instance range' 0 5 = Iter.of_list [0;1;2;3;4]
.
Conversion
of_string s
is the safe version of of_string_exn
. Like of_string_exn
, but return None
instead of raising.
of_string_exn s
converts the given string s
into a 64-bit integer. Alias to Int64.of_string
. The string is read in decimal (by default, or if the string begins with 0u
) or in hexadecimal, octal or binary if the string begins with 0x
, 0o
or 0b
respectively.
The 0u
prefix reads the input as an unsigned integer in the range [0, 2*CCInt64.max_int+1]
. If the input exceeds CCInt64.max_int
it is converted to the signed integer CCInt64.min_int + input - CCInt64.max_int - 1
.
The _
(underscore) character can appear anywhere in the string and is ignored. Raise Failure "Int64.of_string"
if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type int64
.
to_string_binary x
returns the string representation of the integer x
, in binary.
Printing
Infix Operators
Infix operators
include module type of Infix
x / y
is the integer quotient of x
and y
. Integer division. Raise Division_by_zero
if the second argument y
is zero. This division rounds the real quotient of its arguments towards zero, as specified for Stdlib.(/)
.
x mod y
is the integer remainder of x / y
. If y <> zero
, the result of x mod y
satisfies the following properties: zero <= x mod y < abs y
and x = ((x / y) * y) + (x mod y)
. If y = 0
, x mod y
raises Division_by_zero
.
x lsl y
shifts x
to the left by y
bits, filling in with zeroes. The result is unspecified if y < 0
or y >= 64
.
x lsr y
shifts x
to the right by y
bits. This is a logical shift: zeroes are inserted in the vacated bits regardless of the sign of x
. The result is unspecified if y < 0
or y >= 64
.
x asr y
shifts x
to the right by y
bits. This is an arithmetic shift: the sign bit of x
is replicated and inserted in the vacated bits. The result is unspecified if y < 0
or y >= 64
.