To focus the search input from anywhere on the page, press the 'S' key.
in-package search v0.1.0
-
batteries
-
batteriesThread
Library
Module
Module type
Parameter
Class
Class type
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.
- author Xavier Leroy (base module)
- author Gabriel Scherer
- author David Teller
Integer division. This division rounds the real quotient of its arguments towards zero, as specified for Pervasives.(/)
.
- raises Division_by_zero
if the second argument is zero.
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)
.
- raises Division_by_zero
if the second argument is zero.
Int32.shift_left x y
shifts x
to the left by y
bits. The result is unspecified if y < 0
or y >= 32
.
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
.
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
.
Enumerate an interval.
5l -- 10l
is the enumeration 5l,6l,7l,8l,9l,10l. 10l -- 5l
is the empty enumeration
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.
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.
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
].
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 32-bit integer (type int32
) to a 64-bit integer (type int64
).
Convert the given native integer (type nativeint
) to a 32-bit integer (type int32
). On 64-bits platform the top 32 bits are lost.
Convert the given 32-bit integer (type int32
) to a native integer.
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.
- raises 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
.
Same as of_string
, but return None
instead of raising.
- since 2.7.0
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.
Return the floating-point number whose internal representation, according to the IEEE 754 floating-point ``single format'' bit layout, is the given int32
.
val pack : 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 : 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 : 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 : Bytes.t -> int -> int32
unpack s off
reads 4 bytes from byte sequence str
starting at offset off
as a big-endian int32
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 ord : t -> t -> BatOrd.order
val operations : t BatNumber.numeric
Submodules grouping all infix operators
module Infix : BatNumber.Infix with type bat__infix_t = t
module Compare : BatNumber.Compare with type bat__compare_t = t
Boilerplate code
Printing
val print : 'a BatInnerIO.output -> t -> unit
prints as decimal string
val print_hex : 'a BatInnerIO.output -> t -> unit
prints as hex string