Module Int32_u

module Boxed = Core.Int32
type t = Base.int32

Utilities for unboxed int32s. This module is mostly a copy of Base's Int32 module, but with much functionality missing because it can't yet be implemented for unboxed int32s or unboxed types generally.

It's part of the same family of libraries as `lib/float_u`, `lib/nativeint_u`, and `lib/int64_u`. They share similar project structures, conventions, and tests.

val globalize : t @ local -> t
include Ppx_quickcheck_runtime.Quickcheckable.S with type t := t
val quickcheck_generator : t Base_quickcheck.Generator.t
val quickcheck_observer : t Base_quickcheck.Observer.t
val quickcheck_shrinker : t Base_quickcheck.Shrinker.t

These definitions are available. They're included from O below.

  external box : int32# -> (int32[@local_opt]) = "%box_int32"
  external unbox : (int32[@local_opt]) -> int32# = "%unbox_int32"

Synonyms for box and unbox.

val of_int32 : Base.int32 -> t @@ portable
val to_int32 : t -> Base.int32 @@ portable

Int_intf.S inlined

Inlined from Floatable

val of_float : Base.float -> t @@ portable
val to_float : t -> Base.float @@ portable

Inlined from Intable

val of_int_exn : Base.int -> t @@ portable
val to_int_exn : t -> Base.int @@ portable

Inlined from Identifiable

Inlined from Sexpable

val sexp_of_t : t -> Base.Sexp.t @@ portable
val t_of_sexp : Base.Sexp.t -> t @@ portable

For bin_io

include Bin_prot.Binable.S__local with type t := t
include Bin_prot.Binable.S_only_functions__local with type t := t
include sig ... end
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : t Bin_prot.Read.vtag_reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader

For hash

include Ppx_hash_lib.Hashable.S_any with type t := t
val hash_fold_t : t Ppx_hash_lib.hash_fold

From Typerep

val typerep_of_t : t Typerep_lib.Std.Typerep.t @@ portable

Inlined from Stringable

val of_string : Base.string -> t @@ portable
val to_string : t -> Base.string @@ portable

Inlined from Comparable

val equal : t -> t -> Base.bool
val compare : t -> t -> Base.int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

val min : t -> t -> t @@ portable
val max : t -> t -> t @@ portable
val ascending : t -> t -> Base.int @@ portable

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> Base.int @@ portable
val between : t -> low:t -> high:t -> Base.bool @@ portable

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t @@ portable

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

Inlined from Pretty_printer

val pp : Base.Formatter.t -> t -> Base.unit @@ portable

Inlined from Comparable.With_zero

val is_positive : t -> Base.bool @@ portable
val is_non_negative : t -> Base.bool @@ portable
val is_negative : t -> Base.bool @@ portable
val is_non_positive : t -> Base.bool @@ portable
val sign : t -> Base.Sign.t @@ portable

Returns Neg, Zero, or Pos in a way consistent with the above functions.

val invariant : t -> Base.unit @@ portable

Inlined from Invariant.S

val to_string_hum : ?delimiter:Base.char -> t -> Base.string @@ portable

delimiter is an underscore by default.

Infix operators and constants

val one : Base.unit -> t @@ portable
val minus_one : Base.unit -> t @@ portable

Other common functions

Inlined from Round

round rounds an int to a multiple of a given to_multiple_of argument, according to a direction dir, with default dir being `Nearest. round will raise if to_multiple_of <= 0. If the result overflows (too far positive or too far negative), round returns an incorrect result.

   | `Down    | rounds toward Int.neg_infinity                          |
   | `Up      | rounds toward Int.infinity                              |
   | `Nearest | rounds to the nearest multiple, or `Up in case of a tie |
   | `Zero    | rounds toward zero                                      |

