include module type of struct include Core end
include module type of struct include Base.T end
included first so that everything else shadows it
Exceptions
Raise the given exception value
val raise_notrace : exn -> 'aA faster version raise which does not record the backtrace.
val invalid_arg : string -> 'aRaise exception Invalid_argument with the given string.
val failwith : string -> 'aRaise exception Failure with the given string.
The Exit exception is not raised by any library function. It is provided for use in your programs.
Comparisons
val (==) : 'a -> 'a -> boole1 == 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.
val (!=) : 'a -> 'a -> boolBoolean operations
val (&&) : bool -> bool -> boolThe 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 -> boolThe 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
__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"
__FILE__ returns the name of the file currently being parsed by the compiler.
__LINE__ returns the line number at which this expression appears in the file currently being parsed by the compiler.
__MODULE__ returns the module name of the file being parsed by the compiler.
val __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.
val __FUNCTION__ : string__FUNCTION__ returns the name of the current function or method, including any enclosing modules or classes.
val __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"
val __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.
val __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
val (|>) : 'a -> ('a -> 'b) -> 'bReverse-application operator: x |> f |> g is exactly equivalent to g (f (x)).
val (@@) : ('a -> 'b) -> 'a -> 'bApplication operator: g @@ f @@ x is exactly equivalent to g (f (x)).
Integer arithmetic
Integers are 31 bits wide (or 63 bits on 64-bit processors). All operations are taken modulo 231 (or 263). They do not fail on overflow.
Unary negation. You can also write - e instead of ~- e.
Unary addition. You can also write + e instead of ~+ e.
val (+) : int -> int -> intval (-) : int -> int -> intval (*) : int -> int -> intval (/) : int -> int -> intInteger 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 -> intInteger 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.
Return the absolute value of the argument. Note that this may be negative if the argument is min_int.
The greatest representable integer.
The smallest representable integer.
Bitwise operations
val (land) : int -> int -> intval (lor) : int -> int -> intval (lxor) : int -> int -> intBitwise logical exclusive or.
Bitwise logical negation.
val (lsl) : int -> int -> intn 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 -> intn 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 -> intn 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 -> floatUnary negation. You can also write -. e instead of ~-. e.
val (~+.) : float -> floatUnary addition. You can also write +. e instead of ~+. e.
val (+.) : float -> float -> floatval (-.) : float -> float -> floatFloating-point subtraction
val (*.) : float -> float -> floatFloating-point multiplication
val (/.) : float -> float -> floatval (**) : float -> float -> floatval sqrt : float -> floatval log10 : float -> floatval expm1 : float -> floatexpm1 x computes exp x -. 1.0, giving numerically-accurate results even if x is close to 0.0.
val log1p : float -> floatlog1p x computes log(1.0 +. x) (natural logarithm), giving numerically-accurate results even if x is close to 0.0.
Cosine. Argument is in radians.
Sine. Argument is in radians.
Tangent. Argument is in radians.
val acos : float -> floatArc cosine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between 0.0 and pi.
val asin : float -> floatArc sine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between -pi/2 and pi/2.
val atan : float -> floatArc tangent. Result is in radians and is between -pi/2 and pi/2.
val atan2 : float -> float -> floatatan2 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.
val hypot : float -> float -> floathypot 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.
val cosh : float -> floatHyperbolic cosine. Argument is in radians.
val sinh : float -> floatHyperbolic sine. Argument is in radians.
val tanh : float -> floatHyperbolic tangent. Argument is in radians.
val acosh : float -> floatHyperbolic arc cosine. The argument must fall within the range [1.0, inf]. Result is in radians and is between 0.0 and inf.
val asinh : float -> floatHyperbolic arc sine. The argument and result range over the entire real line. Result is in radians.
val atanh : float -> floatHyperbolic arc tangent. The argument must fall within the range [-1.0, 1.0]. Result is in radians and ranges over the entire real line.
val ceil : float -> floatRound 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.
val floor : float -> floatRound 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.
val abs_float : float -> floatabs_float f returns the absolute value of f.
val copysign : float -> float -> floatcopysign 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.
val mod_float : float -> float -> floatmod_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.
val frexp : float -> float * intfrexp 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.
val ldexp : float -> int -> floatldexp x n returns x *. 2 ** n.
val modf : float -> float * floatmodf f returns the pair of the fractional and integral part of f.
Same as Caml.float_of_int.
val float_of_int : int -> floatConvert an integer to floating-point.
val truncate : float -> intSame as Caml.int_of_float.
val int_of_float : float -> intTruncate 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.
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.
The largest positive finite value of type float.
The smallest positive, non-zero, non-denormalized value of type float.
val epsilon_float : floatThe difference between 1.0 and the smallest exactly representable floating-point number greater than 1.0.
type fpclass = Stdlib.fpclass = | FP_normalNormal number, none of the below
| FP_subnormalNumber very close to 0.0, has reduced precision
| FP_zero| FP_infiniteNumber is positive or negative infinity
| FP_nanNot 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 -> fpclassReturn the class of the given floating-point number: normal, subnormal, zero, infinite, or not a number.
String operations
More string operations are provided in module String.
val (^) : string -> string -> stringCharacter operations
More character operations are provided in module Char.
val int_of_char : char -> intReturn the ASCII code of the argument.
val char_of_int : int -> charReturn the character with the given ASCII code. Raise Invalid_argument "char_of_int" if the argument is outside the range 0--255.
Unit operations
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 -> stringReturn 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 -> boolConvert 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 -> stringReturn the string representation of an integer, in decimal.
val int_of_string : string -> intConvert 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 -> stringReturn the string representation of a floating-point number.
val float_of_string : string -> floatConvert 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) -> 'aReturn the first component of a pair.
val snd : ('a * 'b) -> 'bReturn the second component of a pair.
List operations
More list operations are provided in module List.
Note: all input/output functions can raise Sys_error when the system calls they invoke fail.
type in_channel = Stdlib.in_channelThe type of input channel.
type out_channel = Stdlib.out_channelThe type of output channel.
val stdin : Stdlib.in_channelThe standard input for the process.
val stdout : Stdlib.out_channelThe standard output for the process.
val stderr : Stdlib.out_channelThe standard error output for the process.
Output functions on standard output
val print_char : char -> unitPrint a character on standard output.
val print_string : string -> unitPrint a string on standard output.
val print_bytes : bytes -> unitPrint a byte sequence on standard output.
val print_int : int -> unitPrint an integer, in decimal, on standard output.
val print_float : float -> unitPrint a floating-point number, in decimal, on standard output.
val print_endline : string -> unitPrint a string, followed by a newline character, on standard output and flush standard output.
val print_newline : unit -> unitPrint a newline character on standard output, and flush standard output. This can be used to simulate line buffering of standard output.
Output functions on standard error
val prerr_char : char -> unitPrint a character on standard error.
val prerr_string : string -> unitPrint a string on standard error.
val prerr_bytes : bytes -> unitPrint a byte sequence on standard error.
val prerr_int : int -> unitPrint an integer, in decimal, on standard error.
val prerr_float : float -> unitPrint a floating-point number, in decimal, on standard error.
val prerr_endline : string -> unitPrint a string, followed by a newline character on standard error and flush standard error.
val prerr_newline : unit -> unitPrint a newline character on standard error, and flush standard error.
val read_line : unit -> stringFlush 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.
val read_int : unit -> intFlush 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.
val read_float : unit -> floatFlush 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.
General output functions
type open_flag = Stdlib.open_flag = | Open_rdonly| Open_wronly| Open_appendopen for appending: always write at end of file.
| Open_creatcreate the file if it does not exist.
| Open_truncempty the file if it already exists.
| Open_exclfail if Open_creat and the file already exists.
| Open_binaryopen in binary mode (no conversion).
| Open_textopen in text mode (may perform conversions).
| Open_nonblockopen in non-blocking mode.
Opening modes for Caml.open_out_gen and Caml.open_in_gen.
val open_out : string -> Stdlib.out_channelOpen 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.
val open_out_bin : string -> Stdlib.out_channelSame 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.
val open_out_gen : Stdlib.open_flag list -> int -> string -> Stdlib.out_channelopen_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.
val flush : Stdlib.out_channel -> unitFlush 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.
val flush_all : unit -> unitFlush all open output channels; ignore errors.
val output_char : Stdlib.out_channel -> char -> unitWrite the character on the given output channel.
val output_string : Stdlib.out_channel -> string -> unitWrite the string on the given output channel.
val output_bytes : Stdlib.out_channel -> bytes -> unitWrite the byte sequence on the given output channel.
val output : Stdlib.out_channel -> bytes -> int -> int -> unitoutput 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.
val output_substring : Stdlib.out_channel -> string -> int -> int -> unitSame as output but take a string as argument instead of a byte sequence.
val output_byte : Stdlib.out_channel -> int -> unitWrite one 8-bit integer (as the single character with that code) on the given output channel. The given integer is taken modulo 256.
val output_binary_int : Stdlib.out_channel -> int -> unitWrite one integer in binary format (4 bytes, big-endian) on the given output channel. The given integer is taken modulo 232. 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.
val output_value : Stdlib.out_channel -> 'a -> unitWrite 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.
val seek_out : Stdlib.out_channel -> int -> unitseek_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.
val pos_out : Stdlib.out_channel -> intReturn the current writing position for the given channel. Does not work on channels opened with the Open_append flag (returns unspecified results).
val out_channel_length : Stdlib.out_channel -> intReturn 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.
val close_out : Stdlib.out_channel -> unitClose 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.
val close_out_noerr : Stdlib.out_channel -> unitSame as close_out, but ignore all errors.
val set_binary_mode_out : Stdlib.out_channel -> bool -> unitset_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.
val open_in : string -> Stdlib.in_channelOpen the named file for reading, and return a new input channel on that file, positionned at the beginning of the file.
val open_in_bin : string -> Stdlib.in_channelSame 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.
val open_in_gen : Stdlib.open_flag list -> int -> string -> Stdlib.in_channelopen_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.
Read one character from the given input channel. Raise End_of_file if there are no more characters to read.
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.
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.
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.
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.
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.
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.
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.
val seek_in : Stdlib.in_channel -> int -> unitseek_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.
val pos_in : Stdlib.in_channel -> intReturn the current reading position for the given channel.
val in_channel_length : Stdlib.in_channel -> intReturn 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.
val close_in : Stdlib.in_channel -> unitClose 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.
val close_in_noerr : Stdlib.in_channel -> unitSame as close_in, but ignore all errors.
val set_binary_mode_in : Stdlib.in_channel -> bool -> unitset_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.
Operations on large files
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 ref = 'a Stdlib.ref = {mutable contents : 'a;
}The type of references (mutable indirection cells) containing a value of type 'a.
Return a fresh reference containing the given value.
!r returns the current contents of reference r. Equivalent to fun r -> r.contents.
val (:=) : 'a ref -> 'a -> unitr := a stores the value of a in reference r. Equivalent to fun r v -> r.contents <- v.
val incr : int ref -> unitIncrement the integer contained in the given reference. Equivalent to fun r -> r := succ !r.
val decr : int ref -> unitDecrement the integer contained in the given reference. Equivalent to fun r -> r := pred !r.
Result type
type ('a, 'b) result = ('a, 'b) Stdlib.result = | Ok of 'a| Error of 'b
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.
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.
Converts a format string into a string.
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) format6 ->
('f, 'b, 'c, 'e, 'g, 'h) format6 ->
('a, 'b, 'c, 'd, 'g, 'h) format6f1 ^^ 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
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) -> unitRegister 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 -> boolval (<=) : int -> int -> boolval (=) : int -> int -> boolval (>) : int -> int -> boolval (<) : int -> int -> boolval (<>) : int -> int -> boolval equal : int -> int -> boolval compare : int -> int -> intval min : int -> int -> intval max : int -> int -> intval (|!) : 'a -> ('a -> 'b) -> 'binclude module type of struct include Core.Either.Export end
type (!'f, !'s) _either = ('f, 's) Base__Either.t = | First of 'f| Second of 's
val sexp_of_bigstring : bigstring -> Sexplib0.Sexp.tval bigstring_of_sexp : Sexplib0.Sexp.t -> bigstringval sexp_of_mat : mat -> Sexplib0.Sexp.tval mat_of_sexp : Sexplib0.Sexp.t -> matval sexp_of_vec : vec -> Sexplib0.Sexp.tval vec_of_sexp : Sexplib0.Sexp.t -> vecval sexp_of_opaque : _ -> Base.Sexp.tval opaque_of_sexp : Base.Sexp.t -> _val sexp_of_pair :
('a -> Base.Sexp.t) ->
('b -> Base.Sexp.t) ->
('a * 'b) ->
Base.Sexp.tval pair_of_sexp :
(Base.Sexp.t -> 'a) ->
(Base.Sexp.t -> 'b) ->
Base.Sexp.t ->
'a * 'bexception Of_sexp_error of Base.Exn.t * Base.Sexp.tval of_sexp_error : Base.String.t -> Base.Sexp.t -> _val of_sexp_error_exn : Base.Exn.t -> Base.Sexp.t -> _include module type of struct include Core.List.Infix end
val (@) : 'a Base__List.t -> 'a Base__List.t -> 'a Base__List.tinclude module type of struct include Core.Perms.Export end
val compare_read : read -> read -> Base.Int.tval hash_fold_read :
Ppx_hash_lib.Std.Hash.state ->
read ->
Ppx_hash_lib.Std.Hash.stateval hash_read : read -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_read : read -> Sexplib0.Sexp.tval read_of_sexp : Sexplib0.Sexp.t -> readval equal_read : read -> read -> Base.Bool.tWe 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.
val hash_fold_write :
Ppx_hash_lib.Std.Hash.state ->
write ->
Ppx_hash_lib.Std.Hash.stateval hash_write : write -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_write : write -> Sexplib0.Sexp.tval write_of_sexp : Sexplib0.Sexp.t -> writeval hash_fold_immutable :
Ppx_hash_lib.Std.Hash.state ->
immutable ->
Ppx_hash_lib.Std.Hash.stateval hash_immutable : immutable -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_immutable : immutable -> Sexplib0.Sexp.tval immutable_of_sexp : Sexplib0.Sexp.t -> immutableval hash_fold_read_write :
Ppx_hash_lib.Std.Hash.state ->
read_write ->
Ppx_hash_lib.Std.Hash.stateval hash_read_write : read_write -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_read_write : read_write -> Sexplib0.Sexp.tval read_write_of_sexp : Sexplib0.Sexp.t -> read_writeval compare_perms :
('a -> 'a -> Base.Int.t) ->
'a perms ->
'a perms ->
Base.Int.tval equal_perms :
('a -> 'a -> Base.Bool.t) ->
'a perms ->
'a perms ->
Base.Bool.tval globalize_perms : ('a -> 'a) -> 'a perms -> 'a permsval hash_fold_perms :
(Ppx_hash_lib.Std.Hash.state -> 'a -> Ppx_hash_lib.Std.Hash.state) ->
Ppx_hash_lib.Std.Hash.state ->
'a perms ->
Ppx_hash_lib.Std.Hash.stateval sexp_of_perms : ('a -> Sexplib0.Sexp.t) -> 'a perms -> Sexplib0.Sexp.tval perms_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a permstype -'a return = private 'a Core__.Import.With_return.return = {return : 'b. 'a -> 'b;
}exception C_malloc_exn of Base.Int.t * Base.Int.tRaised if malloc in C bindings fail (errno * size).
exception Finally of Core__.Import.Exn.t * Core__.Import.Exn.tval fst3 : ('a * 'b * 'c) -> 'aval snd3 : ('a * 'b * 'c) -> 'bval trd3 : ('a * 'b * 'c) -> 'cval phys_same : 'a -> 'b -> Base.Bool.tphys_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.
val (%) : int -> int -> intval (/%) : int -> int -> intval (//) : int -> int -> floatval (==>) : bool -> bool -> boolval bprintf :
Base__.Import0.Stdlib.Buffer.t ->
('a, Base__.Import0.Stdlib.Buffer.t, unit) Stdlib.format ->
'aval const : 'a -> 'b -> 'aval eprintf : ('a, Stdlib.out_channel, Base.Unit.t) Stdlib.format -> 'aval error :
?here:Base__.Source_code_position0.t ->
?strict:unit ->
string ->
'a ->
('a -> Base__.Sexp.t) ->
'b Core.Or_error.tval failwithf : ('a, unit, string, unit -> 'b) Stdlib.format4 -> 'aval failwiths :
?strict:Base.Unit.t ->
here:Stdlib.Lexing.position ->
Base.String.t ->
'a ->
('a -> Base.Sexp.t) ->
'bval force : 'a Base.Lazy.t -> 'aval fprintf :
Stdlib.out_channel ->
('a, Stdlib.out_channel, Base.Unit.t) Stdlib.format ->
'aval invalid_argf : ('a, unit, string, unit -> 'b) Stdlib.format4 -> 'aval ifprintf : 'a -> ('b, 'a, 'c, unit) Stdlib.format4 -> 'bval is_none : 'a option -> boolval is_some : 'a option -> boolval ksprintf : (string -> 'a) -> ('b, unit, string, 'a) Stdlib.format4 -> 'bval print_s : ?mach:Base.unit -> Base.Sexp.t -> Base.unitval eprint_s : ?mach:Base.unit -> Base.Sexp.t -> Base.unitval printf : ('a, Stdlib.out_channel, Base.Unit.t) Stdlib.format -> 'aval protect : f:(unit -> 'a) -> finally:(unit -> unit) -> 'aval protectx : f:('a -> 'b) -> 'a -> finally:('a -> unit) -> 'bval raise_s : Base__.Sexp.t -> 'aval round : ?dir:[ `Down | `Nearest | `Up | `Zero ] -> float -> floatval (**.) : Base__Float.t -> Base__Float.t -> Base__Float.tval (%.) : Base__Float.t -> Base__Float.t -> Base__Float.tval sprintf : ('a, unit, string) Stdlib.format -> 'aval stage : 'a -> 'a Core__.Import.Staged.tval unstage : 'a Core__.Import.Staged.t -> 'aval with_return : ('a Core__.Import.With_return.return -> 'a) -> 'aval with_return_option :
('a Core__.Import.With_return.return -> unit) ->
'a optioninclude sig ... end
val compare_array :
('a -> 'a -> Base.Int.t) ->
'a Base.Array.t ->
'a Base.Array.t ->
Base.Int.tval compare_array__local :
('a -> 'a -> Base.Int.t) ->
'a Base.Array.t ->
'a Base.Array.t ->
Base.Int.tval equal_array :
('a -> 'a -> Base.Bool.t) ->
'a Base.Array.t ->
'a Base.Array.t ->
Base.Bool.tval equal_array__local :
('a -> 'a -> Base.Bool.t) ->
'a Base.Array.t ->
'a Base.Array.t ->
Base.Bool.tval globalize_array : ('a -> 'a) -> 'a Base.Array.t -> 'a Base.Array.tval sexp_of_array :
('a -> Sexplib0.Sexp.t) ->
'a Base.Array.t ->
Sexplib0.Sexp.tval array_of_sexp :
(Sexplib0.Sexp.t -> 'a) ->
Sexplib0.Sexp.t ->
'a Base.Array.tval array_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a Base.Array.t Sexplib0.Sexp_grammar.tval compare_bool : Base.Bool.t -> Base.Bool.t -> Base.Int.tval compare_bool__local : Base.Bool.t -> Base.Bool.t -> Base.Int.tval equal_bool : Base.Bool.t -> Base.Bool.t -> Base.Bool.tval equal_bool__local : Base.Bool.t -> Base.Bool.t -> Base.Bool.tval globalize_bool : Base.Bool.t -> Base.Bool.tval hash_fold_bool :
Ppx_hash_lib.Std.Hash.state ->
Base.Bool.t ->
Ppx_hash_lib.Std.Hash.stateval hash_bool : Base.Bool.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_bool : Base.Bool.t -> Sexplib0.Sexp.tval bool_of_sexp : Sexplib0.Sexp.t -> Base.Bool.tval bool_sexp_grammar : Base.Bool.t Sexplib0.Sexp_grammar.tval compare_char : Base.Char.t -> Base.Char.t -> Base.Int.tval compare_char__local : Base.Char.t -> Base.Char.t -> Base.Int.tval equal_char : Base.Char.t -> Base.Char.t -> Base.Bool.tval equal_char__local : Base.Char.t -> Base.Char.t -> Base.Bool.tval globalize_char : Base.Char.t -> Base.Char.tval hash_fold_char :
Ppx_hash_lib.Std.Hash.state ->
Base.Char.t ->
Ppx_hash_lib.Std.Hash.stateval hash_char : Base.Char.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_char : Base.Char.t -> Sexplib0.Sexp.tval char_of_sexp : Sexplib0.Sexp.t -> Base.Char.tval char_sexp_grammar : Base.Char.t Sexplib0.Sexp_grammar.tval compare_float : Base.Float.t -> Base.Float.t -> Base.Int.tval compare_float__local : Base.Float.t -> Base.Float.t -> Base.Int.tval equal_float : Base.Float.t -> Base.Float.t -> Base.Bool.tval equal_float__local : Base.Float.t -> Base.Float.t -> Base.Bool.tval globalize_float : Base.Float.t -> Base.Float.tval hash_fold_float :
Ppx_hash_lib.Std.Hash.state ->
Base.Float.t ->
Ppx_hash_lib.Std.Hash.stateval hash_float : Base.Float.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_float : Base.Float.t -> Sexplib0.Sexp.tval float_of_sexp : Sexplib0.Sexp.t -> Base.Float.tval float_sexp_grammar : Base.Float.t Sexplib0.Sexp_grammar.tval compare_int : Base.Int.t -> Base.Int.t -> Base.Int.tval compare_int__local : Base.Int.t -> Base.Int.t -> Base.Int.tval equal_int : Base.Int.t -> Base.Int.t -> Base.Bool.tval equal_int__local : Base.Int.t -> Base.Int.t -> Base.Bool.tval globalize_int : Base.Int.t -> Base.Int.tval hash_fold_int :
Ppx_hash_lib.Std.Hash.state ->
Base.Int.t ->
Ppx_hash_lib.Std.Hash.stateval hash_int : Base.Int.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_int : Base.Int.t -> Sexplib0.Sexp.tval int_of_sexp : Sexplib0.Sexp.t -> Base.Int.tval int_sexp_grammar : Base.Int.t Sexplib0.Sexp_grammar.tval compare_int32 : Base.Int32.t -> Base.Int32.t -> Base.Int.tval compare_int32__local : Base.Int32.t -> Base.Int32.t -> Base.Int.tval equal_int32 : Base.Int32.t -> Base.Int32.t -> Base.Bool.tval equal_int32__local : Base.Int32.t -> Base.Int32.t -> Base.Bool.tval globalize_int32 : Base.Int32.t -> Base.Int32.tval hash_fold_int32 :
Ppx_hash_lib.Std.Hash.state ->
Base.Int32.t ->
Ppx_hash_lib.Std.Hash.stateval hash_int32 : Base.Int32.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_int32 : Base.Int32.t -> Sexplib0.Sexp.tval int32_of_sexp : Sexplib0.Sexp.t -> Base.Int32.tval int32_sexp_grammar : Base.Int32.t Sexplib0.Sexp_grammar.tval compare_int64 : Base.Int64.t -> Base.Int64.t -> Base.Int.tval compare_int64__local : Base.Int64.t -> Base.Int64.t -> Base.Int.tval equal_int64 : Base.Int64.t -> Base.Int64.t -> Base.Bool.tval equal_int64__local : Base.Int64.t -> Base.Int64.t -> Base.Bool.tval globalize_int64 : Base.Int64.t -> Base.Int64.tval hash_fold_int64 :
Ppx_hash_lib.Std.Hash.state ->
Base.Int64.t ->
Ppx_hash_lib.Std.Hash.stateval hash_int64 : Base.Int64.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_int64 : Base.Int64.t -> Sexplib0.Sexp.tval int64_of_sexp : Sexplib0.Sexp.t -> Base.Int64.tval int64_sexp_grammar : Base.Int64.t Sexplib0.Sexp_grammar.tval compare_lazy_t :
('a -> 'a -> Base.Int.t) ->
'a lazy_t ->
'a lazy_t ->
Base.Int.tval compare_lazy_t__local :
('a -> 'a -> Base.Int.t) ->
'a lazy_t ->
'a lazy_t ->
Base.Int.tval hash_fold_lazy_t :
(Ppx_hash_lib.Std.Hash.state -> 'a -> Ppx_hash_lib.Std.Hash.state) ->
Ppx_hash_lib.Std.Hash.state ->
'a lazy_t ->
Ppx_hash_lib.Std.Hash.stateval sexp_of_lazy_t : ('a -> Sexplib0.Sexp.t) -> 'a lazy_t -> Sexplib0.Sexp.tval lazy_t_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a lazy_tval lazy_t_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a lazy_t Sexplib0.Sexp_grammar.tval compare_list :
('a -> 'a -> Base.Int.t) ->
'a Base.List.t ->
'a Base.List.t ->
Base.Int.tval compare_list__local :
('a -> 'a -> Base.Int.t) ->
'a Base.List.t ->
'a Base.List.t ->
Base.Int.tval equal_list :
('a -> 'a -> Base.Bool.t) ->
'a Base.List.t ->
'a Base.List.t ->
Base.Bool.tval equal_list__local :
('a -> 'a -> Base.Bool.t) ->
'a Base.List.t ->
'a Base.List.t ->
Base.Bool.tval globalize_list : ('a -> 'a) -> 'a Base.List.t -> 'a Base.List.tval hash_fold_list :
(Ppx_hash_lib.Std.Hash.state -> 'a -> Ppx_hash_lib.Std.Hash.state) ->
Ppx_hash_lib.Std.Hash.state ->
'a Base.List.t ->
Ppx_hash_lib.Std.Hash.stateval sexp_of_list : ('a -> Sexplib0.Sexp.t) -> 'a Base.List.t -> Sexplib0.Sexp.tval list_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a Base.List.tval list_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a Base.List.t Sexplib0.Sexp_grammar.tval compare_nativeint : Base.Nativeint.t -> Base.Nativeint.t -> Base.Int.tval compare_nativeint__local :
Base.Nativeint.t ->
Base.Nativeint.t ->
Base.Int.tval equal_nativeint : Base.Nativeint.t -> Base.Nativeint.t -> Base.Bool.tval equal_nativeint__local :
Base.Nativeint.t ->
Base.Nativeint.t ->
Base.Bool.tval globalize_nativeint : Base.Nativeint.t -> Base.Nativeint.tval hash_fold_nativeint :
Ppx_hash_lib.Std.Hash.state ->
Base.Nativeint.t ->
Ppx_hash_lib.Std.Hash.stateval hash_nativeint : Base.Nativeint.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_nativeint : Base.Nativeint.t -> Sexplib0.Sexp.tval nativeint_of_sexp : Sexplib0.Sexp.t -> Base.Nativeint.tval nativeint_sexp_grammar : Base.Nativeint.t Sexplib0.Sexp_grammar.tval compare_option :
('a -> 'a -> Base.Int.t) ->
'a Base.Option.t ->
'a Base.Option.t ->
Base.Int.tval compare_option__local :
('a -> 'a -> Base.Int.t) ->
'a Base.Option.t ->
'a Base.Option.t ->
Base.Int.tval equal_option :
('a -> 'a -> Base.Bool.t) ->
'a Base.Option.t ->
'a Base.Option.t ->
Base.Bool.tval equal_option__local :
('a -> 'a -> Base.Bool.t) ->
'a Base.Option.t ->
'a Base.Option.t ->
Base.Bool.tval globalize_option : ('a -> 'a) -> 'a Base.Option.t -> 'a Base.Option.tval hash_fold_option :
(Ppx_hash_lib.Std.Hash.state -> 'a -> Ppx_hash_lib.Std.Hash.state) ->
Ppx_hash_lib.Std.Hash.state ->
'a Base.Option.t ->
Ppx_hash_lib.Std.Hash.stateval sexp_of_option :
('a -> Sexplib0.Sexp.t) ->
'a Base.Option.t ->
Sexplib0.Sexp.tval option_of_sexp :
(Sexplib0.Sexp.t -> 'a) ->
Sexplib0.Sexp.t ->
'a Base.Option.tval option_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a Base.Option.t Sexplib0.Sexp_grammar.tval compare_result :
('ok -> 'ok -> Base.Int.t) ->
('err -> 'err -> Base.Int.t) ->
('ok, 'err) result ->
('ok, 'err) result ->
Base.Int.tval compare_result__local :
('ok -> 'ok -> Base.Int.t) ->
('err -> 'err -> Base.Int.t) ->
('ok, 'err) result ->
('ok, 'err) result ->
Base.Int.tval equal_result :
('ok -> 'ok -> Base.Bool.t) ->
('err -> 'err -> Base.Bool.t) ->
('ok, 'err) result ->
('ok, 'err) result ->
Base.Bool.tval equal_result__local :
('ok -> 'ok -> Base.Bool.t) ->
('err -> 'err -> Base.Bool.t) ->
('ok, 'err) result ->
('ok, 'err) result ->
Base.Bool.tval globalize_result :
('ok -> 'ok) ->
('err -> 'err) ->
('ok, 'err) result ->
('ok, 'err) resultval hash_fold_result :
(Ppx_hash_lib.Std.Hash.state -> 'ok -> Ppx_hash_lib.Std.Hash.state) ->
(Ppx_hash_lib.Std.Hash.state -> 'err -> Ppx_hash_lib.Std.Hash.state) ->
Ppx_hash_lib.Std.Hash.state ->
('ok, 'err) result ->
Ppx_hash_lib.Std.Hash.stateval sexp_of_result :
('ok -> Sexplib0.Sexp.t) ->
('err -> Sexplib0.Sexp.t) ->
('ok, 'err) result ->
Sexplib0.Sexp.tval result_of_sexp :
(Sexplib0.Sexp.t -> 'ok) ->
(Sexplib0.Sexp.t -> 'err) ->
Sexplib0.Sexp.t ->
('ok, 'err) resultval result_sexp_grammar :
'ok Sexplib0.Sexp_grammar.t ->
'err Sexplib0.Sexp_grammar.t ->
('ok, 'err) result Sexplib0.Sexp_grammar.tval compare_string : Base.String.t -> Base.String.t -> Base.Int.tval compare_string__local : Base.String.t -> Base.String.t -> Base.Int.tval equal_string : Base.String.t -> Base.String.t -> Base.Bool.tval equal_string__local : Base.String.t -> Base.String.t -> Base.Bool.tval globalize_string : Base.String.t -> Base.String.tval hash_fold_string :
Ppx_hash_lib.Std.Hash.state ->
Base.String.t ->
Ppx_hash_lib.Std.Hash.stateval hash_string : Base.String.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_string : Base.String.t -> Sexplib0.Sexp.tval string_of_sexp : Sexplib0.Sexp.t -> Base.String.tval string_sexp_grammar : Base.String.t Sexplib0.Sexp_grammar.tval compare_bytes : Base.Bytes.t -> Base.Bytes.t -> Base.Int.tval compare_bytes__local : Base.Bytes.t -> Base.Bytes.t -> Base.Int.tval equal_bytes : Base.Bytes.t -> Base.Bytes.t -> Base.Bool.tval equal_bytes__local : Base.Bytes.t -> Base.Bytes.t -> Base.Bool.tval globalize_bytes : Base.Bytes.t -> Base.Bytes.tval sexp_of_bytes : Base.Bytes.t -> Sexplib0.Sexp.tval bytes_of_sexp : Sexplib0.Sexp.t -> Base.Bytes.tval bytes_sexp_grammar : Base.Bytes.t Sexplib0.Sexp_grammar.tval compare_ref : ('a -> 'a -> Base.Int.t) -> 'a ref -> 'a ref -> Base.Int.tval compare_ref__local :
('a -> 'a -> Base.Int.t) ->
'a ref ->
'a ref ->
Base.Int.tval equal_ref : ('a -> 'a -> Base.Bool.t) -> 'a ref -> 'a ref -> Base.Bool.tval equal_ref__local :
('a -> 'a -> Base.Bool.t) ->
'a ref ->
'a ref ->
Base.Bool.tval globalize_ref : ('a -> 'a) -> 'a ref -> 'a refval sexp_of_ref : ('a -> Sexplib0.Sexp.t) -> 'a ref -> Sexplib0.Sexp.tval ref_of_sexp : (Sexplib0.Sexp.t -> 'a) -> Sexplib0.Sexp.t -> 'a refval ref_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a ref Sexplib0.Sexp_grammar.tval compare_unit : Base.Unit.t -> Base.Unit.t -> Base.Int.tval compare_unit__local : Base.Unit.t -> Base.Unit.t -> Base.Int.tval equal_unit : Base.Unit.t -> Base.Unit.t -> Base.Bool.tval equal_unit__local : Base.Unit.t -> Base.Unit.t -> Base.Bool.tval globalize_unit : Base.Unit.t -> Base.Unit.tval hash_fold_unit :
Ppx_hash_lib.Std.Hash.state ->
Base.Unit.t ->
Ppx_hash_lib.Std.Hash.stateval hash_unit : Base.Unit.t -> Ppx_hash_lib.Std.Hash.hash_valueval sexp_of_unit : Base.Unit.t -> Sexplib0.Sexp.tval unit_of_sexp : Sexplib0.Sexp.t -> Base.Unit.tval unit_sexp_grammar : Base.Unit.t Sexplib0.Sexp_grammar.tval sexp_of_exn : Core__.Import.Exn.t -> Sexplib0.Sexp.texception Not_found_s of Sexplib0.Sexp.tTop-level values
val phys_equal : 'a -> 'a -> Base.Bool.ttype 'a _maybe_bound = 'a Maybe_bound.t = | Incl of 'a| Excl of 'a| Unbounded
val am_running_test : boolval does_raise : (unit -> 'a) -> boolval (^/) : Base.string -> Base.string -> Base.stringTo be used in implementing Core, but not by end users.