package core

Overview
No Docs

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

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

Industrial strength alternative to OCaml's standard library

Install

dune-project

Dependency

github.com Edit opam file Versions (13)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

v0.17.1.tar.gz

md5=743a141234e04210e295980f7a78a6d9

sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f

doc/core/Core/index.html

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.

Sourcemodule 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 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

Conversions between units of measure that are based on bytes (like kilobytes, megabytes, gigabytes, and words).

Sourcemodule Bytes : sig ... end

This module extends Base.Bytes.

Sourcemodule Caml : sig ... end

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

Extends Base.Comparator, providing a type-indexed value that allows you to compare values of that type.

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 = Md5

Sourcemodule Doubly_linked : sig ... end

Sourcemodule Either : sig ... end

This module extends Base.Either.

Sourcemodule Ephemeron = Ephemeron

Sourcemodule Equal = Base.Equal

Sourcemodule Error : sig ... end

This module extends Base.Error with bin_io and diff.

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 Identifiable : sig ... end

Sourcemodule Immediate_option : sig ... end

Sourcemodule Immediate_option_intf : sig ... end

A non-allocating alternative to the standard Option type.

Sourcemodule 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 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 Nothing : sig ... end

This module extends Base.Nothing.

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.

Sourcemodule Ordered_collection_common : sig ... end

This module extends 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.

Sourcemodule 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

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 = 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

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 = Time_float

Sourcemodule Time_float : sig ... end

Sourcemodule Time_ns : sig ... end

Time module.

Sourcemodule Tuple : sig ... end

Functors and signatures for dealing with modules for tuples.

Sourcemodule Tuple2 = Tuple.T2

Sourcemodule Tuple3 = Tuple.T3

Sourcemodule Type_equal : sig ... end

This module extends Base.Type_equal.

Sourcemodule Type_immediacy : sig ... end

Witnesses that express whether a type's values are always, sometimes, or never immediate.

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 = 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

Sourcemodule type T = Base.T.T

Sourcemodule type T1 = Base.T.T1

Sourcemodule type T2 = Base.T.T2

Sourcemodule type T3 = Base.T.T3

Sourcemodule type T_bin = sig ... end

included first so that everything else shadows it

Exceptions

Sourceval raise : exn -> 'a

Raise the given exception value

Sourceval raise_notrace : exn -> 'a

A faster version raise which does not record the backtrace.

since 4.02.0

Sourceval invalid_arg : string -> 'a

Raise exception Invalid_argument with the given string.

Sourceval failwith : string -> 'a

Raise exception Failure with the given string.

Sourceexception Exit

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

Comparisons

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

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]

Sourceval (!=) : 'a -> 'a -> bool

Negation of (==).

deprecated [since 2014-10] Use [phys_equal]

Boolean operations

Sourceval not : bool -> bool

The boolean negation.

Sourceval (&&) : bool -> bool -> bool

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.

Sourceval (||) : bool -> bool -> bool

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

Sourceval __LOC__ : string

__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"

Sourceval __FILE__ : string

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

Sourceval __LINE__ : int

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

Sourceval __MODULE__ : string

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

Sourceval __POS__ : string * int * int * int

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

Sourceval __FUNCTION__ : string

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

Sourceval __LOC_OF__ : 'a -> string * 'a

__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"

Sourceval __LINE_OF__ : 'a -> int * 'a

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

Sourceval __POS_OF__ : 'a -> (string * int * int * int) * 'a

__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

Sourceval (|>) : 'a -> ('a -> 'b) -> 'b

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

since 4.01

Sourceval (@@) : ('a -> 'b) -> 'a -> 'b

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³¹ (or 2⁶³). They do not fail on overflow.

Sourceval (~-) : int -> int

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

Sourceval (~+) : int -> int

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

since 3.12.0

Sourceval succ : int -> int

succ x is x + 1.

Sourceval pred : int -> int

pred x is x - 1.

Sourceval (+) : int -> int -> int

Integer addition.

Sourceval (-) : int -> int -> int

Integer subtraction.

Sourceval (*) : int -> int -> int

Integer multiplication.

Sourceval (/) : int -> int -> int

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

Sourceval (mod) : int -> int -> int

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.

Sourceval abs : int -> int

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

Sourceval max_int : int

