Module `Core`Source

Core greatly expands the functionality available in Base while still remaining platform-agnostic. Core changes more frequently (i.e., is less stable) than Base.

Some modules are mere extensions of their counterparts in Base, usually adding generic functionality by including functors that make them binable, comparable, sexpable, blitable, etc. The bulk of Core, though, is modules providing entirely new functionality.

module Applicative = Base.Applicative

Sourcemodule Arg : sig ... end

INRIA's original command-line parsing library.

Sourcemodule Array : sig ... end

Fixed-length, mutable vector of elements with O(1) get and set operations.

Sourcemodule Atomic : sig ... end

An atomic (mutable) reference to a value of type 'a.

Sourcemodule Avltree = Base.Avltree

Sourcemodule Backtrace = Base.Backtrace

Sourcemodule Bag : sig ... end

Sourcemodule Bigbuffer : sig ... end

Extensible string buffers based on Bigstrings.

Sourcemodule Bigstring : sig ... end

String type based on Bigarray, for use in I/O and C-bindings.

Sourcemodule Bigsubstring : sig ... end

Substring type based on Bigarray, for use in I/O and C-bindings

Sourcemodule Bin_prot : sig ... end

Sourcemodule Binable : sig ... end

Sourcemodule Binary_search = Base.Binary_search

Sourcemodule Binary_searchable : sig ... end

This module extends the Base.Binary_searchable module.

Sourcemodule Blang : sig ... end

Boolean expressions.

Sourcemodule Blit : sig ... end

This module extends Base.Blit.

Sourcemodule Bool : sig ... end

This module extends Base.Bool.

Sourcemodule Bounded_index : sig ... end

Bounded_index creates unique index types with explicit bounds and human-readable labels. "(thing 2 of 0 to 4)" refers to a 0-based index for the third element of five with the label "thing", whereas a 1-based index for the second element of twelve with the label "item" renders as "(item 2 of 1 to 12)", even though both represent the index 2.

Sourcemodule Buffer = Base.Buffer

Sourcemodule Byte_units : sig ... end

Sourcemodule Bytes : sig ... end

This module extends Base.Bytes.

Sourcemodule Capsule = Portable.Capsule

Sourcemodule Char : sig ... end

This module extends Base.Char, adding Identifiable for making char identifiers and Quickcheckable to facilitate automated testing with pseudorandom data.

Sourcemodule Command : sig ... end

Sourcemodule Comparable : sig ... end

Comparable extends Base.Comparable and provides functions for comparing like types.

Sourcemodule Comparator : sig ... end

Sourcemodule Comparisons = Base.Comparisons

Sourcemodule Container : sig ... end

Provides generic signatures for container data structures.

Sourcemodule Container_intf : sig ... end

This module extends Base.Container.

Sourcemodule Continue_or_stop = Base.Continue_or_stop

Sourcemodule Core_kernel_stable : sig ... end

Sourcemodule Core_stable : sig ... end

Sourcemodule Date : sig ... end

Date module.

Sourcemodule Day_of_week : sig ... end

Provides a variant type for days of the week (Mon, Tue, etc.) and convenience functions for converting these days into other formats, like sexp or string or ISO 8601 weekday number.

Sourcemodule Debug : sig ... end

Utilities for printing debug messages.

Sourcemodule Deque : sig ... end

A double-ended queue that can shrink and expand on both ends.

Sourcemodule Deriving_hash : sig ... end

Generates hash functions from type expressions and definitions.

Sourcemodule Digest = Core.Md5

Sourcemodule Doubly_linked : sig ... end

Sourcemodule Dynamic = Base.Dynamic

Sourcemodule Either : sig ... end

This module extends Base.Either.

Sourcemodule Ephemeron = Stdlib.Ephemeron

Sourcemodule Equal = Base.Equal

Sourcemodule Error : sig ... end

This module extends Base.Error with bin_io, diff, and quickcheck.

Sourcemodule Exn = Base.Exn

Sourcemodule Expect_test_config = Expect_test_config

Sourcemodule Fdeque : sig ... end

A simple polymorphic functional double-ended queue. Use this if you need a queue-like data structure that provides enqueue and dequeue accessors on both ends. For strictly first-in, first-out access, see Fqueue.

Sourcemodule Field = Fieldslib.Field

Sourcemodule Filename : sig ... end

Sourcemodule Float : sig ... end

Floating-point numbers.

Sourcemodule Float_with_finite_only_serialization : sig ... end

An alias to the Float.t type that causes the sexp and bin-io serializers to fail when provided with nan or infinity.

Sourcemodule Floatable = Base.Floatable

Sourcemodule Fn : sig ... end

Sourcemodule Formatter = Base.Formatter

Sourcemodule Fqueue : sig ... end

A simple polymorphic functional queue. Use this data structure for strictly first-in, first-out access to a sequence of values. For a similar data structure with enqueue and dequeue accessors on both ends of a sequence, see Core.Fdeque.

Sourcemodule Gc : sig ... end

This is a wrapper around INRIA's standard Gc module. Provides memory management control and statistics, and finalized values.

Sourcemodule Hash = Base.Hash

Sourcemodule Hash_queue : sig ... end

Sourcemodule Hash_set : sig ... end

Sourcemodule Hashable : sig ... end

Sourcemodule Hashtbl : sig ... end

Sourcemodule Hashtbl_intf : sig ... end

Hashtbl is a reimplementation of the standard MoreLabels.Hashtbl. Its worst case time complexity is O(log(N)) for lookups and additions, unlike the standard MoreLabels.Hashtbl, which is O(N).

Sourcemodule Heap_block = Heap_block

Sourcemodule Hexdump : sig ... end

Sourcemodule Hexdump_intf : sig ... end

A functor for displaying a type as a sequence of ASCII characters printed in hexadecimal.

Sourcemodule Host_and_port : sig ... end

Type for the commonly-used notion of host and port in networking.

Sourcemodule Iarray : sig ... end

Sourcemodule Identifiable : sig ... end

Sourcemodule Immediate_option : sig ... end

Always immediate.

Sourcemodule Immediate_option_intf : sig ... end

A non-allocating alternative to the standard Option type.

module In_channel = Stdio.In_channel

Sourcemodule Indexed_container : sig ... end

Sourcemodule Info : sig ... end

This module extends Base.Info, which provides a type for info-level debug messages.

Sourcemodule Int : sig ... end

This module extends Base.Int.

Sourcemodule Int32 : sig ... end

This module extends Base.Int32.

Sourcemodule Int63 : sig ... end

This module extends Base.Int63.

Sourcemodule Int64 : sig ... end

This module extends Base.Int64.

Sourcemodule Int_conversions = Base.Int_conversions

Sourcemodule Int_intf : sig ... end

This module extends Base.Int_intf.

Sourcemodule Int_math = Base.Int_math

Sourcemodule Intable = Base.Intable

Sourcemodule Interfaces : sig ... end

Various interface exports.

Sourcemodule Invariant = Base.Invariant

Sourcemodule Dictionary_immutable = Base.Dictionary_immutable

Sourcemodule Dictionary_mutable = Base.Dictionary_mutable

Sourcemodule Lazy : sig ... end

This module extends Base.Lazy.

Sourcemodule Linked_queue : sig ... end

This module extends the Base.Linked_queue module with bin_io support. As a reminder, the Base.Linked_queue module is a wrapper around OCaml's standard Queue module that follows Base idioms and adds some functions.

Sourcemodule List : sig ... end

This module extends Base.List with bin_io and quickcheck.

Sourcemodule Map : sig ... end

Map is a functional data structure (balanced binary tree) implementing finite maps over a totally-ordered domain, called a "key".

Sourcemodule Map_intf : sig ... end

This module defines interfaces used in Map. See those docs for a description of the design.

Sourcemodule Maybe_bound : sig ... end

This module extends Base.Maybe_bound with bin_io and with compare functions in the form of As_lower_bound and As_upper_bound modules.

Sourcemodule Md5 : sig ... end

This module implements the MD5 message-digest algorithm as described IETF RFC 1321. t is the result type and val digest_string : string -> t is the implementation of the algorithm itself.

Sourcemodule Memo : sig ... end

Memoization of OCaml functions of a single argument.

Sourcemodule Modes : sig ... end

Sourcemodule Monad = Base.Monad

Sourcemodule Month : sig ... end

Provides a variant type for representing months (e.g., Jan, Feb, or Nov) and functions for converting them to other formats (like an int).

Sourcemodule Mutex : sig ... end

Sourcemodule Nativeint : sig ... end

This module extends Base.Nativeint.

Sourcemodule No_polymorphic_compare : sig ... end

Open this in modules where you don't want to accidentally use polymorphic comparison. Then, use Poly.(<), for example, where needed.

Sourcemodule Nonempty_list : sig ... end

Sourcemodule Nothing : sig ... end

This module extends Base.Nothing.

Sourcemodule Obj = Base.Obj

Sourcemodule Only_in_test : sig ... end

This module can be used to safely expose functions and values in signatures that should only be used in unit tests.

Sourcemodule Option : sig ... end

This module extends Base.Option with bin_io, quickcheck, and support for ppx_optional.

Sourcemodule Option_array : sig ... end

This module extends Base.Option_array with bin_io.

Sourcemodule Optional_syntax : sig ... end

Interfaces for use with the match%optional syntax, provided by ppx_optional.

Sourcemodule Optional_syntax_intf : sig ... end

Sourcemodule Or_error : sig ... end

This module extends Base.Or_error with bin_io, diff, and quickcheck.

Sourcemodule Or_null : sig ... end

This module extends Base.Or_null with bin_io and quickcheck.

Sourcemodule Ordered_collection_common = Base.Ordered_collection_common

Sourcemodule Ordering : sig ... end

Extends Base.Ordering, intended to make code that matches on the result of a comparison more concise and easier to read.

module Out_channel = Stdio.Out_channel

Sourcemodule Percent : sig ... end

A scale factor, not bounded between 0% and 100%, represented as a float.

Sourcemodule Perms : sig ... end

These types are intended to be used as phantom types encoding the permissions on a given type.

Sourcemodule Pid : sig ... end

Process ID.

Sourcemodule Poly = Base.Poly

module Portability_hacks = Base.Portability_hacks

Sourcemodule Portable_lazy : sig ... end

Sourcemodule Pretty_printer = Base.Pretty_printer

Sourcemodule Printexc : sig ... end