Here are some examples for round ~to_multiple_of:10 for each direction:

   | `Down    | {10 .. 19} --> 10 | { 0 ... 9} --> 0 | {-10 ... -1} --> -10 |
   | `Up      | { 1 .. 10} --> 10 | {-9 ... 0} --> 0 | {-19 .. -10} --> -10 |
   | `Zero    | {10 .. 19} --> 10 | {-9 ... 9} --> 0 | {-19 .. -10} --> -10 |
   | `Nearest | { 5 .. 14} --> 10 | {-5 ... 4} --> 0 | {-15 ... -6} --> -10 |

For convenience and performance, there are variants of round with dir hard-coded. If you are writing performance-critical code you should use these.

val round : ?dir:[ `Zero | `Nearest | `Up | `Down ] -> t -> to_multiple_of:t -> t @@ portable
val round_down : t -> to_multiple_of:t -> t @@ portable
val round_up : t -> to_multiple_of:t -> t @@ portable
val round_nearest : t -> to_multiple_of:t -> t @@ portable

Successor and predecessor functions

val succ : t -> t @@ portable
val pred : t -> t @@ portable

Exponentiation

val pow : t -> t -> t @@ portable

pow base exponent returns base raised to the power of exponent. It is OK if base <= 0. pow raises if exponent < 0, or an integer overflow would occur.

Bit-wise logical operations

val bit_and : t -> t -> t @@ portable

These are identical to land, lor, etc. except they're not infix and have different names.

val bit_or : t -> t -> t @@ portable
val bit_xor : t -> t -> t @@ portable
val bit_not : t -> t @@ portable
val popcount : t -> t @@ portable

Returns the number of 1 bits in the binary representation of the input.

Bit-shifting operations

The results are unspecified for negative shifts and shifts >= num_bits.

val shift_left : t -> Base.int -> t @@ portable

Shifts left, filling in with zeroes.

val shift_right : t -> Base.int -> t @@ portable

Shifts right, preserving the sign of the input.

Increment and decrement functions for integer references

val of_int32_exn : Base.int32 -> t @@ portable
val to_int32_exn : t -> Base.int32 @@ portable
val of_int64_exn : Base.int64 -> t @@ portable
val to_int64 : t -> Base.int64 @@ portable
val of_nativeint_exn : Base.nativeint -> t @@ portable
val to_nativeint_exn : t -> Base.nativeint @@ portable
val to_int64_u : t -> Base.int64 @@ portable
val of_int64_u_trunc : Base.int64 -> t @@ portable
val of_int64_u_exn : Base.int64 -> t @@ portable
val of_float_unchecked : Base.float -> t @@ portable

of_float_unchecked truncates the given floating point number to an integer, rounding towards zero. The result is unspecified if the argument is nan or falls outside the range of representable integers.

val num_bits : Base.int32 @@ portable

The number of bits available in this integer type. Note that the integer representations are signed.

val max_value : Base.unit -> t @@ portable

The largest representable integer.

val min_value : Base.unit -> t @@ portable

The smallest representable integer.

val shift_right_logical : t -> Base.int -> t @@ portable

Shifts right, filling in with zeroes, which will not preserve the sign of the input.

val ceil_pow2 : t -> t @@ portable

ceil_pow2 x returns the smallest power of 2 that is greater than or equal to x. The implementation may only be called for x > 0. Example: ceil_pow2 17 = 32

val floor_pow2 : t -> t @@ portable

floor_pow2 x returns the largest power of 2 that is less than or equal to x. The implementation may only be called for x > 0. Example: floor_pow2 17 = 16

val ceil_log2 : t -> t @@ portable

ceil_log2 x returns the ceiling of log-base-2 of x, and raises if x <= 0.

val floor_log2 : t -> t @@ portable

floor_log2 x returns the floor of log-base-2 of x, and raises if x <= 0.

val is_pow2 : t -> Base.bool @@ portable

is_pow2 x returns true iff x is a power of 2. is_pow2 raises if x <= 0.

val clz : t -> t @@ portable

Returns the number of leading zeros in the binary representation of the input, as an integer between 0 and one less than num_bits.

The results are unspecified for t = 0.

