package stdint
Install
Authors
Maintainers
Sources
sha256=1560198d8bc9c7af3ea952c40dabe82666694210ecc3fdf9bbfeb43211e977e6
sha512=b0319c2e7490e58effc7a01f2c5635d3468e501741478249e012dda039729609f7bb7d3cb6239eed709f1c043bc23a1c6cff777b174d215fbf6f2eba9f0d023d
Description
The stdint library provides signed and unsigned integer types of various fixed widths: 8, 16, 24, 32, 40, 48, 56, 64 and 128 bit.
This interface is similar to Int32 and Int64 from the base library but provides more functions and constants like arithmetic and bitwise operations, constants like maximum and minimum values, infix operators conversion to and from every other integer type (including int, float and nativeint), parsing from and conversion to readable strings (binary, octal, decimal, hexademical), conversion to and from buffers in both big endian and little endian byte order.
Published: 19 Oct 2022
README
ocamlstdint
This OCaml library provides integer types having specified widths.
It provides the following unsigned integer types:
uint8
uint16
uint24
uint32
uint40
uint48
uint56
uint64
uint128
and the following list of signed integer types:
int8
int16
int24
int32 (identical to int32 from the base library)
int40
int48
int56
int64 (identical to int64 from the base library)
int128
There is a module for every integer type that implements the Int interface. This interface is similar to Int32 and Int64 from the base library but provides more functions and constants like
arithmetic and bitwise operations
constants like maximum and minimum value
infix operators
conversion to and from every other integer type (including int, float and nativeint)
parsing from and conversion to readable strings (binary, octal, decimal, hexademical)
conversion to and from buffers in both big endian and little endian byte order
The library also comes with C header files that allow easy access to the integer values in C bindings. The functions are modeled on base of the int32 and int64 access functions provided by the base library. The semantics of all operations is identical to the Int32, Int64 modules, C, C++, Java etc.: Conversion will silently truncate larger values as will other operations leading to overflowing integer values.
The API of stdint can be found online at the OCaml forge.
To use the integer types, we recommend to open Stdint
but not the individual modules:
open Stdint
let _ =
let a = Uint8.of_int 21 in
let x = Uint8.(a * (one + one)) in
print_endline (Uint8.to_string x)
The 128 bit integer types are currently only available on 64 bit platforms; the compatibility layer for 32 bit platforms is not yet fully implemented and will raise Failure
for several functions.
Implementation
The representation of integers depends on their size:
Signed integers smaller than the standard integer type are stored in a standard
int
. They are leftaligned so that most arithmetic operations are just the same as the ones on normal integers. The standard OCaml integer type is 31 bit on 32 bit machines and 63 bit on 64 bit machines. Operations like addition and division require an extra shift; others like xor require an additional mask to keep the unused bits (at the right) at0
.Unsigned integers smaller than the standard integer types are stored in the standard
int
, too. They are rightaligned making most arithmetic operations compatible to standard integer operations. Operations like addition require an additional mask operation to keep the unused bits (at the left) at0
.uint32
anduint64
have their custom inmemory representation implemented in CSigned integers larger than the standard integer but smaller than
int64
are stored in the latter. The requirements are otherwise identical to small signed integers store in the standard integer.Unsigned integers larger than the standard integer but smaller then
uint64
are stored in the latter. The requirements are otherwise identical to small unsigned integers store in the standard integer.128 Bit integers have a custom inmemory representation implemented in C. On 64 Bit platforms they use the specialized arithmetic operations provided by the C compiler that are much faster than manual operations, to which a fallback solution exists on 32 Bit platforms.
Copyright
The stdint library is written by Andre Nathan, Jeff Shaw, Markus Weissmann and Florian Pichlmeier. It is based on the ocamluint library.
The sourcecode of stdint is available under the MIT license.
Used by (25)
 amf
 bitcoinml

capnp
>= "3.4.0"

capnprpc
>= "0.4.0"

capnprpclwt
>= "1.2.3"

current_rpc
>= "0.4"

fstar
>= "0.9.3.0beta1"
 i3ipc
 ip2location

jupyter
>= "1.0.2"
 karamel

kremlin
< "transition"
 libudev
 octezlibs
 octezplompiler
 open_packaging
 osbx
 plebeia
 procsmaps
 safemoney
 sid
 stdintliterals
 tezosplompiler

uint
>= "2.0.1"

zmq
>= "4.06" & < "5.2.1"