package core_extended

  1. Overview
  2. Docs
package core_extended
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of struct include Core.Int end

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 module type of struct include Base.Int end with module Hex := Base.Int.Hex
include Base.Int_intf.S with type t = int with module Hex := Base.Int.Hex
include Base.Int_intf.S_common with type t = int with module Hex := Base.Int.Hex
type t = int
include sig ... end
include Base.Floatable.S with type t := t
val of_float : float -> t
val to_float : t -> float
include Base.Intable.S with type t := t
val of_int_exn : int -> t
val to_int_exn : t -> int
include Base.Identifiable.S with type t := t
include sig ... end
include Base.Stringable.S with type t := t
include Base.Comparable.S with type t := t
include Base.Comparable_intf.Polymorphic_compare with type t := t
include Base.Comparisons.Infix with type t := t
include Base.Comparator.S with type t := t
type comparator_witness = Core.Int.comparator_witness
include Base.Comparable_intf.Validate with type t := t
include Base.Pretty_printer.S with type t := t
include Base.Comparable.With_zero with type t := t
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

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

include Base.Int_intf.Hexable with type t := t with module Hex := Base.Int.Hex
val to_string_hum : ?delimiter:char -> t -> string

delimiter is 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 neg : t -> t

Negation

val (~-) : t -> t
val (/%) : t -> t -> t

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.

val (%) : t -> t -> t
val (/) : t -> t -> t
val rem : t -> t -> t
val (//) : t -> t -> float

float division of integers

val (land) : t -> t -> t

Same as bit_and

val (lor) : t -> t -> t

Same as bit_or

val (lxor) : t -> t -> t

Same as bit_xor

val lnot : t -> t

Same as bit_not

val (lsl) : t -> int -> t

Same as shift_left

val (asr) : t -> int -> t

Same as shift_right

Successor and predecessor functions
val succ : t -> t
val pred : t -> t
include Base.Int_intf.Round with type t := t

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.

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

val round : ?dir:[ `Zero | `Nearest | `Up | `Down ] -> 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

Exponentiation
val pow : t -> t -> t

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
val bit_and : t -> t -> t
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

The results are unspecified for negative shifts and shifts >= num_bits

val shift_left : t -> int -> t

shifts left, filling in with zeroes

val shift_right : t -> int -> t

shifts right, preserving the sign of the input.

Increment and decrement functions for integer references
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 (lsr) : t -> int -> t

Same as shift_right_logical

val shift_right_logical : t -> int -> t

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

module O = Core.Int.O

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.

val 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

val 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

val ceil_log2 : int -> int

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

val floor_log2 : int -> int

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

val is_pow2 : int -> bool

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

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
include Core_kernel.Int_intf.Extension_with_stable with type t := t and type comparator_witness := comparator_witness
include Core_kernel.Int_intf.Extension with type t := t with type comparator_witness := comparator_witness
include sig ... end
val typerep_of_t : t Typerep_lib.Std.Typerep.t
val typename_of_t : t Typerep_lib.Std.Typename.t
include Core_kernel.Int_intf.Hexable with type t := t
module Hex = Core.Int.Hex
include Core_kernel.Identifiable.S with type t := t with type comparator_witness := comparator_witness
include sig ... end
val bin_read_t : t Bin_prot.Read.reader
val __bin_read_t__ : (Base.Int.t -> t) Bin_prot.Read.reader
val bin_reader_t : t Bin_prot.Type_class.reader
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_shape_t : Bin_prot.Shape.t
val t_of_sexp : Sexplib.Sexp.t -> t
include Core_kernel.Identifiable.S_common with type t := t
include sig ... end
val sexp_of_t : t -> Sexplib.Sexp.t
include Base.Stringable.S with type t := t
val of_string : string -> t
val to_string : t -> string
include Base.Pretty_printer.S with type t := t
val pp : Caml.Format.formatter -> t -> unit
include Core_kernel.Comparable.S_binable with type t := t with type comparator_witness := comparator_witness
include Base.Comparable_intf.S with type t := t with type comparator_witness := comparator_witness
include Base.Comparable_intf.Polymorphic_compare with type t := t
include Base.Comparisons.Infix with type t := t
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

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.

val min : t -> t -> t
val max : t -> t -> t
val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~cmp:ascending and List.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
val clamp_exn : t -> min:t -> max:t -> t

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

val clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t with type comparator_witness := comparator_witness
include Base.Comparable_intf.Validate with type t := t
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
module Replace_polymorphic_compare = Core.Int.Replace_polymorphic_compare
include Core_kernel.Comparator.S with type t := t with type comparator_witness := comparator_witness
module Map = Core.Int.Map
module Set = Core.Int.Set
include Core_kernel.Hashable.S_binable with type t := t
include sig ... end
val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state
val hash : t -> Base.Hash.hash_value
module Table = Core.Int.Table
module Hash_set = Core.Int.Hash_set
module Hash_queue = Core.Int.Hash_queue
include Core_kernel.Quickcheckable.S_int with type t := t
include Core_kernel.Quickcheck_intf.S with type 'a gen := 'a Core_kernel.Quickcheck.Generator.t with type 'a obs := 'a Core_kernel.Quickcheck.Observer.t with type 'a shr := 'a Core_kernel.Quickcheck.Shrinker.t with type t := 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.

val gen_uniform_incl : t -> t -> t Core_kernel.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.

val gen_log_uniform_incl : t -> t -> t Core_kernel.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).

val gen_log_incl : t -> t -> t Core_kernel.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.

module Stable = Core.Int.Stable
include module type of struct include Extended_int end
include Number.Verified_std with type repr = Core.Int.t
type repr = Core.Int.t
module type S = Extended_int.S

Abbreviations

module type S0 = Extended_int.S0
module Pos = Extended_int.Pos

Positive and negative numbers with and without zero.

module Pos0 = Extended_int.Pos0
module Neg = Extended_int.Neg
module Neg0 = Extended_int.Neg0
module type Bounded_spec = Extended_int.Bounded_spec

Specification of bounded numbers

module type Bounded = Extended_int.Bounded

Signature of bounded numbers

module Make_bounded = Extended_int.Make_bounded

Functor of creating bounded numbers

Unsafe modules and functors that still fully expose the representation for extensibility.

module Pos_unsafe = Extended_int.Pos_unsafe
module Pos0_unsafe = Extended_int.Pos0_unsafe
module Neg_unsafe = Extended_int.Neg_unsafe
module Neg0_unsafe = Extended_int.Neg0_unsafe
module Make_bounded_unsafe = Extended_int.Make_bounded_unsafe
val gcd : int -> int -> int

Computes greatest common divisor for the given two integers, with convention that gcd 0 0 = 0.

Returns a nonnegative value unless one of the arguments is Int.min_value and the other is Int.min_value or 0, in which case Int.min_value is returned.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct