Module Base.IntSource

Sourcemodule type Round = sig ... end
Sourcemodule type To_string_hum = sig ... end

Human-readable serialization.

Sourcemodule type To_string_format = sig ... end

String format for integers, to_string / sexp_of_t direction only. Includes comparisons and hash functions for [@@deriving].

Sourcemodule type String_format = sig ... end

String format for integers, including both to_string / sexp_of_t and of_string / t_of_sexp directions. Includes comparisons and hash functions for [@@deriving].

Sourcemodule type Binaryable = sig ... end

Binary format for integers, unsigned and starting with 0b.

Sourcemodule type Hexable = sig ... end

Hex format for integers, signed and starting with 0x.

Sourcemodule type S_common = sig ... end
Sourcemodule type Operators_unbounded = sig ... end
Sourcemodule type Operators = sig ... end
Sourcemodule type S_unbounded = sig ... end

S_unbounded is a generic interface for unbounded integers, e.g. Bignum.Bigint. S_unbounded is a restriction of S (below) that omits values that depend on fixed-size integers.

Sourcemodule type S = sig ... end

S is a generic interface for fixed-size integers.

Sourcemodule type Int_without_module_types = sig ... end

OCaml's native integer type.

Sourcetype t = int
Sourceval globalize : t @ local -> t
include Sexplib0.Sexpable.S__stack with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
include Sexplib0.Sexpable.Sexp_of__stack with type t := t
Sourceval t_sexp_grammar : t Sexplib0.Sexp_grammar.t @@ portable
include Floatable.S_local_input with type t := t
Sourceval of_float : float @ local -> t
Sourceval to_float : t @ local -> float
include Intable.S with type t := t
include Identifiable.S__local__portable with type t := t
include Ppx_hash_lib.Hashable.S with type t := t
include Sexplib0.Sexpable.S with type t := t
include Sexplib0.Sexpable.Of_sexp with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
include Sexplib0.Sexpable.Sexp_of with type t := t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Stringable.S with type t := t
include Stringable.Of_stringable with type t := t
include Stringable.To_stringable with type t := t
include Comparable.S__local__portable with type t := t
include Comparisons.S__local with type t := t
include Comparisons.Infix with type t := t
Sourceval between : t -> low:t -> high:t -> bool @@ portable

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

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

Sourceval clamp : t -> min:t -> max:t -> t Or_error.t @@ portable
include Comparator.S__portable with type t := t
Sourcetype comparator_witness : value mod portable
include Pretty_printer.S with type t := t
Sourceval pp : Formatter.t -> t -> unit
Sourceval hashable : t Hashable.t
include Stringable.S__local__stack with type t := t
include Stringable.Of_stringable__local with type t := t
Sourceval of_string : string @ local -> t
include Stringable.To_stringable__local__stack with type t := t
Sourceval to_string : t @ local -> string
include Comparable.With_zero with type t := t
Sourceval is_positive : t -> bool
Sourceval is_non_negative : t -> bool
Sourceval is_negative : t -> bool
Sourceval is_non_positive : t -> bool
Sourceval sign : t -> Base__.Sign0.t

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

include Invariant.S with type t := t
Sourceval invariant : t -> unit
Sourcemodule Hex : sig ... end
Sourcemodule Binary : sig ... end
Sourceval of_string_opt : string @ local -> t option
Sourceval to_string_hum : ?delimiter:char -> t @ local -> string

delimiter is an underscore by default.

Infix operators and constants

Sourceval one : t
Sourceval minus_one : t

Negation

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.

Sourceval rem : t @ local -> t @ local -> t

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.

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

Successor and predecessor functions

Sourceval succ : t @ local -> t
Sourceval pred : t @ local -> t

Exponentiation

Sourceval pow : t @ local -> t @ local -> t

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

Sourceval bit_and : t @ local -> t @ local -> t

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

Sourceval bit_or : t @ local -> t @ local -> t
Sourceval bit_xor : t @ local -> t @ local -> t
Sourceval bit_not : t @ local -> t
Sourceval popcount : t @ local -> t

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.

Sourceval shift_left : t @ local -> int -> t

Shifts left, filling in with zeroes.

Sourceval shift_right : t @ local -> int -> t

Shifts right, preserving the sign of the input.

Increment and decrement functions for integer references