This module is here to ensure that we don't use the functions in Caml.Printexc inadvertently.

Sourcemodule Printf : sig ... end

Sourcemodule Queue : sig ... end

This module extends Base.Queue with bin_io.

Sourcemodule Quickcheck : sig ... end

Sourcemodule Quickcheck_intf : sig ... end

Quickcheck is a library that uses predicate-based tests and pseudo-random inputs to automate testing.

Sourcemodule Quickcheckable : sig ... end

Sourcemodule Random = Base.Random

Sourcemodule Ref : sig ... end

This module extends Base.Ref.

Sourcemodule Result : sig ... end

This module extends Base.Result.

Sourcemodule Robustly_comparable : sig ... end

This interface compares float-like objects with a small tolerance.

Sourcemodule Sequence : sig ... end

This module extends Base.Sequence with bin_io.

Sourcemodule Set : sig ... end

This module defines the Set module for Core. Functions that construct a set take as an argument the comparator for the element type.

Sourcemodule Set_intf : sig ... end

This module defines interfaces used in Set. See the Map docs for a description of the design.

Sourcemodule Set_once : sig ... end

A 'a Set_once.t is like an 'a option ref that can only be set once. A Set_once.t starts out as None, the first set transitions it to Some, and subsequent sets fail.

Sourcemodule Sexp_maybe = Core.Sexp.Sexp_maybe

Sourcemodule Sexp : sig ... end

Code for managing s-expressions.

Sourcemodule Sexpable : sig ... end

This module extends Base.Sexpable.

Sourcemodule Sign : sig ... end

This module extends Base.Sign with bin_io.

Sourcemodule Signal : sig ... end

Signal handlers.

Sourcemodule Sign_or_nan : sig ... end

This module extends Base.Sign_or_nan with bin_io.

Sourcemodule Source_code_position : sig ... end

This module extends Base.Source_code_position.

Sourcemodule Splittable_random = Splittable_random

Sourcemodule Stable_comparable : sig ... end

Sourcemodule Stable_unit_test : sig ... end

The tests generated by these functors are run like any other unit tests: by the inline test runner when the functor is applied.

Sourcemodule Stack : sig ... end

Sourcemodule Staged = Base.Staged

Sourcemodule String : sig ... end

This module extends Base.String.

Sourcemodule String_id : sig ... end

Like Identifiable, but with t = private string and stable modules.

Sourcemodule Stringable = Base.Stringable

module Subatomic = Portable.Subatomic

Sourcemodule Substring : sig ... end

A substring is a contiguous set of characters within a string. Creating a substring does not copy. Therefore modifying the string also modifies the substring.

Sourcemodule Substring_intf : sig ... end

Interface for Substring.

Sourcemodule Sys : sig ... end

Sourcemodule Thread : sig ... end

Sourcemodule Time_float : sig ... end

A module for representing absolute points in time, independent of time zone.

Sourcemodule Time_ns : sig ... end

Time module.

Sourcemodule Timezone : sig ... end

Timezone handles parsing timezone data and create Timezone.t that can later be used to manipulate time using the Time_float and Time_ns modules.

Sourcemodule Toplevel_value = Base.Toplevel_value

Sourcemodule Tuple : sig ... end

Sourcemodule Tuple2 = Tuple.T2

Sourcemodule Tuple3 = Tuple.T3

Sourcemodule Type_equal : sig ... end

This module extends Base.Type_equal.

Sourcemodule Type_immediacy : sig ... end

Sourcemodule Uchar : sig ... end

This module extends Base.Uchar, adding Comparable and Hashable functionality, bin_io support, and Quickcheckable to facilitate automated testing with pseudorandom data.

Sourcemodule Uniform_array : sig ... end

This module extends Base.Uniform_array with bin_io.

Sourcemodule Union_find : sig ... end

Imperative data structure for representing disjoint sets.

Sourcemodule Unique_id : sig ... end

Functors for creating modules that mint unique identifiers.

Sourcemodule Unit : sig ... end

Module for the type unit, extended from Base.Unit. This is mostly useful for building functor arguments.

Sourcemodule Unit_of_time : sig ... end

Represents a unit of time, e.g., that used by Time.Span.to_string_hum. Comparison respects Nanosecond < Microsecond < Millisecond < Second < Minute < Hour < Day.

Sourcemodule Univ_map = Univ_map

Sourcemodule Unix : sig ... end

Sourcemodule Validate = Validate

Sourcemodule Validated : sig ... end

Sourcemodule Variant = Variantslib.Variant

Sourcemodule Weak = Stdlib.Weak

Sourcemodule With_return = Base.With_return

Sourcemodule Word_size = Base.Word_size

Sourcemodule type Unique_id = Unique_id.Id

include module type of struct include Base.T end

module type T = Base.T.T

include sig ... end

module type T1 = Base.T.T1

include sig ... end

module type T2 = Base.T.T2

include sig ... end

module type T3 = Base.T.T3

include sig ... end

module type T4 = Base.T.T4

Sourcemodule type T_bin = sig ... end

included first so that everything else shadows it

Exceptions

