package core
Install
Dune Dependency
Authors
Maintainers
Sources
md5=743a141234e04210e295980f7a78a6d9
sha512=61b415f4fb12c78d30649fff1aabe3a475eea926ce6edb7774031f4dc7f37ea51f5d9337ead6ec73cd93da5fd1ed0f2738c210c71ebc8fe9d7f6135a06bd176f
doc/core/Core/index.html
Module CoreSource
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.
Fixed-length, mutable vector of elements with O(1) get and set operations.
Substring type based on Bigarray, for use in I/O and C-bindings
This module extends the Base.Binary_searchable module.
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.
Conversions between units of measure that are based on bytes (like kilobytes, megabytes, gigabytes, and words).
This module extends Base.Bytes.
This module extends Base.Char, adding Identifiable for making char identifiers and Quickcheckable to facilitate automated testing with pseudorandom data.
Comparable extends Base.Comparable and provides functions for comparing like types.
Extends Base.Comparator, providing a type-indexed value that allows you to compare values of that type.
This module extends Base.Container.
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.
Generates hash functions from type expressions and definitions.
This module extends Base.Either.
This module extends Base.Error with bin_io and diff.
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.
An alias to the Float.t type that causes the sexp and bin-io serializers to fail when provided with nan or infinity.
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.
This is a wrapper around INRIA's standard Gc module. Provides memory management control and statistics, and finalized values.
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).
A functor for displaying a type as a sequence of ASCII characters printed in hexadecimal.
Type for the commonly-used notion of host and port in networking.
A non-allocating alternative to the standard Option type.
This module extends Base.Info, which provides a type for info-level debug messages.
This module extends Base.Int32.
This module extends Base.Int63.
This module extends Base.Int64.
Various interface exports.
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.
Map is a functional data structure (balanced binary tree) implementing finite maps over a totally-ordered domain, called a "key".
This module defines interfaces used in Map. See those docs for a description of the design.
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.
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.
Provides a variant type for representing months (e.g., Jan, Feb, or Nov) and functions for converting them to other formats (like an int).
This module extends Base.Nativeint.
Open this in modules where you don't want to accidentally use polymorphic comparison. Then, use Poly.(<), for example, where needed.
This module extends Base.Nothing.
This module can be used to safely expose functions and values in signatures that should only be used in unit tests.
This module extends Base.Option with bin_io, quickcheck, and support for ppx_optional.
This module extends Base.Option_array with bin_io.
Interfaces for use with the match%optional syntax, provided by ppx_optional.
This module extends Base.Or_error with bin_io.
This module extends Base.Ordered_collection_common.
Extends Base.Ordering, intended to make code that matches on the result of a comparison more concise and easier to read.
A scale factor, not bounded between 0% and 100%, represented as a float.
These types are intended to be used as phantom types encoding the permissions on a given type.
This module is here to ensure that we don't use the functions in Caml.Printexc inadvertently.
This module extends Base.Queue with bin_io.
Quickcheck is a library that uses predicate-based tests and pseudo-random inputs to automate testing.
This module extends Base.Result.
This interface compares float-like objects with a small tolerance.
This module extends Base.Sequence with bin_io.
This module defines the Set module for Core. Functions that construct a set take as an argument the comparator for the element type.
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.
This module extends Base.Sexpable.
This module extends Base.Sign_or_nan with bin_io.
This module extends Base.Source_code_position.
The tests generated by these functors are run like any other unit tests: by the inline test runner when the functor is applied.
This module extends Base.String.
Like Identifiable, but with t = private string and stable modules.
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.
Interface for Substring.
This module extends Base.Type_equal.
Witnesses that express whether a type's values are always, sometimes, or never immediate.
This module extends Base.Uchar, adding Comparable and Hashable functionality, bin_io support, and Quickcheckable to facilitate automated testing with pseudorandom data.
This module extends Base.Uniform_array with bin_io.
Imperative data structure for representing disjoint sets.
Module for the type unit, extended from Base.Unit. This is mostly useful for building functor arguments.
Represents a unit of time, e.g., that used by Time.Span.to_string_hum. Comparison respects Nanosecond < Microsecond < Millisecond < Second < Minute < Hour < Day.
included first so that everything else shadows it
Exceptions
Raise the given exception value
A faster version raise which does not record the backtrace.
Raise exception Invalid_argument with the given string.
Raise 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
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.
Boolean operations
The boolean negation.
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.
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
__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.
__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.
__FUNCTION__ returns the name of the current function or method, including any enclosing modules or classes.
__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"
__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.
__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
Reverse-application operator: x |> f |> g is exactly equivalent to g (f (x)).
Application 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.
succ x is x + 1.
pred x is x - 1.
Integer addition.
Integer subtraction.
Integer multiplication.
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).
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.
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
Bitwise logical and.
Bitwise logical or.
Bitwise logical exclusive or.
Bitwise logical negation.
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.
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.
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.
Unary negation. You can also write -. e instead of ~-. e.
Unary addition. You can also write +. e instead of ~+. e.
Floating-point addition
Floating-point subtraction
Floating-point multiplication
Floating-point division.
Exponentiation.
Square root.
Exponential.
Natural logarithm.
Base 10 logarithm.
expm1 x computes exp x -. 1.0, giving numerically-accurate results even if x is close to 0.0.
log1p 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.
Arc cosine. The argument must fall within the range [-1.0, 1.0]. Result is in radians and is between 0.0 and pi.
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.
Arc tangent. Result is in radians and is between -pi/2 and pi/2.
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.
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.
Hyperbolic cosine. Argument is in radians.
Hyperbolic sine. Argument is in radians.
Hyperbolic tangent. Argument is in radians.
Hyperbolic arc cosine. The argument must fall within the range [1.0, inf]. Result is in radians and is between 0.0 and inf.
Hyperbolic arc sine. The argument and result range over the entire real line. Result is in radians.
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.
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.
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.
abs_float f returns the absolute value of f.
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.
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.
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.
ldexp x n returns x *. 2 ** n.
modf f returns the pair of the fractional and integral part of f.
Same as Caml.float_of_int.
Convert an integer to floating-point.
Same as Caml.int_of_float.
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.
Positive infinity.
Negative infinity.
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.
The difference between 1.0 and the smallest exactly representable floating-point number greater than 1.0.
The five classes of floating-point numbers, as determined by the Caml.classify_float function.
Return 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.
String concatenation.
Character operations
More character operations are provided in module Char.
Return the ASCII code of the argument.
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
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
Return the string representation of a boolean. As the returned values may be shared, the user should not modify them directly.
Convert the given string to a boolean. Raise Invalid_argument "bool_of_string" if the string is not "true" or "false".
Return the string representation of an integer, in decimal.
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.
Return the string representation of a floating-point number.
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
Return the first component of a pair.
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.
The type of input channel.
The type of output channel.
The standard input for the process.
The standard output for the process.
The standard error output for the process.
Output functions on standard output
Print a character on standard output.
Print a string on standard output.
Print a byte sequence on standard output.
Print an integer, in decimal, on standard output.
Print a floating-point number, in decimal, on standard output.
Print a string, followed by a newline character, on standard output and flush standard output.
Print 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
Print a character on standard error.
Print a string on standard error.
Print a byte sequence on standard error.
Print an integer, in decimal, on standard error.
Print a floating-point number, in decimal, on standard error.
Print a string, followed by a newline character on standard error and flush standard error.
Print a newline character on standard error, and flush standard error.
Input functions on standard input
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.
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.
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.
General output functions
type 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.
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.
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.
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.
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.
Flush all open output channels; ignore errors.
Write the character on the given output channel.
Write the string on the given output channel.
Write the byte sequence on the given output channel.
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.
Same as output but take a string as argument instead of a byte sequence.
Write one 8-bit integer (as the single character with that code) on the given output channel. The given integer is taken modulo 256.
Write 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.
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.
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.
Return the current writing position for the given channel. Does not work on channels opened with the Open_append flag (returns unspecified results).
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.
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.
Same as close_out, but ignore all errors.
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.
General input functions
Open the named file for reading, and return a new input channel on that file, positionned at the beginning of the file.
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.
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.
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.
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.
Return the current reading position for the given channel.
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.
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.
Same as close_in, but ignore all errors.
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.
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
The type of references (mutable indirection cells) containing a value of type 'a.
!r returns the current contents of reference r. Equivalent to fun r -> r.contents.
r := a stores the value of a in reference r. Equivalent to fun r v -> r.contents <- v.
Increment the integer contained in the given reference. Equivalent to fun r -> r := succ !r.
Decrement the integer contained in the given reference. Equivalent to fun r -> r := pred !r.
Result type
Operations on format strings
Format strings are character strings with special lexical conventions that defines the functionality of formatted input/output functions. Format strings are used to read data with formatted input functions from module Scanf and to print data with formatted output functions from modules Printf and Format.
Format strings are made of three kinds of entities:
- conversions specifications, introduced by the special character
'%'followed by one or more characters specifying what kind of argument to read or print, - formatting indications, introduced by the special character
'@'followed by one or more characters specifying how to read or print the argument, - plain characters that are regular characters with usual lexical conventions. Plain characters specify string literals to be read in the input or printed in the output.
There is an additional lexical rule to escape the special characters '%' and '@' in format strings: if a special character follows a '%' character, it is treated as a plain character. In other words, "%%" is considered as a plain '%' and "%@" as a plain '@'.
For more information about conversion specifications and formatting indications available, read the documentation of modules Scanf, Printf and Format.
type ('a, 'b, 'c, 'd, 'e, 'f) format6 =
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6Format 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:
'ais the type of the parameters of the format for formatted output functions (printf-style functions);'ais the type of the values read by the format for formatted input functions (scanf-style functions).
'bis the type of input source for formatted input functions and the type of output target for formatted output functions. Forprintf-style functions from modulePrintf,'bis typicallyout_channel; forprintf-style functions from moduleFormat,'bis typicallyFormat.formatter; forscanf-style functions from moduleScanf,'bis typicallyScanf.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.
'cis the type of the result of the%aand%tprinting functions, and also the type of the argument transmitted to the first argument ofkprintf-style functions or to thekscanf-style functions.
'dis the type of parameters for thescanf-style functions.
'eis the type of the receiver function for thescanf-style functions.
'fis the final result type of a formatted input/output function invocation: for theprintf-style functions, it is typicallyunit; for thescanf-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.
Register the given function to be called at program termination time. The functions registered with at_exit will be called when the program executes Caml.exit, or terminates, either normally or because of an uncaught exception. The functions are called in 'last in, first out' order: the function most recently added with at_exit is called first.
include module type of struct include Int.Replace_polymorphic_compare end
include Base.Comparisons.Infix
with type t := Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0)
val (>=) :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval (<=) :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval (=) :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval (>) :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval (<) :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval (<>) :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval equal :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
boolval compare :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
intcompare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.
val min :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0)val max :
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0) ->
Int.{t}1/shadowed/(8458c4003360de2cb7a6fde3273943c0)include module type of struct include Base_quickcheck.Export end
val quickcheck_generator_option :
'a Base_quickcheck.Generator.t ->
'a Base.option Base_quickcheck.Generator.tval quickcheck_generator_list :
'a Base_quickcheck.Generator.t ->
'a Base.list Base_quickcheck.Generator.tval quickcheck_generator_array :
'a Base_quickcheck.Generator.t ->
'a Base.array Base_quickcheck.Generator.tval quickcheck_generator_ref :
'a Base_quickcheck.Generator.t ->
'a Base.ref Base_quickcheck.Generator.tval quickcheck_generator_lazy_t :
'a Base_quickcheck.Generator.t ->
'a Base.Lazy.t Base_quickcheck.Generator.tval quickcheck_observer_option :
'a Base_quickcheck.Observer.t ->
'a Base.option Base_quickcheck.Observer.tval quickcheck_observer_list :
'a Base_quickcheck.Observer.t ->
'a Base.list Base_quickcheck.Observer.tval quickcheck_observer_array :
'a Base_quickcheck.Observer.t ->
'a Base.array Base_quickcheck.Observer.tval quickcheck_observer_ref :
'a Base_quickcheck.Observer.t ->
'a Base.ref Base_quickcheck.Observer.tval quickcheck_observer_lazy_t :
'a Base_quickcheck.Observer.t ->
'a Base.Lazy.t Base_quickcheck.Observer.tval quickcheck_shrinker_option :
'a Base_quickcheck.Shrinker.t ->
'a Base.option Base_quickcheck.Shrinker.tval quickcheck_shrinker_list :
'a Base_quickcheck.Shrinker.t ->
'a Base.list Base_quickcheck.Shrinker.tval quickcheck_shrinker_array :
'a Base_quickcheck.Shrinker.t ->
'a Base.array Base_quickcheck.Shrinker.tval quickcheck_shrinker_ref :
'a Base_quickcheck.Shrinker.t ->
'a Base.ref Base_quickcheck.Shrinker.tval quickcheck_shrinker_lazy_t :
'a Base_quickcheck.Shrinker.t ->
'a Base.Lazy.t Base_quickcheck.Shrinker.tinclude module type of struct include Interfaces end
module type Stable_without_comparator_with_witness =
Interfaces.Stable_without_comparator_with_witnessinclude module type of struct include Base.List.Infix end
include module type of struct include Base.Ordering.Export end
include module type of struct include Perms.Export end
We don't expose bin_io for write due to a naming conflict with the functions exported by bin_io for read_write. If you want bin_io for write, use Write.t.
val hash_fold_immutable :
Ppx_hash_lib.Std.Hash.state ->
immutable ->
Ppx_hash_lib.Std.Hash.stateval hash_fold_read_write :
Ppx_hash_lib.Std.Hash.state ->
read_write ->
Ppx_hash_lib.Std.Hash.stateval __bin_read_perms__ :
'a Bin_prot.Read.reader ->
(Base.Int.t -> 'a perms) Bin_prot.Read.readerval 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.stateRaised if malloc in C bindings fail (errno * size).
phys_same is like phys_equal, but with a more general type. phys_same is useful when dealing with existential types, when one has a packed value and an unpacked value that one wants to check are physically equal. One can't use phys_equal in such a situation because the types are different.
val error :
?here:Lexing.position ->
?strict:unit ->
string ->
'a ->
('a -> Base.Sexp.t) ->
'b Or_error.tval failwiths :
?strict:Base.Unit.t ->
here:Lexing.position ->
Base.String.t ->
'a ->
('a -> Base.Sexp.t) ->
'binclude module type of struct include Typerep_lib.Std_internal end
runtime type representations
val typename_of_function :
'a Typerep_lib.Typename.t ->
'b Typerep_lib.Typename.t ->
('a -> 'b) Typerep_lib.Typename.tval typename_of_tuple2 :
'a Typerep_lib.Typename.t ->
'b Typerep_lib.Typename.t ->
('a * 'b) Typerep_lib.Typename.tval typename_of_tuple3 :
'a Typerep_lib.Typename.t ->
'b Typerep_lib.Typename.t ->
'c Typerep_lib.Typename.t ->
('a * 'b * 'c) Typerep_lib.Typename.tval typename_of_tuple4 :
'a Typerep_lib.Typename.t ->
'b Typerep_lib.Typename.t ->
'c Typerep_lib.Typename.t ->
'd Typerep_lib.Typename.t ->
('a * 'b * 'c * 'd) Typerep_lib.Typename.tval typename_of_tuple5 :
'a Typerep_lib.Typename.t ->
'b Typerep_lib.Typename.t ->
'c Typerep_lib.Typename.t ->
'd Typerep_lib.Typename.t ->
'e Typerep_lib.Typename.t ->
('a * 'b * 'c * 'd * 'e) Typerep_lib.Typename.tinclude sig ... end
val bin_size_array__local :
'a Bin_prot.Size.sizer_local ->
'a Base.Array.t Bin_prot.Size.sizer_localval bin_write_array__local :
'a Bin_prot.Write.writer_local ->
'a Base.Array.t Bin_prot.Write.writer_localval bin_writer_array :
'a Bin_prot.Type_class.writer ->
'a Base.Array.t Bin_prot.Type_class.writerval __bin_read_array__ :
'a Bin_prot.Read.reader ->
(Base.Int.t -> 'a Base.Array.t) Bin_prot.Read.readerval bin_reader_array :
'a Bin_prot.Type_class.reader ->
'a Base.Array.t Bin_prot.Type_class.readerval 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 array_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a Base.Array.t Sexplib0.Sexp_grammar.tval typerep_of_array :
'a Typerep_lib.Std.Typerep.t ->
'a Base.Array.t Typerep_lib.Std.Typerep.tval typename_of_array :
'a Typerep_lib.Std.Typename.t ->
'a Base.Array.t Typerep_lib.Std.Typename.tval hash_fold_bool :
Ppx_hash_lib.Std.Hash.state ->
Base.Bool.t ->
Ppx_hash_lib.Std.Hash.stateval hash_fold_char :
Ppx_hash_lib.Std.Hash.state ->
Base.Char.t ->
Ppx_hash_lib.Std.Hash.stateval hash_fold_float :
Ppx_hash_lib.Std.Hash.state ->
Base.Float.t ->
Ppx_hash_lib.Std.Hash.stateval hash_fold_int32 :
Ppx_hash_lib.Std.Hash.state ->
Base.Int32.t ->
Ppx_hash_lib.Std.Hash.stateval hash_fold_int64 :
Ppx_hash_lib.Std.Hash.state ->
Base.Int64.t ->
Ppx_hash_lib.Std.Hash.stateval bin_size_lazy_t__local :
'a Bin_prot.Size.sizer_local ->
'a lazy_t Bin_prot.Size.sizer_localval bin_write_lazy_t__local :
'a Bin_prot.Write.writer_local ->
'a lazy_t Bin_prot.Write.writer_localval __bin_read_lazy_t__ :
'a Bin_prot.Read.reader ->
(Base.Int.t -> 'a lazy_t) Bin_prot.Read.readerval 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 typename_of_lazy_t :
'a Typerep_lib.Std.Typename.t ->
'a lazy_t Typerep_lib.Std.Typename.tval bin_size_list__local :
'a Bin_prot.Size.sizer_local ->
'a Base.List.t Bin_prot.Size.sizer_localval bin_write_list__local :
'a Bin_prot.Write.writer_local ->
'a Base.List.t Bin_prot.Write.writer_localval bin_writer_list :
'a Bin_prot.Type_class.writer ->
'a Base.List.t Bin_prot.Type_class.writerval __bin_read_list__ :
'a Bin_prot.Read.reader ->
(Base.Int.t -> 'a Base.List.t) Bin_prot.Read.readerval bin_reader_list :
'a Bin_prot.Type_class.reader ->
'a Base.List.t Bin_prot.Type_class.readerval compare_list__local :
('a -> 'a -> Base.Int.t) ->
'a Base.List.t ->
'a Base.List.t ->
Base.Int.tval equal_list__local :
('a -> 'a -> Base.Bool.t) ->
'a Base.List.t ->
'a Base.List.t ->
Base.Bool.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 typerep_of_list :
'a Typerep_lib.Std.Typerep.t ->
'a Base.List.t Typerep_lib.Std.Typerep.tval typename_of_list :
'a Typerep_lib.Std.Typename.t ->
'a Base.List.t Typerep_lib.Std.Typename.tval hash_fold_nativeint :
Ppx_hash_lib.Std.Hash.state ->
Base.Nativeint.t ->
Ppx_hash_lib.Std.Hash.stateval bin_size_option__local :
'a Bin_prot.Size.sizer_local ->
'a Base.Option.t Bin_prot.Size.sizer_localval bin_write_option__local :
'a Bin_prot.Write.writer_local ->
'a Base.Option.t Bin_prot.Write.writer_localval bin_writer_option :
'a Bin_prot.Type_class.writer ->
'a Base.Option.t Bin_prot.Type_class.writerval __bin_read_option__ :
'a Bin_prot.Read.reader ->
(Base.Int.t -> 'a Base.Option.t) Bin_prot.Read.readerval bin_reader_option :
'a Bin_prot.Type_class.reader ->
'a Base.Option.t Bin_prot.Type_class.readerval 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 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 option_sexp_grammar :
'a Sexplib0.Sexp_grammar.t ->
'a Base.Option.t Sexplib0.Sexp_grammar.tval typerep_of_option :
'a Typerep_lib.Std.Typerep.t ->
'a Base.Option.t Typerep_lib.Std.Typerep.tval typename_of_option :
'a Typerep_lib.Std.Typename.t ->
'a Base.Option.t Typerep_lib.Std.Typename.tval bin_size_result :
'ok Bin_prot.Size.sizer ->
'err Bin_prot.Size.sizer ->
('ok, 'err) result Bin_prot.Size.sizerval bin_size_result__local :
'ok Bin_prot.Size.sizer_local ->
'err Bin_prot.Size.sizer_local ->
('ok, 'err) result Bin_prot.Size.sizer_localval bin_write_result :
'ok Bin_prot.Write.writer ->
'err Bin_prot.Write.writer ->
('ok, 'err) result Bin_prot.Write.writerval bin_write_result__local :
'ok Bin_prot.Write.writer_local ->
'err Bin_prot.Write.writer_local ->
('ok, 'err) result Bin_prot.Write.writer_localval bin_writer_result :
'ok Bin_prot.Type_class.writer ->
'err Bin_prot.Type_class.writer ->
('ok, 'err) result Bin_prot.Type_class.writerval bin_read_result :
'ok Bin_prot.Read.reader ->
'err Bin_prot.Read.reader ->
('ok, 'err) result Bin_prot.Read.readerval __bin_read_result__ :
'ok Bin_prot.Read.reader ->
'err Bin_prot.Read.reader ->
(Base.Int.t -> ('ok, 'err) result) Bin_prot.Read.readerval bin_reader_result :
'ok Bin_prot.Type_class.reader ->
'err Bin_prot.Type_class.reader ->
('ok, 'err) result Bin_prot.Type_class.readerval bin_result :
'ok Bin_prot.Type_class.t ->
'err Bin_prot.Type_class.t ->
('ok, 'err) result Bin_prot.Type_class.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 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 typerep_of_result :
'ok Typerep_lib.Std.Typerep.t ->
'err Typerep_lib.Std.Typerep.t ->
('ok, 'err) result Typerep_lib.Std.Typerep.tval typename_of_result :
'ok Typerep_lib.Std.Typename.t ->
'err Typerep_lib.Std.Typename.t ->
('ok, 'err) result Typerep_lib.Std.Typename.tval hash_fold_string :
Ppx_hash_lib.Std.Hash.state ->
Base.String.t ->
Ppx_hash_lib.Std.Hash.stateval bin_write_ref__local :
'a Bin_prot.Write.writer_local ->
'a ref Bin_prot.Write.writer_localval hash_fold_unit :
Ppx_hash_lib.Std.Hash.state ->
Base.Unit.t ->
Ppx_hash_lib.Std.Hash.stateTop-level values
To be used in implementing Core, but not by end users.
- 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