64-bit integers.
include Floatable.S with type t := t
val of_float : float -> tval to_float : t -> floatinclude Intable.S with type t := t
val of_int_exn : int -> tval to_int_exn : t -> intinclude Identifiable.S with type t := t
include Stringable.S with type t := t
val of_string : string -> tval to_string : t -> stringinclude Comparable.S with type t := t
include Comparisons.S with type t := t
val equal : t -> t -> boolval compare : t -> t -> 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 ascending : t -> t -> 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 -> t -> intval between : t -> low:t -> high:t -> boolbetween t ~low ~high means low <= t <= high
val clamp_exn : t -> min:t -> max:t -> tclamp_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 Comparable.With_zero with type t := t
val is_positive : t -> boolval is_non_negative : t -> boolval is_negative : t -> boolval is_non_positive : t -> boolReturns Neg, Zero, or Pos in a way consistent with the above functions.
val compare__local : t -> t -> intval equal__local : t -> t -> boolval of_string_opt : string -> t optionval to_string_hum : ?delimiter:char -> t -> 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.
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 ] ->
t ->
to_multiple_of:t ->
tval round_towards_zero : t -> to_multiple_of:t -> tval round_down : t -> to_multiple_of:t -> tval round_up : t -> to_multiple_of:t -> tval round_nearest : t -> to_multiple_of:t -> tSuccessor and predecessor functions
Exponentiation
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 -> tThese are identical to land, lor, etc. except they're not infix and have different names.
val bit_xor : t -> t -> tReturns 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 -> int -> tShifts left, filling in with zeroes.
val shift_right : t -> int -> tShifts right, preserving the sign of the input.
Increment and decrement functions for integer references
val of_int32_exn : int32 -> tval to_int32_exn : t -> int32val of_int64_exn : int64 -> tval to_int64 : t -> int64val of_nativeint_exn : nativeint -> tval to_nativeint_exn : t -> nativeintval of_float_unchecked : float -> tof_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 : t -> int -> tShifts right, filling in with zeroes, which will not preserve the sign of the input.
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
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
ceil_log2 x returns the ceiling of log-base-2 of x, and raises if x <= 0.
val floor_log2 : t -> intfloor_log2 x returns the floor of log-base-2 of x, and raises if x <= 0.
is_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 (<>) : t -> t -> boolval (<=) : t -> t -> boolval (>=) : t -> t -> boolval (//) : t -> t -> floatval (lsl) : t -> int -> tval (asr) : t -> int -> tval (lsr) : t -> int -> tConversion functions
val of_int32 : int32 -> tval to_int : t -> int optionval to_int32 : t -> int32 optionval of_nativeint : nativeint -> tval to_nativeint : t -> nativeint optionTruncating 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_int_trunc : t -> intval to_int32_trunc : int64 -> int32val to_nativeint_trunc : int64 -> nativeintLow-level float conversions
val bits_of_float : float -> int64bits_of_float will always allocate its result on the heap unless the _unboxed C function call is chosen by the compiler.
val float_of_bits : int64 -> floatfloat_of_bits will always allocate its result on the heap unless the _unboxed C function call is chosen by the compiler.
Byte swap operations
See Int's byte swap section for a description of Base's approach to exposing byte swap primitives.
As of writing, these operations do not sign extend unnecessarily on 64 bit machines, unlike their int32 counterparts, and hence, are more performant. See the Int32 module for more details of the overhead entailed by the int32 byteswap functions.