module BatInt32:sig
..end
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.
Any integer literal followed by l
is taken to be an int32
.
For instance, 1l
is Int32.one
.
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.
This module extends Stdlib's Int32 module, go there for documentation on the rest of the functions and types.
typet =
int32
val zero : int32
The 32-bit integer 0.
val one : int32
The 32-bit integer 1.
val minus_one : int32
The 32-bit integer -1.
val neg : int32 -> int32
Unary negation.
val add : int32 -> int32 -> int32
Addition.
val sub : int32 -> int32 -> int32
Subtraction.
val mul : int32 -> int32 -> int32
Multiplication.
val div : int32 -> int32 -> int32
Integer division.
This division rounds the real quotient of
its arguments towards zero, as specified for Pervasives.(/)
.
Division_by_zero
if the second argument is zero.val unsigned_div : int32 -> int32 -> int32
Same as BatInt32.div
, except that arguments and result are interpreted as unsigned 32-bit integers.
val rem : int32 -> int32 -> int32
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)
.
Division_by_zero
if the second argument is zero.val unsigned_rem : int32 -> int32 -> int32
Same as BatInt32.rem
, except that arguments and result are interpreted as unsigned 32-bit integers.
val modulo : int32 -> int32 -> int32
val pow : int32 -> int32 -> int32
Invalid_argument
if the exponent is negative.val min_num : bounded
val max_num : bounded
val succ : int32 -> int32
Successor. Int32.succ x
is Int32.add x Int32.one
.
val pred : int32 -> int32
Predecessor. Int32.pred x
is Int32.sub x Int32.one
.
val abs : int32 -> int32
Return the absolute value of its argument.
val max_int : int32
The greatest representable 32-bit integer, 231 - 1.
val min_int : int32
The smallest representable 32-bit integer, -231.
val logand : int32 -> int32 -> int32
Bitwise logical and.
val logor : int32 -> int32 -> int32
Bitwise logical or.
val logxor : int32 -> int32 -> int32
Bitwise logical exclusive or.
val lognot : int32 -> int32
Bitwise logical negation
val shift_left : int32 -> int -> int32
Int32.shift_left x y
shifts x
to the left by y
bits.
The result is unspecified if y < 0
or y >= 32
.
val shift_right : int32 -> int -> int32
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
.
val shift_right_logical : int32 -> int -> int32
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
.
val (--) : t -> t -> t BatEnum.t
Enumerate an interval.
5l -- 10l
is the enumeration 5l,6l,7l,8l,9l,10l.
10l -- 5l
is the empty enumeration
val (---) : t -> t -> t BatEnum.t
Enumerate an interval.
5l -- 10l
is the enumeration 5l,6l,7l,8l,9l,10l.
10l -- 5l
is the enumeration 10l,9l,8l,7l,6l,5l.
val of_int : int -> int32
Convert the given integer (type int
) to a 32-bit integer
(type int32
).
val to_int : int32 -> 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.
val unsigned_to_int : int32 -> int option
Same as BatInt32.to_int
, but interprets the argument as an unsigned integer.
Returns None
if the unsigned value of the argument cannot fit into an
int
.
val of_float : float -> int32
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
].
val to_float : int32 -> float
Convert the given 32-bit integer to a floating-point number.
val of_int64 : int64 -> int32
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.
val to_int64 : int32 -> int64
Convert the given 32-bit integer (type int32
)
to a 64-bit integer (type int64
).
val of_nativeint : nativeint -> int32
Convert the given native integer (type nativeint
)
to a 32-bit integer (type int32
). On 64-bits platform
the top 32 bits are lost.
val to_nativeint : int32 -> nativeint
Convert the given 32-bit integer (type int32
) to a
native integer.
val of_string : string -> int32
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.
Failure
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.
val to_string : int32 -> string
Return the string representation of its argument, in signed decimal.
val bits_of_float : float -> int32
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.
val float_of_bits : int32 -> float
Return the floating-point number whose internal representation,
according to the IEEE 754 floating-point ``single format'' bit layout,
is the given int32
.
val of_byte : char -> int32
val to_byte : int32 -> char
val pack : Stdlib.Bytes.t -> int -> int32 -> unit
pack s off i
writes the little endian bit representation
of i
into byte sequence s
at offset off
val pack_big : Stdlib.Bytes.t -> int -> int32 -> unit
pack_big s off i
writes the big endian bit
representation of i
into byte sequence s
at offset off
val unpack : Stdlib.Bytes.t -> int -> int32
unpack s off
reads 4 bytes from byte sequence str
starting at
offset off
as a little-endian int32
val unpack_big : Stdlib.Bytes.t -> int -> int32
unpack s off
reads 4 bytes from byte sequence str
starting at
offset off
as a big-endian int32
val compare : t -> t -> int
The comparison function for 32-bit integers, with the same specification as
Pervasives.compare
. Along with the type t
, this function compare
allows the module Int32
to be passed as argument to the functors
Set.Make
and Map.Make
.
val unsigned_compare : t -> t -> int
Same as BatInt32.compare
, except that arguments are interpreted as unsigned
32-bit integers.
val equal : t -> t -> bool
Equality function for 32-bit integers, useful for HashedType
.
val ord : t -> t -> BatOrd.order
val (+) : t -> t -> t
val (-) : t -> t -> t
val ( * ) : t -> t -> t
val (/) : t -> t -> t
val ( ** ) : t -> t -> t
val operations : t BatNumber.numeric
module Infix:BatNumber.Infix
with type bat__infix_t = t
module Compare:BatNumber.Compare
with type bat__compare_t = t
include BatNumber.Bounded
val print : 'a BatInnerIO.output -> t -> unit
prints as decimal string
val print_hex : 'a BatInnerIO.output -> t -> unit
prints as hex string