32-bit integers.
This module provides operations on the type int32
of signed 32-bit integers. Unlike the built-in int
type,
the type int32
is guaranteed to be exactly 32-bit wide on all
platforms. All arithmetic operations over int32
are taken
modulo 232.
Performance notice: values of type int32
occupy more memory
space than values of type int
, and arithmetic operations on
int32
are generally slower than those on int
. Use int32
only when the application requires exact 32-bit arithmetic.
external div : int32 -> int32 -> int32 = "%int32_div"
Integer division. Raise Division_by_zero
if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for Pervasives.(/).
external rem : int32 -> int32 -> int32 = "%int32_mod"
Integer remainder. If y
is not zero, the result
of Int32.rem x y
satisfies the following property:
x = Int32.add (Int32.mul (Int32.div x y) y) (Int32.rem x y)
.
If y = 0
, Int32.rem x y
raises Division_by_zero
.
external shift_left : int32 -> int -> int32 = "%int32_lsl"
Int32.shift_left x y
shifts x
to the left by y
bits.
The result is unspecified if y < 0
or y >= 32
.
external shift_right : int32 -> int -> int32 = "%int32_asr"
Int32.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 >= 32
.
external shift_right_logical : int32 -> int -> int32 = "%int32_lsr"
Int32.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 >= 32
.
external of_int : int -> int32 = "%int32_of_int"
Convert the given integer (type int
) to a 32-bit integer
(type int32
).
external to_int : int32 -> int = "%int32_to_int"
Convert the given 32-bit integer (type int32
) to an
integer (type int
). On 32-bit platforms, the 32-bit integer
is taken modulo 231, i.e. the high-order bit is lost
during the conversion. On 64-bit platforms, the conversion
is exact.
external of_float : float -> int32 = "caml_int32_of_float" "caml_int32_of_float_unboxed"
Convert the given floating-point number to a 32-bit integer, discarding the fractional part (truncate towards 0). The result of the conversion is undefined if, after truncation, the number is outside the range [Int32.min_int, Int32.max_int].
external to_float : int32 -> float = "caml_int32_to_float" "caml_int32_to_float_unboxed"
Convert the given 32-bit integer to a floating-point number.
external of_string : string -> int32 = "caml_int32_of_string"
Convert the given string to a 32-bit integer.
The string is read in decimal (by default) or in hexadecimal,
octal or binary if the string begins with 0x
, 0o
or 0b
respectively.
Raise Failure "int_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 int32
.
val of_string_opt : string -> int32 option
Same as of_string
, but return None
instead of raising.
external bits_of_float : float -> int32 = "caml_int32_bits_of_float" "caml_int32_bits_of_float_unboxed"
Return the internal representation of the given float according to the IEEE 754 floating-point 'single format' bit layout. Bit 31 of the result represents the sign of the float; bits 30 to 23 represent the (biased) exponent; bits 22 to 0 represent the mantissa.
external float_of_bits : int32 -> float = "caml_int32_float_of_bits" "caml_int32_float_of_bits_unboxed"
Return the floating-point number whose internal representation,
according to the IEEE 754 floating-point 'single format' bit layout,
is the given int32
.