include Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
val t_sexp_grammar : Sexp.Private.Raw_grammar.t
include Floatable.S with type t := t
include Identifiable.S with type t := t
val hash_fold_t : Hash.state -> t -> Hash.state
val hash : t -> Hash.hash_value
include Sexpable.S with type t := t
val t_of_sexp : Sexplib0.Sexp.t -> t
val sexp_of_t : t -> Sexplib0.Sexp.t
include Stringable.S with type t := t
include Comparable.S with type t := t
val ascending : t -> t -> int
ascending
is identical tocompare
.descending x y = ascending y x
. These are intended to be mnemonic when used likeList.sort ~compare:ascending
andList.sort ~cmp:descending
, since they cause the list to be sorted in ascending or descending order, respectively.
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
between t ~low ~high
meanslow <= t <= high
val clamp_exn : t -> min:t -> max:t -> t
clamp_exn t ~min ~max
returnst'
, the closest value tot
such thatbetween t' ~low:min ~high:max
is true.Raises if
not (min <= max)
.
val clamp : t -> min:t -> max:t -> t Or_error.t
include Comparator.S with type t := t
val comparator : (t, comparator_witness) Comparator.comparator
val validate_lbound : min:t Maybe_bound.t -> t Validate.check
val validate_ubound : max:t Maybe_bound.t -> t Validate.check
val validate_bound : min:t Maybe_bound.t -> max:t Maybe_bound.t -> t Validate.check
include Pretty_printer.S with type t := t
val pp : Formatter.t -> t -> unit
include Comparable.With_zero with type t := t
val validate_positive : t Validate.check
val validate_non_negative : t Validate.check
val validate_negative : t Validate.check
val validate_non_positive : t Validate.check
val is_positive : t -> bool
val is_non_negative : t -> bool
val is_negative : t -> bool
val is_non_positive : t -> bool
val sign : t -> Base__Sign0.t
Returns
Neg
,Zero
, orPos
in a way consistent with the above functions.
include Invariant.S with type t := t
val invariant : t -> unit
module Hex : sig ... end
val to_string_hum : ?delimiter:char -> t -> string
delimiter
is an underscore by default.
Infix operators and constants
val zero : t
val one : t
val minus_one : t
val (+) : t -> t -> t
val (-) : t -> t -> t
val (*) : t -> t -> t
val (**) : t -> t -> t
Integer exponentiation
val (/%) : t -> t -> t
val (%) : t -> t -> t
val (/) : t -> t -> t
val rem : t -> t -> t
val (//) : t -> t -> float
Float division of integers.
Other common functions
val abs : t -> t
Returns the absolute value of the argument. May be negative if the input is
min_value
.
Successor and predecessor functions
Exponentiation
val pow : t -> t -> t
pow base exponent
returnsbase
raised to the power ofexponent
. It is OK ifbase <= 0
.pow
raises ifexponent < 0
, or an integer overflow would occur.
Bit-wise logical operations
val bit_and : t -> t -> t
These are identical to
land
,lor
, etc. except they're not infix and have different names.
val bit_or : t -> t -> t
val bit_xor : t -> t -> t
val bit_not : t -> t
val popcount : t -> int
Returns the number of 1 bits in the binary representation of the input.
Bit-shifting operations
Increment and decrement functions for integer references
Conversion functions to related integer types
val of_int32_exn : int32 -> t
val to_int32_exn : t -> int32
val of_int64_exn : int64 -> t
val to_int64 : t -> int64
val of_nativeint_exn : nativeint -> t
val to_nativeint_exn : t -> nativeint
val of_float_unchecked : float -> 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.
val num_bits : int
The number of bits available in this integer type. Note that the integer representations are signed.
val max_value : t
The largest representable integer.
val min_value : t
The smallest representable integer.
val shift_right_logical : t -> int -> t
Shifts right, filling in with zeroes, which will not preserve the sign of the input.
val ceil_pow2 : t -> t
ceil_pow2 x
returns the smallest power of 2 that is greater than or equal tox
. The implementation may only be called forx > 0
. Example:ceil_pow2 17 = 32
val floor_pow2 : t -> t
floor_pow2 x
returns the largest power of 2 that is less than or equal tox
. The implementation may only be called forx > 0
. Example:floor_pow2 17 = 16
val ceil_log2 : t -> int
ceil_log2 x
returns the ceiling of log-base-2 ofx
, and raises ifx <= 0
.
val floor_log2 : t -> int
floor_log2 x
returns the floor of log-base-2 ofx
, and raises ifx <= 0
.
val is_pow2 : t -> bool
is_pow2 x
returns true iffx
is a power of 2.is_pow2
raises ifx <= 0
.
val clz : t -> 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 : t -> 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 : sig ... end
A sub-module designed to be opened to make working with ints more convenient.