package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type

This module extends Base.Int32.

Interface from Base

val globalize : int32 -> int32
val t_sexp_grammar : int32 Sexplib0.Sexp_grammar.t
val of_float : float -> int32
val to_float : int32 -> float
val of_int_exn : int -> int32
val to_int_exn : int32 -> int
type comparator_witness = Base__Int32.comparator_witness
val is_positive : int32 -> bool
val is_non_negative : int32 -> bool
val is_negative : int32 -> bool
val is_non_positive : int32 -> bool
val sign : int32 -> Base__Comparable_intf.Sign.t
val compare__local : int32 Base__Ppx_compare_lib.compare__local
val equal__local : int32 Base__Ppx_compare_lib.equal__local
val invariant : int32 Base__Invariant_intf.inv
val of_string_opt : string -> int32 option
val to_string_hum : ?delimiter:char -> int32 -> string
val zero : int32
val one : int32
val minus_one : int32
val (+) : int32 -> int32 -> int32
val (-) : int32 -> int32 -> int32
val (*) : int32 -> int32 -> int32
val (**) : int32 -> int32 -> int32
val neg : int32 -> int32
val (~-) : int32 -> int32
val (/%) : int32 -> int32 -> int32
val (%) : int32 -> int32 -> int32
val (/) : int32 -> int32 -> int32
val rem : int32 -> int32 -> int32
val (//) : int32 -> int32 -> float
val (land) : int32 -> int32 -> int32
val (lor) : int32 -> int32 -> int32
val (lxor) : int32 -> int32 -> int32
val lnot : int32 -> int32
val (lsl) : int32 -> int -> int32
val (asr) : int32 -> int -> int32
val round : ?dir:[ `Down | `Nearest | `Up | `Zero ] -> int32 -> to_multiple_of:int32 -> int32
val round_towards_zero : int32 -> to_multiple_of:int32 -> int32
val round_down : int32 -> to_multiple_of:int32 -> int32
val round_up : int32 -> to_multiple_of:int32 -> int32
val round_nearest : int32 -> to_multiple_of:int32 -> int32
val abs : int32 -> int32
val succ : int32 -> int32
val pred : int32 -> int32
val pow : int32 -> int32 -> int32
val bit_and : int32 -> int32 -> int32
val bit_or : int32 -> int32 -> int32
val bit_xor : int32 -> int32 -> int32
val bit_not : int32 -> int32
val popcount : int32 -> int
val shift_left : int32 -> int -> int32
val shift_right : int32 -> int -> int32
val decr : int32 Base__.Import.ref -> unit
val incr : int32 Base__.Import.ref -> unit
val of_int32_exn : int32 -> int32
val to_int32_exn : int32 -> int32
val of_int64_exn : int64 -> int32
val to_int64 : int32 -> int64
val of_nativeint_exn : nativeint -> int32
val to_nativeint_exn : int32 -> nativeint
val of_float_unchecked : float -> int32
val num_bits : int
val max_value : int32
val min_value : int32
val (lsr) : int32 -> int -> int32
val shift_right_logical : int32 -> int -> int32
val ceil_pow2 : int32 -> int32
val floor_pow2 : int32 -> int32
val ceil_log2 : int32 -> int
val floor_log2 : int32 -> int
val is_pow2 : int32 -> bool
val clz : int32 -> int
val ctz : int32 -> int
module O : sig ... end
val of_int : int -> int32 option
val to_int : int32 -> int option
val of_int32 : int32 -> int32
val to_int32 : int32 -> int32
val of_nativeint : nativeint -> int32 option
val to_nativeint : int32 -> nativeint
val of_int64 : int64 -> int32 option
val of_int_trunc : int -> int32
val to_int_trunc : int32 -> int
val of_nativeint_trunc : nativeint -> int32
val of_int64_trunc : int64 -> int32
val bits_of_float : float -> int32
val float_of_bits : int32 -> float
val bswap16 : int32 -> int32
val bswap32 : int32 -> int32

Extensions

include Bin_prot.Binable.S with type t := {t}1
include Bin_prot.Binable.S_only_functions with type t := {t}1
include Typerep_lib.Typerepable.S with type t := {t}1
val typerep_of_t : {t}1 Typerep_lib.Std_internal.Typerep.t
val typename_of_t : {t}1 Typerep_lib.Typename.t
include Int_intf.Binaryable with type t := {t}1
module Binary : sig ... end
include Base.Int.Binaryable with type t := {t}1 and module Binary := Binary
include Int_intf.Hexable with type t := {t}1
module Hex : sig ... end
include Base.Int.Hexable with type t := {t}1 and module Hex := Hex
include Identifiable.S with type t := {t}1 with type comparator_witness := comparator_witness
include Bin_prot.Binable.S with type t := {t}1
include Bin_prot.Binable.S_only_functions with type t := {t}1
include Ppx_hash_lib.Hashable.S with type t := {t}1
include Sexplib0.Sexpable.S with type t := {t}1
val t_of_sexp : Sexplib0__.Sexp.t -> {t}1
include Ppx_compare_lib.Comparable.S with type t := {t}1
include Ppx_hash_lib.Hashable.S with type t := {t}1
val sexp_of_t : {t}1 -> Sexplib0.Sexp.t
val of_string : string -> {t}1
val to_string : {t}1 -> string
val pp : Base__.Formatter.t -> {t}1 -> unit
include Comparable.S_binable with type t := {t}1 with type comparator_witness := comparator_witness
include Base.Comparable.S with type t := {t}1 with type comparator_witness := comparator_witness
val (>=) : {t}1 -> {t}1 -> bool
val (<=) : {t}1 -> {t}1 -> bool
val (=) : {t}1 -> {t}1 -> bool
val (>) : {t}1 -> {t}1 -> bool
val (<) : {t}1 -> {t}1 -> bool
val (<>) : {t}1 -> {t}1 -> bool
val equal : {t}1 -> {t}1 -> bool
val compare : {t}1 -> {t}1 -> int
val min : {t}1 -> {t}1 -> {t}1
val max : {t}1 -> {t}1 -> {t}1
val ascending : {t}1 -> {t}1 -> int
val descending : {t}1 -> {t}1 -> int
val between : {t}1 -> low:{t}1 -> high:{t}1 -> bool
val clamp_exn : {t}1 -> min:{t}1 -> max:{t}1 -> {t}1
val clamp : {t}1 -> min:{t}1 -> max:{t}1 -> {t}1 Base__.Or_error.t
module Replace_polymorphic_compare : sig ... end
include Comparator.S with type t := {t}1 with type comparator_witness := comparator_witness
val comparator : ({t}1, comparator_witness) Comparator.comparator
module Map : Map.S_binable with type Key.t = {t}1 with type Key.comparator_witness = comparator_witness
module Set : Set.S_binable with type Elt.t = {t}1 with type Elt.comparator_witness = comparator_witness
include Hashable.S_binable with type t := {t}1
include Ppx_hash_lib.Hashable.S with type t := {t}1
val hash_fold_t : {t}1 Base__Ppx_hash_lib.hash_fold
val hash : {t}1 -> Base__Ppx_hash_lib.Std.Hash.hash_value
val hashable : {t}1 Core__.Hashtbl.Hashable.t
module Table : Hashtbl.S_binable with type key = {t}1
module Hash_set : Hash_set.S_binable with type elt = {t}1
module Hash_queue : Hash_queue.S with type key = {t}1
include Comparable.Validate_with_zero with type t := {t}1
val validate_lbound : min:{t}1 Maybe_bound.t -> {t}1 Validate.check
val validate_ubound : max:{t}1 Maybe_bound.t -> {t}1 Validate.check
val validate_bound : min:{t}1 Maybe_bound.t -> max:{t}1 Maybe_bound.t -> {t}1 Validate.check
val validate_positive : {t}1 Validate.check
val validate_non_negative : {t}1 Validate.check
val validate_negative : {t}1 Validate.check
val validate_non_positive : {t}1 Validate.check
include Quickcheckable.S_int with type t := {t}1
include Quickcheck_intf.S_range with type t := {t}1
include Quickcheck_intf.S with type t := {t}1
val quickcheck_generator : {t}1 Base_quickcheck.Generator.t
val quickcheck_observer : {t}1 Base_quickcheck.Observer.t
val quickcheck_shrinker : {t}1 Base_quickcheck.Shrinker.t
val gen_incl : {t}1 -> {t}1 -> {t}1 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.

val gen_uniform_incl : {t}1 -> {t}1 -> {t}1 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.

val gen_log_uniform_incl : {t}1 -> {t}1 -> {t}1 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).

val gen_log_incl : {t}1 -> {t}1 -> {t}1 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
type nonrec t = {t}1
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
val bin_size_t : t Bin_prot.Size.sizer
val bin_write_t : t Bin_prot.Write.writer
val bin_read_t : t Bin_prot.Read.reader
val __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.

val bin_size_t__local : t Bin_prot.Size.sizer_local
val bin_write_t__local : t Bin_prot.Write.writer_local
val bin_shape_t : Bin_prot.Shape.t
val bin_writer_t : t Bin_prot.Type_class.writer
val bin_reader_t : t Bin_prot.Type_class.reader
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