This module extends Base.Int.
val globalize : int -> intinclude Base.Floatable.S with type t := int
val of_float : float -> intval to_float : int -> floatinclude Base.Intable.S with type t := int
val of_int_exn : int -> intval to_int_exn : int -> intinclude Base.Comparable.With_zero with type t := int
val is_positive : int -> boolval is_non_negative : int -> boolval is_negative : int -> boolval is_non_positive : int -> boolReturns Neg, Zero, or Pos in a way consistent with the above functions.
val compare__local : int -> int -> intval equal__local : int -> int -> boolval of_string_opt : string -> int optionval to_string_hum : ?delimiter:char -> int -> stringdelimiter is an underscore by default.
Infix operators and constants
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.
val rem : int -> int -> intOther 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 ] ->
int ->
to_multiple_of:int ->
intval round_towards_zero : int -> to_multiple_of:int -> intval round_down : int -> to_multiple_of:int -> intval round_up : int -> to_multiple_of:int -> intval round_nearest : int -> to_multiple_of:int -> intSuccessor and predecessor functions
Exponentiation
val pow : int -> int -> intpow 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 : int -> int -> intThese are identical to land, lor, etc. except they're not infix and have different names.
val bit_or : int -> int -> intval bit_xor : int -> int -> intval popcount : int -> intReturns 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 : int -> int -> intShifts left, filling in with zeroes.
val shift_right : int -> int -> intShifts right, preserving the sign of the input.
Increment and decrement functions for integer references
val decr : int Stdlib.ref -> unitval incr : int Stdlib.ref -> unitval of_int32_exn : int32 -> intval to_int32_exn : int -> int32val of_int64_exn : int64 -> intval to_int64 : int -> int64val of_nativeint_exn : nativeint -> intval to_nativeint_exn : int -> nativeintval of_float_unchecked : float -> intof_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.
The number of bits available in this integer type. Note that the integer representations are signed.
The largest representable integer.
The smallest representable integer.
val shift_right_logical : int -> int -> intShifts right, filling in with zeroes, which will not preserve the sign of the input.
val ceil_pow2 : int -> intceil_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 : int -> intfloor_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 : int -> intceil_log2 x returns the ceiling of log-base-2 of x, and raises if x <= 0.
val floor_log2 : int -> intfloor_log2 x returns the floor of log-base-2 of x, and raises if x <= 0.
val is_pow2 : int -> boolis_pow2 x returns true iff x is a power of 2. is_pow2 raises if x <= 0.
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.
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.
include module type of O
val (+) : int -> int -> intval (-) : int -> int -> intval (*) : int -> int -> intval (/) : int -> int -> intval (**) : int -> int -> intval (land) : int -> int -> intval (lor) : int -> int -> intval (lxor) : int -> int -> intval (%) : int -> int -> intval (/%) : int -> int -> intval (//) : int -> int -> floatval (lsl) : int -> int -> intval (asr) : int -> int -> intval (lsr) : int -> int -> intval max_value_30_bits : intmax_value_30_bits = 2^30 - 1. It is useful for writing tests that work on both 64-bit and 32-bit platforms.
Conversion functions
val of_int32 : int32 -> int optionval to_int32 : int -> int32 optionval of_int64 : int64 -> int optionval of_nativeint : nativeint -> int optionval to_nativeint : int -> nativeintTruncating conversions
These functions return the least-significant bits of the input. In cases where optional conversions return Some x, truncating conversions return x.
val to_int32_trunc : int -> int32val of_int32_trunc : int32 -> intval of_int64_trunc : int64 -> intval of_nativeint_trunc : nativeint -> intByte 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.
Byte swaps bottom 16 bits (2 bytes). The values of the remaining bytes are undefined.
Note that int is already stable by itself, since as a primitive type it is an integral part of the sexp / bin_io protocol. Int.Stable exists only to introduce Int.Stable.Set and Int.Stable.Map, and provide interface uniformity with other stable types.
include Int_intf.Extension_with_stable
with type t := {t}1
and type comparator_witness := comparator_witness
include Int_intf.Extension
with type t := {t}1
with type comparator_witness := comparator_witness
include Identifiable.S
with type t := {t}1
with type comparator_witness := comparator_witness
include Base.Stringable.S with type t := {t}1
val of_string : string -> {t}1val to_string : {t}1 -> stringinclude 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 -> boolval (<=) : {t}1 -> {t}1 -> boolval (=) : {t}1 -> {t}1 -> boolval (>) : {t}1 -> {t}1 -> boolval (<) : {t}1 -> {t}1 -> boolval (<>) : {t}1 -> {t}1 -> boolval equal : {t}1 -> {t}1 -> boolval compare : {t}1 -> {t}1 -> intcompare 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}1val max : {t}1 -> {t}1 -> {t}1val ascending : {t}1 -> {t}1 -> intascending 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 -> intval between : {t}1 -> low:{t}1 -> high:{t}1 -> boolbetween t ~low ~high means low <= t <= high
val clamp_exn : {t}1 -> min:{t}1 -> max:{t}1 -> {t}1clamp_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).
include Quickcheckable.S_int with type t := {t}1
include Quickcheck_intf.S_range with type t := {t}1
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.
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.
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).
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.