Module Core.Int32Source
This module extends Base.Int32.
Interface from Base
Sourceval globalize : int32 -> int32 include Base.Comparable.With_zero with type t := int32
Sourceval is_positive : int32 -> bool Sourceval is_non_negative : int32 -> bool Sourceval is_negative : int32 -> bool Sourceval is_non_positive : int32 -> bool Returns Neg, Zero, or Pos in a way consistent with the above functions.
Sourceval compare__local : int32 -> int32 -> int Sourceval equal__local : int32 -> int32 -> bool Sourceval of_string_opt : string -> int32 option Sourceval to_string_hum : ?delimiter:char -> int32 -> string delimiter is an underscore by default.
Infix operators and constants
Sourceval (+) : int32 -> int32 -> int32 Sourceval (-) : int32 -> int32 -> int32 Sourceval (*) : int32 -> int32 -> int32 Sourceval (**) : int32 -> int32 -> int32 Negation
Sourceval neg : int32 -> int32 Sourceval (~-) : 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.
Sourceval (/%) : int32 -> int32 -> int32 Sourceval (%) : int32 -> int32 -> int32 Sourceval (/) : int32 -> int32 -> int32 Sourceval rem : int32 -> int32 -> int32 Sourceval (//) : int32 -> int32 -> float Float division of integers.
Sourceval (land) : int32 -> int32 -> int32 Sourceval (lor) : int32 -> int32 -> int32 Sourceval (lxor) : int32 -> int32 -> int32 Sourceval lnot : int32 -> int32 Sourceval (lsl) : int32 -> int -> int32 Sourceval (asr) : int32 -> int -> int32 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 ] ->
int32 ->
to_multiple_of:int32 ->
int32 Sourceval round_towards_zero : int32 -> to_multiple_of:int32 -> int32 Sourceval round_down : int32 -> to_multiple_of:int32 -> int32 Sourceval round_up : int32 -> to_multiple_of:int32 -> int32 Sourceval round_nearest : int32 -> to_multiple_of:int32 -> int32 Sourceval abs : int32 -> int32 Returns the absolute value of the argument. May be negative if the input is min_value.
Successor and predecessor functions
Sourceval succ : int32 -> int32 Sourceval pred : int32 -> int32 Exponentiation
Sourceval 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
Sourceval bit_and : int32 -> int32 -> int32 These are identical to land, lor, etc. except they're not infix and have different names.
Sourceval bit_or : int32 -> int32 -> int32 Sourceval bit_xor : int32 -> int32 -> int32 Sourceval bit_not : int32 -> int32 Sourceval 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.
Sourceval shift_left : int32 -> int -> int32 Shifts left, filling in with zeroes.
Sourceval shift_right : int32 -> int -> int32 Shifts right, preserving the sign of the input.
Increment and decrement functions for integer references
Sourceval of_int32_exn : int32 -> int32 Sourceval to_int32_exn : int32 -> int32 Sourceval of_int64_exn : int64 -> int32 Sourceval to_int64 : int32 -> int64 Sourceval of_nativeint_exn : nativeint -> int32 Sourceval to_nativeint_exn : int32 -> nativeint Sourceval 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.
The number of bits available in this integer type. Note that the integer representations are signed.
The largest representable integer.
The smallest representable integer.
Sourceval (lsr) : int32 -> int -> int32 Same as shift_right_logical.
Sourceval shift_right_logical : int32 -> int -> int32 Shifts right, filling in with zeroes, which will not preserve the sign of the input.
Sourceval 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
Sourceval 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
Sourceval ceil_log2 : int32 -> int ceil_log2 x returns the ceiling of log-base-2 of x, and raises if x <= 0.
Sourceval floor_log2 : int32 -> int floor_log2 x returns the floor of log-base-2 of x, and raises if x <= 0.
Sourceval is_pow2 : int32 -> bool 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.
A sub-module designed to be opened to make working with ints more convenient.
Conversion functions
Sourceval of_int : int -> int32 option Sourceval to_int : int32 -> int option Sourceval of_int32 : int32 -> int32 Sourceval to_int32 : int32 -> int32 Sourceval of_nativeint : nativeint -> int32 option Sourceval to_nativeint : int32 -> nativeint Sourceval 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.
Sourceval of_int_trunc : int -> int32 Sourceval to_int_trunc : int32 -> int Sourceval of_nativeint_trunc : nativeint -> int32 Sourceval of_int64_trunc : int64 -> int32 Low-level float conversions
Sourceval 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.
Sourceval 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
Sourceval bswap16 : int32 -> int32 Sourceval bswap32 : int32 -> int32 Extensions
include Identifiable.S
with type t := int32
with type comparator_witness := comparator_witness
include Comparable.S_binable
with type t := int32
with type comparator_witness := comparator_witness
include Base.Comparable.S
with type t := int32
with type comparator_witness := comparator_witness
include Base.Comparisons.S with type t := int32
Sourceval equal : int32 -> int32 -> bool Sourceval compare : int32 -> int32 -> 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.
Sourceval min : int32 -> int32 -> int32 Sourceval max : int32 -> int32 -> int32 Sourceval ascending : int32 -> int32 -> 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.
Sourceval descending : int32 -> int32 -> int Sourceval between : int32 -> low:int32 -> high:int32 -> bool between t ~low ~high means low <= t <= high
Sourceval clamp_exn : int32 -> min:int32 -> max:int32 -> int32 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).
include Quickcheckable.S_int with type t := int32
include Quickcheck_intf.S_range with type t := int32
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.