val raise : ('a : value_or_null). exn -> 'a @ portable portable @@ portable

Raise the given exception value

val raise_notrace : 
  ('a : value_or_null). exn ->
  'a @ portable portable @@ portable

A faster version raise which does not record the backtrace.

since 4.02.0

val invalid_arg : 
  ('a : value_or_null). string ->
  'a @ portable portable @@ portable

Raise exception Invalid_argument with the given string.

val failwith : 
  ('a : value_or_null). string ->
  'a @ portable portable @@ portable

Raise exception Failure with the given string.

exception Exit

The Exit exception is not raised by any library function. It is provided for use in your programs.

Comparisons

val (==) : 'a -> 'a -> bool @@ portable

e1 == e2 tests for physical equality of e1 and e2. On mutable types such as references, arrays, byte sequences, records with mutable fields and objects with mutable instance variables, e1 == e2 is true if and only if physical modification of e1 also affects e2. On non-mutable types, the behavior of ( == ) is implementation-dependent; however, it is guaranteed that e1 == e2 implies compare e1 e2 = 0.

deprecated [since 2014-10] Use [phys_equal]

val (!=) : 'a -> 'a -> bool @@ portable

Negation of (==).

deprecated [since 2014-10] Use [phys_equal]

Boolean operations

val not : bool -> bool @@ portable

The boolean negation.

val (&&) : bool -> bool -> bool @@ portable

The boolean 'and'. Evaluation is sequential, left-to-right: in e1 && e2, e1 is evaluated first, and if it returns false, e2 is not evaluated at all.

val (||) : bool -> bool -> bool @@ portable

The boolean 'or'. Evaluation is sequential, left-to-right: in e1 || e2, e1 is evaluated first, and if it returns true, e2 is not evaluated at all.

Debugging

val __LOC__ : string @@ portable

__LOC__ returns the location at which this expression appears in the file currently being parsed by the compiler, with the standard error format of OCaml: "File %S, line %d, characters %d-%d"

val __FILE__ : string @@ portable

__FILE__ returns the name of the file currently being parsed by the compiler.

val __LINE__ : int @@ portable

__LINE__ returns the line number at which this expression appears in the file currently being parsed by the compiler.

val __MODULE__ : string @@ portable

__MODULE__ returns the module name of the file being parsed by the compiler.

val __POS__ : string * int * int * int @@ portable

__POS__ returns a tuple (file,lnum,cnum,enum), corresponding to the location at which this expression appears in the file currently being parsed by the compiler. file is the current filename, lnum the line number, cnum the character position in the line and enum the last character position in the line.

val __FUNCTION__ : string @@ portable

__FUNCTION__ returns the name of the current function or method, including any enclosing modules or classes.

val __LOC_OF__ : 'a -> string * 'a @@ portable

__LOC_OF__ expr returns a pair (loc, expr) where loc is the location of expr in the file currently being parsed by the compiler, with the standard error format of OCaml: "File %S, line %d, characters %d-%d"

val __LINE_OF__ : 'a -> int * 'a @@ portable

__LINE_OF__ expr returns a pair (line, expr), where line is the line number at which the expression expr appears in the file currently being parsed by the compiler.

val __POS_OF__ : 'a -> (string * int * int * int) * 'a @@ portable

__POS_OF__ expr returns a pair (expr,loc), where loc is a tuple (file,lnum,cnum,enum) corresponding to the location at which the expression expr appears in the file currently being parsed by the compiler. file is the current filename, lnum the line number, cnum the character position in the line and enum the last character position in the line.

Composition operators

val (|>) : ('a : any) ('b : any). 'a -> ('a -> 'b) -> 'b @@ portable

Reverse-application operator: x |> f |> g is exactly equivalent to g (f (x)).

since 4.01

val (@@) : ('a : any) ('b : any). ('a -> 'b) -> 'a -> 'b @@ portable

Application operator: g @@ f @@ x is exactly equivalent to g (f (x)).

since 4.01

Integer arithmetic

Integers are 31 bits wide (or 63 bits on 64-bit processors). All operations are taken modulo 2{^31} (or 2{^63}). They do not fail on overflow.

val (~-) : int -> int @@ portable

Unary negation. You can also write - e instead of ~- e.

val (~+) : int -> int @@ portable

Unary addition. You can also write + e instead of ~+ e.

since 3.12.0

val succ : int -> int @@ portable

succ x is x + 1.

val pred : int -> int @@ portable

pred x is x - 1.

val (+) : int -> int -> int @@ portable

Integer addition.

val (-) : int -> int -> int @@ portable

Integer subtraction.

val (*) : int -> int -> int @@ portable

Integer multiplication.

val (/) : int -> int -> int @@ portable

Integer division. Raise Division_by_zero if the second argument is 0. Integer division rounds the real quotient of its arguments towards zero. More precisely, if x >= 0 and y > 0, x / y is the greatest integer less than or equal to the real quotient of x by y. Moreover, (- x) / y = x / (- y) = - (x / y).

val (mod) : int -> int -> int @@ portable

Integer remainder. If y is not zero, the result of x mod y satisfies the following properties: x = (x / y) * y + x mod y and abs(x mod y) <= abs(y) - 1. If y = 0, x mod y raises Division_by_zero. Note that x mod y is negative only if x < 0. Raise Division_by_zero if y is zero.

val abs : int -> int @@ portable

Return the absolute value of the argument. Note that this may be negative if the argument is min_int.

val max_int : int @@ portable

The greatest representable integer.

deprecated [since 2014-10] Use [Int.max_value]

val min_int : int @@ portable

The smallest representable integer.

deprecated [since 2014-10] Use [Int.min_value]

Bitwise operations

val (land) : int -> int -> int @@ portable

Bitwise logical and.

val (lor) : int -> int -> int @@ portable

Bitwise logical or.

val (lxor) : int -> int -> int @@ portable

Bitwise logical exclusive or.

val lnot : int -> int @@ portable

Bitwise logical negation.

val (lsl) : int -> int -> int @@ portable

n lsl m shifts n to the left by m bits. The result is unspecified if m < 0 or m >= bitsize, where bitsize is 32 on a 32-bit platform and 64 on a 64-bit platform.

val (lsr) : int -> int -> int @@ portable

n lsr m shifts n to the right by m bits. This is a logical shift: zeroes are inserted regardless of the sign of n. The result is unspecified if m < 0 or m >= bitsize.

val (asr) : int -> int -> int @@ portable

n asr m shifts n to the right by m bits. This is an arithmetic shift: the sign bit of n is replicated. The result is unspecified if m < 0 or m >= bitsize.

Floating-point arithmetic

OCaml's floating-point numbers follow the IEEE 754 standard, using double precision (64 bits) numbers. Floating-point operations never raise an exception on overflow, underflow, division by zero, etc. Instead, special IEEE numbers are returned as appropriate, such as infinity for 1.0 /. 0.0, neg_infinity for -1.0 /. 0.0, and nan ('not a number') for 0.0 /. 0.0. These special numbers then propagate through floating-point computations as expected: for instance, 1.0 /. infinity is 0.0, and any arithmetic operation with nan as argument returns nan as result.

val (~-.) : float -> float @@ portable

Unary negation. You can also write -. e instead of ~-. e.

val (~+.) : float -> float @@ portable

Unary addition. You can also write +. e instead of ~+. e.

since 3.12.0

val (+.) : float -> float -> float @@ portable

Floating-point addition

val (-.) : float -> float -> float @@ portable

Floating-point subtraction

val (*.) : float -> float -> float @@ portable

Floating-point multiplication

val (/.) : float -> float -> float @@ portable

Floating-point division.

val (**) : float -> float -> float @@ portable

Exponentiation.

val sqrt : float -> float @@ portable

Square root.

val exp : float -> float @@ portable

Exponential.

val log : float -> float @@ portable

Natural logarithm.

val log10 : float -> float @@ portable

Base 10 logarithm.

deprecated [since 2016-07] Use [Float.log10]

val expm1 : float -> float @@ portable

expm1 x computes exp x -. 1.0, giving numerically-accurate results even if x is close to 0.0.

since 3.12.0

deprecated [since 2016-07] Use [Float.expm1]

val log1p : float -> float @@ portable

log1p x computes log(1.0 +. x) (natural logarithm), giving numerically-accurate results even if x is close to 0.0.

since 3.12.0

deprecated [since 2016-07] Use [Float.log1p]

val cos : float -> float @@ portable

Cosine. Argument is in radians.

deprecated [since 2016-07] Use [Float.cos]

val sin : float -> float @@ portable

Sine. Argument is in radians.

deprecated [since 2016-07] Use [Float.sin]

val tan : float -> float @@ portable

Tangent. Argument is in radians.

deprecated [since 2016-07] Use [Float.tan]

val acos : float -> float @@ portable

Arc cosine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between 0.0 and pi.

deprecated [since 2016-07] Use [Float.acos]

val asin : float -> float @@ portable

Arc sine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between -pi/2 and pi/2.

deprecated [since 2016-07] Use [Float.asin]

val atan : float -> float @@ portable

Arc tangent. Result is in radians and is between -pi/2 and pi/2.

deprecated [since 2016-07] Use [Float.atan]

val atan2 : float -> float -> float @@ portable

atan2 y x returns the arc tangent of y /. x. The signs of x and y are used to determine the quadrant of the result. Result is in radians and is between -pi and pi.

deprecated [since 2016-07] Use [Float.atan2]

val hypot : float -> float -> float @@ portable

hypot x y returns sqrt(x *. x + y *. y), that is, the length of the hypotenuse of a right-angled triangle with sides of length x and y, or, equivalently, the distance of the point (x,y) to origin.

since 4.00.0

deprecated [since 2016-07] Use [Float.hypot]

val cosh : float -> float @@ portable

Hyperbolic cosine. Argument is in radians.

deprecated [since 2016-07] Use [Float.cosh]

val sinh : float -> float @@ portable

Hyperbolic sine. Argument is in radians.

deprecated [since 2016-07] Use [Float.sinh]

val tanh : float -> float @@ portable

Hyperbolic tangent. Argument is in radians.

deprecated [since 2016-07] Use [Float.tanh]

val acosh : float -> float @@ portable

Hyperbolic arc cosine. The argument must fall within the range [1.0, inf]. Result is in radians and is between 0.0 and inf.

since 4.13.0

deprecated [since 2022-11] Use [Float.acosh]

val asinh : float -> float @@ portable

Hyperbolic arc sine. The argument and result range over the entire real line. Result is in radians.

since 4.13.0

deprecated [since 2022-11] Use [Float.asinh]

val atanh : float -> float @@ portable

Hyperbolic arc tangent. The argument must fall within the range [-1.0, 1.0]. Result is in radians and ranges over the entire real line.

since 4.13.0

deprecated [since 2022-11] Use [Float.atanh]

val ceil : float -> float @@ portable

Round above to an integer value. ceil f returns the least integer value greater than or equal to f. The result is returned as a float.

deprecated [since 2014-10] Use [Float.round_up]

val floor : float -> float @@ portable

Round below to an integer value. floor f returns the greatest integer value less than or equal to f. The result is returned as a float.

deprecated [since 2014-10] Use [Float.round_down]

val abs_float : float -> float @@ portable

abs_float f returns the absolute value of f.

deprecated [since 2014-10] Use [Float.abs]

val copysign : float -> float -> float @@ portable

copysign x y returns a float whose absolute value is that of x and whose sign is that of y. If x is nan, returns nan. If y is nan, returns either x or -. x, but it is not specified which.

since 4.00.0

deprecated [since 2016-07] Use [Float.copysign]

val mod_float : float -> float -> float @@ portable

mod_float a b returns the remainder of a with respect to b. The returned value is a -. n *. b, where n is the quotient a /. b rounded towards zero to an integer.

deprecated [since 2014-10] Use [Float.mod_float]

val frexp : float -> float * int @@ portable

frexp f returns the pair of the significant and the exponent of f. When f is zero, the significant x and the exponent n of f are equal to zero. When f is non-zero, they are defined by f = x *. 2 ** n and 0.5 <= x < 1.0.

deprecated [since 2014-10] Use [Float.frexp]

val ldexp : float -> int -> float @@ portable

ldexp x n returns x *. 2 ** n.

deprecated [since 2014-10] Use [Float.ldexp]

val modf : float -> float * float @@ portable

modf f returns the pair of the fractional and integral part of f.

deprecated [since 2014-10] Use [Float.modf]

val float : int -> float @@ portable

Same as Caml.float_of_int.

val float_of_int : int -> float @@ portable

Convert an integer to floating-point.

val truncate : float -> int @@ portable

Same as Caml.int_of_float.

deprecated [since 2014-10] Use [Float.iround_towards_zero_exn]

val int_of_float : float -> int @@ portable

Truncate the given floating-point number to an integer. The result is unspecified if the argument is nan or falls outside the range of representable integers.

val infinity : float @@ portable

Positive infinity.

deprecated [since 2014-10] Use [Float.infinity]

val neg_infinity : float @@ portable

Negative infinity.

deprecated [since 2014-10] Use [Float.neg_infinity]

val nan : float @@ portable

A special floating-point value denoting the result of an undefined operation such as 0.0 /. 0.0. Stands for 'not a number'. Any floating-point operation with nan as argument returns nan as result. As for floating-point comparisons, =, <, <=, > and >= return false and <> returns true if one or both of their arguments is nan.

deprecated [since 2014-10] Use [Float.nan]

val max_float : float @@ portable

The largest positive finite value of type float.

deprecated [since 2014-10] Use [Float.max_value]

val min_float : float @@ portable

The smallest positive, non-zero, non-denormalized value of type float.

deprecated [since 2014-10] Use [Float.min_value]

val epsilon_float : float @@ portable

The difference between 1.0 and the smallest exactly representable floating-point number greater than 1.0.

deprecated [since 2014-10] Use [Float.epsilon_float]

type fpclass = Stdlib.fpclass =

| FP_normal
(*
Normal number, none of the below
*)
| FP_subnormal
(*
Number very close to 0.0, has reduced precision
*)
| FP_zero
(*
Number is 0.0 or -0.0
*)
| FP_infinite
(*
Number is positive or negative infinity
*)
| FP_nan
(*
Not a number: result of an undefined operation
*)

The five classes of floating-point numbers, as determined by the Caml.classify_float function.

val classify_float : float -> Core.fpclass @@ portable

Return the class of the given floating-point number: normal, subnormal, zero, infinite, or not a number.

deprecated [since 2014-10] Use [Float.classify]

String operations

More string operations are provided in module String.

val (^) : string -> string -> string @@ portable

String concatenation.

Character operations

More character operations are provided in module Char.

val int_of_char : char -> int @@ portable

Return the ASCII code of the argument.

val char_of_int : int -> char @@ portable

Return the character with the given ASCII code. Raise Invalid_argument "char_of_int" if the argument is outside the range 0--255.

Unit operations

val ignore : ('a : any). 'a -> unit @@ portable

Discard the value of its argument and return (). For instance, ignore(f x) discards the result of the side-effecting function f. It is equivalent to f x; (), except that the latter may generate a compiler warning; writing ignore(f x) instead avoids the warning.

String conversion functions

val string_of_bool : bool -> string @@ portable

Return the string representation of a boolean. As the returned values may be shared, the user should not modify them directly.

val bool_of_string : string -> bool @@ portable

Convert the given string to a boolean. Raise Invalid_argument "bool_of_string" if the string is not "true" or "false".

val string_of_int : int -> string @@ portable

Return the string representation of an integer, in decimal.

val int_of_string : string -> int @@ portable

Convert the given string to an integer. The string is read in decimal (by default) or in hexadecimal (if it begins with 0x or 0X), octal (if it begins with 0o or 0O), or binary (if it begins with 0b or 0B). Raise Failure "int_of_string" if the given string is not a valid representation of an integer, or if the integer represented exceeds the range of integers representable in type int.

val string_of_float : float -> string @@ portable

Return the string representation of a floating-point number.

val float_of_string : string -> float @@ portable

Convert the given string to a float. Raise Failure "float_of_string" if the given string is not a valid representation of a float.

Pair operations

val fst : ('a * 'b) -> 'a @@ portable

Return the first component of a pair.

val snd : ('a * 'b) -> 'b @@ portable

Return the second component of a pair.

List operations

More list operations are provided in module List.

Input/output

Note: all input/output functions can raise Sys_error when the system calls they invoke fail.

type in_channel = Stdlib.in_channel

The type of input channel.

deprecated [since 2016-04] Use [In_channel.t]

type out_channel = Stdlib.out_channel

The type of output channel.

deprecated [since 2016-04] Use [Out_channel.t]

val stdin : Stdlib.in_channel @@ portable

The standard input for the process.

deprecated [since 2016-04] Use [In_channel.stdin]

val stdout : Stdlib.out_channel @@ portable

The standard output for the process.

val stderr : Stdlib.out_channel @@ portable

The standard error output for the process.

Output functions on standard output

val print_char : char -> unit @@ portable

Print a character on standard output.

deprecated [since 2016-04] Use [Out_channel.output_char stdout]

val print_string : string @ local -> unit @@ portable

Print a string on standard output.

val print_bytes : bytes @ local -> unit @@ portable

Print a byte sequence on standard output.

deprecated [since 2016-04] Core doesn't support [bytes] yet.

val print_int : int -> unit @@ portable

Print an integer, in decimal, on standard output.

deprecated [since 2016-04] Use [Out_channel.output_string stdout]

val print_float : float -> unit @@ portable

Print a floating-point number, in decimal, on standard output.

deprecated [since 2016-04] Use [Out_channel.output_string stdout]

val print_endline : string @ local -> unit @@ portable

Print a string, followed by a newline character, on standard output and flush standard output.

val print_newline : unit -> unit @@ portable

Print a newline character on standard output, and flush standard output. This can be used to simulate line buffering of standard output.

deprecated [since 2016-04] Use [Out_channel.newline stdout]

Output functions on standard error

val prerr_char : char -> unit @@ portable

Print a character on standard error.

deprecated [since 2016-04] Use [Out_channel.output_char stderr]

val prerr_string : string @ local -> unit @@ portable

Print a string on standard error.

deprecated [since 2016-04] Use [Out_channel.output_string stderr]

val prerr_bytes : bytes @ local -> unit @@ portable

Print a byte sequence on standard error.

deprecated [since 2016-04] Core doesn't support [bytes] yet

val prerr_int : int -> unit @@ portable

Print an integer, in decimal, on standard error.

deprecated [since 2016-04] Use [Out_channel.output_string stderr]

val prerr_float : float -> unit @@ portable

Print a floating-point number, in decimal, on standard error.

deprecated [since 2016-04] Use [Out_channel.output_string stderr]

val prerr_endline : string @ local -> unit @@ portable

Print a string, followed by a newline character on standard error and flush standard error.

val prerr_newline : unit -> unit @@ portable

Print a newline character on standard error, and flush standard error.

deprecated [since 2016-04] Use [Out_channel.newline stderr]

Input functions on standard input

val read_line : unit -> string @@ portable

Flush standard output, then read characters from standard input until a newline character is encountered. Return the string of all characters read, without the newline character at the end.

deprecated [since 2016-04] Use [Out_channel.(flush stdout); In_channel.(input_line_exn stdin)]

val read_int : unit -> int @@ portable

Flush standard output, then read one line from standard input and convert it to an integer. Raise Failure "int_of_string" if the line read is not a valid representation of an integer.

deprecated [since 2016-04] Use [Out_channel.(flush stdout); Int.of_string In_channel.(input_line_exn stdin)]

val read_float : unit -> float @@ portable

Flush standard output, then read one line from standard input and convert it to a floating-point number. The result is unspecified if the line read is not a valid representation of a floating-point number.

deprecated [since 2016-04] Use [Out_channel.(flush stdout); Float.of_string In_channel.(input_line_exn stdin)]

General output functions

type open_flag = Stdlib.open_flag =

| Open_rdonly
(*
open for reading.
*)
| Open_wronly
(*
open for writing.
*)
| Open_append
(*
open for appending: always write at end of file.
*)
| Open_creat
(*
create the file if it does not exist.
*)
| Open_trunc
(*
empty the file if it already exists.
*)
| Open_excl
(*
fail if Open_creat and the file already exists.
*)
| Open_binary
(*
open in binary mode (no conversion).
*)
| Open_text
(*
open in text mode (may perform conversions).
*)
| Open_nonblock
(*
open in non-blocking mode.
*)

Opening modes for Caml.open_out_gen and Caml.open_in_gen.

deprecated [since 2016-04] Use [In_channel.create] and [Out_channel.create]

val open_out : string -> Stdlib.out_channel @@ portable

Open the named file for writing, and return a new output channel on that file, positionned at the beginning of the file. The file is truncated to zero length if it already exists. It is created if it does not already exists.

deprecated [since 2016-04] Use [Out_channel.create]

val open_out_bin : string -> Stdlib.out_channel @@ portable

Same as Caml.open_out, but the file is opened in binary mode, so that no translation takes place during writes. On operating systems that do not distinguish between text mode and binary mode, this function behaves like Caml.open_out.

deprecated [since 2016-04] Use [Out_channel.create]

val open_out_gen : 
  Stdlib.open_flag list ->
  int ->
  string ->
  Stdlib.out_channel @@ portable

open_out_gen mode perm filename opens the named file for writing, as described above. The extra argument mode specify the opening mode. The extra argument perm specifies the file permissions, in case the file must be created. Caml.open_out and Caml.open_out_bin are special cases of this function.

deprecated [since 2016-04] Use [Out_channel.create]

val flush : Stdlib.out_channel -> unit @@ portable

Flush the buffer associated with the given output channel, performing all pending writes on that channel. Interactive programs must be careful about flushing standard output and standard error at the right time.

deprecated [since 2016-04] Use [Out_channel.flush]

val flush_all : unit -> unit @@ portable

Flush all open output channels; ignore errors.

deprecated [since 2016-04]

val output_char : Stdlib.out_channel -> char -> unit @@ portable

Write the character on the given output channel.

deprecated [since 2016-04] Use [Out_channel.output_char]

val output_string : Stdlib.out_channel -> string -> unit @@ portable

Write the string on the given output channel.

deprecated [since 2016-04] Use [Out_channel.output_string]

val output_bytes : Stdlib.out_channel -> bytes -> unit @@ portable

Write the byte sequence on the given output channel.

deprecated [since 2016-04] Core doesn't yet support bytes.

val output : Stdlib.out_channel -> bytes -> int -> int -> unit @@ portable

output oc buf pos len writes len characters from byte sequence buf, starting at offset pos, to the given output channel oc. Raise Invalid_argument "output" if pos and len do not designate a valid range of buf.

deprecated [since 2016-04] Core doesn't yet support bytes.

val output_substring : 
  Stdlib.out_channel ->
  string ->
  int ->
  int ->
  unit @@ portable

Same as output but take a string as argument instead of a byte sequence.

deprecated [since 2016-04] Use [Out_channel.output]

val output_byte : Stdlib.out_channel -> int -> unit @@ portable

Write one 8-bit integer (as the single character with that code) on the given output channel. The given integer is taken modulo

256.

deprecated [since 2016-04] Use [Out_channel.output_byte]

val output_binary_int : Stdlib.out_channel -> int -> unit @@ portable

Write one integer in binary format (4 bytes, big-endian) on the given output channel. The given integer is taken modulo 2{^32}. The only reliable way to read it back is through the Caml.input_binary_int function. The format is compatible across all machines for a given version of OCaml.

deprecated [since 2016-04] Use [Out_channel.output_binary_int]

val output_value : Stdlib.out_channel -> 'a -> unit @@ portable

Write the representation of a structured value of any type to a channel. Circularities and sharing inside the value are detected and preserved. The object can be read back, by the function Caml.input_value. See the description of module Marshal for more information. Caml.output_value is equivalent to Marshal.to_channel with an empty list of flags.

deprecated [since 2016-04] Use [Out_channel.output_value]

val seek_out : Stdlib.out_channel -> int -> unit @@ portable

seek_out chan pos sets the current writing position to pos for channel chan. This works only for regular files. On files of other kinds (such as terminals, pipes and sockets), the behavior is unspecified.

deprecated [since 2014-10] Use [Out_channel.seek]

val pos_out : Stdlib.out_channel -> int @@ portable

Return the current writing position for the given channel. Does not work on channels opened with the Open_append flag (returns unspecified results).

deprecated [since 2014-10] Use [Out_channel.pos]

val out_channel_length : Stdlib.out_channel -> int @@ portable

Return the size (number of characters) of the regular file on which the given channel is opened. If the channel is opened on a file that is not a regular file, the result is meaningless.

deprecated [since 2014-10] Use [Out_channel.length]

val close_out : Stdlib.out_channel -> unit @@ portable

Close the given channel, flushing all buffered write operations. Output functions raise a Sys_error exception when they are applied to a closed output channel, except close_out and flush, which do nothing when applied to an already closed channel. Note that close_out may raise Sys_error if the operating system signals an error when flushing or closing.

deprecated [since 2014-10] Use [Out_channel.close]

val close_out_noerr : Stdlib.out_channel -> unit @@ portable

Same as close_out, but ignore all errors.

deprecated [since 2016-04] Use [Out_channel.close] and catch exceptions

val set_binary_mode_out : Stdlib.out_channel -> bool -> unit @@ portable

set_binary_mode_out oc true sets the channel oc to binary mode: no translations take place during output. set_binary_mode_out oc false sets the channel oc to text mode: depending on the operating system, some translations may take place during output. For instance, under Windows, end-of-lines will be translated from \n to \r\n. This function has no effect under operating systems that do not distinguish between text mode and binary mode.

deprecated [since 2016-04] Use [Out_channel.set_binary_mode]

General input functions

val open_in : string -> Stdlib.in_channel @@ portable

Open the named file for reading, and return a new input channel on that file, positionned at the beginning of the file.

deprecated [since 2016-04] Use [In_channel.create]

val open_in_bin : string -> Stdlib.in_channel @@ portable

Same as Caml.open_in, but the file is opened in binary mode, so that no translation takes place during reads. On operating systems that do not distinguish between text mode and binary mode, this function behaves like Caml.open_in.

deprecated [since 2016-04] Use [In_channel.create]

val open_in_gen : 
  Stdlib.open_flag list ->
  int ->
  string ->
  Stdlib.in_channel @@ portable

open_in_gen mode perm filename opens the named file for reading, as described above. The extra arguments mode and perm specify the opening mode and file permissions. Caml.open_in and Caml.open_in_bin are special cases of this function.

deprecated [since 2016-04] Use [In_channel.create]

val input_char : Stdlib.in_channel -> char @@ portable

Read one character from the given input channel. Raise End_of_file if there are no more characters to read.

deprecated [since 2016-04] Use [In_channel.input_char]

val input_line : Stdlib.in_channel -> string @@ portable

Read characters from the given input channel, until a newline character is encountered. Return the string of all characters read, without the newline character at the end. Raise End_of_file if the end of the file is reached at the beginning of line.

deprecated [since 2016-04] Use [In_channel.input_line]

val input : Stdlib.in_channel -> bytes -> int -> int -> int @@ portable

input ic buf pos len reads up to len characters from the given channel ic, storing them in byte sequence buf, starting at character number pos. It returns the actual number of characters read, between 0 and len (inclusive). A return value of 0 means that the end of file was reached. A return value between 0 and len exclusive means that not all requested len characters were read, either because no more characters were available at that time, or because the implementation found it convenient to do a partial read; input must be called again to read the remaining characters, if desired. (See also Caml.really_input for reading exactly len characters.) Exception Invalid_argument "input" is raised if pos and len do not designate a valid range of buf.

deprecated [since 2016-04] Core doesn't yet support bytes.

val really_input : Stdlib.in_channel -> bytes -> int -> int -> unit @@ portable

really_input ic buf pos len reads len characters from channel ic, storing them in byte sequence buf, starting at character number pos. Raise End_of_file if the end of file is reached before len characters have been read. Raise Invalid_argument "really_input" if pos and len do not designate a valid range of buf.

deprecated [since 2016-04] Core doesn't yet support bytes.

val really_input_string : Stdlib.in_channel -> int -> string @@ portable

really_input_string ic len reads len characters from channel ic and returns them in a new string. Raise End_of_file if the end of file is reached before len characters have been read.

deprecated [since 2016-04] Use [In_channel.really_input_exn ~pos:0]

val input_byte : Stdlib.in_channel -> int @@ portable

Same as Caml.input_char, but return the 8-bit integer representing the character. Raise End_of_file if an end of file was reached.

deprecated [since 2016-04] Use [In_channel.input_byte]

val input_binary_int : Stdlib.in_channel -> int @@ portable

Read an integer encoded in binary format (4 bytes, big-endian) from the given input channel. See Caml.output_binary_int. Raise End_of_file if an end of file was reached while reading the integer.

deprecated [since 2016-04] Use [In_channel.input_binary_int]

val input_value : Stdlib.in_channel -> 'a @@ portable

Read the representation of a structured value, as produced by Caml.output_value, and return the corresponding value. This function is identical to Marshal.from_channel; see the description of module Marshal for more information, in particular concerning the lack of type safety.

deprecated [since 2016-04] Use [In_channel.unsafe_input_value]

val seek_in : Stdlib.in_channel -> int -> unit @@ portable

seek_in chan pos sets the current reading position to pos for channel chan. This works only for regular files. On files of other kinds, the behavior is unspecified.

deprecated [since 2014-10] Use [In_channel.seek]

val pos_in : Stdlib.in_channel -> int @@ portable

Return the current reading position for the given channel.

deprecated [since 2014-10] Use [In_channel.pos]

val in_channel_length : Stdlib.in_channel -> int @@ portable

Return the size (number of characters) of the regular file on which the given channel is opened. If the channel is opened on a file that is not a regular file, the result is meaningless. The returned size does not take into account the end-of-line translations that can be performed when reading from a channel opened in text mode.

deprecated [since 2014-10] Use [In_channel.length]

val close_in : Stdlib.in_channel -> unit @@ portable

Close the given channel. Input functions raise a Sys_error exception when they are applied to a closed input channel, except close_in, which does nothing when applied to an already closed channel.

deprecated [since 2014-10] Use [In_channel.close]

val close_in_noerr : Stdlib.in_channel -> unit @@ portable

Same as close_in, but ignore all errors.

deprecated [since 2016-04] Use [In_channel.close] and catch exceptions

val set_binary_mode_in : Stdlib.in_channel -> bool -> unit @@ portable

set_binary_mode_in ic true sets the channel ic to binary mode: no translations take place during input. set_binary_mode_out ic false sets the channel ic to text mode: depending on the operating system, some translations may take place during input. For instance, under Windows, end-of-lines will be translated from \r\n to \n. This function has no effect under operating systems that do not distinguish between text mode and binary mode.

deprecated [since 2016-04] Use [In_channel.set_binary_mode]

Operations on large files

Sourcemodule LargeFile : sig ... end

Operations on large files. This sub-module provides 64-bit variants of the channel functions that manipulate file positions and file sizes. By representing positions and sizes by 64-bit integers (type int64) instead of regular integers (type int), these alternate functions allow operating on files whose sizes are greater than max_int.

References

type ('a : value_or_null) ref = 'a Stdlib.ref = {

mutable contents : 'a;

}

The type of references (mutable indirection cells) containing a value of type 'a.

val ref : ('a : value_or_null). 'a -> 'a Core.ref @@ portable

Return a fresh reference containing the given value.

val (!) : ('a : value_or_null). 'a Core.ref -> 'a @@ portable

!r returns the current contents of reference r. Equivalent to fun r -> r.contents.

val (:=) : ('a : value_or_null). 'a Core.ref -> 'a -> unit @@ portable

r := a stores the value of a in reference r. Equivalent to fun r v -> r.contents <- v.

val incr : int Core.ref -> unit @@ portable

Increment the integer contained in the given reference. Equivalent to fun r -> r := succ !r.

val decr : int Core.ref -> unit @@ portable

Decrement the integer contained in the given reference. Equivalent to fun r -> r := pred !r.

Result type

type (('a : value_or_null), ('b : value_or_null)) result =
  ('a, 'b) Stdlib.result =

| Ok of 'a
| Error of 'b

Operations on format strings

Format strings are character strings with special lexical conventions that defines the functionality of formatted input/output functions. Format strings are used to read data with formatted input functions from module Scanf and to print data with formatted output functions from modules Printf and Format.

Format strings are made of three kinds of entities:

conversions specifications, introduced by the special character '%' followed by one or more characters specifying what kind of argument to read or print,
formatting indications, introduced by the special character '@' followed by one or more characters specifying how to read or print the argument,
plain characters that are regular characters with usual lexical conventions. Plain characters specify string literals to be read in the input or printed in the output.

There is an additional lexical rule to escape the special characters '%' and '@' in format strings: if a special character follows a '%' character, it is treated as a plain character. In other words, "%%" is considered as a plain '%' and "%@" as a plain '@'.

For more information about conversion specifications and formatting indications available, read the documentation of modules Scanf, Printf and Format.

type ('a, 'b, 'c, 'd, 'e, 'f) format6 =
  ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6

Format strings have a general and highly polymorphic type ('a, 'b, 'c, 'd, 'e, 'f) format6. The two simplified types, format and format4 below are included for backward compatibility with earlier releases of OCaml.

The meaning of format string type parameters is as follows:

'a is the type of the parameters of the format for formatted output functions (printf-style functions); 'a is the type of the values read by the format for formatted input functions (scanf-style functions).

'b is the type of input source for formatted input functions and the type of output target for formatted output functions. For printf-style functions from module Printf, 'b is typically out_channel; for printf-style functions from module Format, 'b is typically Format.formatter; for scanf-style functions from module Scanf, 'b is typically Scanf.Scanning.in_channel.

Type argument 'b is also the type of the first argument given to user's defined printing functions for %a and %t conversions, and user's defined reading functions for %r conversion.

'c is the type of the result of the %a and %t printing functions, and also the type of the argument transmitted to the first argument of kprintf-style functions or to the kscanf-style functions.

'd is the type of parameters for the scanf-style functions.

'e is the type of the receiver function for the scanf-style functions.

'f is the final result type of a formatted input/output function invocation: for the printf-style functions, it is typically unit; for the scanf-style functions, it is typically the result type of the receiver function.

type ('a, 'b, 'c, 'd) format4 = ('a, 'b, 'c, 'c, 'c, 'd) Core.format6

type ('a, 'b, 'c) format = ('a, 'b, 'c, 'c) Core.format4

val string_of_format : 
  ('a, 'b, 'c, 'd, 'e, 'f) Core.format6 ->
  string @@ portable

Converts a format string into a string.

val format_of_string : 
  ('a, 'b, 'c, 'd, 'e, 'f) Core.format6 ->
  ('a, 'b, 'c, 'd, 'e, 'f) Core.format6 @@ portable

format_of_string s returns a format string read from the string literal s. Note: format_of_string can not convert a string argument that is not a literal. If you need this functionality, use the more general Scanf.format_from_string function.

val (^^) : 
  ('a, 'b, 'c, 'd, 'e, 'f) Core.format6 ->
  ('f, 'b, 'c, 'e, 'g, 'h) Core.format6 ->
  ('a, 'b, 'c, 'd, 'g, 'h) Core.format6 @@ portable

f1 ^^ f2 catenates format strings f1 and f2. The result is a format string that behaves as the concatenation of format strings f1 and f2: in case of formatted output, it accepts arguments from f1, then arguments from f2; in case of formatted input, it returns results from f1, then results from f2.

Program termination

val exit : int -> 'a

Terminate the process, returning the given status code to the operating system: usually 0 to indicate no errors, and a small positive integer to indicate failure. All open output channels are flushed with flush_all. An implicit exit 0 is performed each time a program terminates normally. An implicit exit 2 is performed if the program terminates early because of an uncaught exception.

val at_exit : (unit -> unit) -> unit

Register the given function to be called at program termination time. The functions registered with at_exit will be called when the program executes Caml.exit, or terminates, either normally or because of an uncaught exception. The functions are called in 'last in, first out' order: the function most recently added with at_exit is called first.

include module type of struct include Core.Int.Replace_polymorphic_compare end

val (>=) : int -> int -> bool

val (<=) : int -> int -> bool

val (=) : int -> int -> bool

val (>) : int -> int -> bool

val (<) : int -> int -> bool

val (<>) : int -> int -> bool

val equal : int -> int -> bool

val compare : int -> int -> int

val equal__local : int @ local -> int @ local -> bool

val compare__local : int @ local -> int @ local -> int

val min : int -> int -> int

val max : int -> int -> int

include module type of struct include Base_quickcheck.Export end

val quickcheck_generator_unit : 
  Base.unit Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_bool : 
  Base.bool Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_char : 
  Base.char Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_string : 
  Base.string Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_bytes : 
  Base.bytes Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_int : Base.int Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_int32 : 
  Base.int32 Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_int64 : 
  Base.int64 Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_nativeint : 
  Base.nativeint Base_quickcheck.Generator.t @@ portable

val quickcheck_generator_float : 
  Base.float Base_quickcheck.Generator.t @@ portable

val quickcheck_observer_unit : Base.unit Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_bool : Base.bool Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_char : Base.char Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_string : 
  Base.string Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_bytes : 
  Base.bytes Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_int : Base.int Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_int32 : 
  Base.int32 Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_int64 : 
  Base.int64 Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_nativeint : 
  Base.nativeint Base_quickcheck.Observer.t @@ portable

val quickcheck_observer_float : 
  Base.float Base_quickcheck.Observer.t @@ portable

val quickcheck_shrinker_unit : Base.unit Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_bool : Base.bool Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_char : Base.char Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_string : 
  Base.string Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_bytes : 
  Base.bytes Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_int : Base.int Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_int32 : 
  Base.int32 Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_int64 : 
  Base.int64 Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_nativeint : 
  Base.nativeint Base_quickcheck.Shrinker.t @@ portable

val quickcheck_shrinker_float : 
  Base.float Base_quickcheck.Shrinker.t @@ portable

include sig ... end

val quickcheck_generator_option : 
  ('a : value_or_null). 'a Base_quickcheck.Generator.t ->
  'a Base.option Base_quickcheck.Generator.t

val quickcheck_generator_or_null : 
  'a Base_quickcheck.Generator.t ->
  'a Base.or_null Base_quickcheck.Generator.t

val quickcheck_generator_list : 
  ('a : value_or_null). 'a Base_quickcheck.Generator.t ->
  'a Base.list Base_quickcheck.Generator.t

val quickcheck_generator_array : 
  'a Base_quickcheck.Generator.t ->
  'a Base.array Base_quickcheck.Generator.t

val quickcheck_generator_ref : 
  ('a : value_or_null). 'a Base_quickcheck.Generator.t ->
  'a Base.ref Base_quickcheck.Generator.t

val quickcheck_generator_lazy_t : 
  'a Base_quickcheck.Generator.t ->
  'a Base.Lazy.t Base_quickcheck.Generator.t

val quickcheck_observer_option : 
  ('a : value_or_null). 'a Base_quickcheck.Observer.t ->
  'a Base.option Base_quickcheck.Observer.t

val quickcheck_observer_or_null : 
  'a Base_quickcheck.Observer.t ->
  'a Base.or_null Base_quickcheck.Observer.t

val quickcheck_observer_list : 
  ('a : value_or_null). 'a Base_quickcheck.Observer.t ->
  'a Base.list Base_quickcheck.Observer.t

val quickcheck_observer_array : 
  'a Base_quickcheck.Observer.t ->
  'a Base.array Base_quickcheck.Observer.t

val quickcheck_observer_ref : 
  ('a : value_or_null). 'a Base_quickcheck.Observer.t ->
  'a Base.ref Base_quickcheck.Observer.t

val quickcheck_observer_lazy_t : 
  'a Base_quickcheck.Observer.t ->
  'a Base.Lazy.t Base_quickcheck.Observer.t

val quickcheck_shrinker_option : 
  ('a : value_or_null). 'a Base_quickcheck.Shrinker.t ->
  'a Base.option Base_quickcheck.Shrinker.t

val quickcheck_shrinker_or_null : 
  'a Base_quickcheck.Shrinker.t ->
  'a Base.or_null Base_quickcheck.Shrinker.t

val quickcheck_shrinker_list : 
  ('a : value_or_null). 'a Base_quickcheck.Shrinker.t ->
  'a Base.list Base_quickcheck.Shrinker.t

val quickcheck_shrinker_array : 
  'a Base_quickcheck.Shrinker.t ->
  'a Base.array Base_quickcheck.Shrinker.t

val quickcheck_shrinker_ref : 
  ('a : value_or_null). 'a Base_quickcheck.Shrinker.t ->
  'a Base.ref Base_quickcheck.Shrinker.t

val quickcheck_shrinker_lazy_t : 
  'a Base_quickcheck.Shrinker.t ->
  'a Base.Lazy.t Base_quickcheck.Shrinker.t

val (|!) : 'a -> ('a -> 'b) -> 'b

deprecated [since 2016-07] Use [ |> ]

type (('f : value_or_null), ('s : value_or_null)) _either =
  ('f, 's) Base.Either.t =

| First of 'f
| Second of 's

type bigstring = Sexplib.Conv.bigstring

val sexp_of_bigstring : Core.bigstring -> Sexplib0.Sexp.t

val bigstring_of_sexp : Sexplib0.Sexp.t -> Core.bigstring

type mat = Sexplib.Conv.mat

include sig ... end

val sexp_of_mat : Core.mat -> Sexplib0.Sexp.t

val mat_of_sexp : Sexplib0.Sexp.t -> Core.mat

type vec = Sexplib.Conv.vec

include sig ... end

val sexp_of_vec : Core.vec -> Sexplib0.Sexp.t

val vec_of_sexp : Sexplib0.Sexp.t -> Core.vec

val sexp_of_opaque : _ -> Base.Sexp.t @@ portable

val opaque_of_sexp : Base.Sexp.t -> _ @@ portable

val sexp_of_pair : 
  ('a -> Base.Sexp.t) ->
  ('b -> Base.Sexp.t) ->
  ('a * 'b) ->
  Base.Sexp.t @@ portable

val pair_of_sexp : 
  (Base.Sexp.t -> 'a) ->
  (Base.Sexp.t -> 'b) ->
  Base.Sexp.t ->
  'a * 'b @@ portable

exception Of_sexp_error of Base.Exn.t * Base.Sexp.t

val of_sexp_error : Base.String.t -> Base.Sexp.t -> _ @@ portable

val of_sexp_error_exn : Base.Exn.t -> Base.Sexp.t -> _ @@ portable

include module type of struct include Core.Interfaces end

module type Applicative = Core.Interfaces.Applicative

module type Comparable__portable = Core.Interfaces.Comparable__portable

module type Comparable = Core.Interfaces.Comparable

module type Comparable__local__portable =
  Core.Interfaces.Comparable__local__portable

module type Comparable__local = Core.Interfaces.Comparable__local

module type Comparable_binable__portable =
  Core.Interfaces.Comparable_binable__portable

module type Comparable_binable = Core.Interfaces.Comparable_binable

module type Comparable_binable__local__portable =
  Core.Interfaces.Comparable_binable__local__portable

module type Comparable_binable__local =
  Core.Interfaces.Comparable_binable__local

module type Floatable = Core.Interfaces.Floatable

module type Hashable = Core.Interfaces.Hashable

module type Hashable_binable = Core.Interfaces.Hashable_binable

module type Identifiable__portable = Core.Interfaces.Identifiable__portable

module type Identifiable = Core.Interfaces.Identifiable

module type Identifiable__local__portable =
  Core.Interfaces.Identifiable__local__portable

module type Identifiable__local = Core.Interfaces.Identifiable__local

module type Infix_comparators = Core.Interfaces.Infix_comparators

module type Intable = Core.Interfaces.Intable

module type Monad = Core.Interfaces.Monad

module type Quickcheckable = Core.Interfaces.Quickcheckable

module type Robustly_comparable = Core.Interfaces.Robustly_comparable

module type Sexpable = Core.Interfaces.Sexpable

module type Stringable = Core.Interfaces.Stringable

module type Unit = Core.Interfaces.Unit

module type Binable = Core.Interfaces.Binable

module type Stable_int63able = Core.Interfaces.Stable_int63able

module type Stable_int63able_without_comparator =
  Core.Interfaces.Stable_int63able_without_comparator

module type Stable_int63able_with_witness =
  Core.Interfaces.Stable_int63able_with_witness

include sig ... end

module type Stable__portable = Core.Interfaces.Stable__portable

module type Stable = Core.Interfaces.Stable

module type Stable_without_comparator =
  Core.Interfaces.Stable_without_comparator

module type Stable1 = Core.Interfaces.Stable1

module type Stable2 = Core.Interfaces.Stable2

module type Stable3 = Core.Interfaces.Stable3

module type Stable4 = Core.Interfaces.Stable4

module type Stable_with_witness__portable =
  Core.Interfaces.Stable_with_witness__portable

module type Stable_with_witness = Core.Interfaces.Stable_with_witness

module type Stable_without_comparator_with_witness =
  Core.Interfaces.Stable_without_comparator_with_witness

module type Stable1_with_witness = Core.Interfaces.Stable1_with_witness

module type Stable2_with_witness = Core.Interfaces.Stable2_with_witness

module type Stable3_with_witness = Core.Interfaces.Stable3_with_witness

module type Stable4_with_witness = Core.Interfaces.Stable4_with_witness

include module type of struct include Base.List.Infix end

val (@) : 
  ('a : value_or_null). 'a Base.List.t ->
  'a Base.List.t ->
  'a Base.List.t

type never_returns = Core.Nothing.t

val sexp_of_never_returns : Core.never_returns -> Sexplib0.Sexp.t

val never_returns : Core.never_returns -> _ @@ portable

include module type of struct include Base.Modes.Export end

type ('a : value_or_null) global = 'a Base.Modes.Global.t = {

global : 'a;

}

include sig ... end

val compare_global : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> int) ->
  ('a : value_or_null) Core.global ->
  ('a : value_or_null) Core.global ->
  int

val compare_global__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          int) ->
  ('a : value_or_null) Core.global @ local ->
  ('a : value_or_null) Core.global @ local ->
  int

val equal_global : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> bool) ->
  ('a : value_or_null) Core.global ->
  ('a : value_or_null) Core.global ->
  bool

val equal_global__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          bool) ->
  ('a : value_or_null) Core.global @ local ->
  ('a : value_or_null) Core.global @ local ->
  bool

val hash_fold_global : 
  ('a : value_or_null). (Ppx_hash_lib.Std.Hash.state ->
                          ('a : value_or_null) ->
                          Ppx_hash_lib.Std.Hash.state) ->
  Ppx_hash_lib.Std.Hash.state ->
  ('a : value_or_null) Core.global ->
  Ppx_hash_lib.Std.Hash.state

val sexp_of_global : 
  ('a : value_or_null). (('a : value_or_null) -> Sexplib0.Sexp.t) ->
  ('a : value_or_null) Core.global ->
  Sexplib0.Sexp.t

val sexp_of_global__stack : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          Sexplib0.Sexp.t @ local) ->
  ('a : value_or_null) Core.global @ local ->
  Sexplib0.Sexp.t @ local

val global_of_sexp : 
  ('a : value_or_null). (Sexplib0.Sexp.t -> ('a : value_or_null)) ->
  Sexplib0.Sexp.t ->
  ('a : value_or_null) Core.global

val global_sexp_grammar : 
  ('a : value_or_null). ('a : value_or_null) Sexplib0.Sexp_grammar.t ->
  ('a : value_or_null) Core.global Sexplib0.Sexp_grammar.t @@ portable

type ('a : value_or_null) portable = 'a Base.Modes.Portable.t = {

portable : 'a;

}

include sig ... end

val compare_portable : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> int) ->
  ('a : value_or_null) Core.portable ->
  ('a : value_or_null) Core.portable ->
  int

val compare_portable__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          int) ->
  ('a : value_or_null) Core.portable @ local ->
  ('a : value_or_null) Core.portable @ local ->
  int

val equal_portable : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> bool) ->
  ('a : value_or_null) Core.portable ->
  ('a : value_or_null) Core.portable ->
  bool

val equal_portable__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          bool) ->
  ('a : value_or_null) Core.portable @ local ->
  ('a : value_or_null) Core.portable @ local ->
  bool

val hash_fold_portable : 
  ('a : value_or_null). (Ppx_hash_lib.Std.Hash.state ->
                          ('a : value_or_null) ->
                          Ppx_hash_lib.Std.Hash.state) ->
  Ppx_hash_lib.Std.Hash.state ->
  ('a : value_or_null) Core.portable ->
  Ppx_hash_lib.Std.Hash.state

val sexp_of_portable : 
  ('a : value_or_null). (('a : value_or_null) -> Sexplib0.Sexp.t) ->
  ('a : value_or_null) Core.portable ->
  Sexplib0.Sexp.t

val sexp_of_portable__stack : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          Sexplib0.Sexp.t @ local) ->
  ('a : value_or_null) Core.portable @ local ->
  Sexplib0.Sexp.t @ local

val portable_sexp_grammar : 
  ('a : value_or_null). ('a : value_or_null) Sexplib0.Sexp_grammar.t ->
  ('a : value_or_null) Core.portable Sexplib0.Sexp_grammar.t @@ portable

type ('a : value_or_null) contended = 'a Base.Modes.Contended.t = {

contended : 'a;

}

include sig ... end

val contended_of_sexp : 
  ('a : value_or_null). (Sexplib0.Sexp.t -> ('a : value_or_null)) ->
  Sexplib0.Sexp.t ->
  ('a : value_or_null) Core.contended

type ('a : value_or_null) shared = 'a Base.Modes.Shared.t = {

shared : 'a;

}

include sig ... end

val shared_of_sexp : 
  ('a : value_or_null). (Sexplib0.Sexp.t -> ('a : value_or_null)) ->
  Sexplib0.Sexp.t ->
  ('a : value_or_null) Core.shared

type ('a : value_or_null) portended = 'a Base.Modes.Portended.t = {

portended : 'a;

}

type ('a : value_or_null) many = 'a Base.Modes.Many.t = {

many : 'a;

}

include sig ... end

val compare_many : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> int) ->
  ('a : value_or_null) Core.many ->
  ('a : value_or_null) Core.many ->
  int

val compare_many__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          int) ->
  ('a : value_or_null) Core.many @ local ->
  ('a : value_or_null) Core.many @ local ->
  int

val equal_many : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> bool) ->
  ('a : value_or_null) Core.many ->
  ('a : value_or_null) Core.many ->
  bool

val equal_many__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          bool) ->
  ('a : value_or_null) Core.many @ local ->
  ('a : value_or_null) Core.many @ local ->
  bool

val hash_fold_many : 
  ('a : value_or_null). (Ppx_hash_lib.Std.Hash.state ->
                          ('a : value_or_null) ->
                          Ppx_hash_lib.Std.Hash.state) ->
  Ppx_hash_lib.Std.Hash.state ->
  ('a : value_or_null) Core.many ->
  Ppx_hash_lib.Std.Hash.state

val sexp_of_many : 
  ('a : value_or_null). (('a : value_or_null) -> Sexplib0.Sexp.t) ->
  ('a : value_or_null) Core.many ->
  Sexplib0.Sexp.t

val sexp_of_many__stack : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          Sexplib0.Sexp.t @ local) ->
  ('a : value_or_null) Core.many @ local ->
  Sexplib0.Sexp.t @ local

val many_sexp_grammar : 
  ('a : value_or_null). ('a : value_or_null) Sexplib0.Sexp_grammar.t ->
  ('a : value_or_null) Core.many Sexplib0.Sexp_grammar.t @@ portable

type ('a : value_or_null) aliased = 'a Base.Modes.Aliased.t = {

aliased : 'a;

}

type ('a : value_or_null) aliased_many = 'a Base.Modes.Aliased_many.t = {

aliased_many : 'a;

}

type ('a : value_or_null) forkable = 'a Base.Modes.Forkable.t = {

forkable : 'a;

}

type ('a : value_or_null) unyielding = 'a Base.Modes.Unyielding.t = {

unyielding : 'a;

}

include sig ... end

val compare_unyielding : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> int) ->
  ('a : value_or_null) Core.unyielding ->
  ('a : value_or_null) Core.unyielding ->
  int

val compare_unyielding__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          int) ->
  ('a : value_or_null) Core.unyielding @ local ->
  ('a : value_or_null) Core.unyielding @ local ->
  int

val equal_unyielding : 
  ('a : value_or_null). (('a : value_or_null) -> ('a : value_or_null) -> bool) ->
  ('a : value_or_null) Core.unyielding ->
  ('a : value_or_null) Core.unyielding ->
  bool

val equal_unyielding__local : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          ('a : value_or_null) @ local ->
                          bool) ->
  ('a : value_or_null) Core.unyielding @ local ->
  ('a : value_or_null) Core.unyielding @ local ->
  bool

val hash_fold_unyielding : 
  ('a : value_or_null). (Ppx_hash_lib.Std.Hash.state ->
                          ('a : value_or_null) ->
                          Ppx_hash_lib.Std.Hash.state) ->
  Ppx_hash_lib.Std.Hash.state ->
  ('a : value_or_null) Core.unyielding ->
  Ppx_hash_lib.Std.Hash.state

val sexp_of_unyielding : 
  ('a : value_or_null). (('a : value_or_null) -> Sexplib0.Sexp.t) ->
  ('a : value_or_null) Core.unyielding ->
  Sexplib0.Sexp.t

val sexp_of_unyielding__stack : 
  ('a : value_or_null). (('a : value_or_null) @ local ->
                          Sexplib0.Sexp.t @ local) ->
  ('a : value_or_null) Core.unyielding @ local ->
  Sexplib0.Sexp.t @ local

val unyielding_of_sexp : 
  ('a : value_or_null). (Sexplib0.Sexp.t -> ('a : value_or_null)) ->
  Sexplib0.Sexp.t ->
  ('a : value_or_null) Core.unyielding

val unyielding_sexp_grammar : 
  ('a : value_or_null). ('a : value_or_null) Sexplib0.Sexp_grammar.t ->
  ('a : value_or_null) Core.unyielding Sexplib0.Sexp_grammar.t @@ portable

type ('a : value_or_null) stateless = 'a Base.Modes.Stateless.t = {

stateless : 'a;

}

type ('a : value_or_null) observing = 'a Base.Modes.Observing.t = {

observing : 'a;

}

type 'a immutable_data = 'a Base.Modes.Immutable_data.t = {

immutable_data : 'a;

}

include module type of struct include Base.Ordering.Export end

type _ordering = Base.Ordering.t =

| Less
| Equal
| Greater

include module type of struct include Core.Perms.Export end

type read = Core.Perms.Read.t

include sig ... end

val bin_shape_read : Bin_prot.Shape.t

val bin_size_read : Core.read Bin_prot.Size.sizer

val bin_size_read__local : Core.read Bin_prot.Size.sizer__local

val bin_write_read : Core.read Bin_prot.Write.writer

val bin_write_read__local : Core.read Bin_prot.Write.writer__local

val bin_writer_read : Core.read Bin_prot.Type_class.writer

val bin_read_read : Core.read Bin_prot.Read.reader

val __bin_read_read__ : Core.read Bin_prot.Read.vtag_reader

val bin_reader_read : Core.read Bin_prot.Type_class.reader

val bin_read : Core.read Bin_prot.Type_class.t

val compare_read : Core.read -> Core.read -> Base.Int.t

val compare_read__local : Core.read @ local -> Core.read @ local -> Base.Int.t

val equal_read : Core.read -> Core.read -> Base.Bool.t

val equal_read__local : Core.read @ local -> Core.read @ local -> Base.Bool.t

val globalize_read : Core.read @ local -> Core.read

val hash_fold_read : 
  Ppx_hash_lib.Std.Hash.state ->
  Core.read ->
  Ppx_hash_lib.Std.Hash.state

val hash_read : Core.read -> Ppx_hash_lib.Std.Hash.hash_value

val sexp_of_read : Core.read -> Sexplib0.Sexp.t

val read_of_sexp : Sexplib0.Sexp.t -> Core.read

val read_sexp_grammar : Core.read Sexplib0.Sexp_grammar.t @@ portable

val stable_witness_read : Core.read Ppx_stable_witness_runtime.Stable_witness.t

type write = Core.Perms.Write.t

We don't expose bin_io for write due to a naming conflict with the functions exported by bin_io for read_write. If you want bin_io for write, use Write.t.

include sig ... end

val compare_write : Core.write -> Core.write -> Base.Int.t

val compare_write__local : 
  Core.write @ local ->
  Core.write @ local ->
  Base.Int.t

val equal_write : Core.write -> Core.write -> Base.Bool.t

val equal_write__local : 
  Core.write @ local ->
  Core.write @ local ->
  Base.Bool.t

val hash_fold_write : 
  Ppx_hash_lib.Std.Hash.state ->
  Core.write ->
  Ppx_hash_lib.Std.Hash.state

val hash_write : Core.write -> Ppx_hash_lib.Std.Hash.hash_value

val globalize_write : Core.write @ local -> Core.write

val sexp_of_write : Core.write -> Sexplib0.Sexp.t

val write_of_sexp : Sexplib0.Sexp.t -> Core.write

val write_sexp_grammar : Core.write Sexplib0.Sexp_grammar.t @@ portable

val stable_witness_write : 
  Core.write Ppx_stable_witness_runtime.Stable_witness.t

type immutable = Core.Perms.Immutable.t

include sig ... end

val bin_shape_immutable : Bin_prot.Shape.t

val bin_size_immutable : Core.immutable Bin_prot.Size.sizer

val bin_size_immutable__local : Core.immutable Bin_prot.Size.sizer__local

val bin_write_immutable : Core.immutable Bin_prot.Write.writer

val bin_write_immutable__local : Core.immutable Bin_prot.Write.writer__local

val bin_writer_immutable : Core.immutable Bin_prot.Type_class.writer

val bin_read_immutable : Core.immutable Bin_prot.Read.reader

val __bin_read_immutable__ : Core.immutable Bin_prot.Read.vtag_reader

val bin_reader_immutable : Core.immutable Bin_prot.Type_class.reader

val bin_immutable : Core.immutable Bin_prot.Type_class.t

val compare_immutable : Core.immutable -> Core.immutable -> Base.Int.t

val compare_immutable__local : 
  Core.immutable @ local ->
  Core.immutable @ local ->
  Base.Int.t

val equal_immutable : Core.immutable -> Core.immutable -> Base.Bool.t

val equal_immutable__local : 
  Core.immutable @ local ->
  Core.immutable @ local ->
  Base.Bool.t

val globalize_immutable : Core.immutable @ local -> Core.immutable

val hash_fold_immutable : 
  Ppx_hash_lib.Std.Hash.state ->
  Core.immutable ->
  Ppx_hash_lib.Std.Hash.state

val hash_immutable : Core.immutable -> Ppx_hash_lib.Std.Hash.hash_value

val sexp_of_immutable : Core.immutable -> Sexplib0.Sexp.t

val immutable_of_sexp : Sexplib0.Sexp.t -> Core.immutable

val immutable_sexp_grammar : Core.immutable Sexplib0.Sexp_grammar.t @@ portable

val stable_witness_immutable : 
  Core.immutable Ppx_stable_witness_runtime.Stable_witness.t

type read_write = Core.Perms.Read_write.t

include sig ... end

val bin_shape_read_write : Bin_prot.Shape.t

val bin_size_read_write : Core.read_write Bin_prot.Size.sizer

val bin_size_read_write__local : Core.read_write Bin_prot.Size.sizer__local

val bin_write_read_write : Core.read_write Bin_prot.Write.writer

val bin_write_read_write__local : Core.read_write Bin_prot.Write.writer__local

val bin_writer_read_write : Core.read_write Bin_prot.Type_class.writer

val bin_read_read_write : Core.read_write Bin_prot.Read.reader

val __bin_read_read_write__ : Core.read_write Bin_prot.Read.vtag_reader

val bin_reader_read_write : Core.read_write Bin_prot.Type_class.reader

val bin_read_write : Core.read_write Bin_prot.Type_class.t

val compare_read_write : Core.read_write -> Core.read_write -> Base.Int.t

val compare_read_write__local : 
  Core.read_write @ local ->
  Core.read_write @ local ->
  Base.Int.t

val equal_read_write : Core.read_write -> Core.read_write -> Base.Bool.t

val equal_read_write__local : 
  Core.read_write @ local ->
  Core.read_write @ local ->
  Base.Bool.t

val globalize_read_write : Core.read_write @ local -> Core.read_write

val hash_fold_read_write : 
  Ppx_hash_lib.Std.Hash.state ->
  Core.read_write ->
  Ppx_hash_lib.Std.Hash.state

val hash_read_write : Core.read_write -> Ppx_hash_lib.Std.Hash.hash_value

val sexp_of_read_write : Core.read_write -> Sexplib0.Sexp.t

val read_write_of_sexp : Sexplib0.Sexp.t -> Core.read_write

val read_write_sexp_grammar : 
  Core.read_write Sexplib0.Sexp_grammar.t @@ portable

val stable_witness_read_write : 
  Core.read_write Ppx_stable_witness_runtime.Stable_witness.t

type 'a perms = 'a Core.Perms.Upper_bound.t

include sig ... end

val bin_shape_perms : Bin_prot.Shape.t -> Bin_prot.Shape.t

val bin_size_perms : 
  'a. 'a Bin_prot.Size.sizer ->
  'a Core.perms Bin_prot.Size.sizer

val bin_size_perms__local : 
  'a. 'a Bin_prot.Size.sizer__local ->
  'a Core.perms Bin_prot.Size.sizer__local

val bin_write_perms : 
  'a. 'a Bin_prot.Write.writer ->
  'a Core.perms Bin_prot.Write.writer

val bin_write_perms__local : 
  'a. 'a Bin_prot.Write.writer__local ->
  'a Core.perms Bin_prot.Write.writer__local

val bin_writer_perms : 
  'a. 'a Bin_prot.Type_class.writer ->
  'a Core.perms Bin_prot.Type_class.writer

val bin_read_perms : 
  'a. 'a Bin_prot.Read.reader ->
  'a Core.perms Bin_prot.Read.reader

val __bin_read_perms__ : 
  'a. 'a Bin_prot.Read.reader ->
  'a Core.perms Bin_prot.Read.vtag_reader

val bin_reader_perms : 
  'a. 'a Bin_prot.Type_class.reader ->
  'a Core.perms Bin_prot.Type_class.reader

val bin_perms : 
  'a. 'a Bin_prot.Type_class.t ->
  'a Core.perms Bin_prot.Type_class.t

val compare_perms : 
  'a. ('a -> 'a -> Base.Int.t) ->
  'a Core.perms ->
  'a Core.perms ->
  Base.Int.t

val compare_perms__local : 
  'a. ('a @ local -> 'a @ local -> Base.Int.t) ->
  'a Core.perms @ local ->
  'a Core.perms @ local ->
  Base.Int.t

val equal_perms : 
  'a. ('a -> 'a -> Base.Bool.t) ->
  'a Core.perms ->
  'a Core.perms ->
  Base.Bool.t

val equal_perms__local : 
  'a. ('a @ local -> 'a @ local -> Base.Bool.t) ->
  'a Core.perms @ local ->
  'a Core.perms @ local ->
  Base.Bool.t

val globalize_perms : 
  'a. ('a @ local -> 'a) ->
  'a Core.perms @ local ->
  'a Core.perms

val hash_fold_perms : 
  'a. (Ppx_hash_lib.Std.Hash.state -> 'a -> Ppx_hash_lib.Std.Hash.state) ->
  Ppx_hash_lib.Std.Hash.state ->
  'a Core.perms ->
  Ppx_hash_lib.Std.Hash.state

val sexp_of_perms : ('a -> Sexplib0.Sexp.t) -> 'a Core.perms -> Sexplib0.Sexp.t

val perms_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a Core.perms

val perms_sexp_grammar : 
  'a. 'a Sexplib0.Sexp_grammar.t ->
  'a Core.perms Sexplib0.Sexp_grammar.t @@ portable

val stable_witness_perms : 
  'a Ppx_stable_witness_runtime.Stable_witness.t ->
  'a Core.perms Ppx_stable_witness_runtime.Stable_witness.t

include module type of struct include Base.Result.Export end

type (('ok : value_or_null), ('err : value_or_null)) _result =
  ('ok, 'err) Base.Result.t =

| Ok of 'ok
| Error of 'err

include sig ... end

val is_ok : 
  ('ok : value_or_null) ('err : value_or_null). ('ok, 'err) Base.Result.t ->
  bool

val is_error : 
  ('ok : value_or_null) ('err : value_or_null). ('ok, 'err) Base.Result.t ->
  bool

include module type of struct include Core.Iarray.O end

val (.:()) : 'a. 'a Basement.Stdlib_iarray_labels.t -> int -> 'a

An alias for get.

Sourcetype -('a : value_or_null) return = private 'a Base.With_return.return = {

return : ('b : value_or_null). 'a -> 'b;

}

Sourceexception C_malloc_exn of Base.Int.t * Base.Int.t

Raised if malloc in C bindings fail (errno * size).

Sourceexception Finally of Base.Exn.t * Base.Exn.t

Sourceval fst3 : ('a * 'b * 'c) -> 'a

Sourceval snd3 : ('a * 'b * 'c) -> 'b

Sourceval trd3 : ('a * 'b * 'c) -> 'c

Sourceval phys_same : 'a -> 'b -> Base.Bool.t @@ portable

phys_same is like phys_equal, but with a more general type. phys_same is useful when dealing with existential types, when one has a packed value and an unpacked value that one wants to check are physically equal. One can't use phys_equal in such a situation because the types are different.

Sourceval (%) : int @ local -> int @ local -> int

Sourceval (/%) : int @ local -> int @ local -> int

Sourceval (//) : int @ local -> int @ local -> float

Sourceval (==>) : bool -> bool -> bool

Module CoreSource

Exceptions

Comparisons

Boolean operations

Debugging

Composition operators

Integer arithmetic

Bitwise operations

Floating-point arithmetic

String operations

Character operations

Unit operations

String conversion functions

Pair operations

List operations

Input/output

Output functions on standard output

Output functions on standard error

Input functions on standard input

General output functions

General input functions

Operations on large files

References

Operations on format strings

Program termination

Top-level values

Module `Core`Source