package core

  1. Overview
  2. Docs
Industrial strength alternative to OCaml's standard library

Install

Dune Dependency

Authors

Maintainers

Sources

v0.17.1.tar.gz
md5=743a141234e04210e295980f7a78a6d9
sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f

doc/core/Core/Int/index.html

Module Core.IntSource

This module extends Base.Int.

Sourceval globalize : int -> int
include Sexplib0.Sexpable.S with type t := int
Sourceval t_sexp_grammar : int Sexplib0.Sexp_grammar.t
include Base.Floatable.S with type t := int
Sourceval of_float : float -> int
Sourceval to_float : int -> float
include Base.Intable.S with type t := int
Sourceval of_int_exn : int -> int
Sourceval to_int_exn : int -> 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
Sourcetype comparator_witness = Base.Int.comparator_witness
include Base.Pretty_printer.S with type t := int
include Base.Comparable.With_zero with type t := int
Sourceval is_positive : int -> bool
Sourceval is_non_negative : int -> bool
Sourceval is_negative : int -> bool
Sourceval is_non_positive : int -> bool
Sourceval sign : int -> Base.Sign.t

Returns Neg, Zero, or Pos in a way consistent with the above functions.

Sourceval compare__local : int -> int -> int
Sourceval equal__local : int -> int -> bool
include Base.Invariant.S with type t := int
Sourceval invariant : int -> unit
Sourceval of_string_opt : string -> int option
Sourceval to_string_hum : ?delimiter:char -> int -> string

delimiter is an underscore by default.

Infix operators and constants

Sourceval one : int
Sourceval minus_one : int

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.

Sourceval rem : int -> int -> int

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 ] -> int -> to_multiple_of:int -> int
Sourceval round_towards_zero : int -> to_multiple_of:int -> int
Sourceval round_down : int -> to_multiple_of:int -> int
Sourceval round_up : int -> to_multiple_of:int -> int
Sourceval round_nearest : int -> to_multiple_of:int -> int

Successor and predecessor functions

Sourceval succ : int -> int
Sourceval pred : int -> int

Exponentiation

Sourceval pow : int -> int -> int

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 : int -> int -> int

These are identical to land, lor, etc. except they're not infix and have different names.

Sourceval bit_or : int -> int -> int
Sourceval bit_xor : int -> int -> int
Sourceval bit_not : int -> int
Sourceval popcount : int -> 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 : int -> int -> int

Shifts left, filling in with zeroes.

Sourceval shift_right : int -> int -> int

Shifts right, preserving the sign of the input.

Increment and decrement functions for integer references

Sourceval decr : int ref -> unit
Sourceval incr : int ref -> unit
Sourceval of_int32_exn : int32 -> int
Sourceval to_int32_exn : int -> int32
Sourceval of_int64_exn : int64 -> int
Sourceval to_int64 : int -> int64
Sourceval of_nativeint_exn : nativeint -> int
Sourceval to_nativeint_exn : int -> nativeint
Sourceval of_float_unchecked : float -> int

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.

Sourceval num_bits : int

The number of bits available in this integer type. Note that the integer representations are signed.

Sourceval max_value : int

The largest representable integer.

Sourceval min_value : int

The smallest representable integer.

Sourceval shift_right_logical : int -> int -> int

Shifts right, filling in with zeroes, which will not preserve the sign of the input.

Sourceval ceil_pow2 : int -> int

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 : int -> int

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 : int -> int

ceil_log2 x returns the ceiling of log-base-2 of x, and raises if x <= 0.

Sourceval floor_log2 : int -> int

floor_log2 x returns the floor of log-base-2 of x, and raises if x <= 0.

Sourceval is_pow2 : int -> bool

is_pow2 x returns true iff x is a power of 2. is_pow2 raises if x <= 0.

Sourceval clz : int -> 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.

Sourceval ctz : int -> 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.

