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.Int63 end

Interface from Base

include module type of struct include Base.Int63 end with module Hex := Base.Int63.Hex
type t = Base__.Int63_backend.t
val of_float : float -> t
val to_float : t -> float
val of_int_exn : int -> t
val to_int_exn : t -> int
type comparator_witness = Base__Int63.comparator_witness
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
val to_string_hum : ?delimiter:char -> t -> string
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
val (~-) : t -> t
val (/%) : t -> t -> t
val (%) : t -> t -> t
val (/) : t -> t -> t
val rem : t -> t -> t
val (//) : t -> t -> float
val (land) : t -> t -> t
val (lor) : t -> t -> t
val (lxor) : t -> t -> t
val lnot : t -> t
val (lsl) : t -> int -> t
val (asr) : t -> int -> t
val succ : t -> t
val pred : t -> t
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
val pow : t -> t -> t
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
val shift_left : t -> int -> t
val shift_right : t -> int -> t
val decr : t Base__.Import.ref -> unit
val incr : t Base__.Import.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
val num_bits : int
val max_value : t
val min_value : t
val (lsr) : t -> int -> t
val shift_right_logical : t -> int -> t
module O = Core.Int63.O
module Overflow_exn = Core.Int63.Overflow_exn
val of_int : int -> t
val to_int : t -> int option
val of_int32 : Base__.Int32.t -> t
val random : ?state:Base__.Random.State.t -> t -> t
val random_incl : ?state:Base__.Random.State.t -> t -> t -> t
module Private = Core.Int63.Private

Extensions

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.Int63.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
val of_string : string -> t
val to_string : t -> string
val pp : Base__.Import.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
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 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.Int63.Replace_polymorphic_compare
include Core_kernel.Comparator.S with type t := t with type comparator_witness := comparator_witness
module Map = Core.Int63.Map
module Set = Core.Int63.Set
include Core_kernel.Hashable.S_binable with type t := t
include sig ... end
val hash_fold_t : Ppx_hash_lib.Std.Hash.state -> t -> Ppx_hash_lib.Std.Hash.state
val hash : t -> Ppx_hash_lib.Std.Hash.hash_value
val hashable : t Core_kernel__.Hashtbl.Hashable.t
module Table = Core.Int63.Table
module Hash_set = Core.Int63.Hash_set
module Hash_queue = Core.Int63.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.Int63.Stable
include module type of struct include Extended_int63 end
include Number.Verified_std with type repr = Core.Int63.t
type repr = Core.Int63.t
module type S = Extended_int63.S

Abbreviations

module type S0 = Extended_int63.S0
module Pos = Extended_int63.Pos

Positive and negative numbers with and without zero.

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

Specification of bounded numbers

module type Bounded = Extended_int63.Bounded

Signature of bounded numbers

module Make_bounded = Extended_int63.Make_bounded

Functor of creating bounded numbers

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

module Pos_unsafe = Extended_int63.Pos_unsafe
module Pos0_unsafe = Extended_int63.Pos0_unsafe
module Neg_unsafe = Extended_int63.Neg_unsafe
module Neg0_unsafe = Extended_int63.Neg0_unsafe
module Make_bounded_unsafe = Extended_int63.Make_bounded_unsafe
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