package core
Install
Dune Dependency
Authors
Maintainers
Sources
md5=743a141234e04210e295980f7a78a6d9
sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f
doc/core/Core/Int/index.html
Module Core.Int
Source
This module extends Base.Int
.
include Sexplib0.Sexpable.S with type t := int
include Base.Identifiable.S
with type t := int
with type comparator_witness = Base.Int.comparator_witness
include Sexplib0.Sexpable.S with type t := int
include Base.Stringable.S with type t := int
include Base.Comparable.S
with type t := int
with type comparator_witness = Base.Int.comparator_witness
include Base.Comparisons.S with type t := int
include Base.Comparisons.Infix with type t := int
include Base.Comparator.S
with type t := int
with type comparator_witness = Base.Int.comparator_witness
include Base.Pretty_printer.S with type t := int
include Base.Comparable.With_zero with type t := int
Returns Neg
, Zero
, or Pos
in a way consistent with the above functions.
include Base.Invariant.S with type t := int
delimiter
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.
Successor 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
These are identical to land
, lor
, etc. except they're not infix and have different names.
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
.
Shifts left, filling in with zeroes.
Shifts right, preserving the sign of the input.
Increment and decrement functions for integer references
Conversion functions to related integer types
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.
Shifts 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
.
floor_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
.
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
Truncating conversions
These functions return the least-significant bits of the input. In cases where optional conversions return Some x
, truncating conversions return x
.
Byte 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 := int
and type comparator_witness := comparator_witness
include Int_intf.Extension
with type t := int
with type comparator_witness := comparator_witness
include Bin_prot.Binable.S with type t := int
include Bin_prot.Binable.S_only_functions with type t := int
include Int_intf.Binaryable with type t := int
include Base.Int.Binaryable with type t := int and module Binary := Binary
include Int_intf.Hexable with type t := int
include Base.Int.Hexable with type t := int and module Hex := Hex
include Identifiable.S
with type t := int
with type comparator_witness := comparator_witness
include Bin_prot.Binable.S with type t := int
include Bin_prot.Binable.S_only_functions with type t := int
include Ppx_hash_lib.Hashable.S with type t := int
include Sexplib0.Sexpable.S with type t := int
include Ppx_compare_lib.Comparable.S with type t := int
include Ppx_hash_lib.Hashable.S with type t := int
include Base.Pretty_printer.S with type t := int
include Comparable.S_binable
with type t := int
with type comparator_witness := comparator_witness
include Base.Comparable.S
with type t := int
with type comparator_witness := comparator_witness
include Base.Comparisons.S with type t := 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
.
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.
between t ~low ~high
means low <= t <= high
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 Base.Comparator.S
with type t := int
with type comparator_witness := comparator_witness
include Comparator.S
with type t := int
with type comparator_witness := comparator_witness
module Map :
Map.S_binable
with type Key.t = int
with type Key.comparator_witness = comparator_witness
module Set :
Set.S_binable
with type Elt.t = int
with type Elt.comparator_witness = comparator_witness
include Quickcheckable.S_int with type t := int
include Quickcheck_intf.S_range with type t := int
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.
module Stable :
Int_intf.Stable
with type V1.t = int
and type V1.comparator_witness = comparator_witness
include sig ... end
include Bin_prot.Binable.S_local with type t := t
include Bin_prot.Binable.S_local_only_functions with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
This function only needs implementation if t
exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t
afterwards.
- Infix operators and constants
- Other common functions
- Successor and predecessor functions
- Exponentiation
- Bit-wise logical operations
- Bit-shifting operations
- Increment and decrement functions for integer references
- Conversion functions to related integer types
- Conversion functions
- Byte swap operations