package core

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module extends Base.Int32.

Interface from Base

val globalize : int32 -> int32
include Sexplib0.Sexpable.S with type t := int32
val t_sexp_grammar : int32 Sexplib0.Sexp_grammar.t
include Base.Floatable.S with type t := int32
val of_float : float -> int32
val to_float : int32 -> float
include Base.Intable.S with type t := int32
val of_int_exn : int -> int32
val to_int_exn : int32 -> int
include Base.Identifiable.S with type t := int32
include Sexplib0.Sexpable.S with type t := int32
include Base.Stringable.S with type t := int32
include Base.Comparable.S with type t := int32
include Base.Comparisons.S with type t := int32
include Base.Comparisons.Infix with type t := int32
include Base.Comparator.S with type t := int32
type comparator_witness = Base.Int32.comparator_witness
include Base.Pretty_printer.S with type t := int32
include Base.Comparable.With_zero with type t := int32
val is_positive : int32 -> bool
val is_non_negative : int32 -> bool
val is_negative : int32 -> bool
val is_non_positive : int32 -> bool
val sign : int32 -> Base.Sign.t

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

val compare__local : int32 -> int32 -> int
val equal__local : int32 -> int32 -> bool
include Base.Invariant.S with type t := int32
val invariant : int32 -> unit
val of_string_opt : string -> int32 option
val to_string_hum : ?delimiter:char -> int32 -> string

delimiter is an underscore by default.

Infix operators and constants
val zero : int32
val one : int32
val minus_one : int32
val (+) : int32 -> int32 -> int32
val (-) : int32 -> int32 -> int32
val (*) : int32 -> int32 -> int32
val (**) : int32 -> int32 -> int32

Integer exponentiation

Negation

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

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 (/%) : int32 -> int32 -> int32
val (%) : int32 -> int32 -> int32
val (/) : int32 -> int32 -> int32
val rem : int32 -> int32 -> int32
val (//) : int32 -> int32 -> float

Float division of integers.

val (land) : int32 -> int32 -> int32

Same as bit_and.

val (lor) : int32 -> int32 -> int32

Same as bit_or.

val (lxor) : int32 -> int32 -> int32

Same as bit_xor.

val lnot : int32 -> int32

Same as bit_not.

val (lsl) : int32 -> int -> int32

Same as shift_left.

val (asr) : int32 -> int -> int32

Same as shift_right.

Other common functions

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 ] -> int32 -> to_multiple_of:int32 -> int32
val round_towards_zero : int32 -> to_multiple_of:int32 -> int32
val round_down : int32 -> to_multiple_of:int32 -> int32
val round_up : int32 -> to_multiple_of:int32 -> int32
val round_nearest : int32 -> to_multiple_of:int32 -> int32
val abs : int32 -> int32

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

Successor and predecessor functions
val succ : int32 -> int32
val pred : int32 -> int32
Exponentiation
val pow : int32 -> int32 -> int32

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 : int32 -> int32 -> int32

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

val bit_or : int32 -> int32 -> int32
val bit_xor : int32 -> int32 -> int32
val bit_not : int32 -> int32
val popcount : int32 -> int

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 : int32 -> int -> int32

Shifts left, filling in with zeroes.

val shift_right : int32 -> int -> int32

Shifts right, preserving the sign of the input.

Increment and decrement functions for integer references
val decr : int32 ref -> unit
val incr : int32 ref -> unit
val of_int32_exn : int32 -> int32
val to_int32_exn : int32 -> int32
val of_int64_exn : int64 -> int32
val to_int64 : int32 -> int64
val of_nativeint_exn : nativeint -> int32
val to_nativeint_exn : int32 -> nativeint
val of_float_unchecked : float -> int32

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 : int

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

val max_value : int32

The largest representable integer.

val min_value : int32

The smallest representable integer.

val (lsr) : int32 -> int -> int32

Same as shift_right_logical.

val shift_right_logical : int32 -> int -> int32

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

val ceil_pow2 : int32 -> int32

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 : int32 -> int32

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 : int32 -> int

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

val floor_log2 : int32 -> int

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

val is_pow2 : int32 -> bool

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

val clz : int32 -> int

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 : int32 -> int

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.

module O = Base.Int32.O

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

Conversion functions
val of_int : int -> int32 option
val to_int : int32 -> int option
val of_int32 : int32 -> int32
val to_int32 : int32 -> int32
val of_nativeint : nativeint -> int32 option
val to_nativeint : int32 -> nativeint
val of_int64 : int64 -> int32 option
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 : int -> int32
val to_int_trunc : int32 -> int
val of_nativeint_trunc : nativeint -> int32
val of_int64_trunc : int64 -> int32
Low-level float conversions
val bits_of_float : float -> int32

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 : int32 -> float

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 : int32 -> int32
val bswap32 : int32 -> int32

Extensions