val ctz : t -> t @@ portable

Returns the number of trailing zeros in the binary representation of the input, as an integer between 0 and one less than num_bits.

The results are unspecified for t = 0.

A sub-module designed to be opened to make working with ints more convenient.

module O : sig ... end
include module type of O
val box : Base.int32 -> Base.int32
val unbox : Base.int32 -> Base.int32
val (+) : t -> t -> t
val (-) : t -> t -> t
val (*) : t -> t -> t

Inlined from Comparisons.Infix

val (>=) : t -> t -> Base.bool
val (<=) : t -> t -> Base.bool
val (=) : t -> t -> Base.bool
val (>) : t -> t -> Base.bool
val (<) : t -> t -> Base.bool
val (<>) : t -> t -> Base.bool
val (**) : t -> t -> t

Integer exponentiation

Negation

val neg : t -> t
val (~-) : t -> t

There are two pairs of integer division and remainder functions, /% and %, and / and rem. They both satisfy the same equation relating the quotient and the remainder:

  x = (x /% y * y) + (x % y);
  x = (x / y * y) + rem x y

The functions return the same values if x and y are positive. They all raise if y = 0.

The functions differ if x < 0 or y < 0.

If y < 0, then % and /% raise, whereas / and rem do not.

x % y always returns a value between 0 and y - 1, even when x < 0. On the other hand, rem x y returns a negative value if and only if x < 0; that value satisfies abs (rem x y) <= abs y - 1.

val (/%) : t -> t -> t
val (%) : t -> t -> t
val (/) : t -> t -> t
val rem : t -> t -> t
val (//) : t -> t -> Base.float

Float division of integers.

val (land) : t -> t -> t

Same as bit_and.

val (lor) : t -> t -> t

Same as bit_or.

val (lxor) : t -> t -> t

Same as bit_xor.

val lnot : t -> t

Same as bit_not.

val (lsl) : t -> Base.int -> t

Same as shift_left.

val (asr) : t -> Base.int -> t

Same as shift_right.

val (lsr) : t -> Base.int -> t

Same as shift_right_logical.

val abs : t -> t

Returns the absolute value of the argument. May be negative if the input is min_value.

val zero : Base.unit -> t

Conversion functions

val to_int : t -> Base.int Base.option @@ portable
val to_nativeint : t -> Base.nativeint @@ portable

Truncating conversions

These functions return the least-significant bits of the input. In cases where optional conversions return Some x, truncating conversions return x.

val of_int_trunc : Base.int -> t @@ portable
val to_int_trunc : t -> Base.int @@ portable
val of_nativeint_trunc : Base.nativeint -> t @@ portable
val of_int64_trunc : Base.int64 -> t @@ portable

Low-level float conversions

val bits_of_float : Base.float -> t @@ portable

Rounds a regular 64-bit OCaml float to a 32-bit IEEE-754 "single" float, and returns its bit representation. We make no promises about the exact rounding behavior, or what happens in case of over- or underflow.

val float_of_bits : t -> Base.float @@ portable

Creates a 32-bit IEEE-754 "single" float from the given bits, and converts it to a regular 64-bit OCaml float.

Byte swap operations

See Int's byte swap section for a description of Base's approach to exposing byte swap primitives.

When compiling for 64-bit machines, if signedness of the output value does not matter, use byteswap functions for int64, if possible, for better performance. As of writing, 32-bit byte swap operations on 64-bit machines have extra overhead for moving to 32-bit registers and sign-extending values when returning to 64-bit registers.

The x86 instruction sequence that demonstrates the overhead is in base/bench/bench_int.ml

val bswap16 : t -> t @@ portable
val bswap32 : t -> t @@ portable
val select : Base.bool -> t -> t -> t @@ portable

Branchless, as Bool.select.

Indexing into an array

module Array_index : sig ... end

An array of _ : bits32

module Array : sig ... end
module Stable : sig ... end
module Hex_unsigned : sig ... end