Sourcemodule O : sig ... end
include module type of O
Sourceval (+) : int -> int -> int
Sourceval (-) : int -> int -> int
Sourceval (*) : int -> int -> int
Sourceval (/) : int -> int -> int
Sourceval (~-) : int -> int
Sourceval (**) : int -> int -> int
Sourceval (land) : int -> int -> int
Sourceval (lor) : int -> int -> int
Sourceval (lxor) : int -> int -> int
Sourceval lnot : int -> int
Sourceval abs : int -> int
Sourceval neg : int -> int
Sourceval zero : int
Sourceval (%) : int -> int -> int
Sourceval (/%) : int -> int -> int
Sourceval (//) : int -> int -> float
Sourceval (lsl) : int -> int -> int
Sourceval (asr) : int -> int -> int
Sourceval (lsr) : int -> int -> int
Sourceval max_value_30_bits : int

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

Sourceval of_int : int -> int
Sourceval to_int : int -> int
Sourceval of_int32 : int32 -> int option
Sourceval to_int32 : int -> int32 option
Sourceval of_int64 : int64 -> int option
Sourceval of_nativeint : nativeint -> int option
Sourceval to_nativeint : int -> 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.

Sourceval to_int32_trunc : int -> int32
Sourceval of_int32_trunc : int32 -> int
Sourceval of_int64_trunc : int64 -> int
Sourceval of_nativeint_trunc : nativeint -> int

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.

Sourceval bswap16 : int -> int

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 Typerep_lib.Typerepable.S with type t := int
Sourceval typename_of_t : int Typerep_lib.Typename.t
include Int_intf.Binaryable with type t := int
Sourcemodule Binary : sig ... end
include Base.Int.Binaryable with type t := int and module Binary := Binary
include Int_intf.Hexable with type t := int
Sourcemodule Hex : sig ... end
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
Sourceval t_of_sexp : Sexplib0.Sexp.t -> int
include Ppx_compare_lib.Comparable.S with type t := int
include Ppx_hash_lib.Hashable.S with type t := int
Sourceval sexp_of_t : int -> Sexplib0.Sexp.t
include Base.Stringable.S with type t := int
Sourceval of_string : string -> int
Sourceval to_string : int -> string
include Base.Pretty_printer.S with type t := int
Sourceval pp : Base.Formatter.t -> int -> unit
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
include Base.Comparisons.Infix with type t := int
Sourceval (>=) : int -> int -> bool
Sourceval (<=) : int -> int -> bool
Sourceval (=) : int -> int -> bool
Sourceval (>) : int -> int -> bool
Sourceval (<) : int -> int -> bool
Sourceval (<>) : int -> int -> bool
Sourceval equal : int -> int -> bool
Sourceval compare : int -> int -> 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 : int -> int -> int
Sourceval max : int -> int -> int
Sourceval ascending : int -> int -> 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 : int -> int -> int
Sourceval between : int -> low:int -> high:int -> bool

between t ~low ~high means low <= t <= high

Sourceval clamp_exn : int -> min:int -> max:int -> int

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).

Sourceval clamp : int -> min:int -> max:int -> int Base.Or_error.t
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
include Hashable.S_binable with type t := int
include Ppx_hash_lib.Hashable.S with type t := int
Sourceval hash_fold_t : Base.Hash.state -> int -> Base.Hash.state
Sourceval hash : int -> Base.Hash.hash_value
Sourceval hashable : int Base.Hashable.t
Sourcemodule Table : Hashtbl.S_binable with type key = int
Sourcemodule Hash_set : Hash_set.S_binable with type elt = int
Sourcemodule Hash_queue : Hash_queue.S with type key = int
include Comparable.Validate_with_zero with type t := int
Sourceval validate_lbound : min:int Maybe_bound.t -> int Validate.check
Sourceval validate_ubound : max:int Maybe_bound.t -> int Validate.check
Sourceval validate_bound : min:int Maybe_bound.t -> max:int Maybe_bound.t -> int Validate.check
Sourceval validate_positive : int Validate.check
Sourceval validate_non_negative : int Validate.check
Sourceval validate_negative : int Validate.check
Sourceval validate_non_positive : int Validate.check
include Quickcheckable.S_int with type t := int
include Quickcheck_intf.S_range with type t := int
include Quickcheck_intf.S with type t := int
Sourceval quickcheck_generator : int Base_quickcheck.Generator.t
Sourceval quickcheck_observer : int Base_quickcheck.Observer.t
Sourceval quickcheck_shrinker : int Base_quickcheck.Shrinker.t
Sourceval gen_incl : int -> int -> int Base_quickcheck.Generator.t

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.

Sourceval gen_uniform_incl : int -> int -> int Base_quickcheck.Generator.t

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.

Sourceval gen_log_uniform_incl : int -> int -> int Base_quickcheck.Generator.t

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).

Sourceval gen_log_incl : int -> int -> int Base_quickcheck.Generator.t

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.

include sig ... end
Sourcetype nonrec t = int
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
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

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.

Sourceval bin_size_t__local : t Bin_prot.Size.sizer_local
Sourceval bin_write_t__local : t Bin_prot.Write.writer_local
Sourceval bin_shape_t : Bin_prot.Shape.t
OCaml

Innovation. Community. Security.