CCInt32
Helpers for 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.
val hash : t -> int
hash x
computes the hash of x
. Like Stdlib
.abs(to_intx).
val sign : t -> int
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.
val popcount : t -> int
Number of bits set to 1.
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]
.
val random : t -> t random_gen
val random_small : t random_gen
val random_range : t -> t -> t random_gen
val of_string : string -> t option
of_string s
is the safe version of of_string_exn
. Like of_string_exn
, but return None
instead of raising.
val of_string_exn : string -> t
of_string_exn s
converts the given string s
into a 32-bit integer. Alias to Int32
.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*CCInt32.max_int+1]
. If the input exceeds CCInt32.max_int
it is converted to the signed integer CCInt32.min_int + input - CCInt32.max_int - 1
.
The _
(underscore) character can appear anywhere in the string and is ignored. Raise Failure "Int32.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 to_string_binary : t -> string
to_string_binary x
returns the string representation of the integer x
, in binary.
module Infix : sig ... end
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 >= 32
.
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 >= 32
.
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 >= 32
.