The greatest representable integer.

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

Sourceval min_int : int

The smallest representable integer.

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

Bitwise operations

Sourceval (land) : int -> int -> int

Bitwise logical and.

Sourceval (lor) : int -> int -> int

Bitwise logical or.

Sourceval (lxor) : int -> int -> int

Bitwise logical exclusive or.

Sourceval lnot : int -> int

Bitwise logical negation.

Sourceval (lsl) : int -> int -> int

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.

Sourceval (lsr) : int -> int -> int

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.

Sourceval (asr) : int -> int -> int

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.

Sourceval (~-.) : float -> float

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

Sourceval (~+.) : float -> float

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

since 3.12.0

Sourceval (+.) : float -> float -> float

Floating-point addition

Sourceval (-.) : float -> float -> float

Floating-point subtraction

Sourceval (*.) : float -> float -> float

Floating-point multiplication

Sourceval (/.) : float -> float -> float

Floating-point division.

Sourceval (**) : float -> float -> float

Exponentiation.

Sourceval sqrt : float -> float

Square root.

Sourceval exp : float -> float

Exponential.

Sourceval log : float -> float

Natural logarithm.

Sourceval log10 : float -> float

Base 10 logarithm.

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

Sourceval expm1 : float -> float

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]

Sourceval log1p : float -> float

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]

Sourceval cos : float -> float

Cosine. Argument is in radians.

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

Sourceval sin : float -> float

Sine. Argument is in radians.

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

Sourceval tan : float -> float

Tangent. Argument is in radians.

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

Sourceval acos : float -> float

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]

Sourceval asin : float -> float

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]

Sourceval atan : float -> float

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

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

Sourceval atan2 : float -> float -> float

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]

Sourceval hypot : float -> float -> float

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]

Sourceval cosh : float -> float

Hyperbolic cosine. Argument is in radians.

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

Sourceval sinh : float -> float

Hyperbolic sine. Argument is in radians.

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

Sourceval tanh : float -> float

Hyperbolic tangent. Argument is in radians.

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

Sourceval acosh : float -> float

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]

Sourceval asinh : float -> float

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]

Sourceval atanh : float -> float

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]

Sourceval ceil : float -> float

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]

Sourceval floor : float -> float

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]

Sourceval abs_float : float -> float

abs_float f returns the absolute value of f.

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

Sourceval copysign : float -> float -> float

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]

Sourceval mod_float : float -> float -> float

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]

Sourceval frexp : float -> float * int

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]

Sourceval ldexp : float -> int -> float

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

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

Sourceval modf : float -> float * float

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

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

Sourceval float : int -> float

Same as Caml.float_of_int.

Sourceval float_of_int : int -> float

Convert an integer to floating-point.

Sourceval truncate : float -> int

Same as Caml.int_of_float.

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

Sourceval int_of_float : float -> int

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.

Sourceval infinity : float

Positive infinity.

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

Sourceval neg_infinity : float

Negative infinity.

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

Sourceval nan : float

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]

Sourceval max_float : float

The largest positive finite value of type float.

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

Sourceval min_float : float

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

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

Sourceval epsilon_float : float

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]

Sourcetype fpclass = 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.

Sourceval classify_float : float -> fpclass

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.

Sourceval (^) : string -> string -> string

String concatenation.

Character operations

More character operations are provided in module Char.

Sourceval int_of_char : char -> int

Return the ASCII code of the argument.

Sourceval char_of_int : int -> char

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

Sourceval ignore : 'a -> unit

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

Sourceval string_of_bool : bool -> string

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

Sourceval bool_of_string : string -> bool

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

Sourceval string_of_int : int -> string

Return the string representation of an integer, in decimal.

Sourceval int_of_string : string -> int

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.

Sourceval string_of_float : float -> string

Return the string representation of a floating-point number.

Sourceval float_of_string : string -> float

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

Sourceval fst : ('a * 'b) -> 'a

Return the first component of a pair.

Sourceval snd : ('a * 'b) -> 'b

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.

Sourcetype in_channel = in_channel

The type of input channel.

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

Sourcetype out_channel = out_channel

The type of output channel.

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

Sourceval stdin : in_channel

The standard input for the process.

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

Sourceval stdout : out_channel

The standard output for the process.