include Bin_prot.Binable.S with type t := {t}1
include Bin_prot.Binable.S_only_functions with type t := {t}1
include Typerep_lib.Typerepable.S with type t := {t}1
val typerep_of_t : {t}1 Typerep_lib.Std_internal.Typerep.t
val typename_of_t : {t}1 Typerep_lib.Typename.t
include Int_intf.Binaryable with type t := {t}1
module Binary : sig ... end
include Base.Int.Binaryable with type t := {t}1 and module Binary := Binary
include Int_intf.Hexable with type t := {t}1
module Hex : sig ... end
include Base.Int.Hexable with type t := {t}1 and module Hex := Hex
include Identifiable.S with type t := {t}1 with type comparator_witness := comparator_witness
include Bin_prot.Binable.S with type t := {t}1
include Bin_prot.Binable.S_only_functions with type t := {t}1
include Ppx_hash_lib.Hashable.S with type t := {t}1
include Sexplib0.Sexpable.S with type t := {t}1
val t_of_sexp : Sexplib0.Sexp.t -> {t}1
include Ppx_compare_lib.Comparable.S with type t := {t}1
include Ppx_hash_lib.Hashable.S with type t := {t}1
val sexp_of_t : {t}1 -> Sexplib0.Sexp.t
include Base.Stringable.S with type t := {t}1
val of_string : string -> {t}1
val to_string : {t}1 -> string
include Base.Pretty_printer.S with type t := {t}1
val pp : Base.Formatter.t -> {t}1 -> unit
include Comparable.S_binable with type t := {t}1 with type comparator_witness := comparator_witness
include Base.Comparable.S with type t := {t}1 with type comparator_witness := comparator_witness
include Base.Comparisons.S with type t := {t}1
include Base.Comparisons.Infix with type t := {t}1
val (>=) : {t}1 -> {t}1 -> bool
val (<=) : {t}1 -> {t}1 -> bool
val (=) : {t}1 -> {t}1 -> bool
val (>) : {t}1 -> {t}1 -> bool
val (<) : {t}1 -> {t}1 -> bool
val (<>) : {t}1 -> {t}1 -> bool
val equal : {t}1 -> {t}1 -> bool
val compare : {t}1 -> {t}1 -> 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}1 -> {t}1 -> {t}1
val max : {t}1 -> {t}1 -> {t}1
val ascending : {t}1 -> {t}1 -> int

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}1 -> {t}1 -> int
val between : {t}1 -> low:{t}1 -> high:{t}1 -> bool

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

val clamp_exn : {t}1 -> min:{t}1 -> max:{t}1 -> {t}1

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).

val clamp : {t}1 -> min:{t}1 -> max:{t}1 -> {t}1 Base.Or_error.t
include Base.Comparator.S with type t := {t}1 with type comparator_witness := comparator_witness
include Comparator.S with type t := {t}1 with type comparator_witness := comparator_witness
module Map : Map.S_binable with type Key.t = {t}1 with type Key.comparator_witness = comparator_witness
module Set : Set.S_binable with type Elt.t = {t}1 with type Elt.comparator_witness = comparator_witness
include Hashable.S_binable with type t := {t}1
include Ppx_hash_lib.Hashable.S with type t := {t}1
val hash_fold_t : Base.Hash.state -> {t}1 -> Base.Hash.state
val hash : {t}1 -> Base.Hash.hash_value
val hashable : {t}1 Base.Hashable.t
module Table : Hashtbl.S_binable with type key = {t}1
module Hash_set : Hash_set.S_binable with type elt = {t}1
module Hash_queue : Hash_queue.S with type key = {t}1
include Comparable.Validate_with_zero with type t := {t}1
val validate_lbound : min:{t}1 Maybe_bound.t -> {t}1 Validate.check
val validate_ubound : max:{t}1 Maybe_bound.t -> {t}1 Validate.check
val validate_bound : min:{t}1 Maybe_bound.t -> max:{t}1 Maybe_bound.t -> {t}1 Validate.check
val validate_positive : {t}1 Validate.check
val validate_non_negative : {t}1 Validate.check
val validate_negative : {t}1 Validate.check
val validate_non_positive : {t}1 Validate.check
include Quickcheckable.S_int with type t := {t}1
include Quickcheck_intf.S_range with type t := {t}1
include Quickcheck_intf.S with type t := {t}1
val quickcheck_generator : {t}1 Base_quickcheck.Generator.t
val quickcheck_observer : {t}1 Base_quickcheck.Observer.t
val quickcheck_shrinker : {t}1 Base_quickcheck.Shrinker.t
val gen_incl : {t}1 -> {t}1 -> {t}1 Base_quickcheck.Generator.t

gen_incl lower_bound upper_bound produces values between lower_bound and upper_bound, inclusive. It uses an ad hoc distribution that stresses boundary conditions more often than a uniform distribution, while still able to produce any value in the range. Raises if lower_bound > upper_bound.

val gen_uniform_incl : {t}1 -> {t}1 -> {t}1 Base_quickcheck.Generator.t

gen_uniform_incl lower_bound upper_bound produces a generator for values uniformly distributed between lower_bound and upper_bound, inclusive. Raises if lower_bound > upper_bound.

val gen_log_uniform_incl : {t}1 -> {t}1 -> {t}1 Base_quickcheck.Generator.t

gen_log_uniform_incl lower_bound upper_bound produces a generator for values between lower_bound and upper_bound, inclusive, where the number of bits used to represent the value is uniformly distributed. Raises if (lower_bound < 0) || (lower_bound > upper_bound).

val gen_log_incl : {t}1 -> {t}1 -> {t}1 Base_quickcheck.Generator.t

gen_log_incl lower_bound upper_bound is like gen_log_uniform_incl, but weighted slightly more in favor of generating lower_bound and upper_bound specifically.

include sig ... end
type nonrec t = {t}1
include Bin_prot.Binable.S_local with type t := t
include Bin_prot.Binable.S_local_only_functions with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
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__ : (int -> t) Bin_prot.Read.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_size_t__local : t Bin_prot.Size.sizer_local
val bin_write_t__local : t Bin_prot.Write.writer_local
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
OCaml

Innovation. Community. Security.