Module Base__Int
include Base__.Int_intf.Int_without_module_types
include Base__.Int_intf.S with type t = int
val of_float : float -> t
val to_float : t -> float
val of_int_exn : int -> t
val to_int_exn : t -> int
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
val t_of_sexp : Base.Sexp.t -> t
val sexp_of_t : t -> Base.Sexp.t
val of_string : string -> t
val to_string : t -> string
val (>=) : t -> t -> bool
val (<=) : t -> t -> bool
val (=) : t -> t -> bool
val (>) : t -> t -> bool
val (<) : t -> t -> bool
val (<>) : t -> t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int
val descending : t -> t -> int
val between : t -> low:t -> high:t -> bool
val clamp_exn : t -> min:t -> max:t -> t
val clamp : t -> min:t -> max:t -> t Base.Or_error.t
val comparator : (t, comparator_witness) Base.Comparator.comparator
val validate_lbound : min:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_ubound : max:t Base.Maybe_bound.t -> t Base.Validate.check
val validate_bound : min:t Base.Maybe_bound.t -> max:t Base.Maybe_bound.t -> t Base.Validate.check
val pp : Base.Formatter.t -> t -> unit
val validate_positive : t Base.Validate.check
val validate_non_negative : t Base.Validate.check
val validate_negative : t Base.Validate.check
val validate_non_positive : t Base.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
module Hex : sig ... end
val to_string_hum : ?delimiter:char -> t -> string
delimiter
is an underscore by default.
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 neg : t -> t
val (~-) : t -> t
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.
val round : ?dir:[ `Down | `Nearest | `Up | `Zero ] -> t -> to_multiple_of:t -> t
val round_towards_zero : t -> to_multiple_of:t -> t
val round_down : t -> to_multiple_of:t -> t
val round_up : t -> to_multiple_of:t -> t
val round_nearest : t -> to_multiple_of:t -> t
val abs : t -> t
Returns the absolute value of the argument. May be negative if the input is
min_value
.
val succ : t -> t
val pred : t -> t
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.
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.
val decr : t Caml.ref -> unit
val incr : t Caml.ref -> unit
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
.
module O : sig ... end
A sub-module designed to be opened to make working with ints more convenient.
val 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
val of_int : int -> t
val to_int : t -> int
val of_int32 : int32 -> t option
val to_int32 : t -> int32 option
val of_int64 : int64 -> t option
val of_nativeint : nativeint -> t option
val 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
.
module type Hexable = sig ... end
module type Int_without_module_types = sig ... end
module type Operators = sig ... end
module type Operators_unbounded = sig ... end
module type Round = sig ... end
module type S = sig ... end
module type S_common = sig ... end
module type S_unbounded = sig ... end