Sourceval stderr : out_channel

The standard error output for the process.

Output functions on standard output

Sourceval print_char : char -> unit

Print a character on standard output.

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

Sourceval print_string : string -> unit

Print a string on standard output.

Sourceval print_bytes : bytes -> unit

Print a byte sequence on standard output.

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

Sourceval print_int : int -> unit

Print an integer, in decimal, on standard output.

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

Sourceval print_float : float -> unit

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

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

Sourceval print_endline : string -> unit

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

Sourceval print_newline : unit -> unit

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

Sourceval prerr_char : char -> unit

Print a character on standard error.

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

Sourceval prerr_string : string -> unit

Print a string on standard error.

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

Sourceval prerr_bytes : bytes -> unit

Print a byte sequence on standard error.

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

Sourceval prerr_int : int -> unit

Print an integer, in decimal, on standard error.

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

Sourceval prerr_float : float -> unit

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

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

Sourceval prerr_endline : string -> unit

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

Sourceval prerr_newline : unit -> unit

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

Sourceval read_line : unit -> string

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

Sourceval read_int : unit -> int

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

Sourceval read_float : unit -> float

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

Sourcetype open_flag = 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]

Sourceval open_out : string -> out_channel

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]

Sourceval open_out_bin : string -> out_channel

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]

Sourceval open_out_gen : open_flag list -> int -> string -> out_channel

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]

Sourceval flush : out_channel -> unit

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]

Sourceval flush_all : unit -> unit

Flush all open output channels; ignore errors.

deprecated [since 2016-04]

Sourceval output_char : out_channel -> char -> unit

Write the character on the given output channel.

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

Sourceval output_string : out_channel -> string -> unit

Write the string on the given output channel.

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

Sourceval output_bytes : out_channel -> bytes -> unit

Write the byte sequence on the given output channel.

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

Sourceval output : out_channel -> bytes -> int -> int -> unit

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.

Sourceval output_substring : out_channel -> string -> int -> int -> unit

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

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

Sourceval output_byte : out_channel -> int -> unit

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]

Sourceval output_binary_int : out_channel -> int -> unit

Write one integer in binary format (4 bytes, big-endian) on the given output channel. The given integer is taken modulo 2³². 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]

Sourceval output_value : out_channel -> 'a -> unit

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]

Sourceval seek_out : out_channel -> int -> unit

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]

Sourceval pos_out : out_channel -> int

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]

Sourceval out_channel_length : out_channel -> int

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]

Sourceval close_out : out_channel -> unit

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]

Sourceval close_out_noerr : out_channel -> unit

Same as close_out, but ignore all errors.

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

Sourceval set_binary_mode_out : out_channel -> bool -> unit

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

Sourceval open_in : string -> in_channel

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]

Sourceval open_in_bin : string -> in_channel

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]

Sourceval open_in_gen : open_flag list -> int -> string -> in_channel

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]

Sourceval input_char : in_channel -> char

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]

Sourceval input_line : in_channel -> string

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]

Sourceval input : in_channel -> bytes -> int -> int -> int

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.

Sourceval really_input : in_channel -> bytes -> int -> int -> unit

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.

Sourceval really_input_string : in_channel -> int -> string

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]

Sourceval input_byte : in_channel -> int

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]

Sourceval input_binary_int : in_channel -> int

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]

Sourceval input_value : in_channel -> 'a

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]

Sourceval seek_in : in_channel -> int -> unit

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]

Sourceval pos_in : in_channel -> int

Return the current reading position for the given channel.

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

Sourceval in_channel_length : in_channel -> int

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]

Sourceval close_in : in_channel -> unit

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]

Sourceval close_in_noerr : in_channel -> unit

Same as close_in, but ignore all errors.

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

Sourceval set_binary_mode_in : in_channel -> bool -> unit

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

Sourcetype 'a ref = 'a ref = {

mutable contents : 'a;

}

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

Sourceval ref : 'a -> 'a ref

Return a fresh reference containing the given value.

Sourceval (!) : 'a ref -> 'a

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

Sourceval (:=) : 'a ref -> 'a -> unit

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

Sourceval incr : int ref -> unit

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

Sourceval decr : int ref -> unit

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

Result type

Sourcetype ('a, 'b) result = ('a, 'b) 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.