Sourceval decr : t ref @ local -> unit
Sourceval incr : t ref @ local -> unit
Sourceval of_int32_exn : int32 -> t
Sourceval to_int32_exn : t -> int32
Sourceval to_int64 : t -> int64
Sourceval of_nativeint_exn : nativeint -> t
Sourceval to_nativeint_exn : t -> nativeint
Sourceval of_local_int32_exn : int32 @ local -> t @ local
Sourceval to_local_int32_exn : t @ local -> int32 @ local
Sourceval of_local_int64_exn : int64 @ local -> t @ local
Sourceval to_local_int64 : t @ local -> int64 @ local
Sourceval of_local_nativeint_exn : nativeint @ local -> t @ local
Sourceval to_local_nativeint_exn : t @ local -> nativeint @ local
Sourceval of_float_unchecked : float @ local -> t

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.

Sourcemodule Summable : sig ... end
Sourceval num_bits : t

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

Sourceval max_value : t

The largest representable integer.

Sourceval min_value : t

The smallest representable integer.

Sourceval shift_right_logical : t @ local -> int -> t

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

Sourceval ceil_pow2 : t @ local -> t

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

Sourceval floor_pow2 : t @ local -> t

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

Sourceval ceil_log2 : t @ local -> t

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

Sourceval floor_log2 : t @ local -> t

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

Sourceval is_pow2 : t @ local -> bool

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

Sourceval clz : t @ local -> t

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.

Sourceval ctz : t @ local -> t

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.

Sourceval of_int_exn : int -> t [@@zero_alloc]
Sourceval to_int_exn : t @ local -> int [@@zero_alloc]
Sourcemodule O : sig ... end
include module type of O
Sourceval (+) : t -> t -> t
Sourceval (-) : t -> t -> t
Sourceval (*) : t -> t -> t
Sourceval (/) : t -> t -> t
Sourceval (~-) : t -> t
Sourceval (**) : t @ local -> t @ local -> t
Sourceval (land) : t -> t -> t
Sourceval (lor) : t -> t -> t
Sourceval (lxor) : t -> t -> t
Sourceval lnot : t @ local -> t
Sourceval abs : t -> t
Sourceval abs_local : t @ local -> t @ local
Sourceval neg : t -> t
Sourceval zero : t
Sourceval (%) : t @ local -> t @ local -> t
Sourceval (/%) : t @ local -> t @ local -> t
Sourceval (//) : t @ local -> t @ local -> float
Sourceval (lsl) : t -> int -> t
Sourceval (asr) : t -> int -> t
Sourceval (lsr) : t -> int -> t
Sourceval (=) : t -> t -> bool @@ portable
Sourceval (<>) : t -> t -> bool @@ portable
Sourceval (<) : t -> t -> bool @@ portable
Sourceval (>) : t -> t -> bool @@ portable
Sourceval (<=) : t -> t -> bool @@ portable
Sourceval (>=) : t -> t -> bool @@ portable
Sourceval compare : t -> t -> int @@ portable
Sourceval compare__local : t -> t -> int @@ portable
Sourceval equal : t -> t -> bool @@ portable
Sourceval equal__local : t -> t -> bool @@ portable
Sourceval ascending : t -> t -> int @@ portable
Sourceval descending : t -> t -> int @@ portable
Sourceval max : t -> t -> t @@ portable
Sourceval min : t -> t -> t @@ portable
Sourceval max_value_30_bits : t

max_value_30_bits = 2^30 - 1. It is useful for writing tests that work on both 64-bit and 32-bit platforms.

Conversion functions

Sourceval of_int : int -> t
Sourceval to_int : t -> int
Sourceval of_int32 : int32 @ local -> t option
Sourceval to_int32 : t -> int32 option
Sourceval of_int64 : int64 @ local -> t option
Sourceval of_int64_exn : int64 @ local -> t
Sourceval of_nativeint : nativeint @ local -> t option
Sourceval to_nativeint : t -> nativeint

Truncating conversions

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

Sourceval to_int32_trunc : t -> int32
Sourceval of_int32_trunc : int32 @ local -> t
Sourceval of_int64_trunc : int64 @ local -> t
Sourceval of_nativeint_trunc : nativeint @ local -> t

Byte swap operations

Byte swap operations reverse the order of bytes in an integer. For example, Int32.bswap32 reorders the bottom 32 bits (or 4 bytes), turning 0x1122_3344 to 0x4433_2211. Byte swap functions exposed by Base use OCaml primitives to generate assembly instructions to perform the relevant byte swaps.

For a more extensive list of byteswap functions, see Int32 and Int64.

Sourceval bswap16 : t -> t

Byte swaps bottom 16 bits (2 bytes). The values of the remaining bytes are undefined.