The unix library makes many Unix system calls and system-related library functions available to OCaml programs. This chapter describes briefly the functions provided. Refer to sections 2 and 3 of the Unix manual for more details on the behavior of these functions.
Not all functions are provided by all Unix variants. If some functions are not available, they will raise Invalid_arg when called.
Programs that use the unix library must be linked as follows:
ocamlc other options unix.cma other files
ocamlopt other options unix.cmxa other files
For interactive use of the unix library, do:
ocamlmktop -o mytop unix.cma
./mytop
or (if dynamic linking of C libraries is supported on your platform), start ocaml and type #load "unix.cma";;.
Windows: A fairly complete emulation of the Unix system calls is provided in the Windows version of OCaml. The end of this chapter gives more information on the functions that are not supported under Windows.
Windows: The Cygwin port of OCaml fully implements all functions from the Unix module. The native Win32 ports implement a subset of them. Below is a list of the functions that are not implemented, or only partially implemented, by the Win32 ports. Functions not mentioned are fully implemented and behave as described previously in this chapter.
Functions Comment fork not implemented, use create_process or threads wait not implemented, use waitpid waitpid can only wait for a given PID, not any child process getppid not implemented (meaningless under Windows) nice not implemented truncate, ftruncate not implemented link implemented (since 3.02) symlink, readlink implemented (since 4.03.0) access execute permission X_OK cannot be tested, it just tests for read permission instead fchmod not implemented chown, fchown not implemented (make no sense on a DOS file system) umask not implemented mkfifo not implemented kill partially implemented (since 4.00.0): only the sigkill signal is implemented pause not implemented (no inter-process signals in Windows) alarm not implemented times partially implemented, will not report timings for child processes getitimer, setitimer not implemented getuid, geteuid, getgid, getegid always return 1 getgroups always returns [|1|] (since 2.00) setuid, setgid, setgroups not implemented getpwnam, getpwuid always raise Not_found getgrnam, getgrgid always raise Not_found type socket_domain PF_INET is fully supported; PF_INET6 is fully supported (since 4.01.0); PF_UNIX is not supported establish_server not implemented; use threads terminal functions (tc*) not implemented
ocaml-doc-4.05/ocaml.html/language.html 0000644 0001750 0001750 00000005711 13131636457 016762 0 ustar mehdi mehdi
This document is intended as a reference manual for the OCaml language. It lists the language constructs, and gives their precise syntax and informal semantics. It is by no means a tutorial introduction to the language: there is not a single example. A good working knowledge of OCaml is assumed.
No attempt has been made at mathematical rigor: words are employed with their intuitive meaning, without further definition. As a consequence, the typing rules have been left out, by lack of the mathematical framework required to express them, while they are definitely part of a full formal definition of the language.
The syntax of the language is given in BNF-like notation. Terminal symbols are set in typewriter font (like this). Non-terminal symbols are set in italic font (like that). Square brackets […] denote optional components. Curly brackets {…} denotes zero, one or several repetitions of the enclosed components. Curly brackets with a trailing plus sign {…}+ denote one or several repetitions of the enclosed components. Parentheses (…) denote grouping.
ocaml-doc-4.05/ocaml.html/libstr.html 0000644 0001750 0001750 00000003723 13131636457 016477 0 ustar mehdi mehdi
The str library provides high-level string processing functions, some based on regular expressions. It is intended to support the kind of file processing that is usually performed with scripting languages such as awk, perl or sed.
Programs that use the str library must be linked as follows:
ocamlc other options str.cma other files
ocamlopt other options str.cmxa other files
For interactive use of the str library, do:
ocamlmktop -o mytop str.cma
./mytop
or (if dynamic linking of C libraries is supported on your platform), start ocaml and type #load "str.cma";;.
ocaml-doc-4.05/ocaml.html/moduleexamples.html 0000644 0001750 0001750 00000052741 13131636457 020230 0 ustar mehdi mehdi
This chapter introduces the module system of OCaml.
A primary motivation for modules is to package together related definitions (such as the definitions of a data type and associated operations over that type) and enforce a consistent naming scheme for these definitions. This avoids running out of names or accidentally confusing names. Such a package is called a structure and is introduced by the struct…end construct, which contains an arbitrary sequence of definitions. The structure is usually given a name with the module binding. Here is for instance a structure packaging together a type of priority queues and their operations:
module PrioQueue = struct type priority = int type 'a queue = Empty | Node of priority * 'a * 'a queue * 'a queue let empty = Empty let rec insert queue prio elt = match queue with Empty -> Node(prio, elt, Empty, Empty) | Node(p, e, left, right) -> if prio <= p then Node(prio, elt, insert right p e, left) else Node(p, e, insert right prio elt, left) exception Queue_is_empty let rec remove_top = function Empty -> raise Queue_is_empty | Node(prio, elt, left, Empty) -> left | Node(prio, elt, Empty, right) -> right | Node(prio, elt, (Node(lprio, lelt, _, _) as left), (Node(rprio, relt, _, _) as right)) -> if lprio <= rprio then Node(lprio, lelt, remove_top left, right) else Node(rprio, relt, left, remove_top right) let extract = function Empty -> raise Queue_is_empty | Node(prio, elt, _, _) as queue -> (prio, elt, remove_top queue) end;;module PrioQueue : sig type priority = int type 'a queue = Empty | Node of priority * 'a * 'a queue * 'a queue val empty : 'a queue val insert : 'a queue -> priority -> 'a -> 'a queue exception Queue_is_empty val remove_top : 'a queue -> 'a queue val extract : 'a queue -> priority * 'a * 'a queue end
Outside the structure, its components can be referred to using the “dot notation”, that is, identifiers qualified by a structure name. For instance, PrioQueue.insert is the function insert defined inside the structure PrioQueue and PrioQueue.queue is the type queue defined in PrioQueue.
PrioQueue.insert PrioQueue.empty 1 "hello";;- : string PrioQueue.queue = PrioQueue.Node (1, "hello", PrioQueue.Empty, PrioQueue.Empty)
Signatures are interfaces for structures. A signature specifies which components of a structure are accessible from the outside, and with which type. It can be used to hide some components of a structure (e.g. local function definitions) or export some components with a restricted type. For instance, the signature below specifies the three priority queue operations empty, insert and extract, but not the auxiliary function remove_top. Similarly, it makes the queue type abstract (by not providing its actual representation as a concrete type).
module type PRIOQUEUE = sig type priority = int (* still concrete *) type 'a queue (* now abstract *) val empty : 'a queue val insert : 'a queue -> int -> 'a -> 'a queue val extract : 'a queue -> int * 'a * 'a queue exception Queue_is_empty end;;module type PRIOQUEUE = sig type priority = int type 'a queue val empty : 'a queue val insert : 'a queue -> int -> 'a -> 'a queue val extract : 'a queue -> int * 'a * 'a queue exception Queue_is_empty end
Restricting the PrioQueue structure by this signature results in another view of the PrioQueue structure where the remove_top function is not accessible and the actual representation of priority queues is hidden:
module AbstractPrioQueue = (PrioQueue : PRIOQUEUE);;module AbstractPrioQueue : PRIOQUEUE
AbstractPrioQueue.remove_top ;;Error: Unbound value AbstractPrioQueue.remove_top
AbstractPrioQueue.insert AbstractPrioQueue.empty 1 "hello";;- : string AbstractPrioQueue.queue = <abstr>
The restriction can also be performed during the definition of the structure, as in
module PrioQueue = (struct ... end : PRIOQUEUE);;
An alternate syntax is provided for the above:
module PrioQueue : PRIOQUEUE = struct ... end;;
Functors are “functions” from structures to structures. They are used to express parameterized structures: a structure A parameterized by a structure B is simply a functor F with a formal parameter B (along with the expected signature for B) which returns the actual structure A itself. The functor F can then be applied to one or several implementations B1 …Bn of B, yielding the corresponding structures A1 …An.
For instance, here is a structure implementing sets as sorted lists, parameterized by a structure providing the type of the set elements and an ordering function over this type (used to keep the sets sorted):
type comparison = Less | Equal | Greater;;type comparison = Less | Equal | Greater
module type ORDERED_TYPE = sig type t val compare: t -> t -> comparison end;;module type ORDERED_TYPE = sig type t val compare : t -> t -> comparison end
module Set = functor (Elt: ORDERED_TYPE) -> struct type element = Elt.t type set = element list let empty = [] let rec add x s = match s with [] -> [x] | hd::tl -> match Elt.compare x hd with Equal -> s (* x is already in s *) | Less -> x :: s (* x is smaller than all elements of s *) | Greater -> hd :: add x tl let rec member x s = match s with [] -> false | hd::tl -> match Elt.compare x hd with Equal -> true (* x belongs to s *) | Less -> false (* x is smaller than all elements of s *) | Greater -> member x tl end;;module Set : functor (Elt : ORDERED_TYPE) -> sig type element = Elt.t type set = element list val empty : 'a list val add : Elt.t -> Elt.t list -> Elt.t list val member : Elt.t -> Elt.t list -> bool end
By applying the Set functor to a structure implementing an ordered type, we obtain set operations for this type:
module OrderedString = struct type t = string let compare x y = if x = y then Equal else if x < y then Less else Greater end;;module OrderedString : sig type t = string val compare : 'a -> 'a -> comparison end
module StringSet = Set(OrderedString);;module StringSet : sig type element = OrderedString.t type set = element list val empty : 'a list val add : OrderedString.t -> OrderedString.t list -> OrderedString.t list val member : OrderedString.t -> OrderedString.t list -> bool end
StringSet.member "bar" (StringSet.add "foo" StringSet.empty);;- : bool = false
As in the PrioQueue example, it would be good style to hide the actual implementation of the type set, so that users of the structure will not rely on sets being lists, and we can switch later to another, more efficient representation of sets without breaking their code. This can be achieved by restricting Set by a suitable functor signature:
module type SETFUNCTOR = functor (Elt: ORDERED_TYPE) -> sig type element = Elt.t (* concrete *) type set (* abstract *) val empty : set val add : element -> set -> set val member : element -> set -> bool end;;module type SETFUNCTOR = functor (Elt : ORDERED_TYPE) -> sig type element = Elt.t type set val empty : set val add : element -> set -> set val member : element -> set -> bool end
module AbstractSet = (Set : SETFUNCTOR);;module AbstractSet : SETFUNCTOR
module AbstractStringSet = AbstractSet(OrderedString);;module AbstractStringSet : sig type element = OrderedString.t type set = AbstractSet(OrderedString).set val empty : set val add : element -> set -> set val member : element -> set -> bool end
AbstractStringSet.add "gee" AbstractStringSet.empty;;- : AbstractStringSet.set = <abstr>
In an attempt to write the type constraint above more elegantly, one may wish to name the signature of the structure returned by the functor, then use that signature in the constraint:
module type SET = sig type element type set val empty : set val add : element -> set -> set val member : element -> set -> bool end;;module type SET = sig type element type set val empty : set val add : element -> set -> set val member : element -> set -> bool end
module WrongSet = (Set : functor(Elt: ORDERED_TYPE) -> SET);;module WrongSet : functor (Elt : ORDERED_TYPE) -> SET
module WrongStringSet = WrongSet(OrderedString);;module WrongStringSet : sig type element = WrongSet(OrderedString).element type set = WrongSet(OrderedString).set val empty : set val add : element -> set -> set val member : element -> set -> bool end
WrongStringSet.add "gee" WrongStringSet.empty ;;Error: This expression has type string but an expression was expected of type WrongStringSet.element = WrongSet(OrderedString).element
The problem here is that SET specifies the type element abstractly, so that the type equality between element in the result of the functor and t in its argument is forgotten. Consequently, WrongStringSet.element is not the same type as string, and the operations of WrongStringSet cannot be applied to strings. As demonstrated above, it is important that the type element in the signature SET be declared equal to Elt.t; unfortunately, this is impossible above since SET is defined in a context where Elt does not exist. To overcome this difficulty, OCaml provides a with type construct over signatures that allows enriching a signature with extra type equalities:
module AbstractSet2 = (Set : functor(Elt: ORDERED_TYPE) -> (SET with type element = Elt.t));;module AbstractSet2 : functor (Elt : ORDERED_TYPE) -> sig type element = Elt.t type set val empty : set val add : element -> set -> set val member : element -> set -> bool end
As in the case of simple structures, an alternate syntax is provided for defining functors and restricting their result:
module AbstractSet2(Elt: ORDERED_TYPE) : (SET with type element = Elt.t) = struct ... end;;
Abstracting a type component in a functor result is a powerful technique that provides a high degree of type safety, as we now illustrate. Consider an ordering over character strings that is different from the standard ordering implemented in the OrderedString structure. For instance, we compare strings without distinguishing upper and lower case.
module NoCaseString = struct type t = string let compare s1 s2 = OrderedString.compare (String.lowercase_ascii s1) (String.lowercase_ascii s2) end;;module NoCaseString : sig type t = string val compare : string -> string -> comparison end
module NoCaseStringSet = AbstractSet(NoCaseString);;module NoCaseStringSet : sig type element = NoCaseString.t type set = AbstractSet(NoCaseString).set val empty : set val add : element -> set -> set val member : element -> set -> bool end
NoCaseStringSet.add "FOO" AbstractStringSet.empty ;;Error: This expression has type AbstractStringSet.set = AbstractSet(OrderedString).set but an expression was expected of type NoCaseStringSet.set = AbstractSet(NoCaseString).set
Note that the two types AbstractStringSet.set and NoCaseStringSet.set are not compatible, and values of these two types do not match. This is the correct behavior: even though both set types contain elements of the same type (strings), they are built upon different orderings of that type, and different invariants need to be maintained by the operations (being strictly increasing for the standard ordering and for the case-insensitive ordering). Applying operations from AbstractStringSet to values of type NoCaseStringSet.set could give incorrect results, or build lists that violate the invariants of NoCaseStringSet.
All examples of modules so far have been given in the context of the interactive system. However, modules are most useful for large, batch-compiled programs. For these programs, it is a practical necessity to split the source into several files, called compilation units, that can be compiled separately, thus minimizing recompilation after changes.
In OCaml, compilation units are special cases of structures and signatures, and the relationship between the units can be explained easily in terms of the module system. A compilation unit A comprises two files:
These two files together define a structure named A as if the following definition was entered at top-level:
module A: sig (* contents of file A.mli *) end = struct (* contents of file A.ml *) end;;
The files that define the compilation units can be compiled separately using the ocamlc -c command (the -c option means “compile only, do not try to link”); this produces compiled interface files (with extension .cmi) and compiled object code files (with extension .cmo). When all units have been compiled, their .cmo files are linked together using the ocamlc command. For instance, the following commands compile and link a program composed of two compilation units Aux and Main:
$ ocamlc -c Aux.mli # produces aux.cmi $ ocamlc -c Aux.ml # produces aux.cmo $ ocamlc -c Main.mli # produces main.cmi $ ocamlc -c Main.ml # produces main.cmo $ ocamlc -o theprogram Aux.cmo Main.cmo
The program behaves exactly as if the following phrases were entered at top-level:
module Aux: sig (* contents of Aux.mli *) end
= struct (* contents of Aux.ml *) end;;
module Main: sig (* contents of Main.mli *) end
= struct (* contents of Main.ml *) end;;
In particular, Main can refer to Aux: the definitions and declarations contained in Main.ml and Main.mli can refer to definition in Aux.ml, using the Aux.ident notation, provided these definitions are exported in Aux.mli.
The order in which the .cmo files are given to ocamlc during the linking phase determines the order in which the module definitions occur. Hence, in the example above, Aux appears first and Main can refer to it, but Aux cannot refer to Main.
Note that only top-level structures can be mapped to separately-compiled files, but neither functors nor module types. However, all module-class objects can appear as components of a structure, so the solution is to put the functor or module type inside a structure, which can then be mapped to a file.
ocaml-doc-4.05/ocaml.html/stdlib.html 0000644 0001750 0001750 00000017622 13131636457 016464 0 ustar mehdi mehdi
This chapter describes the functions provided by the OCaml standard library. The modules from the standard library are automatically linked with the user’s object code files by the ocamlc command. Hence, these modules can be used in standalone programs without having to add any .cmo file on the command line for the linking phase. Similarly, in interactive use, these globals can be used in toplevel phrases without having to load any .cmo file in memory.
Unlike the Pervasives module from the core library, the modules from the standard library are not automatically “opened” when a compilation starts, or when the toplevel system is launched. Hence it is necessary to use qualified identifiers to refer to the functions provided by these modules, or to add open directives.
For easy reference, the modules are listed below in alphabetical order of module names. For each module, the declarations from its signature are printed one by one in typewriter font, followed by a short comment. All modules and the identifiers they export are indexed at the end of this report.
ocaml-doc-4.05/ocaml.html/contents_motif.gif 0000644 0001750 0001750 00000000474 13131636457 020034 0 ustar mehdi mehdi GIF89a p !" Imported from XPM image: toc.xpm ! , @6313c B0 0 A0 0 0 0 `0 @`0 ` `0 @`0 `0 @`0000000000 0000000000 00000000 000000 0000 000000000 00000000000 00000000000 000`
; ocaml-doc-4.05/ocaml.html/core.html 0000644 0001750 0001750 00000024557 13131636457 016140 0 ustar mehdi mehdi
This chapter describes the OCaml core library, which is composed of declarations for built-in types and exceptions, plus the module Pervasives that provides basic operations on these built-in types. The Pervasives module is special in two ways:
The declarations of the built-in types and the components of module Pervasives are printed one by one in typewriter font, followed by a short comment. All library modules and the components they provide are indexed at the end of this report.
The following built-in types and predefined exceptions are always defined in the compilation environment, but are not part of any module. As a consequence, they can only be referred by their short names.
type int
The type of integer numbers.
type char
The type of characters.
type bytes
The type of (writable) byte sequences.
type string
The type of (read-only) character strings.
type float
The type of floating-point numbers.
type bool = false | true
The type of booleans (truth values).
type unit = ()
The type of the unit value.
type exn
The type of exception values.
type 'a array
The type of arrays whose elements have type 'a.
type 'a list = [] | :: of 'a * 'a list
The type of lists whose elements have type 'a.
type 'a option = None | Some of 'a
The type of optional values of type 'a.
type int32
The type of signed 32-bit integers. See the Int32[Int32] module.
type int64
The type of signed 64-bit integers. See the Int64[Int64] module.
type nativeint
The type of signed, platform-native integers (32 bits on 32-bit processors, 64 bits on 64-bit processors). See the Nativeint[Nativeint] module.
type ('a, 'b, 'c, 'd, 'e, 'f) format6
The type of format strings. 'a is the type of the parameters of the format, 'f is the result type for the printf-style functions, 'b is the type of the first argument given to %a and %t printing functions (see module Printf[Printf]), 'c is the result type of these functions, and also the type of the argument transmitted to the first argument of kprintf-style functions, 'd is the result type for the scanf-style functions (see module Scanf[Scanf]), and 'e is the type of the receiver function for the scanf-style functions.
type 'a lazy_t
This type is used to implement the Lazy[Lazy] module. It should not be used directly.
exception Match_failure of (string * int * int)
Exception raised when none of the cases of a pattern-matching apply. The arguments are the location of the match keyword in the source code (file name, line number, column number).
exception Assert_failure of (string * int * int)
Exception raised when an assertion fails. The arguments are the location of the assert keyword in the source code (file name, line number, column number).
exception Invalid_argument of string
Exception raised by library functions to signal that the given arguments do not make sense. The string gives some information to the programmer. As a general rule, this exception should not be caught, it denotes a programming error and the code should be modified not to trigger it.
exception Failure of string
Exception raised by library functions to signal that they are
undefined on the given arguments. The string is meant to give some
information to the programmer; you must not pattern match on
the string literal because it may change in future versions (use
Failure _ instead).
exception Not_found
Exception raised by search functions when the desired object could not be found.
exception Out_of_memory
Exception raised by the garbage collector when there is insufficient memory to complete the computation.
exception Stack_overflow
Exception raised by the bytecode interpreter when the evaluation stack reaches its maximal size. This often indicates infinite or excessively deep recursion in the user’s program. (Not fully implemented by the native-code compiler; see section 11.5.)
exception Sys_error of string
Exception raised by the input/output functions to report an
operating system error. The string is meant to give some
information to the programmer; you must not pattern match on
the string literal because it may change in future versions (use
Sys_error _ instead).
exception End_of_file
Exception raised by input functions to signal that the end of file has been reached.
exception Division_by_zero
Exception raised by integer division and remainder operations when their second argument is zero.
exception Sys_blocked_io
A special case of Sys_error raised when no I/O is possible on a non-blocking I/O channel.
exception Undefined_recursive_module of (string * int * int)
Exception raised when an ill-founded recursive module definition is evaluated. (See section 7.4.) The arguments are the location of the definition in the source code (file name, line number, column number).
ocaml-doc-4.05/ocaml.html/libgraph.html 0000644 0001750 0001750 00000010024 13131636457 016760 0 ustar mehdi mehdi
The graphics library provides a set of portable drawing primitives. Drawing takes place in a separate window that is created when Graphics.open_graph is called.
Unix: This library is implemented under the X11 windows system. Programs that use the graphics library must be linked as follows:ocamlc other options graphics.cma other filesFor interactive use of the graphics library, do:ocamlmktop -o mytop graphics.cma ./mytopor (if dynamic linking of C libraries is supported on your platform), start ocaml and type #load "graphics.cma";;.Here are the graphics mode specifications supported by Graphics.open_graph on the X11 implementation of this library: the argument to Graphics.open_graph has the format "display-name geometry", where display-name is the name of the X-windows display to connect to, and geometry is a standard X-windows geometry specification. The two components are separated by a space. Either can be omitted, or both. Examples:
- Graphics.open_graph "foo:0"
- connects to the display foo:0 and creates a window with the default geometry
- Graphics.open_graph "foo:0 300x100+50-0"
- connects to the display foo:0 and creates a window 300 pixels wide by 100 pixels tall, at location (50,0)
- Graphics.open_graph " 300x100+50-0"
- connects to the default display and creates a window 300 pixels wide by 100 pixels tall, at location (50,0)
- Graphics.open_graph ""
- connects to the default display and creates a window with the default geometry.
Windows: This library is available both for standalone compiled programs and under the toplevel application ocamlwin.exe. For the latter, this library must be loaded in-core by typing#load "graphics.cma";;
The screen coordinates are interpreted as shown in the figure below. Notice that the coordinate system used is the same as in mathematics: y increases from the bottom of the screen to the top of the screen, and angles are measured counterclockwise (in degrees). Drawing is clipped to the screen.
ocaml-doc-4.05/ocaml.html/patterns.html 0000644 0001750 0001750 00000056734 13131636457 017052 0 ustar mehdi mehdi
|
See also the following language extensions: lazy patterns, local opens, first-class modules, attributes, extension nodes and exception cases in pattern matching.
The table below shows the relative precedences and associativity of operators and non-closed pattern constructions. The constructions with higher precedences come first.
| Operator | Associativity |
| .. | – |
| lazy (see section 7.3) | – |
| Constructor application, Tag application | right |
| :: | right |
| , | – |
| | | left |
| as | – |
Patterns are templates that allow selecting data structures of a given shape, and binding identifiers to components of the data structure. This selection operation is called pattern matching; its outcome is either “this value does not match this pattern”, or “this value matches this pattern, resulting in the following bindings of names to values”.
A pattern that consists in a value name matches any value, binding the name to the value. The pattern _ also matches any value, but does not bind any name.
Patterns are linear: a variable cannot be bound several times by a given pattern. In particular, there is no way to test for equality between two parts of a data structure using only a pattern (but when guards can be used for this purpose).
A pattern consisting in a constant matches the values that are equal to this constant.
The pattern pattern1 as value-name matches the same values as pattern1. If the matching against pattern1 is successful, the name value-name is bound to the matched value, in addition to the bindings performed by the matching against pattern1.
The pattern ( pattern1 ) matches the same values as pattern1. A type constraint can appear in a parenthesized pattern, as in ( pattern1 : typexpr ). This constraint forces the type of pattern1 to be compatible with typexpr.
The pattern pattern1 | pattern2 represents the logical “or” of the two patterns pattern1 and pattern2. A value matches pattern1 | pattern2 if it matches pattern1 or pattern2. The two sub-patterns pattern1 and pattern2 must bind exactly the same identifiers to values having the same types. Matching is performed from left to right. More precisely, in case some value v matches pattern1 | pattern2, the bindings performed are those of pattern1 when v matches pattern1. Otherwise, value v matches pattern2 whose bindings are performed.
The pattern constr ( pattern1 , … , patternn ) matches all variants whose constructor is equal to constr, and whose arguments match pattern1 … patternn. It is a type error if n is not the number of arguments expected by the constructor.
The pattern constr _ matches all variants whose constructor is constr.
The pattern pattern1 :: pattern2 matches non-empty lists whose heads match pattern1, and whose tails match pattern2.
The pattern [ pattern1 ; … ; patternn ] matches lists of length n whose elements match pattern1 …patternn, respectively. This pattern behaves like pattern1 :: … :: patternn :: [].
The pattern `tag-name pattern1 matches all polymorphic variants whose tag is equal to tag-name, and whose argument matches pattern1.
If the type [('a,'b,…)] typeconstr = [ ` tag-name1 typexpr1 | … | ` tag-namen typexprn] is defined, then the pattern #typeconstr is a shorthand for the following or-pattern: ( `tag-name1(_ : typexpr1) | … | ` tag-namen(_ : typexprn)). It matches all values of type [< typeconstr ].
The pattern pattern1 , … , patternn matches n-tuples whose components match the patterns pattern1 through patternn. That is, the pattern matches the tuple values (v1, …, vn) such that patterni matches vi for i = 1,… , n.
The pattern { field1 = pattern1 ; … ; fieldn = patternn } matches records that define at least the fields field1 through fieldn, and such that the value associated to fieldi matches the pattern patterni, for i = 1,… , n. The record value can define more fields than field1 …fieldn; the values associated to these extra fields are not taken into account for matching. Optional type constraints can be added field by field with { field1 : typexpr1 = pattern1 ;… ; fieldn : typexprn = patternn } to force the type of fieldk to be compatible with typexprk.
The pattern [| pattern1 ; … ; patternn |] matches arrays of length n such that the i-th array element matches the pattern patterni, for i = 1,… , n.
The pattern ' c ' .. ' d ' is a shorthand for the pattern
where c1, c2, …, cn are the characters that occur between c and d in the ASCII character set. For instance, the pattern '0'..'9' matches all characters that are digits.
ocaml-doc-4.05/ocaml.html/comp.html 0000644 0001750 0001750 00000222364 13131636457 016142 0 ustar mehdi mehdi
This chapter describes the OCaml batch compiler ocamlc, which compiles OCaml source files to bytecode object files and links these object files to produce standalone bytecode executable files. These executable files are then run by the bytecode interpreter ocamlrun.
The ocamlc command has a command-line interface similar to the one of most C compilers. It accepts several types of arguments and processes them sequentially, after all options have been processed:
If the interface file x.mli exists, the implementation x.ml is checked against the corresponding compiled interface x.cmi, which is assumed to exist. If no interface x.mli is provided, the compilation of x.ml produces a compiled interface file x.cmi in addition to the compiled object code file x.cmo. The file x.cmi produced corresponds to an interface that exports everything that is defined in the implementation x.ml.
The output of the linking phase is a file containing compiled bytecode that can be executed by the OCaml bytecode interpreter: the command named ocamlrun. If a.out is the name of the file produced by the linking phase, the command
ocamlrun a.out arg1 arg2 … argn
executes the compiled code contained in a.out, passing it as arguments the character strings arg1 to argn. (See chapter 10 for more details.)
On most systems, the file produced by the linking phase can be run directly, as in:
./a.out arg1 arg2 … argn
The produced file has the executable bit set, and it manages to launch the bytecode interpreter by itself.
The following command-line options are recognized by ocamlc. The options -pack, -a, -c and -output-obj are mutually exclusive.
If -custom, -cclib or -ccopt options are passed on the command line, these options are stored in the resulting .cmalibrary. Then, linking with this library automatically adds back the -custom, -cclib and -ccopt options as if they had been provided on the command line, unless the -noautolink option is given.
The environment variable OCAML_COLOR is considered if -color is not provided. Its values are auto/always/never as above.
Unix: Never use the strip command on executables produced by ocamlc -custom, this would remove the bytecode part of the executable.
Unix: Security warning: never set the “setuid” or “setgid” bits on executables produced by ocamlc -custom, this would make them vulnerable to attacks.
If the given directory starts with +, it is taken relative to the standard library directory. For instance, -I +labltk adds the subdirectory labltk of the standard library to the search path.
The -opaque option, available since 4.04, disables cross-module optimization information for the currently compiled unit. When compiling .mli interface, using -opaque marks the compiled .cmi interface so that subsequent compilations of modules that depend on it will not rely on the corresponding .cmx file, nor warn if it is absent. When the native compiler compiles a .ml implementation, using -opaque generates a .cmx that does not contain any cross-module optimization information.
Using this option may degrade the quality of generated code, but it reduces compilation time, both on clean and incremental builds. Indeed, with the native compiler, when the implementation of a compilation unit changes, all the units that depend on it may need to be recompiled – because the cross-module information may have changed. If the compilation unit whose implementation changed was compiled with -opaque, no such recompilation needs to occur. This option can thus be used, for example, to get faster edit-compile-test feedback loops.
ocamlc -pack -o p.cmo a.cmo b.cmo c.cmogenerates compiled files p.cmo and p.cmi describing a compilation unit having three sub-modules A, B and C, corresponding to the contents of the object files a.cmo, b.cmo and c.cmo. These contents can be referenced as P.A, P.B and P.C in the remainder of the program.
The warning-list argument is a sequence of warning specifiers, with no separators between them. A warning specifier is one of the following:
Warning numbers and letters which are out of the range of warnings that are currently defined are ignored. The warnings are as follows.
The default setting is -w +a-4-6-7-9-27-29-32..39-41..42-44-45-48-50. It is displayed by ocamlc -help. Note that warnings 5 and 10 are not always triggered, depending on the internals of the type checker.
Note: it is not recommended to use warning sets (i.e. letters) as arguments to -warn-error in production code, because this can break your build when future versions of OCaml add some new warnings.
The default setting is -warn-error -a+31 (only warning 31 is fatal).
The compiler command line can be modified “from the outside” with the following mechanisms. These are experimental and subject to change. They should be used only for experimental and development work, not in released packages.
This short section is intended to clarify the relationship between the names of the modules corresponding to compilation units and the names of the files that contain their compiled interface and compiled implementation.
The compiler always derives the module name by taking the capitalized base name of the source file (.ml or .mli file). That is, it strips the leading directory name, if any, as well as the .ml or .mli suffix; then, it set the first letter to uppercase, in order to comply with the requirement that module names must be capitalized. For instance, compiling the file mylib/misc.ml provides an implementation for the module named Misc. Other compilation units may refer to components defined in mylib/misc.ml under the names Misc.name; they can also do open Misc, then use unqualified names name.
The .cmi and .cmo files produced by the compiler have the same base name as the source file. Hence, the compiled files always have their base name equal (modulo capitalization of the first letter) to the name of the module they describe (for .cmi files) or implement (for .cmo files).
When the compiler encounters a reference to a free module identifier Mod, it looks in the search path for a file named Mod.cmi or mod.cmi and loads the compiled interface contained in that file. As a consequence, renaming .cmi files is not advised: the name of a .cmi file must always correspond to the name of the compilation unit it implements. It is admissible to move them to another directory, if their base name is preserved, and the correct -I options are given to the compiler. The compiler will flag an error if it loads a .cmi file that has been renamed.
Compiled bytecode files (.cmo files), on the other hand, can be freely renamed once created. That’s because the linker never attempts to find by itself the .cmo file that implements a module with a given name: it relies instead on the user providing the list of .cmo files by hand.
This section describes and explains the most frequently encountered error messages.
If filename has the format mod.cmo, this means you are trying to link a bytecode object file that does not exist yet. Fix: compile mod.ml first.
If your program spans several directories, this error can also appear because you haven’t specified the directories to look into. Fix: add the correct -I options to the command line.
In some cases, it is hard to understand why the two types t1 and t2 are incompatible. For instance, the compiler can report that “expression of type foo cannot be used with type foo”, and it really seems that the two types foo are compatible. This is not always true. Two type constructors can have the same name, but actually represent different types. This can happen if a type constructor is redefined. Example:
type foo = A | B
let f = function A -> 0 | B -> 1
type foo = C | D
f C
This result in the error message “expression C of type foo cannot be used with type foo”.
Non-generalized type variables in a type cause no difficulties inside a given structure or compilation unit (the contents of a .ml file, or an interactive session), but they cannot be allowed inside signatures nor in compiled interfaces (.cmi file), because they could be used inconsistently later. Therefore, the compiler flags an error when a structure or compilation unit defines a value name whose type contains non-generalized type variables. There are two ways to fix this error:
let sort_int_list = Sort.list (<)
(* inferred type 'a list -> 'a list, with 'a not generalized *)
write
let sort_int_list = (Sort.list (<) : int list -> int list);;
let map_length = List.map Array.length
(* inferred type 'a array list -> int list, with 'a not generalized *)
write
let map_length lv = List.map Array.length lv
Of course, you will always encounter this error if you have mutually recursive functions across modules. That is, function Mod1.f calls function Mod2.g, and function Mod2.g calls function Mod1.f. In this case, no matter what permutations you perform on the command line, the program will be rejected at link-time. Fixes:
mod1.ml: let f x = ... Mod2.g ... mod2.ml: let g y = ... Mod1.f ...define
mod1.ml: let f g x = ... g ... mod2.ml: let rec g y = ... Mod1.f g ...and link mod1.cmo before mod2.cmo.
mod1.ml: let forward_g =
ref((fun x -> failwith "forward_g") : <type>)
let f x = ... !forward_g ...
mod2.ml: let g y = ... Mod1.f ...
let _ = Mod1.forward_g := g
This section describes and explains in detail some warnings:
Some constructors, such as the exception constructors Failure and Invalid_argument, take as parameter a string value holding a text message intended for the user.
These text messages are usually not stable over time: call sites building these constructors may refine the message in a future version to make it more explicit, etc. Therefore, it is dangerous to match over the precise value of the message. For example, until OCaml 4.02, Array.iter2 would raise the exception
Invalid_argument "arrays must have the same length"
Since 4.03 it raises the more helpful message
Invalid_argument "Array.iter2: arrays must have the same length"
but this means that any code of the form
try ... with Invalid_argument "arrays must have the same length" -> ...
is now broken and may suffer from uncaught exceptions.
Warning 52 is there to prevent users from writing such fragile code in the first place. It does not occur on every matching on a literal string, but only in the case in which library authors expressed their intent to possibly change the constructor parameter value in the future, by using the attribute ocaml.warn_on_literal_pattern (see the manual section on builtin attributes in 7.18.1):
type t =
| Foo of string [@ocaml.warn_on_literal_pattern]
| Bar of string
let no_warning = function
| Bar "specific value" -> 0
| _ -> 1
let warning = function
| Foo "specific value" -> 0
| _ -> 1
> | Foo "specific value" -> 0
> ^^^^^^^^^^^^^^^^
> Warning 52: Code should not depend on the actual values of
> this constructor's arguments. They are only for information
> and may change in future versions. (See manual section 8.5)
In particular, all built-in exceptions with a string argument have this attribute set: Invalid_argument, Failure, Sys_error will all raise this warning if you match for a specific string argument.
If your code raises this warning, you should not change the way you test for the specific string to avoid the warning (for example using a string equality inside the right-hand-side instead of a literal pattern), as your code would remain fragile. You should instead enlarge the scope of the pattern by matching on all possible values.
let warning = function | Foo _ -> 0 | _ -> 1
This may require some care: if the scrutinee may return several different cases of the same pattern, or raise distinct instances of the same exception, you may need to modify your code to separate those several cases.
For example,
try (int_of_string count_str, bool_of_string choice_str) with | Failure "int_of_string" -> (0, true) | Failure "bool_of_string" -> (-1, false)
should be rewritten into more atomic tests. For example, using the exception patterns documented in Section 7.21, one can write:
match int_of_string count_str with
| exception (Failure _) -> (0, true)
| count ->
begin match bool_of_string choice_str with
| exception (Failure _) -> (-1, false)
| choice -> (count, choice)
end
The only case where that transformation is not possible is if a given function call may raises distinct exceptions with the same constructor but different string values. In this case, you will have to check for specific string values. This is dangerous API design and it should be discouraged: it’s better to define more precise exception constructors than store useful information in strings.
The semantics of or-patterns in OCaml is specified with a left-to-right bias: a value v matches the pattern p | q if it matches p or q, but if it matches both, the environment captured by the match is the environment captured by p, never the one captured by q.
While this property is generally intuitive, there is at least one specific case where a different semantics might be expected. Consider a pattern followed by a when-guard: | p when g -> e, for example:
| ((Const x, _) | (_, Const x)) when is_neutral x -> branch
The semantics is clear: match the scrutinee against the pattern, if it matches, test the guard, and if the guard passes, take the branch. In particular, consider the input (Const a, Const b), where a fails the test is_neutral a, while b passes the test is_neutral b. With the left-to-right semantics, the clause above is not taken by its input: matching (Const a, Const b) against the or-pattern succeeds in the left branch, it returns the environment x -> a, and then the guard is_neutral a is tested and fails, the branch is not taken.
However, another semantics may be considered more natural here: any pair that has one side passing the test will take the branch. With this semantics the previous code fragment would be equivalent to
| (Const x, _) when is_neutral x -> branch
| (_, Const x) when is_neutral x -> branch
This is not the semantics adopted by OCaml.
Warning 57 is dedicated to these confusing cases where the specified left-to-right semantics is not equivalent to a non-deterministic semantics (any branch can be taken) relatively to a specific guard. More precisely, it warns when guard uses “ambiguous” variables, that are bound to different parts of the scrutinees by different sides of a or-pattern.
ocaml-doc-4.05/ocaml.html/spacetime.html 0000644 0001750 0001750 00000020114 13131636457 017143 0 ustar mehdi mehdi
Spacetime is the name given to functionality within the OCaml compiler that provides for accurate profiling of the memory behaviour of a program. Using Spacetime it is possible to determine the source of memory leaks and excess memory allocation quickly and easily. Excess allocation slows programs down both by imposing a higher load on the garbage collector and reducing the cache locality of the program’s code. Spacetime provides full backtraces for every allocation that occurred on the OCaml heap during the lifetime of the program including those in C stubs.
Spacetime only analyses the memory behaviour of a program with respect to the OCaml heap allocators and garbage collector. It does not analyse allocation on the C heap. Spacetime does not affect the memory behaviour of a program being profiled with the exception of any change caused by the overhead of profiling (see section 21.3)—for example the program running slower might cause it to allocate less memory in total.
Spacetime is currently only available for x86-64 targets and has only been tested on Linux systems (although it is expected to work on most modern Unix-like systems and provision has been made for running under Windows). It is expected that the set of supported platforms will be extended in the future.
To use Spacetime it is necessary to use an OCaml compiler that was configured with the -spacetime option. It is not possible to select Spacetime on a per-source-file basis or for a subset of files in a project; all files involved in the executable being profiled must be built with the Spacetime compiler. Only native code compilation is supported (not bytecode).
If the libunwind library is not available on the system then it will not be possible for Spacetime to profile allocations occurring within C stubs. If the libunwind library is available but in an unusual location then that location may be specified to the configure script using the -libunwinddir option (or alternatively, using separate -libunwindinclude and -libunwindlib options).
OPAM switches will be provided for Spacetime-configured compilers.
Once the appropriate compiler has been selected the program should be built as normal (ensuring that all files are built with the Spacetime compiler—there is currently no protection to ensure this is the case, but it is essential). For many uses it will not be necessary to change the code of the program to use the profiler.
Spacetime-configured compilers run slower and occupy more memory than their counterparts. It is hoped this will be fixed in the future as part of improved cross compilation support.
Programs built with Spacetime instrumentation have a dependency on the libunwind library unless that was unavailable at configure time or the -disable-libunwind option was specified (see section 21.3).
Setting the OCAML_SPACETIME_INTERVAL environment variable to an integer representing a number of milliseconds before running a program built with Spacetime will cause memory profiling to be in operation when the program is started. The contents of the OCaml heap will be sampled each time the number of milliseconds that the program has spent executing since the last sample exceeds the given number. (Note that the time base is combined user plus system time—not wall clock time. This peculiarity may be changed in future.)
The program being profiled must exit normally or be caused to exit using the SIGINT signal (e.g. by pressing Ctrl+C). When the program exits files will be written in the directory that was the working directory when the program was started. One Spacetime file will be written for each process that was involved, indexed by process ID; there will normally only be one such. The Spacetime files may be substantial. The directory to which they are written may be overridden by setting the OCAML_SPACETIME_SNAPSHOT_DIR environment variable before the program is started.
Instead of using the automatic snapshot facility described above it is also possible to manually control Spacetime profiling. (The environment variables OCAML_SPACETIME_INTERVAL and OCAML_SPACETIME_SNAPSHOT_DIR are then not relevant.) Full documentation as regards this method of profiling is provided in the standard library documentation (section 24) for the Spacetime module.
The compiler distribution does not itself provide the facility for analysing Spacetime output files; this is left to external tools. The first such tool will appear in OPAM as a package called prof_spacetime. That tool will provide interactive graphical and terminal-based visualisation of the results of profiling.
The runtime overhead imposed by Spacetime varies considerably depending on the particular program being profiled. The overhead may be as low as ten percent—but more usually programs should be expected to run at perhaps a third or quarter of their normal speed. It is expected that this overhead will be reduced in future versions of the compiler.
Execution speed of instrumented programs may be increased by using a compiler configured with the -disable-libunwind option. This prevents collection of profiling information from C stubs.
Programs running with Spacetime instrumentation consume significantly more memory than their non-instrumented counterparts. It is expected that this memory overhead will also be reduced in the future.
The compiler distribution provides an “otherlibs” library called raw_spacetime_lib for decoding Spacetime files. This library provides facilities to read not only memory profiling information but also the full dynamic call graph of the profiled program which is written into Spacetime output files.
A library package spacetime_lib will be provided in OPAM to provide an interface for decoding profiling information at a higher level than that provided by raw_spacetime_lib.
ocaml-doc-4.05/ocaml.html/libgraph.gif 0000644 0001750 0001750 00000004145 13061513177 016563 0 ustar mehdi mehdi GIF87a!V , !V ڋH扦ʶ L
ĢL*̦ JԪjܮ N
(8HXhx)9IYiy *:JZjzJ
;K[k{*Л++ l 컻\0܊*=m}͜-9P||
= @|\.N ,M/_Ύ<^S6[ b+:" rXn ȑ<<2ʕ,[| 3̙4kڼiD#ΝhL)'С\D=(ҥU1}T)ԩJ&R*֭H$rS+ر=,=,ڵ:t};-ܹڍ{7 z70 _ l8Ċ7`8rD g叙c ys^Ӊ 畝G;sZi\E
6*WSnn*v&M'pĮz`9 yDZmbvNm?7n>omwlQW d(ee]NHa^ana z9 k٭W!(] .b5i5Ruf9Bd=2cA"5bEuaI`M_Q4^Ut]YҴ%]]6xRܘdh!_XznXlyDE~ڦ*NE5 iuʧ_}E\:1ƹ C&FA*z ڪ
t~w7
ŭS ۖB _{C iV-GO4ƀfųKiGy;C?;kMf3oMn7ik20ۯ''jv El-q- ,!4+%t*)po˧\
<
П .t" *ӛH.gR ֗xMd\#L6%i,vkoc]N
w6tCyط#{7}3rȅ"8w#2ʑCWs_.\x>3 nG'u-+no
jjMtYN}s>_K>=@{ Gk o$"[~̋t/$[#c=|cTx lF}G=>#J j0~4O/^oV?P(!ZZaqk խS
`` dA]pse@
b椆yOWæq6QC6E
@cT&/Z"b x+jth BF:1k[ ؑ:&l>@
r"z3KCyHdv(n&;<~Nv,%IYTz28lec&WAg\P+M6NR`T%/ei7fr10L+ļ1@˲%l,i홡Ħ}YLm~3#9jT7MsB3r,'yMaQg:Ϲ|%? ЂvS
L۴ yQ
5C#:}~j ͦDPgZT-GZQ32I)҄t48=R
iCЕơpS* Z7|+O{TD-UgҚfԨE*I6%Pծ4p-Pְ^Ek*8uvkRR&b:լ&VOx)e754Έ FYG~k[ f+qn[2l-">p]%v}j''q͝jHk)3mLGYˑNݞ\W<@$6<r}wnkg(
i]oWY̖%-Ia7ݝ5.c17Vع\EሽHg#pD
V$T6s@X"" 걉[JK$x *5N
\lX:>gge&`
iNx*9I dW9,\LCf@3LJ"7bhGE*4lLkzӜ?
PzԤ.OTzլn_
XzִfJ ; ocaml-doc-4.05/ocaml.html/compunit.html 0000644 0001750 0001750 00000011010 13131636457 017022 0 ustar mehdi mehdi
|
Compilation units bridge the module system and the separate compilation system. A compilation unit is composed of two parts: an interface and an implementation. The interface contains a sequence of specifications, just as the inside of a sig … end signature expression. The implementation contains a sequence of definitions and expressions, just as the inside of a struct … end module expression. A compilation unit also has a name unit-name, derived from the names of the files containing the interface and the implementation (see chapter 8 for more details). A compilation unit behaves roughly as the module definition
A compilation unit can refer to other compilation units by their names, as if they were regular modules. For instance, if U is a compilation unit that defines a type t, other compilation units can refer to that type under the name U.t; they can also refer to U as a whole structure. Except for names of other compilation units, a unit interface or unit implementation must not have any other free variables. In other terms, the type-checking and compilation of an interface or implementation proceeds in the initial environment
where name1 … namen are the names of the other compilation units available in the search path (see chapter 8 for more details) and specification1 … specificationn are their respective interfaces.
ocaml-doc-4.05/ocaml.html/lablexamples.html 0000644 0001750 0001750 00000076141 13131636457 017655 0 ustar mehdi mehdi
(Chapter written by Jacques Garrigue)
This chapter gives an overview of the new features in OCaml 3: labels, and polymorphic variants.
If you have a look at modules ending in Labels in the standard library, you will see that function types have annotations you did not have in the functions you defined yourself.
ListLabels.map;;- : f:('a -> 'b) -> 'a list -> 'b list = <fun>
StringLabels.sub;;- : string -> pos:int -> len:int -> string = <fun>
Such annotations of the form name: are called labels. They are meant to document the code, allow more checking, and give more flexibility to function application. You can give such names to arguments in your programs, by prefixing them with a tilde ~.
let f ~x ~y = x - y;;val f : x:int -> y:int -> int = <fun>
let x = 3 and y = 2 in f ~x ~y;;- : int = 1
When you want to use distinct names for the variable and the label appearing in the type, you can use a naming label of the form ~name:. This also applies when the argument is not a variable.
let f ~x:x1 ~y:y1 = x1 - y1;;val f : x:int -> y:int -> int = <fun>
f ~x:3 ~y:2;;- : int = 1
Labels obey the same rules as other identifiers in OCaml, that is you cannot use a reserved keyword (like in or to) as label.
Formal parameters and arguments are matched according to their respective labels1, the absence of label being interpreted as the empty label. This allows commuting arguments in applications. One can also partially apply a function on any argument, creating a new function of the remaining parameters.
let f ~x ~y = x - y;;val f : x:int -> y:int -> int = <fun>
f ~y:2 ~x:3;;- : int = 1
ListLabels.fold_left;;- : f:('a -> 'b -> 'a) -> init:'a -> 'b list -> 'a = <fun>
ListLabels.fold_left [1;2;3] ~init:0 ~f:( + );;- : int = 6
ListLabels.fold_left ~init:0;;- : f:(int -> 'a -> int) -> 'a list -> int = <fun>
If several arguments of a function bear the same label (or no label), they will not commute among themselves, and order matters. But they can still commute with other arguments.
let hline ~x:x1 ~x:x2 ~y = (x1, x2, y);;val hline : x:'a -> x:'b -> y:'c -> 'a * 'b * 'c = <fun>
hline ~x:3 ~y:2 ~x:5;;- : int * int * int = (3, 5, 2)
As an exception to the above parameter matching rules, if an application is total (omitting all optional arguments), labels may be omitted. In practice, many applications are total, so that labels can often be omitted.
f 3 2;;- : int = 1
ListLabels.map succ [1;2;3];;- : int list = [2; 3; 4]
But beware that functions like ListLabels.fold_left whose result type is a type variable will never be considered as totally applied.
ListLabels.fold_left ( + ) 0 [1;2;3];;Error: This expression has type int -> int -> int but an expression was expected of type 'a list
When a function is passed as an argument to a higher-order function, labels must match in both types. Neither adding nor removing labels are allowed.
let h g = g ~x:3 ~y:2;;val h : (x:int -> y:int -> 'a) -> 'a = <fun>
h f;;- : int = 1
h ( + ) ;;Error: This expression has type int -> int -> int but an expression was expected of type x:int -> y:int -> 'a
Note that when you don’t need an argument, you can still use a wildcard pattern, but you must prefix it with the label.
h (fun ~x:_ ~y -> y+1);;- : int = 3
An interesting feature of labeled arguments is that they can be made optional. For optional parameters, the question mark ? replaces the tilde ~ of non-optional ones, and the label is also prefixed by ? in the function type. Default values may be given for such optional parameters.
let bump ?(step = 1) x = x + step;;val bump : ?step:int -> int -> int = <fun>
bump 2;;- : int = 3
bump ~step:3 2;;- : int = 5
A function taking some optional arguments must also take at least one non-optional argument. The criterion for deciding whether an optional argument has been omitted is the non-labeled application of an argument appearing after this optional argument in the function type. Note that if that argument is labeled, you will only be able to eliminate optional arguments through the special case for total applications.
let test ?(x = 0) ?(y = 0) () ?(z = 0) () = (x, y, z);;val test : ?x:int -> ?y:int -> unit -> ?z:int -> unit -> int * int * int = <fun>
test ();;- : ?z:int -> unit -> int * int * int = <fun>
test ~x:2 () ~z:3 ();;- : int * int * int = (2, 0, 3)
Optional parameters may also commute with non-optional or unlabeled ones, as long as they are applied simultaneously. By nature, optional arguments do not commute with unlabeled arguments applied independently.
test ~y:2 ~x:3 () ();;- : int * int * int = (3, 2, 0)
test () () ~z:1 ~y:2 ~x:3;;- : int * int * int = (3, 2, 1)
(test () ()) ~z:1 ;;Error: This expression has type int * int * int This is not a function; it cannot be applied.
Here (test () ()) is already (0,0,0) and cannot be further applied.
Optional arguments are actually implemented as option types. If you do not give a default value, you have access to their internal representation, type 'a option = None | Some of 'a. You can then provide different behaviors when an argument is present or not.
let bump ?step x = match step with | None -> x * 2 | Some y -> x + y ;;val bump : ?step:int -> int -> int = <fun>
It may also be useful to relay an optional argument from a function call to another. This can be done by prefixing the applied argument with ?. This question mark disables the wrapping of optional argument in an option type.
let test2 ?x ?y () = test ?x ?y () ();;val test2 : ?x:int -> ?y:int -> unit -> int * int * int = <fun>
test2 ?x:None;;- : ?y:int -> unit -> int * int * int = <fun>
While they provide an increased comfort for writing function applications, labels and optional arguments have the pitfall that they cannot be inferred as completely as the rest of the language.
You can see it in the following two examples.
let h' g = g ~y:2 ~x:3;;val h' : (y:int -> x:int -> 'a) -> 'a = <fun>
h' f ;;Error: This expression has type x:int -> y:int -> int but an expression was expected of type y:int -> x:int -> 'a
let bump_it bump x = bump ~step:2 x;;val bump_it : (step:int -> 'a -> 'b) -> 'a -> 'b = <fun>
bump_it bump 1 ;;Error: This expression has type ?step:int -> int -> int but an expression was expected of type step:int -> 'a -> 'b
The first case is simple: g is passed ~y and then ~x, but f expects ~x and then ~y. This is correctly handled if we know the type of g to be x:int -> y:int -> int in advance, but otherwise this causes the above type clash. The simplest workaround is to apply formal parameters in a standard order.
The second example is more subtle: while we intended the argument bump to be of type ?step:int -> int -> int, it is inferred as step:int -> int -> 'a. These two types being incompatible (internally normal and optional arguments are different), a type error occurs when applying bump_it to the real bump.
We will not try here to explain in detail how type inference works. One must just understand that there is not enough information in the above program to deduce the correct type of g or bump. That is, there is no way to know whether an argument is optional or not, or which is the correct order, by looking only at how a function is applied. The strategy used by the compiler is to assume that there are no optional arguments, and that applications are done in the right order.
The right way to solve this problem for optional parameters is to add a type annotation to the argument bump.
let bump_it (bump : ?step:int -> int -> int) x = bump ~step:2 x;;val bump_it : (?step:int -> int -> int) -> int -> int = <fun>
bump_it bump 1;;- : int = 3
In practice, such problems appear mostly when using objects whose methods have optional arguments, so that writing the type of object arguments is often a good idea.
Normally the compiler generates a type error if you attempt to pass to a function a parameter whose type is different from the expected one. However, in the specific case where the expected type is a non-labeled function type, and the argument is a function expecting optional parameters, the compiler will attempt to transform the argument to have it match the expected type, by passing None for all optional parameters.
let twice f (x : int) = f(f x);;val twice : (int -> int) -> int -> int = <fun>
twice bump 2;;- : int = 8
This transformation is coherent with the intended semantics, including side-effects. That is, if the application of optional parameters shall produce side-effects, these are delayed until the received function is really applied to an argument.
Like for names, choosing labels for functions is not an easy task. A good labeling is a labeling which
We explain here the rules we applied when labeling OCaml libraries.
To speak in an “object-oriented” way, one can consider that each function has a main argument, its object, and other arguments related with its action, the parameters. To permit the combination of functions through functionals in commuting label mode, the object will not be labeled. Its role is clear from the function itself. The parameters are labeled with names reminding of their nature or their role. The best labels combine nature and role. When this is not possible the role is to be preferred, since the nature will often be given by the type itself. Obscure abbreviations should be avoided.
ListLabels.map : f:('a -> 'b) -> 'a list -> 'b list
UnixLabels.write : file_descr -> buf:bytes -> pos:int -> len:int -> unit
When there are several objects of same nature and role, they are all left unlabeled.
ListLabels.iter2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> unit
When there is no preferable object, all arguments are labeled.
BytesLabels.blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
However, when there is only one argument, it is often left unlabeled.
BytesLabels.create : int -> bytes
This principle also applies to functions of several arguments whose return type is a type variable, as long as the role of each argument is not ambiguous. Labeling such functions may lead to awkward error messages when one attempts to omit labels in an application, as we have seen with ListLabels.fold_left.
Here are some of the label names you will find throughout the libraries.
| Label | Meaning |
| f: | a function to be applied |
| pos: | a position in a string, array or byte sequence |
| len: | a length |
| buf: | a byte sequence or string used as buffer |
| src: | the source of an operation |
| dst: | the destination of an operation |
| init: | the initial value for an iterator |
| cmp: | a comparison function, e.g. Pervasives.compare |
| mode: | an operation mode or a flag list |
All these are only suggestions, but keep in mind that the choice of labels is essential for readability. Bizarre choices will make the program harder to maintain.
In the ideal, the right function name with right labels should be enough to understand the function’s meaning. Since one can get this information with OCamlBrowser or the ocaml toplevel, the documentation is only used when a more detailed specification is needed.
Variants as presented in section 1.4 are a powerful tool to build data structures and algorithms. However they sometimes lack flexibility when used in modular programming. This is due to the fact that every constructor is assigned to an unique type when defined and used. Even if the same name appears in the definition of multiple types, the constructor itself belongs to only one type. Therefore, one cannot decide that a given constructor belongs to multiple types, or consider a value of some type to belong to some other type with more constructors.
With polymorphic variants, this original assumption is removed. That is, a variant tag does not belong to any type in particular, the type system will just check that it is an admissible value according to its use. You need not define a type before using a variant tag. A variant type will be inferred independently for each of its uses.
In programs, polymorphic variants work like usual ones. You just have to prefix their names with a backquote character `.
[`On; `Off];;- : [> `Off | `On ] list = [`On; `Off]
`Number 1;;- : [> `Number of int ] = `Number 1
let f = function `On -> 1 | `Off -> 0 | `Number n -> n;;val f : [< `Number of int | `Off | `On ] -> int = <fun>
List.map f [`On; `Off];;- : int list = [1; 0]
[>`Off|`On] list means that to match this list, you should at least be able to match `Off and `On, without argument. [<`On|`Off|`Number of int] means that f may be applied to `Off, `On (both without argument), or `Number n where n is an integer. The > and < inside the variant types show that they may still be refined, either by defining more tags or by allowing less. As such, they contain an implicit type variable. Because each of the variant types appears only once in the whole type, their implicit type variables are not shown.
The above variant types were polymorphic, allowing further refinement. When writing type annotations, one will most often describe fixed variant types, that is types that cannot be refined. This is also the case for type abbreviations. Such types do not contain < or >, but just an enumeration of the tags and their associated types, just like in a normal datatype definition.
type 'a vlist = [`Nil | `Cons of 'a * 'a vlist];;type 'a vlist = [ `Cons of 'a * 'a vlist | `Nil ]
let rec map f : 'a vlist -> 'b vlist = function | `Nil -> `Nil | `Cons(a, l) -> `Cons(f a, map f l) ;;val map : ('a -> 'b) -> 'a vlist -> 'b vlist = <fun>
Type-checking polymorphic variants is a subtle thing, and some expressions may result in more complex type information.
let f = function `A -> `C | `B -> `D | x -> x;;val f : ([> `A | `B | `C | `D ] as 'a) -> 'a = <fun>
f `E;;- : [> `A | `B | `C | `D | `E ] = `E
Here we are seeing two phenomena. First, since this matching is open (the last case catches any tag), we obtain the type [> `A | `B] rather than [< `A | `B] in a closed matching. Then, since x is returned as is, input and return types are identical. The notation as 'a denotes such type sharing. If we apply f to yet another tag `E, it gets added to the list.
let f1 = function `A x -> x = 1 | `B -> true | `C -> false let f2 = function `A x -> x = "a" | `B -> true ;;val f1 : [< `A of int | `B | `C ] -> bool = <fun> val f2 : [< `A of string | `B ] -> bool = <fun>
let f x = f1 x && f2 x;;val f : [< `A of string & int | `B ] -> bool = <fun>
Here f1 and f2 both accept the variant tags `A and `B, but the argument of `A is int for f1 and string for f2. In f’s type `C, only accepted by f1, disappears, but both argument types appear for `A as int & string. This means that if we pass the variant tag `A to f, its argument should be both int and string. Since there is no such value, f cannot be applied to `A, and `B is the only accepted input.
Even if a value has a fixed variant type, one can still give it a larger type through coercions. Coercions are normally written with both the source type and the destination type, but in simple cases the source type may be omitted.
type 'a wlist = [`Nil | `Cons of 'a * 'a wlist | `Snoc of 'a wlist * 'a];;type 'a wlist = [ `Cons of 'a * 'a wlist | `Nil | `Snoc of 'a wlist * 'a ]
let wlist_of_vlist l = (l : 'a vlist :> 'a wlist);;val wlist_of_vlist : 'a vlist -> 'a wlist = <fun>
let open_vlist l = (l : 'a vlist :> [> 'a vlist]);;val open_vlist : 'a vlist -> [> 'a vlist ] = <fun>
fun x -> (x :> [`A|`B|`C]);;- : [< `A | `B | `C ] -> [ `A | `B | `C ] = <fun>
You may also selectively coerce values through pattern matching.
let split_cases = function | `Nil | `Cons _ as x -> `A x | `Snoc _ as x -> `B x ;;val split_cases : [< `Cons of 'a | `Nil | `Snoc of 'b ] -> [> `A of [> `Cons of 'a | `Nil ] | `B of [> `Snoc of 'b ] ] = <fun>
When an or-pattern composed of variant tags is wrapped inside an alias-pattern, the alias is given a type containing only the tags enumerated in the or-pattern. This allows for many useful idioms, like incremental definition of functions.
let num x = `Num x let eval1 eval (`Num x) = x let rec eval x = eval1 eval x ;;val num : 'a -> [> `Num of 'a ] = <fun> val eval1 : 'a -> [< `Num of 'b ] -> 'b = <fun> val eval : [< `Num of 'a ] -> 'a = <fun>
let plus x y = `Plus(x,y) let eval2 eval = function | `Plus(x,y) -> eval x + eval y | `Num _ as x -> eval1 eval x let rec eval x = eval2 eval x ;;val plus : 'a -> 'b -> [> `Plus of 'a * 'b ] = <fun> val eval2 : ('a -> int) -> [< `Num of int | `Plus of 'a * 'a ] -> int = <fun> val eval : ([< `Num of int | `Plus of 'a * 'a ] as 'a) -> int = <fun>
To make this even more comfortable, you may use type definitions as abbreviations for or-patterns. That is, if you have defined type myvariant = [`Tag1 of int | `Tag2 of bool], then the pattern #myvariant is equivalent to writing (`Tag1(_ : int) | `Tag2(_ : bool)).
Such abbreviations may be used alone,
let f = function | #myvariant -> "myvariant" | `Tag3 -> "Tag3";;val f : [< `Tag1 of int | `Tag2 of bool | `Tag3 ] -> string = <fun>
or combined with with aliases.
let g1 = function `Tag1 _ -> "Tag1" | `Tag2 _ -> "Tag2";;val g1 : [< `Tag1 of 'a | `Tag2 of 'b ] -> string = <fun>
let g = function | #myvariant as x -> g1 x | `Tag3 -> "Tag3";;val g : [< `Tag1 of int | `Tag2 of bool | `Tag3 ] -> string = <fun>
After seeing the power of polymorphic variants, one may wonder why they were added to core language variants, rather than replacing them.
The answer is twofold. One first aspect is that while being pretty efficient, the lack of static type information allows for less optimizations, and makes polymorphic variants slightly heavier than core language ones. However noticeable differences would only appear on huge data structures.
More important is the fact that polymorphic variants, while being type-safe, result in a weaker type discipline. That is, core language variants do actually much more than ensuring type-safety, they also check that you use only declared constructors, that all constructors present in a data-structure are compatible, and they enforce typing constraints to their parameters.
For this reason, you must be more careful about making types explicit when you use polymorphic variants. When you write a library, this is easy since you can describe exact types in interfaces, but for simple programs you are probably better off with core language variants.
Beware also that some idioms make trivial errors very hard to find. For instance, the following code is probably wrong but the compiler has no way to see it.
type abc = [`A | `B | `C] ;;type abc = [ `A | `B | `C ]
let f = function | `As -> "A" | #abc -> "other" ;;val f : [< `A | `As | `B | `C ] -> string = <fun>
let f : abc -> string = f ;;val f : abc -> string = <fun>
You can avoid such risks by annotating the definition itself.
let f : abc -> string = function | `As -> "A" | #abc -> "other" ;;Error: This pattern matches values of type [? `As ] but a pattern was expected which matches values of type abc The second variant type does not allow tag(s) `As
ocaml-doc-4.05/ocaml.html/ocamldoc.html 0000644 0001750 0001750 00000177156 13131636457 016775 0 ustar mehdi mehdi
This chapter describes OCamldoc, a tool that generates documentation from special comments embedded in source files. The comments used by OCamldoc are of the form (**…*) and follow the format described in section 15.2.
OCamldoc can produce documentation in various formats: HTML, LATEX, TeXinfo, Unix man pages, and dot dependency graphs. Moreover, users can add their own custom generators, as explained in section 15.3.
In this chapter, we use the word element to refer to any of the following parts of an OCaml source file: a type declaration, a value, a module, an exception, a module type, a type constructor, a record field, a class, a class type, a class method, a class value or a class inheritance clause.
OCamldoc is invoked via the command ocamldoc, as follows:
ocamldoc options sourcefiles
The following options determine the format for the generated documentation.
OCamldoc calls the OCaml type-checker to obtain type information. The following options impact the type-checking phase. They have the same meaning as for the ocamlc and ocamlopt commands.
The following options apply in conjunction with the -html option:
module M : functor (A:Module) -> functor (B:Module2) -> sig .. endis displayed as:
module M (A:Module) (B:Module2) : sig .. end
The following options apply in conjunction with the -latex option:
These options are useful when you have, for example, a type and a value with the same name. If you do not specify prefixes, LATEX will complain about multiply defined labels.
The following options apply in conjunction with the -texi option:
The following options apply in conjunction with the -dot option:
The following options apply in conjunction with the -man option:
Information on a module can be extracted either from the .mli or .ml file, or both, depending on the files given on the command line. When both .mli and .ml files are given for the same module, information extracted from these files is merged according to the following rules:
The following rules must be respected in order to avoid name clashes resulting in cross-reference errors:
open Foo (* which has a module Bar with a value x *)
module Foo =
struct
module Bar =
struct
let x = 1
end
end
let dummy = Bar.x
In this case, OCamldoc will associate Bar.x to the x of module
Foo defined just above, instead of to the Bar.x defined in the
opened module Foo.
Comments containing documentation material are called special comments and are written between (** and *). Special comments must start exactly with (**. Comments beginning with ( and more than two * are ignored.
OCamldoc can associate comments to some elements of the language encountered in the source files. The association is made according to the locations of comments with respect to the language elements. The locations of comments in .mli and .ml files are different.
A special comment is associated to an element if it is placed before or
after the element.
A special comment before an element is associated to this element if :
A special comment after an element is associated to this element if there is no blank line or comment between the special comment and the element.
There are two exceptions: for constructors and record fields in type definitions, the associated comment can only be placed after the constructor or field definition, without blank lines or other comments between them. The special comment for a constructor with another constructor following must be placed before the ’|’ character separating the two constructors.
The following sample interface file foo.mli illustrates the placement rules for comments in .mli files.
(** The first special comment of the file is the comment associated
with the whole module.*)
(** Special comments can be placed between elements and are kept
by the OCamldoc tool, but are not associated to any element.
@-tags in these comments are ignored.*)
(*******************************************************************)
(** Comments like the one above, with more than two asterisks,
are ignored. *)
(** The comment for function f. *)
val f : int -> int -> int
(** The continuation of the comment for function f. *)
(** Comment for exception My_exception, even with a simple comment
between the special comment and the exception.*)
(* Hello, I'm a simple comment :-) *)
exception My_exception of (int -> int) * int
(** Comment for type weather *)
type weather =
| Rain of int (** The comment for constructor Rain *)
| Sun (** The comment for constructor Sun *)
(** Comment for type weather2 *)
type weather2 =
| Rain of int (** The comment for constructor Rain *)
| Sun (** The comment for constructor Sun *)
(** I can continue the comment for type weather2 here
because there is already a comment associated to the last constructor.*)
(** The comment for type my_record *)
type my_record = {
val foo : int ; (** Comment for field foo *)
val bar : string ; (** Comment for field bar *)
}
(** Continuation of comment for type my_record *)
(** Comment for foo *)
val foo : string
(** This comment is associated to foo and not to bar. *)
val bar : string
(** This comment is associated to bar. *)
(** The comment for class my_class *)
class my_class :
object
(** A comment to describe inheritance from cl *)
inherit cl
(** The comment for attribute tutu *)
val mutable tutu : string
(** The comment for attribute toto. *)
val toto : int
(** This comment is not attached to titi since
there is a blank line before titi, but is kept
as a comment in the class. *)
val titi : string
(** Comment for method toto *)
method toto : string
(** Comment for method m *)
method m : float -> int
end
(** The comment for the class type my_class_type *)
class type my_class_type =
object
(** The comment for variable x. *)
val mutable x : int
(** The commend for method m. *)
method m : int -> int
end
(** The comment for module Foo *)
module Foo =
struct
(** The comment for x *)
val x : int
(** A special comment that is kept but not associated to any element *)
end
(** The comment for module type my_module_type. *)
module type my_module_type =
sig
(** The comment for value x. *)
val x : int
(** The comment for module M. *)
module M =
struct
(** The comment for value y. *)
val y : int
(* ... *)
end
end
A special comment is associated to an element if it is placed before the element and there is no blank line between the comment and the element. Meanwhile, there can be a simple comment between the special comment and the element. There are two exceptions, for constructors and record fields in type definitions, whose associated comment must be placed after the constructor or field definition, without blank line between them. The special comment for a constructor with another constructor following must be placed before the ’|’ character separating the two constructors.
The following example of file toto.ml shows where to place comments in a .ml file.
(** The first special comment of the file is the comment associated
to the whole module. *)
(** The comment for function f *)
let f x y = x + y
(** This comment is not attached to any element since there is another
special comment just before the next element. *)
(** Comment for exception My_exception, even with a simple comment
between the special comment and the exception.*)
(* A simple comment. *)
exception My_exception of (int -> int) * int
(** Comment for type weather *)
type weather =
| Rain of int (** The comment for constructor Rain *)
| Sun (** The comment for constructor Sun *)
(** The comment for type my_record *)
type my_record = {
val foo : int ; (** Comment for field foo *)
val bar : string ; (** Comment for field bar *)
}
(** The comment for class my_class *)
class my_class =
object
(** A comment to describe inheritance from cl *)
inherit cl
(** The comment for the instance variable tutu *)
val mutable tutu = "tutu"
(** The comment for toto *)
val toto = 1
val titi = "titi"
(** Comment for method toto *)
method toto = tutu ^ "!"
(** Comment for method m *)
method m (f : float) = 1
end
(** The comment for class type my_class_type *)
class type my_class_type =
object
(** The comment for the instance variable x. *)
val mutable x : int
(** The commend for method m. *)
method m : int -> int
end
(** The comment for module Foo *)
module Foo =
struct
(** The comment for x *)
val x : int
(** A special comment in the class, but not associated to any element. *)
end
(** The comment for module type my_module_type. *)
module type my_module_type =
sig
(* Comment for value x. *)
val x : int
(* ... *)
end
The special comment (**/**) tells OCamldoc to discard elements placed after this comment, up to the end of the current class, class type, module or module type, or up to the next stop comment. For instance:
class type foo =
object
(** comment for method m *)
method m : string
(**/**)
(** This method won't appear in the documentation *)
method bar : int
end
(** This value appears in the documentation, since the Stop special comment
in the class does not affect the parent module of the class.*)
val foo : string
(**/**)
(** The value bar does not appear in the documentation.*)
val bar : string
(**/**)
(** The type t appears since in the documentation since the previous stop comment
toggled off the "no documentation mode". *)
type t = string
The -no-stop option to ocamldoc causes the Stop special comments to be ignored.
The inside of documentation comments (**…*) consists of free-form text with optional formatting annotations, followed by optional tags giving more specific information about parameters, version, authors, … The tags are distinguished by a leading @ character. Thus, a documentation comment has the following shape:
(** The comment begins with a description, which is text formatted according to the rules described in the next section. The description continues until the first non-escaped '@' character. @author Mr Smith @param x description for parameter x *)
Some elements support only a subset of all @-tags. Tags that are not relevant to the documented element are simply ignored. For instance, all tags are ignored when documenting type constructors, record fields, and class inheritance clauses. Similarly, a @param tag on a class instance variable is ignored.
At last, (**) is the empty documentation comment.
Here is the BNF grammar for the simple markup language used to format text descriptions.
|
| text-element | ::= |
| ∣ | { { 0 … 9 }+ text } | format text as a section header; the integer following { indicates the sectioning level. |
| ∣ | { { 0 … 9 }+ : label text } | same, but also associate the name label to the current point. This point can be referenced by its fully-qualified label in a {! command, just like any other element. |
| ∣ | {b text } | set text in bold. |
| ∣ | {i text } | set text in italic. |
| ∣ | {e text } | emphasize text. |
| ∣ | {C text } | center text. |
| ∣ | {L text } | left align text. |
| ∣ | {R text } | right align text. |
| ∣ | {ul list } | build a list. |
| ∣ | {ol list } | build an enumerated list. |
| ∣ | {{: string } text } | put a link to the given address (given as string) on the given text. |
| ∣ | [ string ] | set the given string in source code style. |
| ∣ | {[ string ]} | set the given string in preformatted source code style. |
| ∣ | {v string v} | set the given string in verbatim style. |
| ∣ | {% string %} | target-specific content (LATEX code by default, see details in 15.2.4.4) |
| ∣ | {! string } | insert a cross-reference to an element (see section 15.2.4.2 for the syntax of cross-references). |
| ∣ | {!modules: string string ... } | insert an index table for the given module names. Used in HTML only. |
| ∣ | {!indexlist} | insert a table of links to the various indexes (types, values, modules, ...). Used in HTML only. |
| ∣ | {^ text } | set text in superscript. |
| ∣ | {_ text } | set text in subscript. |
| ∣ | escaped-string | typeset the given string as is; special characters (’{’, ’}’, ’[’, ’]’ and ’@’) must be escaped by a ’\’ |
| ∣ | blank-line | force a new line. |
|
A shortcut syntax exists for lists and enumerated lists:
(** Here is a {b list}
- item 1
- item 2
- item 3
The list is ended by the blank line.*)
is equivalent to:
(** Here is a {b list}
{ul {- item 1}
{- item 2}
{- item 3}}
The list is ended by the blank line.*)
The same shortcut is available for enumerated lists, using ’+’ instead of ’-’. Note that only one list can be defined by this shortcut in nested lists.
Cross-references are fully qualified element names, as in the example {!Foo.Bar.t}. This is an ambiguous reference as it may designate a type name, a value name, a class name, etc. It is possible to make explicit the intended syntactic class, using {!type:Foo.Bar.t} to designate a type, and {!val:Foo.Bar.t} a value of the same name.
The list of possible syntactic class is as follows:
| tag | syntactic class |
| module: | module |
| modtype: | module type |
| class: | class |
| classtype: | class type |
| val: | value |
| type: | type |
| exception: | exception |
| attribute: | attribute |
| method: | class method |
| section: | ocamldoc section |
| const: | variant constructor |
| recfield: | record field |
In the case of variant constructors or record field, the constructor or field name should be preceded by the name of the correspond type – to avoid the ambiguity of several types having the same constructor names. For example, the constructor Node of the type tree will be referenced as {!tree.Node} or {!const:tree.Node}, or possibly {!Mod1.Mod2.tree.Node} from outside the module.
In the description of a value, type, exception, module, module type, class or class type, the first sentence is sometimes used in indexes, or when just a part of the description is needed. The first sentence is composed of the first characters of the description, until
outside of the following text formatting : {ul list } , {ol list } , [ string ] , {[ string ]} , {v string v} , {% string %} , {! string } , {^ text } , {_ text } .
The content inside {%foo: ... %} is target-specific and will only be interpreted by the backend foo, and ignored by the others. The backends of the distribution are latex, html, texi and man. If no target is specified (syntax {% ... %}), latex is chosen by default. Custom generators may support their own target prefix.
The HTML tags <b>..</b>, <code>..</code>, <i>..</i>, <ul>..</ul>, <ol>..</ol>, <li>..</li>, <center>..</center> and <h[0-9]>..</h[0-9]> can be used instead of, respectively, {b ..} , [..] , {i ..} , {ul ..} , {ol ..} , {li ..} , {C ..} and {[0-9] ..}.
The following table gives the list of predefined @-tags, with their
syntax and meaning.
| @author string | The author of the element. One author per @author tag. There may be several @author tags for the same element. |
| @deprecated text | The text should describe when the element was deprecated, what to use as a replacement, and possibly the reason for deprecation. |
| @param id text | Associate the given description (text) to the given parameter name id. This tag is used for functions, methods, classes and functors. |
| @raise Exc text | Explain that the element may raise the exception Exc. |
| @return text | Describe the return value and its possible values. This tag is used for functions and methods. |
| @see < URL > text | Add a reference to the URL with the given text as comment. |
| @see 'filename' text | Add a reference to the given file name (written between single quotes), with the given text as comment. |
| @see "document-name" text | Add a reference to the given document name (written between double quotes), with the given text as comment. |
| @since string | Indicate when the element was introduced. |
| @before version text | Associate the given description (text) to the given version in order to document compatibility issues. |
| @version string | The version number for the element. |
You can use custom tags in the documentation comments, but they will have no effect if the generator used does not handle them. To use a custom tag, for example foo, just put @foo with some text in your comment, as in:
(** My comment to show you a custom tag. @foo this is the text argument to the [foo] custom tag. *)
To handle custom tags, you need to define a custom generator, as explained in section 15.3.2.
OCamldoc operates in two steps:
Users can provide their own documentation generator to be used during step 2 instead of the default generators. All the information retrieved during the analysis step is available through the Odoc_info module, which gives access to all the types and functions representing the elements found in the given modules, with their associated description.
The files you can use to define custom generators are installed in the ocamldoc sub-directory of the OCaml standard library.
The type of a generator module depends on the kind of generated documentation. Here is the list of generator module types, with the name of the generator class in the module :
That is, to define a new generator, one must implement a module with the expected signature, and with the given generator class, providing the generate method as entry point to make the generator generates documentation for a given list of modules :
method generate : Odoc_info.Module.t_module list -> unit
This method will be called with the list of analysed and possibly merged Odoc_info.t_module structures.
It is recommended to inherit from the current generator of the same kind as the one you want to define. Doing so, it is possible to load various custom generators to combine improvements brought by each one.
This is done using first class modules (see chapter 7.10).
The easiest way to define a custom generator is the following this example, here extending the current HTML generator. We don’t have to know if this is the original HTML generator defined in ocamldoc or if it has been extended already by a previously loaded custom generator :
module Generator (G : Odoc_html.Html_generator) =
struct
class html =
object(self)
inherit G.html as html
(* ... *)
method generate module_list =
(* ... *)
()
(* ... *)
end
end;;
let _ = Odoc_args.extend_html_generator (module Generator : Odoc_gen.Html_functor);;
To know which methods to override and/or which methods are available, have a look at the different base implementations, depending on the kind of generator you are extending :
Making a custom generator handle custom tags (see 15.2.5) is very simple.
Here is how to develop a HTML generator handling your custom tags.
The class Odoc_html.Generator.html inherits from the class Odoc_html.info, containing a field tag_functions which is a list pairs composed of a custom tag (e.g. "foo") and a function taking a text and returning HTML code (of type string). To handle a new tag bar, extend the current HTML generator and complete the tag_functions field:
module Generator (G : Odoc_html.Html_generator) =
struct
class html =
object(self)
inherit G.html
(** Return HTML code for the given text of a bar tag. *)
method html_of_bar t = (* your code here *)
initializer
tag_functions <- ("bar", self#html_of_bar) :: tag_functions
end
end
let _ = Odoc_args.extend_html_generator (module Generator : Odoc_gen.Html_functor);;
Another method of the class Odoc_html.info will look for the function associated to a custom tag and apply it to the text given to the tag. If no function is associated to a custom tag, then the method prints a warning message on stderr.
You can act the same way for other kinds of generators.
The command line analysis is performed after loading the module containing the documentation generator, thus allowing command line options to be added to the list of existing ones. Adding an option can be done with the function
Odoc_args.add_option : string * Arg.spec * string -> unit
Note: Existing command line options can be redefined using this function.
Let custom.ml be the file defining a new generator class. Compilation of custom.ml can be performed by the following command :
ocamlc -I +ocamldoc -c custom.ml
The file custom.cmo is created and can be used this way :
ocamldoc -g custom.cmo other-options source-files
Options selecting a built-in generator to ocamldoc, such as -html, have no effect if a custom generator of the same kind is provided using -g. If the kinds do not match, the selected built-in generator is used and the custom one is ignored.
It is possible to define a generator class in several modules, which are defined in several files file1.ml[i], file2.ml[i], ..., filen.ml[i]. A .cma library file must be created, including all these files.
The following commands create the custom.cma file from files file1.ml[i], ..., filen.ml[i] :
ocamlc -I +ocamldoc -c file1.ml[i] ocamlc -I +ocamldoc -c file2.ml[i] ... ocamlc -I +ocamldoc -c filen.ml[i] ocamlc -o custom.cma -a file1.cmo file2.cmo ... filen.cmo
Then, the following command uses custom.cma as custom generator:
ocamldoc -g custom.cma other-options source-files
ocaml-doc-4.05/ocaml.html/toplevel.html 0000644 0001750 0001750 00000147707 13131636457 017045 0 ustar mehdi mehdi
This chapter describes the toplevel system for OCaml, that permits interactive use of the OCaml system through a read-eval-print loop. In this mode, the system repeatedly reads OCaml phrases from the input, then typechecks, compile and evaluate them, then prints the inferred type and result value, if any. The system prints a # (sharp) prompt before reading each phrase.
Input to the toplevel can span several lines. It is terminated by ;; (a double-semicolon). The toplevel input consists in one or several toplevel phrases, with the following syntax:
|
A phrase can consist of a definition, like those found in implementations of compilation units or in struct … end module expressions. The definition can bind value names, type names, an exception, a module name, or a module type name. The toplevel system performs the bindings, then prints the types and values (if any) for the names thus defined.
A phrase may also consist in a value expression (section 6.7). It is simply evaluated without performing any bindings, and its value is printed.
Finally, a phrase can also consist in a toplevel directive, starting with # (the sharp sign). These directives control the behavior of the toplevel; they are listed below in section 9.2.
Unix: The toplevel system is started by the command ocaml, as follows:ocaml options objects # interactive mode ocaml options objects scriptfile # script modeoptions are described below. objects are filenames ending in .cmo or .cma; they are loaded into the interpreter immediately after options are set. scriptfile is any file name not ending in .cmo or .cma.If no scriptfile is given on the command line, the toplevel system enters interactive mode: phrases are read on standard input, results are printed on standard output, errors on standard error. End-of-file on standard input terminates ocaml (see also the #quit directive in section 9.2).
On start-up (before the first phrase is read), if the file .ocamlinit exists in the current directory, its contents are read as a sequence of OCaml phrases and executed as per the #use directive described in section 9.2. The evaluation outcode for each phrase are not displayed. If the current directory does not contain an .ocamlinit file, but the user’s home directory (environment variable HOME) does, the latter is read and executed as described below.
The toplevel system does not perform line editing, but it can easily be used in conjunction with an external line editor such as ledit, ocaml2 or rlwrap (see the Caml Hump). Another option is to use ocaml under Gnu Emacs, which gives the full editing power of Emacs (command run-caml from library inf-caml).
At any point, the parsing, compilation or evaluation of the current phrase can be interrupted by pressing ctrl-C (or, more precisely, by sending the INTR signal to the ocaml process). The toplevel then immediately returns to the # prompt.
If scriptfile is given on the command-line to ocaml, the toplevel system enters script mode: the contents of the file are read as a sequence of OCaml phrases and executed, as per the #use directive (section 9.2). The outcome of the evaluation is not printed. On reaching the end of file, the ocaml command exits immediately. No commands are read from standard input. Sys.argv is transformed, ignoring all OCaml parameters, and starting with the script file name in Sys.argv.(0).
In script mode, the first line of the script is ignored if it starts with #!. Thus, it should be possible to make the script itself executable and put as first line #!/usr/local/bin/ocaml, thus calling the toplevel system automatically when the script is run. However, ocaml itself is a #! script on most installations of OCaml, and Unix kernels usually do not handle nested #! scripts. A better solution is to put the following as the first line of the script:
#!/usr/local/bin/ocamlrun /usr/local/bin/ocaml
The following command-line options are recognized by the ocaml command.
If the given directory starts with +, it is taken relative to the standard library directory. For instance, -I +labltk adds the subdirectory labltk of the standard library to the search path.
Directories can also be added to the list once the toplevel is running with the #directory directive (section 9.2).
The warning-list argument is a sequence of warning specifiers, with no separators between them. A warning specifier is one of the following:
Warning numbers and letters which are out of the range of warnings that are currently defined are ignored. The warnings are as follows.
The default setting is -w +a-4-6-7-9-27-29-32..39-41..42-44-45-48-50. It is displayed by -help. Note that warnings 5 and 10 are not always triggered, depending on the internals of the type checker.
Note: it is not recommended to use warning sets (i.e. letters) as arguments to -warn-error in production code, because this can break your build when future versions of OCaml add some new warnings.
The default setting is -warn-error -a+31 (only warning 31 is fatal).
Unix: The following environment variables are also consulted:
- TERM
- When printing error messages, the toplevel system attempts to underline visually the location of the error. It consults the TERM variable to determines the type of output terminal and look up its capabilities in the terminal database.
- HOME
- Directory where the .ocamlinit file is searched.
The following directives control the toplevel behavior, load files in memory, and trace program execution.
Note: all directives start with a # (sharp) symbol. This # must be typed before the directive, and must not be confused with the # prompt displayed by the interactive loop. For instance, typing #quit;; will exit the toplevel loop, but typing quit;; will result in an “unbound value quit” error.
For directives that take file names as arguments, if the given file name specifies no directory, the file is searched in the following directories:
The printing function printer-name should have type Format.formatter -> t -> unit, where t is the type for the values to be printed, and should output its textual representation for the value of type t on the given formatter, using the functions provided by the Format library. For backward compatibility, printer-name can also have type t -> unit and should then output on the standard formatter, but this usage is deprecated.
Toplevel phrases can refer to identifiers defined in compilation units with the same mechanisms as for separately compiled units: either by using qualified names (Modulename.localname), or by using the open construct and unqualified names (see section 6.3).
However, before referencing another compilation unit, an implementation of that unit must be present in memory. At start-up, the toplevel system contains implementations for all the modules in the the standard library. Implementations for user modules can be entered with the #load directive described above. Referencing a unit for which no implementation has been provided results in the error Reference to undefined global `...'.
Note that entering open Mod merely accesses the compiled interface (.cmi file) for Mod, but does not load the implementation of Mod, and does not cause any error if no implementation of Mod has been loaded. The error “reference to undefined global Mod” will occur only when executing a value or module definition that refers to Mod.
This section describes and explains the most frequently encountered error messages.
If filename has the format mod.cmi, this means you have referenced the compilation unit mod, but its compiled interface could not be found. Fix: compile mod.mli or mod.ml first, to create the compiled interface mod.cmi.
If filename has the format mod.cmo, this means you are trying to load with #load a bytecode object file that does not exist yet. Fix: compile mod.ml first.
If your program spans several directories, this error can also appear because you haven’t specified the directories to look into. Fix: use the #directory directive to add the correct directories to the search path.
The ocamlmktop command builds OCaml toplevels that contain user code preloaded at start-up.
The ocamlmktop command takes as argument a set of .cmo and .cma files, and links them with the object files that implement the OCaml toplevel. The typical use is:
ocamlmktop -o mytoplevel foo.cmo bar.cmo gee.cmo
This creates the bytecode file mytoplevel, containing the OCaml toplevel system, plus the code from the three .cmo files. This toplevel is directly executable and is started by:
./mytoplevel
This enters a regular toplevel loop, except that the code from foo.cmo, bar.cmo and gee.cmo is already loaded in memory, just as if you had typed:
#load "foo.cmo";;
#load "bar.cmo";;
#load "gee.cmo";;
on entrance to the toplevel. The modules Foo, Bar and Gee are not opened, though; you still have to do
open Foo;;
yourself, if this is what you wish.
The following command-line options are recognized by ocamlmktop.
ocaml-doc-4.05/ocaml.html/libdynlink.html 0000644 0001750 0001750 00000004170 13131636457 017334 0 ustar mehdi mehdi
The dynlink library supports type-safe dynamic loading and linking of bytecode object files (.cmo and .cma files) in a running bytecode program, or of native plugins (usually .cmxs files) in a running native program. Type safety is ensured by limiting the set of modules from the running program that the loaded object file can access, and checking that the running program and the loaded object file have been compiled against the same interfaces for these modules. In native code, there are also some compatibility checks on the implementations (to avoid errors with cross-module optimizations); it might be useful to hide .cmx files when building native plugins so that they remain independent of the implementation of modules in the main program.
Programs that use the dynlink library simply need to link dynlink.cma or dynlink.cmxa with their object files and other libraries.
ocaml-doc-4.05/ocaml.html/values.html 0000644 0001750 0001750 00000017021 13131636457 016473 0 ustar mehdi mehdi
This section describes the kinds of values that are manipulated by OCaml programs.
Integer values are integer numbers from −230 to 230−1, that is −1073741824 to 1073741823. The implementation may support a wider range of integer values: on 64-bit platforms, the current implementation supports integers ranging from −262 to 262−1.
Floating-point values are numbers in floating-point representation. The current implementation uses double-precision floating-point numbers conforming to the IEEE 754 standard, with 53 bits of mantissa and an exponent ranging from −1022 to 1023.
Character values are represented as 8-bit integers between 0 and 255. Character codes between 0 and 127 are interpreted following the ASCII standard. The current implementation interprets character codes between 128 and 255 following the ISO 8859-1 standard.
String values are finite sequences of characters. The current implementation supports strings containing up to 224 − 5 characters (16777211 characters); on 64-bit platforms, the limit is 257 − 9.
Tuples of values are written (v1, …, vn), standing for the n-tuple of values v1 to vn. The current implementation supports tuple of up to 222 − 1 elements (4194303 elements).
Record values are labeled tuples of values. The record value written { field1 = v1; …; fieldn = vn } associates the value vi to the record field fieldi, for i = 1 … n. The current implementation supports records with up to 222 − 1 fields (4194303 fields).
Arrays are finite, variable-sized sequences of values of the same type. The current implementation supports arrays containing up to 222 − 1 elements (4194303 elements) unless the elements are floating-point numbers (2097151 elements in this case); on 64-bit platforms, the limit is 254 − 1 for all arrays.
Variant values are either a constant constructor, or a non-constant constructor applied to a number of values. The former case is written constr; the latter case is written constr (v1, ... , vn ), where the vi are said to be the arguments of the non-constant constructor constr. The parentheses may be omitted if there is only one argument.
The following constants are treated like built-in constant constructors:
| Constant | Constructor |
| false | the boolean false |
| true | the boolean true |
| () | the “unit” value |
| [] | the empty list |
The current implementation limits each variant type to have at most 246 non-constant constructors and 230−1 constant constructors.
Polymorphic variants are an alternate form of variant values, not belonging explicitly to a predefined variant type, and following specific typing rules. They can be either constant, written `tag-name, or non-constant, written `tag-name(v).
Functional values are mappings from values to values.
Objects are composed of a hidden internal state which is a record of instance variables, and a set of methods for accessing and modifying these variables. The structure of an object is described by the toplevel class that created it.
ocaml-doc-4.05/ocaml.html/runtime.html 0000644 0001750 0001750 00000045504 13131636457 016666 0 ustar mehdi mehdi
The ocamlrun command executes bytecode files produced by the linking phase of the ocamlc command.
The ocamlrun command comprises three main parts: the bytecode interpreter, that actually executes bytecode files; the memory allocator and garbage collector; and a set of C functions that implement primitive operations such as input/output.
The usage for ocamlrun is:
ocamlrun options bytecode-executable arg1 ... argn
The first non-option argument is taken to be the name of the file containing the executable bytecode. (That file is searched in the executable path as well as in the current directory.) The remaining arguments are passed to the OCaml program, in the string array Sys.argv. Element 0 of this array is the name of the bytecode executable file; elements 1 to n are the remaining arguments arg1 to argn.
As mentioned in chapter 8, the bytecode executable files produced by the ocamlc command are self-executable, and manage to launch the ocamlrun command on themselves automatically. That is, assuming a.out is a bytecode executable file,
a.out arg1 ... argn
works exactly as
ocamlrun a.out arg1 ... argn
Notice that it is not possible to pass options to ocamlrun when invoking a.out directly.
Windows: Under several versions of Windows, bytecode executable files are self-executable only if their name ends in .exe. It is recommended to always give .exe names to bytecode executables, e.g. compile with ocamlc -o myprog.exe ... rather than ocamlc -o myprog ....
The following command-line options are recognized by ocamlrun.
The following environment variables are also consulted:
If the option letter is not recognized, the whole parameter is ignored; if the equal sign or the number is missing, the value is taken as 1; if the multiplier is not recognized, it is ignored.
For example, on a 32-bit machine, under bash the command
export OCAMLRUNPARAM='b,s=256k,v=0x015'
tells a subsequent ocamlrun to print backtraces for uncaught exceptions, set its initial minor heap size to 1 megabyte and print a message at the start of each major GC cycle, when the heap size changes, and when compaction is triggered.
On platforms that support dynamic loading, ocamlrun can link dynamically with C shared libraries (DLLs) providing additional C primitives beyond those provided by the standard runtime system. The names for these libraries are provided at link time as described in section 19.1.4), and recorded in the bytecode executable file; ocamlrun, then, locates these libraries and resolves references to their primitives when the bytecode executable program starts.
The ocamlrun command searches shared libraries in the following directories, in the order indicated:
This section describes and explains the most frequently encountered error messages.
To help you diagnose this error, run your program with the -v option to ocamlrun, or with the OCAMLRUNPARAM environment variable set to v=63. If it displays lots of “Growing stack…” messages, this is probably a looping recursive function. If it displays lots of “Growing heap…” messages, with the heap size growing slowly, this is probably an attempt to construct a data structure with too many (infinitely many?) cells. If it displays few “Growing heap…” messages, but with a huge increment in the heap size, this is probably an attempt to build an excessively large array, string or byte sequence.
ocaml-doc-4.05/ocaml.html/manual.css 0000644 0001750 0001750 00000006734 13131636457 016306 0 ustar mehdi mehdi .c000{border-spacing:0;width:80%}
.c001{border-spacing:6px;border-collapse:separate;}
.c002{color:blue}
.c003{font-family:monospace}
.c004{font-family:monospace;color:blue}
.c005{font-family:monospace;font-style:italic}
.c006{font-family:monospace;font-weight:bold}
.c007{font-family:sans-serif}
.c008{font-size:small}
.c009{font-style:italic}
.c010{font-style:italic;color:maroon}
.c011{font-style:italic;font-weight:bold}
.c012{font-style:oblique}
.c013{font-weight:bold}
.c014{text-align:center;border:solid 1px;white-space:nowrap}
.c015{text-align:center;white-space:nowrap}
.c016{text-align:left;border:solid 1px;white-space:nowrap}
.c017{text-align:left;white-space:nowrap}
.c018{text-align:right;white-space:nowrap}
.c019{vertical-align:middle}
.c020{vertical-align:top;text-align:left;}
.c021{vertical-align:top;text-align:left;border:solid 1px;}
.c022{vertical-align:top;text-align:left;border:solid 1px;white-space:nowrap}
.c023{vertical-align:top;text-align:left;white-space:nowrap}
.c024{vertical-align:top;text-align:right;white-space:nowrap}
.li-itemize{margin:1ex 0ex;}
.li-enumerate{margin:1ex 0ex;}
.dd-description{margin:0ex 0ex 1ex 4ex;}
.dt-description{margin:0ex;}
.footnotetext{margin:0ex; padding:0ex;}
div.footnotetext P{margin:0px; text-indent:1em;}
.thefootnotes{text-align:left;margin:0ex;}
.dt-thefootnotes{margin:0em;}
.dd-thefootnotes{margin:0em 0em 0em 2em;}
.center{text-align:center;margin-left:auto;margin-right:auto;}
div table{margin-left:inherit;margin-right:inherit;margin-bottom:2px;margin-top:2px}
td table{margin:auto;}
table{border-collapse:collapse;}
td{padding:0;}
.cellpadding1 tr td{padding:1px;}
pre{text-align:left;margin-left:0ex;margin-right:auto;}
blockquote{margin-left:4ex;margin-right:4ex;text-align:left;}
td p{margin:0px;}
.hbar{border:none;height:2px;width:100%;background-color:black;}
.display{border-collapse:separate;border-spacing:2px;width:auto; border:none;}
.dcell{white-space:nowrap;padding:0px; border:none;}
.dcenter{margin:0ex auto;}
.theorem{text-align:left;margin:1ex auto 1ex 0ex;}
.part{margin:2ex auto;text-align:center}
a:link{color:#00A000;text-decoration:underline;}
a:visited{color:#006000;text-decoration:underline;}
a:hover{color:black;text-decoration:none;background-color:#7FFF7F}
div.caml-output{color:maroon;}
div.caml-input::before{content:"#"; color:black;}
div.caml-input{color:#006000;}
div.caml-example pre{margin:2ex 0px;}
.li-links{margin:0ex 0ex;}
a.syntax:link{color:maroon;text-decoration:underline}
a.syntax:visited{color:maroon;text-decoration:underline}
a.syntax:hover{color:black;text-decoration:none;background-color:#FF6060}
body{background-color:white}
a:link{color:#00B200;text-decoration:underline;}
a:visited{color:#006600;text-decoration:underline;}
a:hover{color:black;text-decoration:none;background-color:#99FF99}
.part{padding:1ex;background-color:#00CC00}
.section{padding:.5ex;background-color:#66FF66}
.subsection{padding:0.3ex;background-color:#7FFF7F}
.subsubsection{padding:0.5ex;background-color:#99FF99}
.paragraph{padding:0.5ex;background-color:#CCFFCC}
.chapter{padding:0.5ex;background-color:#2DE52D}
.ffootnoterule{border:none;margin:1em auto 1em 0px;width:50%;background-color:#00CC00}
.ftoc1{list-style:none;margin:0ex 1ex;padding:0ex 1ex;border-left:1ex solid #00CC00}
.ftoc2{list-style:none;margin:1ex 1ex;padding:0ex 1ex;border-left:1ex solid #2DE52D}
.ftoc3{list-style:none;margin:0ex 1ex;padding:0ex 1ex;border-left:1ex solid #66FF66}
.ftoc4{list-style:none;margin:0ex 1ex;padding:0ex 1ex;border-left:1ex solid #7FFF7F}
ocaml-doc-4.05/ocaml.html/objectexamples.html 0000644 0001750 0001750 00000223014 13131636457 020202 0 ustar mehdi mehdi
(Chapter written by Jérôme Vouillon, Didier Rémy and Jacques Garrigue)
This chapter gives an overview of the object-oriented features of OCaml. Note that the relation between object, class and type in OCaml is very different from that in mainstream object-oriented languages like Java or C++, so that you should not assume that similar keywords mean the same thing.
3.1 Classes and objects
3.2 Immediate objects
3.3 Reference to self
3.4 Initializers
3.5 Virtual methods
3.6 Private methods
3.7 Class interfaces
3.8 Inheritance
3.9 Multiple inheritance
3.10 Parameterized classes
3.11 Polymorphic methods
3.12 Using coercions
3.13 Functional objects
3.14 Cloning objects
3.15 Recursive classes
3.16 Binary methods
3.17 Friends
The class point below defines one instance variable x and two methods get_x and move. The initial value of the instance variable is 0. The variable x is declared mutable, so the method move can change its value.
class point = object val mutable x = 0 method get_x = x method move d = x <- x + d end;;class point : object val mutable x : int method get_x : int method move : int -> unit end
We now create a new point p, instance of the point class.
let p = new point;;val p : point = <obj>
Note that the type of p is point. This is an abbreviation automatically defined by the class definition above. It stands for the object type <get_x : int; move : int -> unit>, listing the methods of class point along with their types.
We now invoke some methods to p:
p#get_x;;- : int = 0
p#move 3;;- : unit = ()
p#get_x;;- : int = 3
The evaluation of the body of a class only takes place at object creation time. Therefore, in the following example, the instance variable x is initialized to different values for two different objects.
let x0 = ref 0;;val x0 : int ref = {contents = 0}
class point = object val mutable x = incr x0; !x0 method get_x = x method move d = x <- x + d end;;class point : object val mutable x : int method get_x : int method move : int -> unit end
new point#get_x;;- : int = 1
new point#get_x;;- : int = 2
The class point can also be abstracted over the initial values of the x coordinate.
class point = fun x_init -> object val mutable x = x_init method get_x = x method move d = x <- x + d end;;class point : int -> object val mutable x : int method get_x : int method move : int -> unit end
Like in function definitions, the definition above can be abbreviated as:
class point x_init = object val mutable x = x_init method get_x = x method move d = x <- x + d end;;class point : int -> object val mutable x : int method get_x : int method move : int -> unit end
An instance of the class point is now a function that expects an initial parameter to create a point object:
new point;;- : int -> point = <fun>
let p = new point 7;;val p : point = <obj>
The parameter x_init is, of course, visible in the whole body of the definition, including methods. For instance, the method get_offset in the class below returns the position of the object relative to its initial position.
class point x_init = object val mutable x = x_init method get_x = x method get_offset = x - x_init method move d = x <- x + d end;;class point : int -> object val mutable x : int method get_offset : int method get_x : int method move : int -> unit end
Expressions can be evaluated and bound before defining the object body of the class. This is useful to enforce invariants. For instance, points can be automatically adjusted to the nearest point on a grid, as follows:
class adjusted_point x_init = let origin = (x_init / 10) * 10 in object val mutable x = origin method get_x = x method get_offset = x - origin method move d = x <- x + d end;;class adjusted_point : int -> object val mutable x : int method get_offset : int method get_x : int method move : int -> unit end
(One could also raise an exception if the x_init coordinate is not on the grid.) In fact, the same effect could here be obtained by calling the definition of class point with the value of the origin.
class adjusted_point x_init = point ((x_init / 10) * 10);;class adjusted_point : int -> point
An alternate solution would have been to define the adjustment in a special allocation function:
let new_adjusted_point x_init = new point ((x_init / 10) * 10);;val new_adjusted_point : int -> point = <fun>
However, the former pattern is generally more appropriate, since the code for adjustment is part of the definition of the class and will be inherited.
This ability provides class constructors as can be found in other languages. Several constructors can be defined this way to build objects of the same class but with different initialization patterns; an alternative is to use initializers, as described below in section 3.4.
There is another, more direct way to create an object: create it without going through a class.
The syntax is exactly the same as for class expressions, but the result is a single object rather than a class. All the constructs described in the rest of this section also apply to immediate objects.
let p = object val mutable x = 0 method get_x = x method move d = x <- x + d end;;val p : < get_x : int; move : int -> unit > = <obj>
p#get_x;;- : int = 0
p#move 3;;- : unit = ()
p#get_x;;- : int = 3
Unlike classes, which cannot be defined inside an expression, immediate objects can appear anywhere, using variables from their environment.
let minmax x y = if x < y then object method min = x method max = y end else object method min = y method max = x end;;val minmax : 'a -> 'a -> < max : 'a; min : 'a > = <fun>
Immediate objects have two weaknesses compared to classes: their types are not abbreviated, and you cannot inherit from them. But these two weaknesses can be advantages in some situations, as we will see in sections 3.3 and 3.10.
A method or an initializer can send messages to self (that is, the current object). For that, self must be explicitly bound, here to the variable s (s could be any identifier, even though we will often choose the name self.)
class printable_point x_init = object (s) val mutable x = x_init method get_x = x method move d = x <- x + d method print = print_int s#get_x end;;class printable_point : int -> object val mutable x : int method get_x : int method move : int -> unit method print : unit end
let p = new printable_point 7;;val p : printable_point = <obj>
p#print;;7- : unit = ()
Dynamically, the variable s is bound at the invocation of a method. In particular, when the class printable_point is inherited, the variable s will be correctly bound to the object of the subclass.
A common problem with self is that, as its type may be extended in subclasses, you cannot fix it in advance. Here is a simple example.
let ints = ref [];;val ints : '_a list ref = {contents = []}
class my_int = object (self) method n = 1 method register = ints := self :: !ints end ;;Error: This expression has type < n : int; register : 'a; .. > but an expression was expected of type 'b Self type cannot escape its class
You can ignore the first two lines of the error message. What matters is the last one: putting self into an external reference would make it impossible to extend it through inheritance. We will see in section 3.12 a workaround to this problem. Note however that, since immediate objects are not extensible, the problem does not occur with them.
let my_int = object (self) method n = 1 method register = ints := self :: !ints end;;val my_int : < n : int; register : unit > = <obj>
Let-bindings within class definitions are evaluated before the object is constructed. It is also possible to evaluate an expression immediately after the object has been built. Such code is written as an anonymous hidden method called an initializer. Therefore, it can access self and the instance variables.
class printable_point x_init = let origin = (x_init / 10) * 10 in object (self) val mutable x = origin method get_x = x method move d = x <- x + d method print = print_int self#get_x initializer print_string "new point at "; self#print; print_newline () end;;class printable_point : int -> object val mutable x : int method get_x : int method move : int -> unit method print : unit end
let p = new printable_point 17;;new point at 10 val p : printable_point = <obj>
Initializers cannot be overridden. On the contrary, all initializers are evaluated sequentially. Initializers are particularly useful to enforce invariants. Another example can be seen in section 5.1.
It is possible to declare a method without actually defining it, using the keyword virtual. This method will be provided later in subclasses. A class containing virtual methods must be flagged virtual, and cannot be instantiated (that is, no object of this class can be created). It still defines type abbreviations (treating virtual methods as other methods.)
class virtual abstract_point x_init = object (self) method virtual get_x : int method get_offset = self#get_x - x_init method virtual move : int -> unit end;;class virtual abstract_point : int -> object method get_offset : int method virtual get_x : int method virtual move : int -> unit end
class point x_init = object inherit abstract_point x_init val mutable x = x_init method get_x = x method move d = x <- x + d end;;class point : int -> object val mutable x : int method get_offset : int method get_x : int method move : int -> unit end
Instance variables can also be declared as virtual, with the same effect as with methods.
class virtual abstract_point2 = object val mutable virtual x : int method move d = x <- x + d end;;class virtual abstract_point2 : object val mutable virtual x : int method move : int -> unit end
class point2 x_init = object inherit abstract_point2 val mutable x = x_init method get_offset = x - x_init end;;class point2 : int -> object val mutable x : int method get_offset : int method move : int -> unit end
Private methods are methods that do not appear in object interfaces. They can only be invoked from other methods of the same object.
class restricted_point x_init = object (self) val mutable x = x_init method get_x = x method private move d = x <- x + d method bump = self#move 1 end;;class restricted_point : int -> object val mutable x : int method bump : unit method get_x : int method private move : int -> unit end
let p = new restricted_point 0;;val p : restricted_point = <obj>
p#move 10 ;;Error: This expression has type restricted_point It has no method move
p#bump;;- : unit = ()
Note that this is not the same thing as private and protected methods in Java or C++, which can be called from other objects of the same class. This is a direct consequence of the independence between types and classes in OCaml: two unrelated classes may produce objects of the same type, and there is no way at the type level to ensure that an object comes from a specific class. However a possible encoding of friend methods is given in section 3.17.
Private methods are inherited (they are by default visible in subclasses), unless they are hidden by signature matching, as described below.
Private methods can be made public in a subclass.
class point_again x = object (self) inherit restricted_point x method virtual move : _ end;;class point_again : int -> object val mutable x : int method bump : unit method get_x : int method move : int -> unit end
The annotation virtual here is only used to mention a method without providing its definition. Since we didn’t add the private annotation, this makes the method public, keeping the original definition.
An alternative definition is
class point_again x = object (self : < move : _; ..> ) inherit restricted_point x end;;class point_again : int -> object val mutable x : int method bump : unit method get_x : int method move : int -> unit end
The constraint on self’s type is requiring a public move method, and this is sufficient to override private.
One could think that a private method should remain private in a subclass. However, since the method is visible in a subclass, it is always possible to pick its code and define a method of the same name that runs that code, so yet another (heavier) solution would be:
class point_again x = object inherit restricted_point x as super method move = super#move end;;class point_again : int -> object val mutable x : int method bump : unit method get_x : int method move : int -> unit end
Of course, private methods can also be virtual. Then, the keywords must appear in this order method private virtual.
Class interfaces are inferred from class definitions. They may also be defined directly and used to restrict the type of a class. Like class declarations, they also define a new type abbreviation.
class type restricted_point_type = object method get_x : int method bump : unit end;;class type restricted_point_type = object method bump : unit method get_x : int end
fun (x : restricted_point_type) -> x;;- : restricted_point_type -> restricted_point_type = <fun>
In addition to program documentation, class interfaces can be used to constrain the type of a class. Both concrete instance variables and concrete private methods can be hidden by a class type constraint. Public methods and virtual members, however, cannot.
class restricted_point' x = (restricted_point x : restricted_point_type);;class restricted_point' : int -> restricted_point_type
Or, equivalently:
class restricted_point' = (restricted_point : int -> restricted_point_type);;class restricted_point' : int -> restricted_point_type
The interface of a class can also be specified in a module signature, and used to restrict the inferred signature of a module.
module type POINT = sig class restricted_point' : int -> object method get_x : int method bump : unit end end;;module type POINT = sig class restricted_point' : int -> object method bump : unit method get_x : int end end
module Point : POINT = struct class restricted_point' = restricted_point end;;module Point : POINT
We illustrate inheritance by defining a class of colored points that inherits from the class of points. This class has all instance variables and all methods of class point, plus a new instance variable c and a new method color.
class colored_point x (c : string) = object inherit point x val c = c method color = c end;;class colored_point : int -> string -> object val c : string val mutable x : int method color : string method get_offset : int method get_x : int method move : int -> unit end
let p' = new colored_point 5 "red";;val p' : colored_point = <obj>
p'#get_x, p'#color;;- : int * string = (5, "red")
A point and a colored point have incompatible types, since a point has no method color. However, the function get_x below is a generic function applying method get_x to any object p that has this method (and possibly some others, which are represented by an ellipsis in the type). Thus, it applies to both points and colored points.
let get_succ_x p = p#get_x + 1;;val get_succ_x : < get_x : int; .. > -> int = <fun>
get_succ_x p + get_succ_x p';;- : int = 8
Methods need not be declared previously, as shown by the example:
let set_x p = p#set_x;;val set_x : < set_x : 'a; .. > -> 'a = <fun>
let incr p = set_x p (get_succ_x p);;val incr : < get_x : int; set_x : int -> 'a; .. > -> 'a = <fun>
Multiple inheritance is allowed. Only the last definition of a method is kept: the redefinition in a subclass of a method that was visible in the parent class overrides the definition in the parent class. Previous definitions of a method can be reused by binding the related ancestor. Below, super is bound to the ancestor printable_point. The name super is a pseudo value identifier that can only be used to invoke a super-class method, as in super#print.
class printable_colored_point y c = object (self) val c = c method color = c inherit printable_point y as super method print = print_string "("; super#print; print_string ", "; print_string (self#color); print_string ")" end;;class printable_colored_point : int -> string -> object val c : string val mutable x : int method color : string method get_x : int method move : int -> unit method print : unit end
let p' = new printable_colored_point 17 "red";;new point at (10, red) val p' : printable_colored_point = <obj>
p'#print;;(10, red)- : unit = ()
A private method that has been hidden in the parent class is no longer visible, and is thus not overridden. Since initializers are treated as private methods, all initializers along the class hierarchy are evaluated, in the order they are introduced.
Reference cells can be implemented as objects. The naive definition fails to typecheck:
class oref x_init = object val mutable x = x_init method get = x method set y = x <- y end;;Error: Some type variables are unbound in this type: class oref : 'a -> object val mutable x : 'a method get : 'a method set : 'a -> unit end The method get has type 'a where 'a is unbound
The reason is that at least one of the methods has a polymorphic type (here, the type of the value stored in the reference cell), thus either the class should be parametric, or the method type should be constrained to a monomorphic type. A monomorphic instance of the class could be defined by:
class oref (x_init:int) = object val mutable x = x_init method get = x method set y = x <- y end;;class oref : int -> object val mutable x : int method get : int method set : int -> unit end
Note that since immediate objects do not define a class type, they have no such restriction.
let new_oref x_init = object val mutable x = x_init method get = x method set y = x <- y end;;val new_oref : 'a -> < get : 'a; set : 'a -> unit > = <fun>
On the other hand, a class for polymorphic references must explicitly list the type parameters in its declaration. Class type parameters are listed between [ and ]. The type parameters must also be bound somewhere in the class body by a type constraint.
class ['a] oref x_init = object val mutable x = (x_init : 'a) method get = x method set y = x <- y end;;class ['a] oref : 'a -> object val mutable x : 'a method get : 'a method set : 'a -> unit end
let r = new oref 1 in r#set 2; (r#get);;- : int = 2
The type parameter in the declaration may actually be constrained in the body of the class definition. In the class type, the actual value of the type parameter is displayed in the constraint clause.
class ['a] oref_succ (x_init:'a) = object val mutable x = x_init + 1 method get = x method set y = x <- y end;;class ['a] oref_succ : 'a -> object constraint 'a = int val mutable x : int method get : int method set : int -> unit end
Let us consider a more complex example: define a circle, whose center may be any kind of point. We put an additional type constraint in method move, since no free variables must remain unaccounted for by the class type parameters.
class ['a] circle (c : 'a) = object val mutable center = c method center = center method set_center c = center <- c method move = (center#move : int -> unit) end;;class ['a] circle : 'a -> object constraint 'a = < move : int -> unit; .. > val mutable center : 'a method center : 'a method move : int -> unit method set_center : 'a -> unit end
An alternate definition of circle, using a constraint clause in the class definition, is shown below. The type #point used below in the constraint clause is an abbreviation produced by the definition of class point. This abbreviation unifies with the type of any object belonging to a subclass of class point. It actually expands to < get_x : int; move : int -> unit; .. >. This leads to the following alternate definition of circle, which has slightly stronger constraints on its argument, as we now expect center to have a method get_x.
class ['a] circle (c : 'a) = object constraint 'a = #point val mutable center = c method center = center method set_center c = center <- c method move = center#move end;;class ['a] circle : 'a -> object constraint 'a = #point val mutable center : 'a method center : 'a method move : int -> unit method set_center : 'a -> unit end
The class colored_circle is a specialized version of class circle that requires the type of the center to unify with #colored_point, and adds a method color. Note that when specializing a parameterized class, the instance of type parameter must always be explicitly given. It is again written between [ and ].
class ['a] colored_circle c = object constraint 'a = #colored_point inherit ['a] circle c method color = center#color end;;class ['a] colored_circle : 'a -> object constraint 'a = #colored_point val mutable center : 'a method center : 'a method color : string method move : int -> unit method set_center : 'a -> unit end
While parameterized classes may be polymorphic in their contents, they are not enough to allow polymorphism of method use.
A classical example is defining an iterator.
List.fold_left;;- : ('a -> 'b -> 'a) -> 'a -> 'b list -> 'a = <fun>
class ['a] intlist (l : int list) = object method empty = (l = []) method fold f (accu : 'a) = List.fold_left f accu l end;;class ['a] intlist : int list -> object method empty : bool method fold : ('a -> int -> 'a) -> 'a -> 'a end
At first look, we seem to have a polymorphic iterator, however this does not work in practice.
let l = new intlist [1; 2; 3];;val l : '_a intlist = <obj>
l#fold (fun x y -> x+y) 0;;- : int = 6
l;;- : int intlist = <obj>
l#fold (fun s x -> s ^ string_of_int x ^ " ") "" ;;Error: This expression has type int but an expression was expected of type string
Our iterator works, as shows its first use for summation. However, since objects themselves are not polymorphic (only their constructors are), using the fold method fixes its type for this individual object. Our next attempt to use it as a string iterator fails.
The problem here is that quantification was wrongly located: it is not the class we want to be polymorphic, but the fold method. This can be achieved by giving an explicitly polymorphic type in the method definition.
class intlist (l : int list) = object method empty = (l = []) method fold : 'a. ('a -> int -> 'a) -> 'a -> 'a = fun f accu -> List.fold_left f accu l end;;class intlist : int list -> object method empty : bool method fold : ('a -> int -> 'a) -> 'a -> 'a end
let l = new intlist [1; 2; 3];;val l : intlist = <obj>
l#fold (fun x y -> x+y) 0;;- : int = 6
l#fold (fun s x -> s ^ string_of_int x ^ " ") "";;- : string = "1 2 3 "
As you can see in the class type shown by the compiler, while polymorphic method types must be fully explicit in class definitions (appearing immediately after the method name), quantified type variables can be left implicit in class descriptions. Why require types to be explicit? The problem is that (int -> int -> int) -> int -> int would also be a valid type for fold, and it happens to be incompatible with the polymorphic type we gave (automatic instantiation only works for toplevel types variables, not for inner quantifiers, where it becomes an undecidable problem.) So the compiler cannot choose between those two types, and must be helped.
However, the type can be completely omitted in the class definition if it is already known, through inheritance or type constraints on self. Here is an example of method overriding.
class intlist_rev l = object inherit intlist l method fold f accu = List.fold_left f accu (List.rev l) end;;
The following idiom separates description and definition.
class type ['a] iterator = object method fold : ('b -> 'a -> 'b) -> 'b -> 'b end;;
class intlist l = object (self : int #iterator) method empty = (l = []) method fold f accu = List.fold_left f accu l end;;
Note here the (self : int #iterator) idiom, which ensures that this object implements the interface iterator.
Polymorphic methods are called in exactly the same way as normal methods, but you should be aware of some limitations of type inference. Namely, a polymorphic method can only be called if its type is known at the call site. Otherwise, the method will be assumed to be monomorphic, and given an incompatible type.
let sum lst = lst#fold (fun x y -> x+y) 0;;val sum : < fold : (int -> int -> int) -> int -> 'a; .. > -> 'a = <fun>
sum l ;;Error: This expression has type intlist but an expression was expected of type < fold : (int -> int -> int) -> int -> 'a; .. > Types for method fold are incompatible
The workaround is easy: you should put a type constraint on the parameter.
let sum (lst : _ #iterator) = lst#fold (fun x y -> x+y) 0;;val sum : int #iterator -> int = <fun>
Of course the constraint may also be an explicit method type. Only occurences of quantified variables are required.
let sum lst = (lst : < fold : 'a. ('a -> _ -> 'a) -> 'a -> 'a; .. >)#fold (+) 0;;val sum : < fold : 'a. ('a -> int -> 'a) -> 'a -> 'a; .. > -> int = <fun>
Another use of polymorphic methods is to allow some form of implicit subtyping in method arguments. We have already seen in section 3.8 how some functions may be polymorphic in the class of their argument. This can be extended to methods.
class type point0 = object method get_x : int end;;class type point0 = object method get_x : int end
class distance_point x = object inherit point x method distance : 'a. (#point0 as 'a) -> int = fun other -> abs (other#get_x - x) end;;class distance_point : int -> object val mutable x : int method distance : #point0 -> int method get_offset : int method get_x : int method move : int -> unit end
let p = new distance_point 3 in (p#distance (new point 8), p#distance (new colored_point 1 "blue"));;- : int * int = (5, 2)
Note here the special syntax (#point0 as 'a) we have to use to quantify the extensible part of #point0. As for the variable binder, it can be omitted in class specifications. If you want polymorphism inside object field it must be quantified independently.
class multi_poly = object method m1 : 'a. (< n1 : 'b. 'b -> 'b; .. > as 'a) -> _ = fun o -> o#n1 true, o#n1 "hello" method m2 : 'a 'b. (< n2 : 'b -> bool; .. > as 'a) -> 'b -> _ = fun o x -> o#n2 x end;;class multi_poly : object method m1 : < n1 : 'b. 'b -> 'b; .. > -> bool * string method m2 : < n2 : 'b -> bool; .. > -> 'b -> bool end
In method m1, o must be an object with at least a method n1, itself polymorphic. In method m2, the argument of n2 and x must have the same type, which is quantified at the same level as 'a.
Subtyping is never implicit. There are, however, two ways to perform subtyping. The most general construction is fully explicit: both the domain and the codomain of the type coercion must be given.
We have seen that points and colored points have incompatible types. For instance, they cannot be mixed in the same list. However, a colored point can be coerced to a point, hiding its color method:
let colored_point_to_point cp = (cp : colored_point :> point);;val colored_point_to_point : colored_point -> point = <fun>
let p = new point 3 and q = new colored_point 4 "blue";;val p : point = <obj> val q : colored_point = <obj>
let l = [p; (colored_point_to_point q)];;val l : point list = [<obj>; <obj>]
An object of type t can be seen as an object of type t' only if t is a subtype of t'. For instance, a point cannot be seen as a colored point.
(p : point :> colored_point);;Error: Type point = < get_offset : int; get_x : int; move : int -> unit > is not a subtype of colored_point = < color : string; get_offset : int; get_x : int; move : int -> unit >
Indeed, narrowing coercions without runtime checks would be unsafe. Runtime type checks might raise exceptions, and they would require the presence of type information at runtime, which is not the case in the OCaml system. For these reasons, there is no such operation available in the language.
Be aware that subtyping and inheritance are not related. Inheritance is a syntactic relation between classes while subtyping is a semantic relation between types. For instance, the class of colored points could have been defined directly, without inheriting from the class of points; the type of colored points would remain unchanged and thus still be a subtype of points.
The domain of a coercion can often be omitted. For instance, one can define:
let to_point cp = (cp :> point);;val to_point : #point -> point = <fun>
In this case, the function colored_point_to_point is an instance of the function to_point. This is not always true, however. The fully explicit coercion is more precise and is sometimes unavoidable. Consider, for example, the following class:
class c0 = object method m = {< >} method n = 0 end;;class c0 : object ('a) method m : 'a method n : int end
The object type c0 is an abbreviation for <m : 'a; n : int> as 'a. Consider now the type declaration:
class type c1 = object method m : c1 end;;class type c1 = object method m : c1 end
The object type c1 is an abbreviation for the type <m : 'a> as 'a. The coercion from an object of type c0 to an object of type c1 is correct:
fun (x:c0) -> (x : c0 :> c1);;- : c0 -> c1 = <fun>
However, the domain of the coercion cannot always be omitted. In that case, the solution is to use the explicit form. Sometimes, a change in the class-type definition can also solve the problem
class type c2 = object ('a) method m : 'a end;;class type c2 = object ('a) method m : 'a end
fun (x:c0) -> (x :> c2);;- : c0 -> c2 = <fun>
While class types c1 and c2 are different, both object types c1 and c2 expand to the same object type (same method names and types). Yet, when the domain of a coercion is left implicit and its co-domain is an abbreviation of a known class type, then the class type, rather than the object type, is used to derive the coercion function. This allows leaving the domain implicit in most cases when coercing form a subclass to its superclass. The type of a coercion can always be seen as below:
let to_c1 x = (x :> c1);;val to_c1 : < m : #c1; .. > -> c1 = <fun>
let to_c2 x = (x :> c2);;val to_c2 : #c2 -> c2 = <fun>
Note the difference between these two coercions: in the case of to_c2, the type #c2 = < m : 'a; .. > as 'a is polymorphically recursive (according to the explicit recursion in the class type of c2); hence the success of applying this coercion to an object of class c0. On the other hand, in the first case, c1 was only expanded and unrolled twice to obtain < m : < m : c1; .. >; .. > (remember #c1 = < m : c1; .. >), without introducing recursion. You may also note that the type of to_c2 is #c2 -> c2 while the type of to_c1 is more general than #c1 -> c1. This is not always true, since there are class types for which some instances of #c are not subtypes of c, as explained in section 3.16. Yet, for parameterless classes the coercion (_ :> c) is always more general than (_ : #c :> c).
A common problem may occur when one tries to define a coercion to a class c while defining class c. The problem is due to the type abbreviation not being completely defined yet, and so its subtypes are not clearly known. Then, a coercion (_ :> c) or (_ : #c :> c) is taken to be the identity function, as in
function x -> (x :> 'a);;- : 'a -> 'a = <fun>
As a consequence, if the coercion is applied to self, as in the following example, the type of self is unified with the closed type c (a closed object type is an object type without ellipsis). This would constrain the type of self be closed and is thus rejected. Indeed, the type of self cannot be closed: this would prevent any further extension of the class. Therefore, a type error is generated when the unification of this type with another type would result in a closed object type.
class c = object method m = 1 end and d = object (self) inherit c method n = 2 method as_c = (self :> c) end;;Error: This expression cannot be coerced to type c = < m : int >; it has type < as_c : c; m : int; n : int; .. > but is here used with type c Self type cannot escape its class
However, the most common instance of this problem, coercing self to its current class, is detected as a special case by the type checker, and properly typed.
class c = object (self) method m = (self :> c) end;;class c : object method m : c end
This allows the following idiom, keeping a list of all objects belonging to a class or its subclasses:
let all_c = ref [];;val all_c : '_a list ref = {contents = []}
class c (m : int) = object (self) method m = m initializer all_c := (self :> c) :: !all_c end;;class c : int -> object method m : int end
This idiom can in turn be used to retrieve an object whose type has been weakened:
let rec lookup_obj obj = function [] -> raise Not_found | obj' :: l -> if (obj :> < >) = (obj' :> < >) then obj' else lookup_obj obj l ;;val lookup_obj : < .. > -> (< .. > as 'a) list -> 'a = <fun>
let lookup_c obj = lookup_obj obj !all_c;;val lookup_c : < .. > -> < m : int > = <fun>
The type < m : int > we see here is just the expansion of c, due to the use of a reference; we have succeeded in getting back an object of type c.
The previous coercion problem can often be avoided by first
defining the abbreviation, using a class type:
class type c' = object method m : int end;;class type c' = object method m : int end
class c : c' = object method m = 1 end and d = object (self) inherit c method n = 2 method as_c = (self :> c') end;;class c : c' and d : object method as_c : c' method m : int method n : int end
It is also possible to use a virtual class. Inheriting from this class simultaneously forces all methods of c to have the same type as the methods of c'.
class virtual c' = object method virtual m : int end;;class virtual c' : object method virtual m : int end
class c = object (self) inherit c' method m = 1 end;;class c : object method m : int end
One could think of defining the type abbreviation directly:
type c' = <m : int>;;
However, the abbreviation #c' cannot be defined directly in a similar way. It can only be defined by a class or a class-type definition. This is because a #-abbreviation carries an implicit anonymous variable .. that cannot be explicitly named. The closer you get to it is:
type 'a c'_class = 'a constraint 'a = < m : int; .. >;;
with an extra type variable capturing the open object type.
It is possible to write a version of class point without assignments on the instance variables. The override construct {< ... >} returns a copy of “self” (that is, the current object), possibly changing the value of some instance variables.
class functional_point y = object val x = y method get_x = x method move d = {< x = x + d >} end;;class functional_point : int -> object ('a) val x : int method get_x : int method move : int -> 'a end
let p = new functional_point 7;;val p : functional_point = <obj>
p#get_x;;- : int = 7
(p#move 3)#get_x;;- : int = 10
p#get_x;;- : int = 7
Note that the type abbreviation functional_point is recursive, which can be seen in the class type of functional_point: the type of self is 'a and 'a appears inside the type of the method move.
The above definition of functional_point is not equivalent to the following:
class bad_functional_point y = object val x = y method get_x = x method move d = new bad_functional_point (x+d) end;;class bad_functional_point : int -> object val x : int method get_x : int method move : int -> bad_functional_point end
While objects of either class will behave the same, objects of their subclasses will be different. In a subclass of bad_functional_point, the method move will keep returning an object of the parent class. On the contrary, in a subclass of functional_point, the method move will return an object of the subclass.
Functional update is often used in conjunction with binary methods as illustrated in section 5.2.1.
Objects can also be cloned, whether they are functional or imperative. The library function Oo.copy makes a shallow copy of an object. That is, it returns a new object that has the same methods and instance variables as its argument. The instance variables are copied but their contents are shared. Assigning a new value to an instance variable of the copy (using a method call) will not affect instance variables of the original, and conversely. A deeper assignment (for example if the instance variable is a reference cell) will of course affect both the original and the copy.
The type of Oo.copy is the following:
Oo.copy;;- : (< .. > as 'a) -> 'a = <fun>
The keyword as in that type binds the type variable 'a to the object type < .. >. Therefore, Oo.copy takes an object with any methods (represented by the ellipsis), and returns an object of the same type. The type of Oo.copy is different from type < .. > -> < .. > as each ellipsis represents a different set of methods. Ellipsis actually behaves as a type variable.
let p = new point 5;;val p : point = <obj>
let q = Oo.copy p;;val q : point = <obj>
q#move 7; (p#get_x, q#get_x);;- : int * int = (5, 12)
In fact, Oo.copy p will behave as p#copy assuming that a public method copy with body {< >} has been defined in the class of p.
Objects can be compared using the generic comparison functions = and <>. Two objects are equal if and only if they are physically equal. In particular, an object and its copy are not equal.
let q = Oo.copy p;;val q : point = <obj>
p = q, p = p;;- : bool * bool = (false, true)
Other generic comparisons such as (<, <=, ...) can also be used on objects. The relation < defines an unspecified but strict ordering on objects. The ordering relationship between two objects is fixed once for all after the two objects have been created and it is not affected by mutation of fields.
Cloning and override have a non empty intersection. They are interchangeable when used within an object and without overriding any field:
class copy = object method copy = {< >} end;;class copy : object ('a) method copy : 'a end
class copy = object (self) method copy = Oo.copy self end;;class copy : object ('a) method copy : 'a end
Only the override can be used to actually override fields, and only the Oo.copy primitive can be used externally.
Cloning can also be used to provide facilities for saving and restoring the state of objects.
class backup = object (self : 'mytype) val mutable copy = None method save = copy <- Some {< copy = None >} method restore = match copy with Some x -> x | None -> self end;;class backup : object ('a) val mutable copy : 'a option method restore : 'a method save : unit end
The above definition will only backup one level. The backup facility can be added to any class by using multiple inheritance.
class ['a] backup_ref x = object inherit ['a] oref x inherit backup end;;class ['a] backup_ref : 'a -> object ('b) val mutable copy : 'b option val mutable x : 'a method get : 'a method restore : 'b method save : unit method set : 'a -> unit end
let rec get p n = if n = 0 then p # get else get (p # restore) (n-1);;val get : (< get : 'b; restore : 'a; .. > as 'a) -> int -> 'b = <fun>
let p = new backup_ref 0 in p # save; p # set 1; p # save; p # set 2; [get p 0; get p 1; get p 2; get p 3; get p 4];;- : int list = [2; 1; 1; 1; 1]
We can define a variant of backup that retains all copies. (We also add a method clear to manually erase all copies.)
class backup = object (self : 'mytype) val mutable copy = None method save = copy <- Some {< >} method restore = match copy with Some x -> x | None -> self method clear = copy <- None end;;class backup : object ('a) val mutable copy : 'a option method clear : unit method restore : 'a method save : unit end
class ['a] backup_ref x = object inherit ['a] oref x inherit backup end;;class ['a] backup_ref : 'a -> object ('b) val mutable copy : 'b option val mutable x : 'a method clear : unit method get : 'a method restore : 'b method save : unit method set : 'a -> unit end
let p = new backup_ref 0 in p # save; p # set 1; p # save; p # set 2; [get p 0; get p 1; get p 2; get p 3; get p 4];;- : int list = [2; 1; 0; 0; 0]
Recursive classes can be used to define objects whose types are mutually recursive.
class window = object val mutable top_widget = (None : widget option) method top_widget = top_widget end and widget (w : window) = object val window = w method window = window end;;class window : object val mutable top_widget : widget option method top_widget : widget option end and widget : window -> object val window : window method window : window end
Although their types are mutually recursive, the classes widget and window are themselves independent.
A binary method is a method which takes an argument of the same type as self. The class comparable below is a template for classes with a binary method leq of type 'a -> bool where the type variable 'a is bound to the type of self. Therefore, #comparable expands to < leq : 'a -> bool; .. > as 'a. We see here that the binder as also allows writing recursive types.
class virtual comparable = object (_ : 'a) method virtual leq : 'a -> bool end;;class virtual comparable : object ('a) method virtual leq : 'a -> bool end
We then define a subclass money of comparable. The class money simply wraps floats as comparable objects. We will extend it below with more operations. We have to use a type constraint on the class parameter x because the primitive <= is a polymorphic function in OCaml. The inherit clause ensures that the type of objects of this class is an instance of #comparable.
class money (x : float) = object inherit comparable val repr = x method value = repr method leq p = repr <= p#value end;;class money : float -> object ('a) val repr : float method leq : 'a -> bool method value : float end
Note that the type money is not a subtype of type comparable, as the self type appears in contravariant position in the type of method leq. Indeed, an object m of class money has a method leq that expects an argument of type money since it accesses its value method. Considering m of type comparable would allow a call to method leq on m with an argument that does not have a method value, which would be an error.
Similarly, the type money2 below is not a subtype of type money.
class money2 x = object inherit money x method times k = {< repr = k *. repr >} end;;class money2 : float -> object ('a) val repr : float method leq : 'a -> bool method times : float -> 'a method value : float end
It is however possible to define functions that manipulate objects of type either money or money2: the function min will return the minimum of any two objects whose type unifies with #comparable. The type of min is not the same as #comparable -> #comparable -> #comparable, as the abbreviation #comparable hides a type variable (an ellipsis). Each occurrence of this abbreviation generates a new variable.
let min (x : #comparable) y = if x#leq y then x else y;;val min : (#comparable as 'a) -> 'a -> 'a = <fun>
This function can be applied to objects of type money or money2.
(min (new money 1.3) (new money 3.1))#value;;- : float = 1.3
(min (new money2 5.0) (new money2 3.14))#value;;- : float = 3.14
More examples of binary methods can be found in sections 5.2.1 and 5.2.3.
Note the use of override for method times. Writing new money2 (k *. repr) instead of {< repr = k *. repr >} would not behave well with inheritance: in a subclass money3 of money2 the times method would return an object of class money2 but not of class money3 as would be expected.
The class money could naturally carry another binary method. Here is a direct definition:
class money x = object (self : 'a) val repr = x method value = repr method print = print_float repr method times k = {< repr = k *. x >} method leq (p : 'a) = repr <= p#value method plus (p : 'a) = {< repr = x +. p#value >} end;;class money : float -> object ('a) val repr : float method leq : 'a -> bool method plus : 'a -> 'a method print : unit method times : float -> 'a method value : float end
The above class money reveals a problem that often occurs with binary methods. In order to interact with other objects of the same class, the representation of money objects must be revealed, using a method such as value. If we remove all binary methods (here plus and leq), the representation can easily be hidden inside objects by removing the method value as well. However, this is not possible as soon as some binary method requires access to the representation of objects of the same class (other than self).
class safe_money x = object (self : 'a) val repr = x method print = print_float repr method times k = {< repr = k *. x >} end;;class safe_money : float -> object ('a) val repr : float method print : unit method times : float -> 'a end
Here, the representation of the object is known only to a particular object. To make it available to other objects of the same class, we are forced to make it available to the whole world. However we can easily restrict the visibility of the representation using the module system.
module type MONEY = sig type t class c : float -> object ('a) val repr : t method value : t method print : unit method times : float -> 'a method leq : 'a -> bool method plus : 'a -> 'a end end;;
module Euro : MONEY = struct type t = float class c x = object (self : 'a) val repr = x method value = repr method print = print_float repr method times k = {< repr = k *. x >} method leq (p : 'a) = repr <= p#value method plus (p : 'a) = {< repr = x +. p#value >} end end;;
Another example of friend functions may be found in section 5.2.3. These examples occur when a group of objects (here objects of the same class) and functions should see each others internal representation, while their representation should be hidden from the outside. The solution is always to define all friends in the same module, give access to the representation and use a signature constraint to make the representation abstract outside the module.
ocaml-doc-4.05/ocaml.html/libbigarray.html 0000644 0001750 0001750 00000024753 13131636457 017475 0 ustar mehdi mehdi
The bigarray library implements large, multi-dimensional, numerical arrays. These arrays are called “big arrays” to distinguish them from the standard OCaml arrays described in Module Array. The main differences between “big arrays” and standard OCaml arrays are as follows:
Programs that use the bigarray library must be linked as follows:
ocamlc other options bigarray.cma other files
ocamlopt other options bigarray.cmxa other files
For interactive use of the bigarray library, do:
ocamlmktop -o mytop bigarray.cma
./mytop
or (if dynamic linking of C libraries is supported on your platform), start ocaml and type #load "bigarray.cma";;.
C stub code that interface C or Fortran code with OCaml code, as described in chapter 19, can exploit big arrays as follows.
The include file <caml/bigarray.h> must be included in the C stub file. It declares the functions, constants and macros discussed below.
If v is a OCaml value representing a big array, the expression Caml_ba_data_val(v) returns a pointer to the data part of the array. This pointer is of type void * and can be cast to the appropriate C type for the array (e.g. double [], char [][10], etc).
Various characteristics of the OCaml big array can be consulted from C as follows:
| C expression | Returns |
| Caml_ba_array_val(v)->num_dims | number of dimensions |
| Caml_ba_array_val(v)->dim[i] | i-th dimension |
| Caml_ba_array_val(v)->flags & BIGARRAY_KIND_MASK | kind of array elements |
The kind of array elements is one of the following constants:
| Constant | Element kind |
| CAML_BA_FLOAT32 | 32-bit single-precision floats |
| CAML_BA_FLOAT64 | 64-bit double-precision floats |
| CAML_BA_SINT8 | 8-bit signed integers |
| CAML_BA_UINT8 | 8-bit unsigned integers |
| CAML_BA_SINT16 | 16-bit signed integers |
| CAML_BA_UINT16 | 16-bit unsigned integers |
| CAML_BA_INT32 | 32-bit signed integers |
| CAML_BA_INT64 | 64-bit signed integers |
| CAML_BA_CAML_INT | 31- or 63-bit signed integers |
| CAML_BA_NATIVE_INT | 32- or 64-bit (platform-native) integers |
The following example shows the passing of a two-dimensional big array to a C function and a Fortran function.
extern void my_c_function(double * data, int dimx, int dimy);
extern void my_fortran_function_(double * data, int * dimx, int * dimy);
value caml_stub(value bigarray)
{
int dimx = Caml_ba_array_val(bigarray)->dim[0];
int dimy = Caml_ba_array_val(bigarray)->dim[1];
/* C passes scalar parameters by value */
my_c_function(Caml_ba_data_val(bigarray), dimx, dimy);
/* Fortran passes all parameters by reference */
my_fortran_function_(Caml_ba_data_val(bigarray), &dimx, &dimy);
return Val_unit;
}
A pointer p to an already-allocated C or Fortran array can be wrapped and returned to OCaml as a big array using the caml_ba_alloc or caml_ba_alloc_dims functions.
Return an OCaml big array wrapping the data pointed to by p. kind is the kind of array elements (one of the CAML_BA_ kind constants above). layout is CAML_BA_C_LAYOUT for an array with C layout and CAML_BA_FORTRAN_LAYOUT for an array with Fortran layout. numdims is the number of dimensions in the array. dims is an array of numdims long integers, giving the sizes of the array in each dimension.
Same as caml_ba_alloc, but the sizes of the array in each dimension are listed as extra arguments in the function call, rather than being passed as an array.
The following example illustrates how statically-allocated C and Fortran arrays can be made available to OCaml.
extern long my_c_array[100][200];
extern float my_fortran_array_[300][400];
value caml_get_c_array(value unit)
{
long dims[2];
dims[0] = 100; dims[1] = 200;
return caml_ba_alloc(CAML_BA_NATIVE_INT | CAML_BA_C_LAYOUT,
2, my_c_array, dims);
}
value caml_get_fortran_array(value unit)
{
return caml_ba_alloc_dims(CAML_BA_FLOAT32 | CAML_BA_FORTRAN_LAYOUT,
2, my_fortran_array_, 300L, 400L);
}
ocaml-doc-4.05/ocaml.html/next_motif.gif 0000644 0001750 0001750 00000000475 13131636457 017156 0 ustar mehdi mehdi GIF89a p p!# Imported from XPM image: next.xpm ! , @63333 B! 0 A0 0 0 0 `0 `0 A @ `0 `00000000000000000000000000000000000000000 000 000000 000000000 0000000000000000000`
; ocaml-doc-4.05/ocaml.html/classes.html 0000644 0001750 0001750 00000136771 13131636457 016647 0 ustar mehdi mehdi
Classes are defined using a small language, similar to the module language.
Class types are the class-level equivalent of type expressions: they specify the general shape and type properties of classes.
|
See also the following language extensions: attributes and extension nodes.
The expression classtype-path is equivalent to the class type bound to the name classtype-path. Similarly, the expression [ typexpr1 , … typexprn ] classtype-path is equivalent to the parametric class type bound to the name classtype-path, in which type parameters have been instantiated to respectively typexpr1, …typexprn.
The class type expression typexpr -> class-type is the type of class functions (functions from values to classes) that take as argument a value of type typexpr and return as result a class of type class-type.
The class type expression object [( typexpr )] {class-field-spec} end is the type of a class body. It specifies its instance variables and methods. In this type, typexpr is matched against the self type, therefore providing a name for the self type.
A class body will match a class body type if it provides definitions for all the components specified in the class body type, and these definitions meet the type requirements given in the class body type. Furthermore, all methods either virtual or public present in the class body must also be present in the class body type (on the other hand, some instance variables and concrete private methods may be omitted). A virtual method will match a concrete method, which makes it possible to forget its implementation. An immutable instance variable will match a mutable instance variable.
The inheritance construct inherit class-body-type provides for inclusion of methods and instance variables from other class types. The instance variable and method types from class-body-type are added into the current class type.
A specification of an instance variable is written val [mutable] [virtual] inst-var-name : typexpr, where inst-var-name is the name of the instance variable and typexpr its expected type. The flag mutable indicates whether this instance variable can be physically modified. The flag virtual indicates that this instance variable is not initialized. It can be initialized later through inheritance.
An instance variable specification will hide any previous specification of an instance variable of the same name.
The specification of a method is written method [private] method-name : poly-typexpr, where method-name is the name of the method and poly-typexpr its expected type, possibly polymorphic. The flag private indicates that the method cannot be accessed from outside the object.
The polymorphism may be left implicit in public method specifications: any type variable which is not bound to a class parameter and does not appear elsewhere inside the class specification will be assumed to be universal, and made polymorphic in the resulting method type. Writing an explicit polymorphic type will disable this behaviour.
If several specifications are present for the same method, they must have compatible types. Any non-private specification of a method forces it to be public.
A virtual method specification is written method [private] virtual method-name : poly-typexpr, where method-name is the name of the method and poly-typexpr its expected type.
The construct constraint typexpr1 = typexpr2 forces the two type expressions to be equal. This is typically used to specify type parameters: in this way, they can be bound to specific type expressions.
Class expressions are the class-level equivalent of value expressions: they evaluate to classes, thus providing implementations for the specifications expressed in class types.
|
|
See also the following language extensions: locally abstract types, explicit overriding in class definitions, attributes and extension nodes.
The expression class-path evaluates to the class bound to the name class-path. Similarly, the expression [ typexpr1 , … typexprn ] class-path evaluates to the parametric class bound to the name class-path, in which type parameters have been instantiated respectively to typexpr1, …typexprn.
The expression ( class-expr ) evaluates to the same module as class-expr.
The expression ( class-expr : class-type ) checks that class-type matches the type of class-expr (that is, that the implementation class-expr meets the type specification class-type). The whole expression evaluates to the same class as class-expr, except that all components not specified in class-type are hidden and can no longer be accessed.
Class application is denoted by juxtaposition of (possibly labeled) expressions. It denotes the class whose constructor is the first expression applied to the given arguments. The arguments are evaluated as for expression application, but the constructor itself will only be evaluated when objects are created. In particular, side-effects caused by the application of the constructor will only occur at object creation time.
The expression fun [[?]label-name:] pattern -> class-expr evaluates to a function from values to classes. When this function is applied to a value v, this value is matched against the pattern pattern and the result is the result of the evaluation of class-expr in the extended environment.
Conversion from functions with default values to functions with patterns only works identically for class functions as for normal functions.
The expression
is a short form for
The let and let rec constructs bind value names locally, as for the core language expressions.
If a local definition occurs at the very beginning of a class definition, it will be evaluated when the class is created (just as if the definition was outside of the class). Otherwise, it will be evaluated when the object constructor is called.
|
The expression object class-body end denotes a class body. This is the prototype for an object : it lists the instance variables and methods of an objet of this class.
A class body is a class value: it is not evaluated at once. Rather, its components are evaluated each time an object is created.
In a class body, the pattern ( pattern [: typexpr] ) is matched against self, therefore providing a binding for self and self type. Self can only be used in method and initializers.
Self type cannot be a closed object type, so that the class remains extensible.
Since OCaml 4.01, it is an error if the same method or instance variable name is defined several times in the same class body.
The inheritance construct inherit class-expr allows reusing methods and instance variables from other classes. The class expression class-expr must evaluate to a class body. The instance variables, methods and initializers from this class body are added into the current class. The addition of a method will override any previously defined method of the same name.
An ancestor can be bound by appending as lowercase-ident to the inheritance construct. lowercase-ident is not a true variable and can only be used to select a method, i.e. in an expression lowercase-ident # method-name. This gives access to the method method-name as it was defined in the parent class even if it is redefined in the current class. The scope of this ancestor binding is limited to the current class. The ancestor method may be called from a subclass but only indirectly.
The definition val [mutable] inst-var-name = expr adds an instance variable inst-var-name whose initial value is the value of expression expr. The flag mutable allows physical modification of this variable by methods.
An instance variable can only be used in the methods and initializers that follow its definition.
Since version 3.10, redefinitions of a visible instance variable with the same name do not create a new variable, but are merged, using the last value for initialization. They must have identical types and mutability. However, if an instance variable is hidden by omitting it from an interface, it will be kept distinct from other instance variables with the same name.
A variable specification is written val [mutable] virtual inst-var-name : typexpr. It specifies whether the variable is modifiable, and gives its type.
Virtual instance variables were added in version 3.10.
A method definition is written method method-name = expr. The definition of a method overrides any previous definition of this method. The method will be public (that is, not private) if any of the definition states so.
A private method, method private method-name = expr, is a method that can only be invoked on self (from other methods of the same object, defined in this class or one of its subclasses). This invocation is performed using the expression value-name # method-name, where value-name is directly bound to self at the beginning of the class definition. Private methods do not appear in object types. A method may have both public and private definitions, but as soon as there is a public one, all subsequent definitions will be made public.
Methods may have an explicitly polymorphic type, allowing them to be used polymorphically in programs (even for the same object). The explicit declaration may be done in one of three ways: (1) by giving an explicit polymorphic type in the method definition, immediately after the method name, i.e. method [private] method-name : {' ident}+ . typexpr = expr; (2) by a forward declaration of the explicit polymorphic type through a virtual method definition; (3) by importing such a declaration through inheritance and/or constraining the type of self.
Some special expressions are available in method bodies for manipulating instance variables and duplicating self:
|
The expression inst-var-name <- expr modifies in-place the current object by replacing the value associated to inst-var-name by the value of expr. Of course, this instance variable must have been declared mutable.
The expression {< inst-var-name1 = expr1 ; … ; inst-var-namen = exprn >} evaluates to a copy of the current object in which the values of instance variables inst-var-name1, …, inst-var-namen have been replaced by the values of the corresponding expressions expr1, …, exprn.
A method specification is written method [private] virtual method-name : poly-typexpr. It specifies whether the method is public or private, and gives its type. If the method is intended to be polymorphic, the type must be explicitly polymorphic.
The construct constraint typexpr1 = typexpr2 forces the two type expressions to be equals. This is typically used to specify type parameters: in that way they can be bound to specific type expressions.
A class initializer initializer expr specifies an expression that will be evaluated whenever an object is created from the class, once all its instance variables have been initialized.
|
A class definition class class-binding { and class-binding } is recursive. Each class-binding defines a class-name that can be used in the whole expression except for inheritance. It can also be used for inheritance, but only in the definitions that follow its own.
A class binding binds the class name class-name to the value of expression class-expr. It also binds the class type class-name to the type of the class, and defines two type abbreviations : class-name and # class-name. The first one is the type of objects of this class, while the second is more general as it unifies with the type of any object belonging to a subclass (see section 6.4).
A class must be flagged virtual if one of its methods is virtual (that is, appears in the class type, but is not actually defined). Objects cannot be created from a virtual class.
The class type parameters correspond to the ones of the class type and of the two type abbreviations defined by the class binding. They must be bound to actual types in the class definition using type constraints. So that the abbreviations are well-formed, type variables of the inferred type of the class must either be type parameters or be bound in the constraint clause.
|
This is the counterpart in signatures of class definitions. A class specification matches a class definition if they have the same type parameters and their types match.
|
A class type definition class class-name = class-body-type defines an abbreviation class-name for the class body type class-body-type. As for class definitions, two type abbreviations class-name and # class-name are also defined. The definition can be parameterized by some type parameters. If any method in the class type body is virtual, the definition must be flagged virtual.
Two class type definitions match if they have the same type parameters and they expand to matching types.
ocaml-doc-4.05/ocaml.html/flambda.html 0000644 0001750 0001750 00000220315 13131636457 016564 0 ustar mehdi mehdi
Flambda is the term used to describe a series of optimisation passes provided by the native code compilers as of OCaml 4.03.
Flambda aims to make it easier to write idiomatic OCaml code without incurring performance penalties.
To use the Flambda optimisers it is necessary to pass the -flambda option to the OCaml configure script. (There is no support for a single compiler that can operate in both Flambda and non-Flambda modes.) Code compiled with Flambda cannot be linked into the same program as code compiled without Flambda. Attempting to do this will result in a compiler error.
Whether or not a particular ocamlopt uses Flambda may be determined by invoking it with the -config option and looking for any line starting with “flambda:”. If such a line is present and says “true”, then Flambda is supported, otherwise it is not.
Flambda provides full optimisation across different compilation units, so long as the .cmx files for the dependencies of the unit currently being compiled are available. (A compilation unit corresponds to a single .ml source file.) However it does not yet act entirely as a whole-program compiler: for example, elimination of dead code across a complete set of compilation units is not supported.
Optimisation with Flambda is not currently supported when generating bytecode.
Flambda should not in general affect the semantics of existing programs. Two exceptions to this rule are: possible elimination of pure code that is being benchmarked (see section 20.14) and changes in behaviour of code using unsafe operations (see section 20.15).
Flambda does not yet optimise array or string bounds checks. Neither does it take hints for optimisation from any assertions written by the user in the code.
Consult the Glossary at the end of this chapter for definitions of technical terms used below.
The Flambda optimisers provide a variety of command-line flags that may be used to control their behaviour. Detailed descriptions of each flag are given in the referenced sections. Those sections also describe any arguments which the particular flags take.
Commonly-used options:
Less commonly-used options:
Advanced options, only needed for detailed tuning:
Flambda operates in rounds: one round consists of a certain sequence of transformations that may then be repeated in order to achieve more satisfactory results. The number of rounds can be set manually using the -rounds parameter (although this is not necessary when using predefined optimisation levels such as with -O2 and -O3). For high optimisation the number of rounds might be set at 3 or 4.
Command-line flags that may apply per round, for example those with -cost in the name, accept arguments of the form:
The flags -Oclassic, -O2 and -O3 are applied before all other flags, meaning that certain parameters may be overridden without having to specify every parameter usually invoked by the given optimisation level.
Inlining refers to the copying of the code of a function to a place where the function is called. The code of the function will be surrounded by bindings of its parameters to the corresponding arguments.
The aims of inlining are:
These goals are often reached not just by inlining itself but also by other optimisations that the compiler is able to perform as a result of inlining.
When a recursive call to a function (within the definition of that function or another in the same mutually-recursive group) is inlined, the procedure is also known as unrolling. This is somewhat akin to loop peeling. For example, given the following code:
let rec fact x =
if x = 0 then
1
else
x * fact (x - 1)
let n = fact 4
unrolling once at the call site fact 4 produces (with the body of fact unchanged):
let n =
if 4 = 0 then
1
else
4 * fact (4 - 1)
This simplifies to:
let n = 4 * fact 3
Flambda provides significantly enhanced inlining capabilities relative to previous versions of the compiler.
Inlining is performed together with all of the other Flambda optimisation passes, that is to say, after closure conversion. This has three particular advantages over a potentially more straightforward implementation prior to closure conversion:
In -Oclassic mode the behaviour of the Flambda inliner mimics previous versions of the compiler. (Code may still be subject to further optimisations not performed by previous versions of the compiler: functors may be inlined, constants are lifted and unused code is eliminated all as described elsewhere in this chapter. See sections 20.3.3, 20.8.1 and 20.10. At the definition site of a function, the body of the function is measured. It will then be marked as eligible for inlining (and hence inlined at every direct call site) if:
Non-Flambda versions of the compiler cannot inline functions that contain a definition of another function. However -Oclassic does permit this. Further, non-Flambda versions also cannot inline functions that are only themselves exposed as a result of a previous pass of inlining, but again this is permitted by -Oclassic. For example:
module M : sig
val i : int
end = struct
let f x =
let g y = x + y in
g
let h = f 3
let i = h 4 (* h is correctly discovered to be g and inlined *)
end
All of this contrasts with the normal Flambda mode, that is to say without -Oclassic, where:
The Flambda mode is described in the next section.
The Flambda inlining heuristics, used whenever the compiler is configured for Flambda and -Oclassic was not specified, make inlining decisions at call sites. This helps in situations where the context is important. For example:
let f b x =
if b then
x
else
... big expression ...
let g x = f true x
In this case, we would like to inline f into g, because a conditional jump can be eliminated and the code size should reduce. If the inlining decision has been made after the declaration of f without seeing the use, its size would have probably made it ineligible for inlining; but at the call site, its final size can be known. Further, this function should probably not be inlined systematically: if b is unknown, or indeed false, there is little benefit to trade off against a large increase in code size. In the existing non-Flambda inliner this isn’t a great problem because chains of inlining were cut off fairly quickly. However it has led to excessive use of overly-large inlining parameters such as -inline 10000.
In more detail, at each call site the following procedure is followed:
Inlining within recursive functions of calls to other functions in the same mutually-recursive group is kept in check by an unrolling depth, described below. This ensures that functions are not unrolled to excess. (Unrolling is only enabled if -O3 optimisation level is selected and/or the -inline-max-unroll flag is passed with an argument greater than zero.)
There is nothing particular about functors that inhibits inlining compared to normal functions. To the inliner, these both look the same, except that functors are marked as such.
Applications of functors at toplevel are biased in favour of inlining. (This bias may be adjusted: see the documentation for -inline-lifting-benefit below.)
Applications of functors not at toplevel, for example in a local module inside some other expression, are treated by the inliner identically to normal function calls.
The inliner will be able to consider inlining a call to a function in a first class module if it knows which particular function is going to be called. The presence of the first-class module record that wraps the set of functions in the module does not per se inhibit inlining.
Method calls to objects are not at present inlined by Flambda.
If the -inlining-report option is provided to the compiler then a file will be emitted corresponding to each round of optimisation. For the OCaml source file basename.ml the files are named basename.round.inlining.org, with round a zero-based integer. Inside the files, which are formatted as “org mode”, will be found English prose describing the decisions that the inliner took.
Inlining typically results in an increase in code size, which if left unchecked, may not only lead to grossly large executables and excessive compilation times but also a decrease in performance due to worse locality. As such, the Flambda inliner trades off the change in code size against the expected runtime performance benefit, with the benefit being computed based on the number of operations that the compiler observes may be removed as a result of inlining.
For example given the following code:
let f b x =
if b then
x
else
... big expression ...
let g x = f true x
it would be observed that inlining of f would remove:
Formally, an estimate of runtime performance benefit is computed by first summing the cost of the operations that are known to be removed as a result of the inlining and subsequent simplification of the inlined body. The individual costs for the various kinds of operations may be adjusted using the various -inline-...-cost flags as follows. Costs are specified as integers. All of these flags accept a single argument describing such integers using the conventions detailed in section 20.2.1.
(Default values are described in section 20.5 below.)
The initial benefit value is then scaled by a factor that attempts to compensate for the fact that the current point in the code, if under some number of conditional branches, may be cold. (Flambda does not currently compute hot and cold paths.) The factor—the estimated probability that the inliner really is on a hot path—is calculated as (1/1 + f)d, where f is set by -inline-branch-factor and d is the nesting depth of branches at the current point. As the inliner descends into more deeply-nested branches, the benefit of inlining thus lessens.
The resulting benefit value is known as the estimated benefit.
The change in code size is also estimated: morally speaking it should be the change in machine code size, but since that is not available to the inliner, an approximation is used.
If the estimated benefit exceeds the increase in code size then the inlined version of the function will be kept. Otherwise the function will not be inlined.
Applications of functors at toplevel will be given an additional benefit (which may be controlled by the -inline-lifting-benefit flag) to bias inlining in such situations towards keeping the inlined version.
As described above, there are three parameters that restrict the search for inlining opportunities during speculation:
These parameters are ultimately bounded by the arguments provided to the corresponding command-line flags (or their default values):
Note in particular that -inline does not have the meaning that it has in the previous compiler or in -Oclassic mode. In both of those situations -inline was effectively some kind of basic assessment of inlining benefit. However in Flambda inlining mode it corresponds to a constraint on the search; the assessment of benefit is independent, as described above.
When speculation starts the inlining threshold starts at the value set by -inline (or -inline-toplevel if appropriate, see above). Upon making a speculative inlining decision the threshold is reduced by the code size of the function being inlined. If the threshold becomes exhausted, at or below zero, no further speculation will be performed.
The inlining depth starts at zero and is increased by one every time the inliner descends into another function. It is then decreased by one every time the inliner leaves such function. If the depth exceeds the value set by -inline-max-depth then speculation stops. This parameter is intended as a general backstop for situations where the inlining threshold does not control the search sufficiently.
The unrolling depth applies to calls within the same mutually-recursive group of functions. Each time an inlining of such a call is performed the depth is incremented by one when examining the resulting body. If the depth reaches the limit set by -inline-max-unroll then speculation stops.
The inliner may discover a call site to a recursive function where something is known about the arguments: for example, they may be equal to some other variables currently in scope. In this situation it may be beneficial to specialise the function to those arguments. This is done by copying the declaration of the function (and any others involved in any same mutually-recursive declaration) and noting the extra information about the arguments. The arguments augmented by this information are known as specialised arguments. In order to try to ensure that specialisation is not performed uselessly, arguments are only specialised if it can be shown that they are invariant: in other words, during the execution of the recursive function(s) themselves, the arguments never change.
Unless overridden by an attribute (see below), specialisation of a function will not be attempted if:
The compiler can prove invariance of function arguments across multiple functions within a recursive group (although this has some limitations, as shown by the example below).
It should be noted that the unboxing of closures pass (see below) can introduce specialised arguments on non-recursive functions. (No other place in the compiler currently does this.)
This function might be written like so:
let rec iter f l =
match l with
| [] -> ()
| h :: t ->
f h;
iter f t
and used like this:
let print_int x = print_endline (string_of_int x) let run xs = iter print_int (List.rev xs)
The argument f to iter is invariant so the function may be specialised:
let run xs =
let rec iter' f l =
(* The compiler knows: f holds the same value as foo throughout iter'. *)
match l with
| [] -> ()
| h :: t ->
f h;
iter' f t
in
iter' print_int (List.rev xs)
The compiler notes down that for the function iter’, the argument f is specialised to the constant closure print_int. This means that the body of iter’ may be simplified:
let run xs =
let rec iter' f l =
(* The compiler knows: f holds the same value as foo throughout iter'. *)
match l with
| [] -> ()
| h :: t ->
print_int h; (* this is now a direct call *)
iter' f t
in
iter' print_int (List.rev xs)
The call to print_int can indeed be inlined:
let run xs =
let rec iter' f l =
(* The compiler knows: f holds the same value as foo throughout iter'. *)
match l with
| [] -> ()
| h :: t ->
print_endline (string_of_int h);
iter' f t
in
iter' print_int (List.rev xs)
The unused specialised argument f may now be removed, leaving:
let run xs =
let rec iter' l =
match l with
| [] -> ()
| h :: t ->
print_endline (string_of_int h);
iter' t
in
iter' (List.rev xs)
The compiler cannot currently detect invariance in cases such as the following.
let rec iter_swap f g l =
match l with
| [] -> ()
| 0 :: t ->
iter_swap g f l
| h :: t ->
f h;
iter_swap f g t
The benefit of specialisation is assessed in a similar way as for inlining. Specialised argument information may mean that the body of the function being specialised can be simplified: the removed operations are accumulated into a benefit. This, together with the size of the duplicated (specialised) function declaration, is then assessed against the size of the call to the original function.
The default settings (when not using -Oclassic) are for one round of optimisation using the following parameters.
| Parameter | Setting |
| -inline | 10 |
| -inline-branch-factor | 0.1 |
| -inline-alloc-cost | 7 |
| -inline-branch-cost | 5 |
| -inline-call-cost | 5 |
| -inline-indirect-cost | 4 |
| -inline-prim-cost | 3 |
| -inline-lifting-benefit | 1300 |
| -inline-toplevel | 160 |
| -inline-max-depth | 1 |
| -inline-max-unroll | 0 |
| -unbox-closures-factor | 10 |
When -O2 is specified two rounds of optimisation are performed. The first round uses the default parameters (see above). The second uses the following parameters.
| Parameter | Setting |
| -inline | 25 |
| -inline-branch-factor | Same as default |
| -inline-alloc-cost | Double the default |
| -inline-branch-cost | Double the default |
| -inline-call-cost | Double the default |
| -inline-indirect-cost | Double the default |
| -inline-prim-cost | Double the default |
| -inline-lifting-benefit | Same as default |
| -inline-toplevel | 400 |
| -inline-max-depth | 2 |
| -inline-max-unroll | Same as default |
| -unbox-closures-factor | Same as default |
When -O3 is specified three rounds of optimisation are performed. The first two rounds are as for -O2. The third round uses the following parameters.
| Parameter | Setting |
| -inline | 50 |
| -inline-branch-factor | Same as default |
| -inline-alloc-cost | Triple the default |
| -inline-branch-cost | Triple the default |
| -inline-call-cost | Triple the default |
| -inline-indirect-cost | Triple the default |
| -inline-prim-cost | Triple the default |
| -inline-lifting-benefit | Same as default |
| -inline-toplevel | 800 |
| -inline-max-depth | 3 |
| -inline-max-unroll | 1 |
| -unbox-closures-factor | Same as default |
Should the inliner prove recalcitrant and refuse to inline a particular function, or if the observed inlining decisions are not to the programmer’s satisfaction for some other reason, inlining behaviour can be dictated by the programmer directly in the source code. One example where this might be appropriate is when the programmer, but not the compiler, knows that a particular function call is on a cold code path. It might be desirable to prevent inlining of the function so that the code size along the hot path is kept smaller, so as to increase locality.
The inliner is directed using attributes. For non-recursive functions (and one-step unrolling of recursive functions, although @unroll is more clear for this purpose) the following are supported:
For recursive functions the relevant attributes are:
A compiler warning will be emitted if it was found impossible to obey an annotation from an @inlined or @specialised attribute.
module F (M : sig type t end) = struct
let[@inline never] bar x =
x * 3
let foo x =
(bar [@inlined]) (42 + x)
end [@@inline never]
module X = F [@inlined] (struct type t = int end)
Simplification, which is run in conjunction with inlining, propagates information (known as approximations) about which variables hold what values at runtime. Certain relationships between variables and symbols are also tracked: for example, some variable may be known to always hold the same value as some other variable; or perhaps some variable may be known to always hold the value pointed to by some symbol.
The propagation can help to eliminate allocations in cases such as:
let f x y = ... let p = x, y in ... ... (fst p) ... (snd p) ...
The projections from p may be replaced by uses of the variables x and y, potentially meaning that p becomes unused.
The propagation performed by the simplification pass is also important for discovering which functions flow to indirect call sites. This can enable the transformation of such call sites into direct call sites, which makes them eligible for an inlining transformation.
Note that no information is propagated about the contents of strings, even in safe-string mode, because it cannot yet be guaranteed that they are immutable throughout a given program.
Expressions found to be constant will be lifted to symbol bindings—that is to say, they will be statically allocated in the object file—when they evaluate to boxed values. Such constants may be straightforward numeric constants, such as the floating-point number 42.0, or more complicated values such as constant closures.
Lifting of constants to toplevel reduces allocation at runtime.
The compiler aims to share constants lifted to toplevel such that there are no duplicate definitions. However if .cmx files are hidden from the compiler then maximal sharing may not be possible.
The following language semantics apply specifically to constant float arrays. (By “constant float array” is meant an array consisting entirely of floating point numbers that are known at compile time. A common case is a literal such as [| 42.0; 43.0; |].
Toplevel let-expressions may be lifted to symbol bindings to ensure that the corresponding bound variables are not captured by closures. If the defining expression of a given binding is found to be constant, it is bound as such (the technical term is a let-symbol binding).
Otherwise, the symbol is bound to a (statically-allocated) preallocated block containing one field. At runtime, the defining expression will be evaluated and the first field of the block filled with the resulting value. This initialise-symbol binding causes one extra indirection but ensures, by virtue of the symbol’s address being known at compile time, that uses of the value are not captured by closures.
It should be noted that the blocks corresponding to initialise-symbol bindings are kept alive forever, by virtue of them occurring in a static table of GC roots within the object file. This extended lifetime of expressions may on occasion be surprising. If it is desired to create some non-constant value (for example when writing GC tests) that does not have this extended lifetime, then it may be created and used inside a function, with the application point of that function (perhaps at toplevel)—or indeed the function declaration itself—marked as to never be inlined. This technique prevents lifting of the definition of the value in question (assuming of course that it is not constant).
The transformations in this section relate to the splitting apart of boxed (that is to say, non-immediate) values. They are largely intended to reduce allocation, which tends to result in a runtime performance profile with lower variance and smaller tails.
This transformation is enabled unless -no-unbox-free-vars-of-closures is provided.
Variables that appear in closure environments may themselves be boxed values. As such, they may be split into further closure variables, each of which corresponds to some projection from the original closure variable(s). This transformation is called unboxing of closure variables or unboxing of free variables of closures. It is only applied when there is reasonable certainty that there are no uses of the boxed free variable itself within the corresponding function bodies.
In the following code, the compiler observes that the closure returned from the function f contains a variable pair (free in the body of f) that may be split into two separate variables.
let f x0 x1 =
let pair = x0, x1 in
Printf.printf "foo\n";
fun y ->
fst pair + snd pair + y
After some simplification one obtains:
let f x0 x1 =
let pair_0 = x0 in
let pair_1 = x1 in
Printf.printf "foo\n";
fun y ->
pair_0 + pair_1 + y
and then:
let f x0 x1 =
Printf.printf "foo\n";
fun y ->
x0 + x1 + y
The allocation of the pair has been eliminated.
This transformation does not operate if it would cause the closure to contain more than twice as many closure variables as it did beforehand.
This transformation is enabled unless -no-unbox-specialised-args is provided.
It may become the case during compilation that one or more invariant arguments to a function become specialised to a particular value. When such values are themselves boxed the corresponding specialised arguments may be split into more specialised arguments corresponding to the projections out of the boxed value that occur within the function body. This transformation is called unboxing of specialised arguments. It is only applied when there is reasonable certainty that the boxed argument itself is unused within the function.
If the function in question is involved in a recursive group then unboxing of specialised arguments may be immediately replicated across the group based on the dataflow between invariant arguments.
Having been given the following code, the compiler will inline loop into f, and then observe inv being invariant and always the pair formed by adding 42 and 43 to the argument x of the function f.
let rec loop inv xs = match xs with | [] -> fst inv + snd inv | x::xs -> x + loop2 xs inv and loop2 ys inv = match ys with | [] -> 4 | y::ys -> y - loop inv ys let f x = Printf.printf "%d\n" (loop (x + 42, x + 43) [1; 2; 3])
Since the functions have sufficiently few arguments, more specialised arguments will be added. After some simplification one obtains:
let f x =
let rec loop' xs inv_0 inv_1 =
match xs with
| [] -> inv_0 + inv_1
| x::xs -> x + loop2' xs inv_0 inv_1
and loop2' ys inv_0 inv_1 =
match ys with
| [] -> 4
| y::ys -> y - loop' ys inv_0 inv_1
in
Printf.printf "%d\n" (loop' [1; 2; 3] (x + 42) (x + 43))
The allocation of the pair within f has been removed. (Since the two closures for loop’ and loop2’ are constant they will also be lifted to toplevel with no runtime allocation penalty. This would also happen without having run the transformation to unbox specialise arguments.)
The transformation to unbox specialised arguments never introduces extra allocation.
The transformation will not unbox arguments if it would result in the original function having sufficiently many arguments so as to inhibit tail-call optimisation.
The transformation is implemented by creating a wrapper function that accepts the original arguments. Meanwhile, the original function is renamed and extra arguments are added corresponding to the unboxed specialised arguments; this new function is called from the wrapper. The wrapper will then be inlined at direct call sites. Indeed, all call sites will be direct unless -unbox-closures is being used, since they will have been generated by the compiler when originally specialising the function. (In the case of -unbox-closures other functions may appear with specialised arguments; in this case there may be indirect calls and these will incur a small penalty owing to having to bounce through the wrapper. The technique of direct call surrogates used for -unbox-closures is not used by the transformation to unbox specialised arguments.)
This transformation is not enabled by default. It may be enabled using the -unbox-closures flag.
The transformation replaces closure variables by specialised arguments. The aim is to cause more closures to become closed. It is particularly applicable, as a means of reducing allocation, where the function concerned cannot be inlined or specialised. For example, some non-recursive function might be too large to inline; or some recursive function might offer no opportunities for specialisation perhaps because its only argument is one of type unit.
At present there may be a small penalty in terms of actual runtime performance when this transformation is enabled, although more stable performance may be obtained due to reduced allocation. It is recommended that developers experiment to determine whether the option is beneficial for their code. (It is expected that in the future it will be possible for the performance degradation to be removed.)
In the following code (which might typically occur when g is too large to inline) the value of x would usually be communicated to the application of the + function via the closure of g.
let f x =
let g y =
x + y
in
(g [@inlined never]) 42
Unboxing of the closure causes the value for x inside g to be passed as an argument to g rather than through its closure. This means that the closure of g becomes constant and may be lifted to toplevel, eliminating the runtime allocation.
The transformation is implemented by adding a new wrapper function in the manner of that used when unboxing specialised arguments. The closure variables are still free in the wrapper, but the intention is that when the wrapper is inlined at direct call sites, the relevant values are passed directly to the main function via the new specialised arguments.
Adding such a wrapper will penalise indirect calls to the function (which might exist in arbitrary places; remember that this transformation is not for example applied only on functions the compiler has produced as a result of specialisation) since such calls will bounce through the wrapper. To mitigate this, if a function is small enough when weighed up against the number of free variables being removed, it will be duplicated by the transformation to obtain two versions: the original (used for indirect calls, since we can do no better) and the wrapper/rewritten function pair as described in the previous paragraph. The wrapper/rewritten function pair will only be used at direct call sites of the function. (The wrapper in this case is known as a direct call surrogate, since it takes the place of another function—the unchanged version used for indirect calls—at direct call sites.)
The -unbox-closures-factor command line flag, which takes an integer, may be used to adjust the point at which a function is deemed large enough to be ineligible for duplication. The benefit of duplication is scaled by the integer before being evaluated against the size.
In the following code, there are two closure variables that would typically cause closure allocations. One is called fv and occurs inside the function baz; the other is called z and occurs inside the function bar. In this toy (yet sophisticated) example we again use an attribute to simulate the typical situation where the first argument of baz is too large to inline.
let foo c =
let rec bar zs fv =
match zs with
| [] -> []
| z::zs ->
let rec baz f = function
| [] -> []
| a::l -> let r = fv + ((f [@inlined never]) a) in r :: baz f l
in
(map2 (fun y -> z + y) [z; 2; 3; 4]) @ bar zs fv
in
Printf.printf "%d" (List.length (bar [1; 2; 3; 4] c))
The code resulting from applying -O3 -unbox-closures to this code passes the free variables via function arguments in order to eliminate all closure allocation in this example (aside from any that might be performed inside printf).
The simplification pass removes unused let bindings so long as their corresponding defining expressions have “no effects”. See the section “Treatment of effects” below for the precise definition of this term.
This transformation is analogous to the removal of let-expressions whose defining expressions have no effects. It operates instead on symbol bindings, removing those that have no effects.
This transformation is only enabled by default for specialised arguments. It may be enabled for all arguments using the -remove-unused-arguments flag.
The pass analyses functions to determine which arguments are unused. Removal is effected by creating a wrapper function, which will be inlined at every direct call site, that accepts the original arguments and then discards the unused ones before calling the original function. As a consequence, this transformation may be detrimental if the original function is usually indirectly called, since such calls will now bounce through the wrapper. (The technique of direct call surrogates used to reduce this penalty during unboxing of closure variables (see above) does not yet apply to the pass that removes unused arguments.)
This transformation performs an analysis across the whole compilation unit to determine whether there exist closure variables that are never used. Such closure variables are then eliminated. (Note that this has to be a whole-unit analysis because a projection of a closure variable from some particular closure may have propagated to an arbitrary location within the code due to inlining.)
Flambda performs a simple analysis analogous to that performed elsewhere in the compiler that can transform refs into mutable variables that may then be held in registers (or on the stack as appropriate) rather than being allocated on the OCaml heap. This only happens so long as the reference concerned can be shown to not escape from its defining scope.
This transformation discovers closure variables that are known to be equal to specialised arguments. Such closure variables are replaced by the specialised arguments; the closure variables may then be removed by the “removal of unused closure variables” pass (see below).
The Flambda optimisers classify expressions in order to determine whether an expression:
This is done by forming judgements on the effects and the coeffects that might be performed were the expression to be executed. Effects talk about how the expression might affect the world; coeffects talk about how the world might affect the expression.
Effects are classified as follows:
There is a single classification for coeffects:
It is assumed in the compiler that, subject to data dependencies, expressions with neither effects nor coeffects may be reordered with respect to other expressions.
Compilation of modules that are able to be statically allocated (for example, the module corresponding to an entire compilation unit, as opposed to a first class module dependent on values computed at runtime) initially follows the strategy used for bytecode. A sequence of let-bindings, which may be interspersed with arbitrary effects, surrounds a record creation that becomes the module block. The Flambda-specific transformation follows: these bindings are lifted to toplevel symbols, as described above.
Especially when writing benchmarking suites that run non-side-effecting algorithms in loops, it may be found that the optimiser entirely elides the code being benchmarked. This behaviour can be prevented by using the Sys.opaque_identity function (which indeed behaves as a normal OCaml function and does not possess any “magic” semantics). The documentation of the Sys module should be consulted for further details.
The behaviour of the Flambda simplification pass means that certain unsafe operations, which may without Flambda or when using previous versions of the compiler be safe, must not be used. This specifically refers to functions found in the Obj module.
In particular, it is forbidden to change any value (for example using Obj.set_field or Obj.set_tag) that is not mutable. (Values returned from C stubs are always treated as mutable.) The compiler will emit warning 59 if it detects such a write—but it cannot warn in all cases. Here is an example of code that will trigger the warning:
let f x = let a = 42, x in (Obj.magic a : int ref) := 1; fst a
The reason this is unsafe is because the simplification pass believes that fst a holds the value 42; and indeed it must, unless type soundness has been broken via unsafe operations.
If it must be the case that code has to be written that triggers warning 59, but the code is known to actually be correct (for some definition of correct), then Sys.opaque_identity may be used to wrap the value before unsafe operations are performed upon it. Great care must be taken when doing this to ensure that the opacity is added at the correct place. It must be emphasised that this use of Sys.opaque_identity is only for exceptional cases. It should not be used in normal code or to try to guide the optimiser.
As an example, this code will return the integer 1:
let f x = let a = Sys.opaque_identity (42, x) in (Obj.magic a : int ref) := 1; fst a
However the following code will still return 42:
let f x = let a = 42, x in Sys.opaque_identity (Obj.magic a : int ref) := 1; fst a
High levels of inlining performed by Flambda may expose bugs in code thought previously to be correct. Take care, for example, not to add type annotations that claim some mutable value is always immediate if it might be possible for an unsafe operation to update it to a boxed value.
The following terminology is used in this chapter of the manual.
ocaml-doc-4.05/ocaml.html/index.html 0000644 0001750 0001750 00000014501 13131636457 016303 0 ustar mehdi mehdi
This manual is also available in PDF. Postscript, DVI, plain text, as a bundle of HTML files, and as a bundle of Emacs Info files.
Part I |
Part II |
Part III |
Part IV |
Part V |
This document was translated from LATEX by HEVEA.ocaml-doc-4.05/ocaml.html/typedecl.html 0000644 0001750 0001750 00000052021 13131636457 017004 0 ustar mehdi mehdi
Type definitions bind type constructors to data types: either variant types, record types, type abbreviations, or abstract data types. They also bind the value constructors and record fields associated with the definition.
|
See also the following language extensions: private types, generalized algebraic datatypes, attributes, extension nodes, extensible variant types and inline records.
Type definitions are introduced by the type keyword, and consist in one or several simple definitions, possibly mutually recursive, separated by the and keyword. Each simple definition defines one type constructor.
A simple definition consists in a lowercase identifier, possibly preceded by one or several type parameters, and followed by an optional type equation, then an optional type representation, and then a constraint clause. The identifier is the name of the type constructor being defined.
In the right-hand side of type definitions, references to one of the type constructor name being defined are considered as recursive, unless type is followed by nonrec. The nonrec keyword was introduced in OCaml 4.02.2.
The optional type parameters are either one type variable ' ident, for type constructors with one parameter, or a list of type variables ('ident1,…,' identn), for type constructors with several parameters. Each type parameter may be prefixed by a variance constraint + (resp. -) indicating that the parameter is covariant (resp. contravariant). These type parameters can appear in the type expressions of the right-hand side of the definition, optionally restricted by a variance constraint ; i.e. a covariant parameter may only appear on the right side of a functional arrow (more precisely, follow the left branch of an even number of arrows), and a contravariant parameter only the left side (left branch of an odd number of arrows). If the type has a representation or an equation, and the parameter is free (i.e. not bound via a type constraint to a constructed type), its variance constraint is checked but subtyping etc. will use the inferred variance of the parameter, which may be less restrictive; otherwise (i.e. for abstract types or non-free parameters), the variance must be given explicitly, and the parameter is invariant if no variance is given.
The optional type equation = typexpr makes the defined type equivalent to the type expression typexpr: one can be substituted for the other during typing. If no type equation is given, a new type is generated: the defined type is incompatible with any other type.
The optional type representation describes the data structure representing the defined type, by giving the list of associated constructors (if it is a variant type) or associated fields (if it is a record type). If no type representation is given, nothing is assumed on the structure of the type besides what is stated in the optional type equation.
The type representation = [|] constr-decl { | constr-decl } describes a variant type. The constructor declarations constr-decl1, …, constr-decln describe the constructors associated to this variant type. The constructor declaration constr-name of typexpr1 * … * typexprn declares the name constr-name as a non-constant constructor, whose arguments have types typexpr1 …typexprn. The constructor declaration constr-name declares the name constr-name as a constant constructor. Constructor names must be capitalized.
The type representation = { field-decl { ; field-decl } [;] } describes a record type. The field declarations field-decl1, …, field-decln describe the fields associated to this record type. The field declaration field-name : poly-typexpr declares field-name as a field whose argument has type poly-typexpr. The field declaration mutable field-name : poly-typexpr behaves similarly; in addition, it allows physical modification of this field. Immutable fields are covariant, mutable fields are non-variant. Both mutable and immutable fields may have a explicitly polymorphic types. The polymorphism of the contents is statically checked whenever a record value is created or modified. Extracted values may have their types instantiated.
The two components of a type definition, the optional equation and the optional representation, can be combined independently, giving rise to four typical situations:
The type variables appearing as type parameters can optionally be prefixed by + or - to indicate that the type constructor is covariant or contravariant with respect to this parameter. This variance information is used to decide subtyping relations when checking the validity of :> coercions (see section 6.7.6).
For instance, type +'a t declares t as an abstract type that is covariant in its parameter; this means that if the type τ is a subtype of the type σ, then τ t is a subtype of σ t. Similarly, type -'a t declares that the abstract type t is contravariant in its parameter: if τ is a subtype of σ, then σ t is a subtype of τ t. If no + or - variance annotation is given, the type constructor is assumed non-variant in the corresponding parameter. For instance, the abstract type declaration type 'a t means that τ t is neither a subtype nor a supertype of σ t if τ is subtype of σ.
The variance indicated by the + and - annotations on parameters is enforced only for abstract and private types, or when there are type constraints. Otherwise, for abbreviations, variant and record types without type constraints, the variance properties of the type constructor are inferred from its definition, and the variance annotations are only checked for conformance with the definition.
The construct constraint ' ident = typexpr allows the specification of type parameters. Any actual type argument corresponding to the type parameter ident has to be an instance of typexpr (more precisely, ident and typexpr are unified). Type variables of typexpr can appear in the type equation and the type declaration.
|
Exception definitions add new constructors to the built-in variant
type exn of exception values. The constructors are declared as
for a definition of a variant type.
The form exception constr-decl generates a new exception, distinct from all other exceptions in the system. The form exception constr-name = constr gives an alternate name to an existing exception.
ocaml-doc-4.05/ocaml.html/native.html 0000644 0001750 0001750 00000163522 13131636457 016472 0 ustar mehdi mehdi
This chapter describes the OCaml high-performance native-code compiler ocamlopt, which compiles OCaml source files to native code object files and link these object files to produce standalone executables.
The native-code compiler is only available on certain platforms. It produces code that runs faster than the bytecode produced by ocamlc, at the cost of increased compilation time and executable code size. Compatibility with the bytecode compiler is extremely high: the same source code should run identically when compiled with ocamlc and ocamlopt.
It is not possible to mix native-code object files produced by ocamlopt with bytecode object files produced by ocamlc: a program must be compiled entirely with ocamlopt or entirely with ocamlc. Native-code object files produced by ocamlopt cannot be loaded in the toplevel system ocaml.
The ocamlopt command has a command-line interface very close to that of ocamlc. It accepts the same types of arguments, and processes them sequentially, after all options have been processed:
The implementation is checked against the interface file x.mli (if it exists) as described in the manual for ocamlc (chapter 8).
The output of the linking phase is a regular Unix or Windows executable file. It does not need ocamlrun to run.
The following command-line options are recognized by ocamlopt. The options -pack, -a, -shared, -c and -output-obj are mutually exclusive.
If -cclib or -ccopt options are passed on the command line, these options are stored in the resulting .cmxalibrary. Then, linking with this library automatically adds back the -cclib and -ccopt options as if they had been provided on the command line, unless the -noautolink option is given.
The environment variable OCAML_COLOR is considered if -color is not provided. Its values are auto/always/never as above.
If the given directory starts with +, it is taken relative to the standard library directory. For instance, -I +labltk adds the subdirectory labltk of the standard library to the search path.
The -opaque option, available since 4.04, disables cross-module optimization information for the currently compiled unit. When compiling .mli interface, using -opaque marks the compiled .cmi interface so that subsequent compilations of modules that depend on it will not rely on the corresponding .cmx file, nor warn if it is absent. When the native compiler compiles a .ml implementation, using -opaque generates a .cmx that does not contain any cross-module optimization information.
Using this option may degrade the quality of generated code, but it reduces compilation time, both on clean and incremental builds. Indeed, with the native compiler, when the implementation of a compilation unit changes, all the units that depend on it may need to be recompiled – because the cross-module information may have changed. If the compilation unit whose implementation changed was compiled with -opaque, no such recompilation needs to occur. This option can thus be used, for example, to get faster edit-compile-test feedback loops.
Unix: See the Unix manual page for gprof(1) for more information about the profiles.Full support for gprof is only available for certain platforms (currently: Intel x86 32 and 64 bits under Linux, BSD and MacOS X). On other platforms, the -p option will result in a less precise profile (no call graph information, only a time profile).
Windows: The -p option does not work under Windows.
ocamlopt -pack -o P.cmx A.cmx B.cmx C.cmxgenerates compiled files P.cmx, P.o and P.cmi describing a compilation unit having three sub-modules A, B and C, corresponding to the contents of the object files A.cmx, B.cmx and C.cmx. These contents can be referenced as P.A, P.B and P.C in the remainder of the program.
The .cmx object files being combined must have been compiled with the appropriate -for-pack option. In the example above, A.cmx, B.cmx and C.cmx must have been compiled with ocamlopt -for-pack P.
Multiple levels of packing can be achieved by combining -pack with -for-pack. Consider the following example:
ocamlopt -for-pack P.Q -c A.ml
ocamlopt -pack -o Q.cmx -for-pack P A.cmx
ocamlopt -for-pack P -c B.ml
ocamlopt -pack -o P.cmx Q.cmx B.cmx
The resulting P.cmx object file has sub-modules P.Q, P.Q.A and P.B.
The warning-list argument is a sequence of warning specifiers, with no separators between them. A warning specifier is one of the following:
Warning numbers and letters which are out of the range of warnings that are currently defined are ignored. The warnings are as follows.
The default setting is -w +a-4-6-7-9-27-29-32..39-41..42-44-45-48-50. It is displayed by ocamlopt -help. Note that warnings 5 and 10 are not always triggered, depending on the internals of the type checker.
Note: it is not recommended to use warning sets (i.e. letters) as arguments to -warn-error in production code, because this can break your build when future versions of OCaml add some new warnings.
The default setting is -warn-error -a+31 (only warning 31 is fatal).
The IA32 code generator (Intel Pentium, AMD Athlon) supports the following additional option:
The AMD64 code generator (64-bit versions of Intel Pentium and AMD Athlon) supports the following additional options:
The Sparc code generator supports the following additional options:
The default is to generate code for SPARC version 7, which runs on all SPARC processors.
The compiler command line can be modified “from the outside” with the following mechanisms. These are experimental and subject to change. They should be used only for experimental and development work, not in released packages.
The error messages are almost identical to those of ocamlc. See section 8.4.
Executables generated by ocamlopt are native, stand-alone executable files that can be invoked directly. They do not depend on the ocamlrun bytecode runtime system nor on dynamically-loaded C/OCaml stub libraries.
During execution of an ocamlopt-generated executable, the following environment variables are also consulted:
This section lists the known incompatibilities between the bytecode compiler and the native-code compiler. Except on those points, the two compilers should generate code that behave identically.
ocaml-doc-4.05/ocaml.html/const.html 0000644 0001750 0001750 00000007673 13131636457 016336 0 ustar mehdi mehdi
|
See also the following language extensions: integer literals for types int32, int64 and nativeint, quoted strings and extension literals.
The syntactic class of constants comprises literals from the four base types (integers, floating-point numbers, characters, character strings), and constant constructors from both normal and polymorphic variants, as well as the special constants false, true, (), [], and [||], which behave like constant constructors, and begin end, which is equivalent to ().
ocaml-doc-4.05/ocaml.html/modtypes.html 0000644 0001750 0001750 00000067243 13131636457 017053 0 ustar mehdi mehdi
Module types are the module-level equivalent of type expressions: they specify the general shape and type properties of modules.
|
|
See also the following language extensions: recovering the type of a module, substitution inside a signature, type-level module aliases, attributes, extension nodes and generative functors.
The expression modtype-path is equivalent to the module type bound to the name modtype-path. The expression ( module-type ) denotes the same type as module-type.
Signatures are type specifications for structures. Signatures sig … end are collections of type specifications for value names, type names, exceptions, module names and module type names. A structure will match a signature if the structure provides definitions (implementations) for all the names specified in the signature (and possibly more), and these definitions meet the type requirements given in the signature.
An optional ;; is allowed after each specification in a signature. It serves as a syntactic separator with no semantic meaning.
A specification of a value component in a signature is written val value-name : typexpr, where value-name is the name of the value and typexpr its expected type.
The form external value-name : typexpr = external-declaration is similar, except that it requires in addition the name to be implemented as the external function specified in external-declaration (see chapter 19).
A specification of one or several type components in a signature is written type typedef { and typedef } and consists of a sequence of mutually recursive definitions of type names.
Each type definition in the signature specifies an optional type equation = typexpr and an optional type representation = constr-decl … or = { field-decl … }. The implementation of the type name in a matching structure must be compatible with the type expression specified in the equation (if given), and have the specified representation (if given). Conversely, users of that signature will be able to rely on the type equation or type representation, if given. More precisely, we have the following four situations:
The specification exception constr-decl in a signature requires the matching structure to provide an exception with the name and arguments specified in the definition, and makes the exception available to all users of the structure.
A specification of one or several classes in a signature is written class class-spec { and class-spec } and consists of a sequence of mutually recursive definitions of class names.
Class specifications are described more precisely in section 6.9.4.
A specification of one or several classe types in a signature is written class type classtype-def { and classtype-def } and consists of a sequence of mutually recursive definitions of class type names. Class type specifications are described more precisely in section 6.9.5.
A specification of a module component in a signature is written module module-name : module-type, where module-name is the name of the module component and module-type its expected type. Modules can be nested arbitrarily; in particular, functors can appear as components of structures and functor types as components of signatures.
For specifying a module component that is a functor, one may write
instead of
A module type component of a signature can be specified either as a manifest module type or as an abstract module type.
An abstract module type specification module type modtype-name allows the name modtype-name to be implemented by any module type in a matching signature, but hides the implementation of the module type to all users of the signature.
A manifest module type specification module type modtype-name = module-type requires the name modtype-name to be implemented by the module type module-type in a matching signature, but makes the equality between modtype-name and module-type apparent to all users of the signature.
The expression open module-path in a signature does not specify any components. It simply affects the parsing of the following items of the signature, allowing components of the module denoted by module-path to be referred to by their simple names name instead of path accesses module-path . name. The scope of the open stops at the end of the signature expression.
The expression include module-type in a signature performs textual inclusion of the components of the signature denoted by module-type. It behaves as if the components of the included signature were copied at the location of the include. The module-type argument must refer to a module type that is a signature, not a functor type.
The module type expression functor ( module-name : module-type1 ) -> module-type2 is the type of functors (functions from modules to modules) that take as argument a module of type module-type1 and return as result a module of type module-type2. The module type module-type2 can use the name module-name to refer to type components of the actual argument of the functor. If the type module-type2 does not depend on type components of module-name, the module type expression can be simplified with the alternative short syntax module-type1 -> module-type2 . No restrictions are placed on the type of the functor argument; in particular, a functor may take another functor as argument (“higher-order” functor).
Assuming module-type denotes a signature, the expression module-type with mod-constraint { and mod-constraint } denotes the same signature where type equations have been added to some of the type specifications, as described by the constraints following the with keyword. The constraint type [type-parameters] typeconstr = typexpr adds the type equation = typexpr to the specification of the type component named typeconstr of the constrained signature. The constraint module module-path = extended-module-path adds type equations to all type components of the sub-structure denoted by module-path, making them equivalent to the corresponding type components of the structure denoted by extended-module-path.
For instance, if the module type name S is bound to the signature
sig type t module M: (sig type u end) end
then S with type t=int denotes the signature
sig type t=int module M: (sig type u end) end
and S with module M = N denotes the signature
sig type t module M: (sig type u=N.u end) end
A functor taking two arguments of type S that share their t component is written
functor (A: S) (B: S with type t = A.t) ...
Constraints are added left to right. After each constraint has been applied, the resulting signature must be a subtype of the signature before the constraint was applied. Thus, the with operator can only add information on the type components of a signature, but never remove information.
ocaml-doc-4.05/ocaml.html/depend.html 0000644 0001750 0001750 00000027725 13131636457 016447 0 ustar mehdi mehdi
The ocamldep command scans a set of OCaml source files (.ml and .mli files) for references to external compilation units, and outputs dependency lines in a format suitable for the make utility. This ensures that make will compile the source files in the correct order, and recompile those files that need to when a source file is modified.
The typical usage is:
ocamldep options *.mli *.ml > .depend
where *.mli *.ml expands to all source files in the current directory and .depend is the file that should contain the dependencies. (See below for a typical Makefile.)
Dependencies are generated both for compiling with the bytecode compiler ocamlc and with the native-code compiler ocamlopt.
The following command-line options are recognized by ocamldep.
filename: Module1 Module2 ... ModuleNwhere Module1, …, ModuleN are the names of the compilation units referenced within the file filename, but these names are not resolved to source file names. Such raw dependencies cannot be used by make, but can be post-processed by other tools such as Omake.
Here is a template Makefile for a OCaml program.
OCAMLC=ocamlc
OCAMLOPT=ocamlopt
OCAMLDEP=ocamldep
INCLUDES= # all relevant -I options here
OCAMLFLAGS=$(INCLUDES) # add other options for ocamlc here
OCAMLOPTFLAGS=$(INCLUDES) # add other options for ocamlopt here
# prog1 should be compiled to bytecode, and is composed of three
# units: mod1, mod2 and mod3.
# The list of object files for prog1
PROG1_OBJS=mod1.cmo mod2.cmo mod3.cmo
prog1: $(PROG1_OBJS)
$(OCAMLC) -o prog1 $(OCAMLFLAGS) $(PROG1_OBJS)
# prog2 should be compiled to native-code, and is composed of two
# units: mod4 and mod5.
# The list of object files for prog2
PROG2_OBJS=mod4.cmx mod5.cmx
prog2: $(PROG2_OBJS)
$(OCAMLOPT) -o prog2 $(OCAMLFLAGS) $(PROG2_OBJS)
# Common rules
.SUFFIXES: .ml .mli .cmo .cmi .cmx
.ml.cmo:
$(OCAMLC) $(OCAMLFLAGS) -c $<
.mli.cmi:
$(OCAMLC) $(OCAMLFLAGS) -c $<
.ml.cmx:
$(OCAMLOPT) $(OCAMLOPTFLAGS) -c $<
# Clean up
clean:
rm -f prog1 prog2
rm -f *.cm[iox]
# Dependencies
depend:
$(OCAMLDEP) $(INCLUDES) *.mli *.ml > .depend
include .depend
If you use module aliases to give shorter names to modules, you need to change the above definitions. Assuming that your map file is called mylib.mli, here are minimal modifications.
OCAMLFLAGS=$(INCLUDES) -open Mylib
mylib.cmi: mylib.mli
$(OCAMLC) $(INCLUDES) -no-alias-deps -w -49 -c $<
depend:
$(OCAMLDEP) $(INCLUDES) -map mylib.mli $(PROG1_OBJS:.cmo=.ml) > .depend
Note that in this case you should not compute dependencies for mylib.mli together with the other files, hence the need to pass explicitly the list of files to process. If mylib.mli itself has dependencies, you should compute them using -as-map.
ocaml-doc-4.05/ocaml.html/libref/ 0000755 0001750 0001750 00000000000 13131636452 015543 5 ustar mehdi mehdi ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.S.T.html 0000644 0001750 0001750 00000016577 13131636451 022473 0 ustar mehdi mehdi
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Hashtbl.MakeSeeded.html 0000644 0001750 0001750 00000026605 13131636446 025105 0 ustar mehdi mehdi
functor (H : SeededHashedType) ->
sig
type key = H.t
and 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val filter_map_inplace :
f:(key:key -> data:'a -> 'a option) -> 'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end ocaml-doc-4.05/ocaml.html/libref/Lexing.html 0000644 0001750 0001750 00000046257 13131636445 017677 0 ustar mehdi mehdi
module Lexing:sig..end
ocamllex.type
|
pos_fname : |
|
pos_lnum : |
|
pos_bol : |
|
pos_cnum : |
position describes a point in a source file.
pos_fname is the file name; pos_lnum is the line number;
pos_bol is the offset of the beginning of the line (number
of characters between the beginning of the lexbuf and the beginning
of the line); pos_cnum is the offset of the position (number of
characters between the beginning of the lexbuf and the position).
The difference between pos_cnum and pos_bol is the character
offset within the line (i.e. the column number, assuming each
character is one column wide).
See the documentation of type lexbuf for information about
how the lexing engine will manage positions.
val dummy_pos : positionposition, guaranteed to be different from any
valid position.type
|
refill_buff : |
|
mutable lex_buffer : |
|
mutable lex_buffer_len : |
|
mutable lex_abs_pos : |
|
mutable lex_start_pos : |
|
mutable lex_curr_pos : |
|
mutable lex_last_pos : |
|
mutable lex_last_action : |
|
mutable lex_eof_reached : |
|
mutable lex_mem : |
|
mutable lex_start_p : |
|
mutable lex_curr_p : |
At each token, the lexing engine will copy lex_curr_p to
lex_start_p, then change the pos_cnum field
of lex_curr_p by updating it with the number of characters read
since the start of the lexbuf. The other fields are left
unchanged by the lexing engine. In order to keep them
accurate, they must be initialised before the first use of the
lexbuf, and updated by the relevant lexer actions (i.e. at each
end of line -- see also new_line).
val from_channel : in_channel -> lexbufLexing.from_channel inchan returns a lexer buffer which reads
from the input channel inchan, at the current reading position.val from_string : string -> lexbufval from_function : (bytes -> int -> int) -> lexbufs and a byte
count n. The function should put n bytes or fewer in s,
starting at index 0, and return the number of bytes
provided. A return value of 0 means end of input.lexbuf, which, in the code generated by
ocamllex, is bound to the lexer buffer passed to the parsing
function.val lexeme : lexbuf -> stringLexing.lexeme lexbuf returns the string matched by
the regular expression.val lexeme_char : lexbuf -> int -> charLexing.lexeme_char lexbuf i returns character number i in
the matched string.val lexeme_start : lexbuf -> intLexing.lexeme_start lexbuf returns the offset in the
input stream of the first character of the matched string.
The first character of the stream has offset 0.val lexeme_end : lexbuf -> intLexing.lexeme_end lexbuf returns the offset in the input stream
of the character following the last character of the matched
string. The first character of the stream has offset 0.val lexeme_start_p : lexbuf -> positionlexeme_start, but return a complete position instead
of an offset.val lexeme_end_p : lexbuf -> positionlexeme_end, but return a complete position instead
of an offset.val new_line : lexbuf -> unitlex_curr_p field of the lexbuf to reflect the start
of a new line. You can call this function in the semantic action
of the rule that matches the end-of-line character.val flush_input : lexbuf -> unitsig
type 'a channel
val new_channel : unit -> 'a Event.channel
type +'a event
val send : 'a Event.channel -> 'a -> unit Event.event
val receive : 'a Event.channel -> 'a Event.event
val always : 'a -> 'a Event.event
val choose : 'a Event.event list -> 'a Event.event
val wrap : 'a Event.event -> ('a -> 'b) -> 'b Event.event
val wrap_abort : 'a Event.event -> (unit -> unit) -> 'a Event.event
val guard : (unit -> 'a Event.event) -> 'a Event.event
val sync : 'a Event.event -> 'a
val select : 'a Event.event list -> 'a
val poll : 'a Event.event -> 'a option
end ocaml-doc-4.05/ocaml.html/libref/type_ArrayLabels.html 0000644 0001750 0001750 00000044323 13131636441 021677 0 ustar mehdi mehdi
sig
external length : 'a array -> int = "%array_length"
external get : 'a array -> int -> 'a = "%array_safe_get"
external set : 'a array -> int -> 'a -> unit = "%array_safe_set"
external make : int -> 'a -> 'a array = "caml_make_vect"
external create : int -> 'a -> 'a array = "caml_make_vect"
val init : int -> f:(int -> 'a) -> 'a array
val make_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
val create_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
val append : 'a array -> 'a array -> 'a array
val concat : 'a array list -> 'a array
val sub : 'a array -> pos:int -> len:int -> 'a array
val copy : 'a array -> 'a array
val fill : 'a array -> pos:int -> len:int -> 'a -> unit
val blit :
src:'a array ->
src_pos:int -> dst:'a array -> dst_pos:int -> len:int -> unit
val to_list : 'a array -> 'a list
val of_list : 'a list -> 'a array
val iter : f:('a -> unit) -> 'a array -> unit
val map : f:('a -> 'b) -> 'a array -> 'b array
val iteri : f:(int -> 'a -> unit) -> 'a array -> unit
val mapi : f:(int -> 'a -> 'b) -> 'a array -> 'b array
val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b array -> 'a
val fold_right : f:('b -> 'a -> 'a) -> 'b array -> init:'a -> 'a
val iter2 : f:('a -> 'b -> unit) -> 'a array -> 'b array -> unit
val map2 : f:('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array
val exists : f:('a -> bool) -> 'a array -> bool
val for_all : f:('a -> bool) -> 'a array -> bool
val mem : 'a -> set:'a array -> bool
val memq : 'a -> set:'a array -> bool
external create_float : int -> float array = "caml_make_float_vect"
val make_float : int -> float array
val sort : cmp:('a -> 'a -> int) -> 'a array -> unit
val stable_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
external unsafe_get : 'a array -> int -> 'a = "%array_unsafe_get"
external unsafe_set : 'a array -> int -> 'a -> unit = "%array_unsafe_set"
end ocaml-doc-4.05/ocaml.html/libref/Hashtbl.SeededS.html 0000644 0001750 0001750 00000025340 13131636444 021336 0 ustar mehdi mehdi
module type SeededS =sig..end
type
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a optionval find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unitval fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics ocaml-doc-4.05/ocaml.html/libref/Queue.html 0000644 0001750 0001750 00000031510 13131636450 017513 0 ustar mehdi mehdi
module Queue:sig..end
This module implements queues (FIFOs), with in-place modification.
Warning This module is not thread-safe: each Queue.t value
must be protected from concurrent access (e.g. with a Mutex.t).
Failure to do so can lead to a crash.
type 'a t
'a.exception Empty
val create : unit -> 'a tval add : 'a -> 'a t -> unitadd x q adds the element x at the end of the queue q.val push : 'a -> 'a t -> unitpush is a synonym for add.val take : 'a t -> 'atake q removes and returns the first element in queue q,
or raises Queue.Empty if the queue is empty.val pop : 'a t -> 'apop is a synonym for take.val peek : 'a t -> 'apeek q returns the first element in queue q, without removing
it from the queue, or raises Queue.Empty if the queue is empty.val top : 'a t -> 'atop is a synonym for peek.val clear : 'a t -> unitval copy : 'a t -> 'a tval is_empty : 'a t -> booltrue if the given queue is empty, false otherwise.val length : 'a t -> intval iter : ('a -> unit) -> 'a t -> unititer f q applies f in turn to all elements of q,
from the least recently entered to the most recently entered.
The queue itself is unchanged.val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'bfold f accu q is equivalent to List.fold_left f accu l,
where l is the list of q's elements. The queue remains
unchanged.val transfer : 'a t -> 'a t -> unittransfer q1 q2 adds all of q1's elements at the end of
the queue q2, then clears q1. It is equivalent to the
sequence iter (fun x -> add x q2) q1; clear q1, but runs
in constant time.sig
type ('k, 'd) t
val create : int -> ('k, 'd) Ephemeron.Kn.t
val get_key : ('k, 'd) Ephemeron.Kn.t -> int -> 'k option
val get_key_copy : ('k, 'd) Ephemeron.Kn.t -> int -> 'k option
val set_key : ('k, 'd) Ephemeron.Kn.t -> int -> 'k -> unit
val unset_key : ('k, 'd) Ephemeron.Kn.t -> int -> unit
val check_key : ('k, 'd) Ephemeron.Kn.t -> int -> bool
val blit_key :
('k, 'a) Ephemeron.Kn.t ->
int -> ('k, 'b) Ephemeron.Kn.t -> int -> int -> unit
val get_data : ('k, 'd) Ephemeron.Kn.t -> 'd option
val get_data_copy : ('k, 'd) Ephemeron.Kn.t -> 'd option
val set_data : ('k, 'd) Ephemeron.Kn.t -> 'd -> unit
val unset_data : ('k, 'd) Ephemeron.Kn.t -> unit
val check_data : ('k, 'd) Ephemeron.Kn.t -> bool
val blit_data : ('k, 'd) Ephemeron.Kn.t -> ('k, 'd) Ephemeron.Kn.t -> unit
module Make :
functor (H : Hashtbl.HashedType) ->
sig
type key = H.t array
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module MakeSeeded :
functor (H : Hashtbl.SeededHashedType) ->
sig
type key = H.t array
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Mty.html 0000644 0001750 0001750 00000026015 13131636441 022332 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_type_desc -> Parsetree.module_type
val attr :
Parsetree.module_type -> Parsetree.attribute -> Parsetree.module_type
val ident :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
val alias :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
val signature :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.signature -> Parsetree.module_type
val functor_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_type option ->
Parsetree.module_type -> Parsetree.module_type
val with_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_type ->
Parsetree.with_constraint list -> Parsetree.module_type
val typeof_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.module_expr -> Parsetree.module_type
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.module_type
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Map.Make.html 0000644 0001750 0001750 00000044120 13131636446 023113 0 ustar mehdi mehdi
functor (Ord : OrderedType) ->
sig
type key = Ord.t
and +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key:key -> data:'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
f:(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : f:(key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val for_all : f:(key -> 'a -> bool) -> 'a t -> bool
val exists : f:(key -> 'a -> bool) -> 'a t -> bool
val filter : f:(key -> 'a -> bool) -> 'a t -> 'a t
val partition : f:(key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : f:(key -> bool) -> 'a t -> key * 'a
val find_first_opt : f:(key -> bool) -> 'a t -> (key * 'a) option
val find_last : f:(key -> bool) -> 'a t -> key * 'a
val find_last_opt : f:(key -> bool) -> 'a t -> (key * 'a) option
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key -> 'a -> 'b) -> 'a t -> 'b t
end ocaml-doc-4.05/ocaml.html/libref/type_Thread.html 0000644 0001750 0001750 00000024027 13131636451 020705 0 ustar mehdi mehdi
sig
type t
val create : ('a -> 'b) -> 'a -> Thread.t
val self : unit -> Thread.t
val id : Thread.t -> int
val exit : unit -> unit
val kill : Thread.t -> unit
val delay : float -> unit
val join : Thread.t -> unit
val wait_read : Unix.file_descr -> unit
val wait_write : Unix.file_descr -> unit
val wait_timed_read : Unix.file_descr -> float -> bool
val wait_timed_write : Unix.file_descr -> float -> bool
val select :
Unix.file_descr list ->
Unix.file_descr list ->
Unix.file_descr list ->
float ->
Unix.file_descr list * Unix.file_descr list * Unix.file_descr list
val wait_pid : int -> int * Unix.process_status
val yield : unit -> unit
val sigmask : Unix.sigprocmask_command -> int list -> int list
val wait_signal : int list -> int
end ocaml-doc-4.05/ocaml.html/libref/Ratio.html 0000644 0001750 0001750 00000016510 13131636450 017510 0 ustar mehdi mehdi
module Ratio:sig..end
This module is used to support the implementation of Num and
should not be called directly.
type
ocaml-doc-4.05/ocaml.html/libref/Clflags.html 0000644 0001750 0001750 00000107111 13131636443 020005 0 ustar mehdi mehdi
module Clflags:sig..end
module Int_arg_helper:sig..end
module Float_arg_helper:sig..end
type
|
inline_call_cost : |
|
inline_alloc_cost : |
|
inline_prim_cost : |
|
inline_branch_cost : |
|
inline_indirect_cost : |
|
inline_lifting_benefit : |
|
inline_branch_factor : |
|
inline_max_depth : |
|
inline_max_unroll : |
|
inline_threshold : |
|
inline_toplevel_threshold : |
val classic_arguments : inlining_arguments
val o1_arguments : inlining_arguments
val o2_arguments : inlining_arguments
val o3_arguments : inlining_arguments
val use_inlining_arguments_set : ?round:int -> inlining_arguments -> unitval objfiles : string list ref
val ccobjs : string list ref
val dllibs : string list ref
val compile_only : bool ref
val output_name : string option ref
val include_dirs : string list ref
val no_std_include : bool ref
val print_types : bool ref
val make_archive : bool ref
val debug : bool ref
val fast : bool ref
val link_everything : bool ref
val custom_runtime : bool ref
val no_check_prims : bool ref
val bytecode_compatible_32 : bool ref
val output_c_object : bool ref
val output_complete_object : bool ref
val all_ccopts : string list ref
val classic : bool ref
val nopervasives : bool ref
val open_modules : string list ref
val preprocessor : string option ref
val all_ppx : string list ref
val annotations : bool ref
val binary_annotations : bool ref
val use_threads : bool ref
val use_vmthreads : bool ref
val noassert : bool ref
val verbose : bool ref
val noprompt : bool ref
val nopromptcont : bool ref
val init_file : string option ref
val noinit : bool ref
val noversion : bool ref
val use_prims : string ref
val use_runtime : string ref
val principal : bool ref
val real_paths : bool ref
val recursive_types : bool ref
val strict_sequence : bool ref
val strict_formats : bool ref
val applicative_functors : bool ref
val make_runtime : bool ref
val gprofile : bool ref
val c_compiler : string option ref
val no_auto_link : bool ref
val dllpaths : string list ref
val make_package : bool ref
val for_package : string option ref
val error_size : int ref
val float_const_prop : bool ref
val transparent_modules : bool ref
val dump_source : bool ref
val dump_parsetree : bool ref
val dump_typedtree : bool ref
val dump_rawlambda : bool ref
val dump_lambda : bool ref
val dump_rawclambda : bool ref
val dump_clambda : bool ref
val dump_rawflambda : bool ref
val dump_flambda : bool ref
val dump_flambda_let : int option ref
val dump_instr : bool ref
val keep_asm_file : bool ref
val optimize_for_speed : bool ref
val dump_cmm : bool ref
val dump_selection : bool ref
val dump_cse : bool ref
val dump_live : bool ref
val dump_spill : bool ref
val dump_split : bool ref
val dump_interf : bool ref
val dump_prefer : bool ref
val dump_regalloc : bool ref
val dump_reload : bool ref
val dump_scheduling : bool ref
val dump_linear : bool ref
val keep_startup_file : bool ref
val dump_combine : bool ref
val native_code : bool ref
val default_inline_threshold : float
val inline_threshold : Float_arg_helper.parsed ref
val inlining_report : bool ref
val simplify_rounds : int option ref
val default_simplify_rounds : int ref
val rounds : unit -> int
val default_inline_max_unroll : int
val inline_max_unroll : Int_arg_helper.parsed ref
val default_inline_toplevel_threshold : int
val inline_toplevel_threshold : Int_arg_helper.parsed ref
val default_inline_call_cost : int
val default_inline_alloc_cost : int
val default_inline_prim_cost : int
val default_inline_branch_cost : int
val default_inline_indirect_cost : int
val default_inline_lifting_benefit : int
val inline_call_cost : Int_arg_helper.parsed ref
val inline_alloc_cost : Int_arg_helper.parsed ref
val inline_prim_cost : Int_arg_helper.parsed ref
val inline_branch_cost : Int_arg_helper.parsed ref
val inline_indirect_cost : Int_arg_helper.parsed ref
val inline_lifting_benefit : Int_arg_helper.parsed ref
val default_inline_branch_factor : float
val inline_branch_factor : Float_arg_helper.parsed ref
val dont_write_files : bool ref
val std_include_flag : string -> string
val std_include_dir : unit -> string list
: bool ref
val dlcode : bool ref
val pic_code : bool ref
val runtime_variant : string ref
val force_slash : bool ref
val keep_docs : bool ref
val keep_locs : bool ref
val unsafe_string : bool ref
val opaque : bool ref
val print_timings : bool ref
val flambda_invariant_checks : bool ref
val unbox_closures : bool ref
val unbox_closures_factor : int ref
val default_unbox_closures_factor : int
val unbox_free_vars_of_closures : bool ref
val unbox_specialised_args : bool ref
val clambda_checks : bool ref
val default_inline_max_depth : int
val inline_max_depth : Int_arg_helper.parsed ref
val remove_unused_arguments : bool ref
val dump_flambda_verbose : bool ref
val classic_inlining : bool ref
val afl_instrument : bool ref
val afl_inst_ratio : int ref
val all_passes : string list ref
val dumped_pass : string -> bool
val set_dumped_pass : string -> bool -> unit
val parse_color_setting : string -> Misc.Color.setting option
val color : Misc.Color.setting option ref
val unboxed_types : bool ref
val arg_spec : (string * Arg.spec * string) list ref
val add_arguments : string -> (string * Arg.spec * string) list -> unit
val parse_arguments : Arg.anon_fun -> string -> unit
val print_arguments : string -> unit ocaml-doc-4.05/ocaml.html/libref/type_Ast_iterator.html 0000644 0001750 0001750 00000043673 13131636441 022145 0 ustar mehdi mehdi
sig
type iterator = {
attribute : Ast_iterator.iterator -> Parsetree.attribute -> unit;
attributes : Ast_iterator.iterator -> Parsetree.attribute list -> unit;
case : Ast_iterator.iterator -> Parsetree.case -> unit;
cases : Ast_iterator.iterator -> Parsetree.case list -> unit;
class_declaration :
Ast_iterator.iterator -> Parsetree.class_declaration -> unit;
class_description :
Ast_iterator.iterator -> Parsetree.class_description -> unit;
class_expr : Ast_iterator.iterator -> Parsetree.class_expr -> unit;
class_field : Ast_iterator.iterator -> Parsetree.class_field -> unit;
class_signature :
Ast_iterator.iterator -> Parsetree.class_signature -> unit;
class_structure :
Ast_iterator.iterator -> Parsetree.class_structure -> unit;
class_type : Ast_iterator.iterator -> Parsetree.class_type -> unit;
class_type_declaration :
Ast_iterator.iterator -> Parsetree.class_type_declaration -> unit;
class_type_field :
Ast_iterator.iterator -> Parsetree.class_type_field -> unit;
constructor_declaration :
Ast_iterator.iterator -> Parsetree.constructor_declaration -> unit;
expr : Ast_iterator.iterator -> Parsetree.expression -> unit;
extension : Ast_iterator.iterator -> Parsetree.extension -> unit;
extension_constructor :
Ast_iterator.iterator -> Parsetree.extension_constructor -> unit;
include_declaration :
Ast_iterator.iterator -> Parsetree.include_declaration -> unit;
include_description :
Ast_iterator.iterator -> Parsetree.include_description -> unit;
label_declaration :
Ast_iterator.iterator -> Parsetree.label_declaration -> unit;
location : Ast_iterator.iterator -> Location.t -> unit;
module_binding :
Ast_iterator.iterator -> Parsetree.module_binding -> unit;
module_declaration :
Ast_iterator.iterator -> Parsetree.module_declaration -> unit;
module_expr : Ast_iterator.iterator -> Parsetree.module_expr -> unit;
module_type : Ast_iterator.iterator -> Parsetree.module_type -> unit;
module_type_declaration :
Ast_iterator.iterator -> Parsetree.module_type_declaration -> unit;
open_description :
Ast_iterator.iterator -> Parsetree.open_description -> unit;
pat : Ast_iterator.iterator -> Parsetree.pattern -> unit;
payload : Ast_iterator.iterator -> Parsetree.payload -> unit;
signature : Ast_iterator.iterator -> Parsetree.signature -> unit;
signature_item :
Ast_iterator.iterator -> Parsetree.signature_item -> unit;
structure : Ast_iterator.iterator -> Parsetree.structure -> unit;
structure_item :
Ast_iterator.iterator -> Parsetree.structure_item -> unit;
typ : Ast_iterator.iterator -> Parsetree.core_type -> unit;
type_declaration :
Ast_iterator.iterator -> Parsetree.type_declaration -> unit;
type_extension :
Ast_iterator.iterator -> Parsetree.type_extension -> unit;
type_kind : Ast_iterator.iterator -> Parsetree.type_kind -> unit;
value_binding : Ast_iterator.iterator -> Parsetree.value_binding -> unit;
value_description :
Ast_iterator.iterator -> Parsetree.value_description -> unit;
with_constraint :
Ast_iterator.iterator -> Parsetree.with_constraint -> unit;
}
val default_iterator : Ast_iterator.iterator
end ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.Thing.html 0000644 0001750 0001750 00000017111 13131636444 023123 0 ustar mehdi mehdi
sig
type t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : Pervasives.out_channel -> Identifiable.Thing.t -> unit
val print : Format.formatter -> Identifiable.Thing.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/Spacetime.Snapshot.html 0000644 0001750 0001750 00000020024 13131636450 022135 0 ustar mehdi mehdi
module Snapshot:sig..end
val take : ?time:float -> Spacetime.Series.t -> unittake series takes a snapshot of the profiling annotations on the values
in the minor and major heaps, together with GC stats, and write the
result to the series file. This function triggers a minor GC but does
not allocate any memory itself.
If the optional time is specified, it will be used instead of the
result of Sys.time as the timestamp of the snapshot. Such times
should start from zero and be monotonically increasing. This parameter
is intended to be used so that snapshots can be correlated against wall
clock time (which is not supported in the standard library) rather than
elapsed CPU time.sig
val register : string -> 'a -> unit
val register_exception : string -> exn -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Sys.html 0000644 0001750 0001750 00000035251 13131636451 020255 0 ustar mehdi mehdi
sig
val argv : string array
val executable_name : string
external file_exists : string -> bool = "caml_sys_file_exists"
external is_directory : string -> bool = "caml_sys_is_directory"
external remove : string -> unit = "caml_sys_remove"
external rename : string -> string -> unit = "caml_sys_rename"
external getenv : string -> string = "caml_sys_getenv"
val getenv_opt : string -> string option
external command : string -> int = "caml_sys_system_command"
external time : unit -> (float [@unboxed]) = "caml_sys_time"
"caml_sys_time_unboxed" [@@noalloc]
external chdir : string -> unit = "caml_sys_chdir"
external getcwd : unit -> string = "caml_sys_getcwd"
external readdir : string -> string array = "caml_sys_read_directory"
val interactive : bool Pervasives.ref
val os_type : string
type backend_type = Native | Bytecode | Other of string
val backend_type : Sys.backend_type
val unix : bool
val win32 : bool
val cygwin : bool
val word_size : int
val int_size : int
val big_endian : bool
val max_string_length : int
val max_array_length : int
external runtime_variant : unit -> string = "caml_runtime_variant"
external runtime_parameters : unit -> string = "caml_runtime_parameters"
type signal_behavior =
Signal_default
| Signal_ignore
| Signal_handle of (int -> unit)
external signal : int -> Sys.signal_behavior -> Sys.signal_behavior
= "caml_install_signal_handler"
val set_signal : int -> Sys.signal_behavior -> unit
val sigabrt : int
val sigalrm : int
val sigfpe : int
val sighup : int
val sigill : int
val sigint : int
val sigkill : int
val sigpipe : int
val sigquit : int
val sigsegv : int
val sigterm : int
val sigusr1 : int
val sigusr2 : int
val sigchld : int
val sigcont : int
val sigstop : int
val sigtstp : int
val sigttin : int
val sigttou : int
val sigvtalrm : int
val sigprof : int
val sigbus : int
val sigpoll : int
val sigsys : int
val sigtrap : int
val sigurg : int
val sigxcpu : int
val sigxfsz : int
exception Break
val catch_break : bool -> unit
val ocaml_version : string
val enable_runtime_warnings : bool -> unit
val runtime_warnings_enabled : unit -> bool
external opaque_identity : 'a -> 'a = "%opaque"
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Map.S.html 0000644 0001750 0001750 00000066240 13131636446 022447 0 ustar mehdi mehdi
sig
type key
and +'a t
val empty : 'a MoreLabels.Map.S.t
val is_empty : 'a MoreLabels.Map.S.t -> bool
val mem : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> bool
val add :
key:MoreLabels.Map.S.key ->
data:'a -> 'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val singleton : MoreLabels.Map.S.key -> 'a -> 'a MoreLabels.Map.S.t
val remove :
MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val merge :
f:(MoreLabels.Map.S.key -> 'a option -> 'b option -> 'c option) ->
'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t -> 'c MoreLabels.Map.S.t
val union :
f:(MoreLabels.Map.S.key -> 'a -> 'a -> 'a option) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val compare :
cmp:('a -> 'a -> int) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> int
val equal :
cmp:('a -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> bool
val iter :
f:(key:MoreLabels.Map.S.key -> data:'a -> unit) ->
'a MoreLabels.Map.S.t -> unit
val fold :
f:(key:MoreLabels.Map.S.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Map.S.t -> init:'b -> 'b
val for_all :
f:(MoreLabels.Map.S.key -> 'a -> bool) -> 'a MoreLabels.Map.S.t -> bool
val exists :
f:(MoreLabels.Map.S.key -> 'a -> bool) -> 'a MoreLabels.Map.S.t -> bool
val filter :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val partition :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t * 'a MoreLabels.Map.S.t
val cardinal : 'a MoreLabels.Map.S.t -> int
val bindings : 'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) list
val min_binding : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val min_binding_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val max_binding : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val max_binding_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val choose : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val choose_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val split :
MoreLabels.Map.S.key ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t * 'a option * 'a MoreLabels.Map.S.t
val find : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a
val find_opt : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a option
val find_first :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val find_first_opt :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val find_last :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val find_last_opt :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val map : f:('a -> 'b) -> 'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t
val mapi :
f:(MoreLabels.Map.S.key -> 'a -> 'b) ->
'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t
end ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.S.html 0000644 0001750 0001750 00000133733 13131636445 022266 0 ustar mehdi mehdi
sig
type t
module T :
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : Pervasives.out_channel -> Identifiable.S.t -> unit
val print : Format.formatter -> Identifiable.S.t -> unit
val to_string : Identifiable.S.t -> string
val of_list : elt list -> Identifiable.S.t
val map : (elt -> elt) -> Identifiable.S.t -> Identifiable.S.t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map :
'a Identifiable.S.t ->
f:(key -> 'a -> 'b option) -> 'b Identifiable.S.t
val of_list : (key * 'a) list -> 'a Identifiable.S.t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_right :
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_left :
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_merge :
('a -> 'a -> 'a) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val rename : key Identifiable.S.t -> key -> key
val map_keys :
(key -> key) -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val keys : 'a Identifiable.S.t -> Identifiable.S.Set.t
val data : 'a Identifiable.S.t -> 'a list
val of_set : (key -> 'a) -> Identifiable.S.Set.t -> 'a Identifiable.S.t
val transpose_keys_and_data :
key Identifiable.S.t -> key Identifiable.S.t
val transpose_keys_and_data_set :
key Identifiable.S.t -> Identifiable.S.Set.t Identifiable.S.t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a Identifiable.S.t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a Identifiable.S.t -> (Identifiable.S.T.t * 'a) list
val of_list : (Identifiable.S.T.t * 'a) list -> 'a Identifiable.S.t
val to_map : 'a Identifiable.S.t -> 'a Identifiable.S.Map.t
val of_map : 'a Identifiable.S.Map.t -> 'a Identifiable.S.t
val memoize : 'a Identifiable.S.t -> (key -> 'a) -> key -> 'a
val map : 'a Identifiable.S.t -> ('a -> 'b) -> 'b Identifiable.S.t
end
end ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.K1.html 0000644 0001750 0001750 00000056163 13131636443 021701 0 ustar mehdi mehdi
sig
type ('k, 'd) t
val create : unit -> ('k, 'd) Ephemeron.K1.t
val get_key : ('k, 'd) Ephemeron.K1.t -> 'k option
val get_key_copy : ('k, 'd) Ephemeron.K1.t -> 'k option
val set_key : ('k, 'd) Ephemeron.K1.t -> 'k -> unit
val unset_key : ('k, 'd) Ephemeron.K1.t -> unit
val check_key : ('k, 'd) Ephemeron.K1.t -> bool
val blit_key : ('k, 'a) Ephemeron.K1.t -> ('k, 'b) Ephemeron.K1.t -> unit
val get_data : ('k, 'd) Ephemeron.K1.t -> 'd option
val get_data_copy : ('k, 'd) Ephemeron.K1.t -> 'd option
val set_data : ('k, 'd) Ephemeron.K1.t -> 'd -> unit
val unset_data : ('k, 'd) Ephemeron.K1.t -> unit
val check_data : ('k, 'd) Ephemeron.K1.t -> bool
val blit_data : ('a, 'd) Ephemeron.K1.t -> ('b, 'd) Ephemeron.K1.t -> unit
module Make :
functor (H : Hashtbl.HashedType) ->
sig
type key = H.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module MakeSeeded :
functor (H : Hashtbl.SeededHashedType) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Te.html 0000644 0001750 0001750 00000023411 13131636441 021065 0 ustar mehdi mehdi
module Te:sig..end
val mk : ?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
?priv:Asttypes.private_flag ->
Ast_helper.lid ->
Parsetree.extension_constructor list -> Parsetree.type_extension
val constructor : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
Ast_helper.str ->
Parsetree.extension_constructor_kind -> Parsetree.extension_constructor
val decl : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
?args:Parsetree.constructor_arguments ->
?res:Parsetree.core_type -> Ast_helper.str -> Parsetree.extension_constructor
val rebind : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
Ast_helper.str -> Ast_helper.lid -> Parsetree.extension_constructor ocaml-doc-4.05/ocaml.html/libref/MoreLabels.Hashtbl.html 0000644 0001750 0001750 00000032272 13131636446 022053 0 ustar mehdi mehdi
module Hashtbl:sig..end
type('a, 'b)t =('a, 'b) Hashtbl.t
val create : ?random:bool -> int -> ('a, 'b) t
val clear : ('a, 'b) t -> unit
val reset : ('a, 'b) t -> unit
val copy : ('a, 'b) t -> ('a, 'b) t
val add : ('a, 'b) t -> key:'a -> data:'b -> unit
val find : ('a, 'b) t -> 'a -> 'b
val find_opt : ('a, 'b) t -> 'a -> 'b option
val find_all : ('a, 'b) t -> 'a -> 'b list
val mem : ('a, 'b) t -> 'a -> bool
val remove : ('a, 'b) t -> 'a -> unit
val replace : ('a, 'b) t -> key:'a -> data:'b -> unit
val iter : f:(key:'a -> data:'b -> unit) -> ('a, 'b) t -> unit
val filter_map_inplace : f:(key:'a -> data:'b -> 'b option) -> ('a, 'b) t -> unit
val fold : f:(key:'a -> data:'b -> 'c -> 'c) ->
('a, 'b) t -> init:'c -> 'c
val length : ('a, 'b) t -> int
val randomize : unit -> unit
val is_randomized : unit -> bool
typestatistics =Hashtbl.statistics
val stats : ('a, 'b) t -> statistics
module type HashedType = Hashtbl.HashedType
module type SeededHashedType = Hashtbl.SeededHashedType
module type S =sig..end
module type SeededS =sig..end
module Make:
module MakeSeeded:
val hash : 'a -> int
val seeded_hash : int -> 'a -> int
val hash_param : int -> int -> 'a -> int
val seeded_hash_param : int -> int -> int -> 'a -> int ocaml-doc-4.05/ocaml.html/libref/Consistbl.html 0000644 0001750 0001750 00000021650 13131636443 020375 0 ustar mehdi mehdi
module Consistbl:sig..end
type
val create : unit -> t
val clear : t -> unit
val check : t -> string -> Digest.t -> string -> unit
val check_noadd : t -> string -> Digest.t -> string -> unit
val set : t -> string -> Digest.t -> string -> unit
val source : t -> string -> string
val extract : string list -> t -> (string * Digest.t option) list
val filter : (string -> bool) -> t -> unit
exception Inconsistency of string * string * string
exception Not_available of string
ocaml-doc-4.05/ocaml.html/libref/CamlinternalOO.html 0000644 0001750 0001750 00000063013 13131636443 021303 0 ustar mehdi mehdi
module CamlinternalOO:sig..end
type
type
type
type
type
type
type
val public_method_label : string -> tag
val new_method : table -> label
val new_variable : table -> string -> int
val new_methods_variables : table ->
string array -> string array -> label array
val get_variable : table -> string -> int
val get_variables : table -> string array -> int array
val get_method_label : table -> string -> label
val get_method_labels : table -> string array -> label array
val get_method : table -> label -> meth
val set_method : table -> label -> meth -> unit
val set_methods : table -> label array -> unit
val narrow : table -> string array -> string array -> string array -> unit
val widen : table -> unit
val add_initializer : table -> (obj -> unit) -> unit
val dummy_table : table
val create_table : string array -> table
val init_class : table -> unit
val inherits : table ->
string array ->
string array ->
string array ->
t * (table -> obj -> Obj.t) *
t * obj -> bool -> Obj.t array
val make_class : string array ->
(table -> Obj.t -> t) ->
t * (table -> Obj.t -> t) *
(Obj.t -> t) * Obj.t
type
val make_class_store : string array ->
(table -> t) ->
init_table -> unit
val dummy_class : string * int * int ->
t * (table -> Obj.t -> t) *
(Obj.t -> t) * Obj.tval copy : (< .. > as 'a) -> 'a
val create_object : table -> obj
val create_object_opt : obj -> table -> obj
val run_initializers : obj -> table -> unit
val run_initializers_opt : obj ->
obj -> table -> obj
val create_object_and_run_initializers : obj -> table -> obj
val send : obj -> tag -> t
val sendcache : obj ->
tag -> t -> int -> t
val sendself : obj -> label -> t
val get_public_method : obj -> tag -> closuretype
val lookup_tables : tables ->
closure array -> tablestype
| |
GetConst |
| |
GetVar |
| |
GetEnv |
| |
GetMeth |
| |
SetVar |
| |
AppConst |
| |
AppVar |
| |
AppEnv |
| |
AppMeth |
| |
AppConstConst |
| |
AppConstVar |
| |
AppConstEnv |
| |
AppConstMeth |
| |
AppVarConst |
| |
AppEnvConst |
| |
AppMethConst |
| |
MethAppConst |
| |
MethAppVar |
| |
MethAppEnv |
| |
MethAppMeth |
| |
SendConst |
| |
SendVar |
| |
SendEnv |
| |
SendMeth |
| |
Closure of |
type
|
mutable compact_table : |
|
mutable copy_parent : |
|
mutable clean_when_copying : |
|
mutable retry_count : |
|
mutable bucket_small_size : |
val params : paramstype
|
classes : |
|
methods : |
|
inst_vars : |
val stats : unit -> stats ocaml-doc-4.05/ocaml.html/libref/Weak.Make.html 0000644 0001750 0001750 00000034554 13131636452 020207 0 ustar mehdi mehdi
module Make:
H.equal can't be the physical equality, since only shallow
copies of the elements in the set are given to it.| Parameters: |
|
type
type
data.
Note that weak hash sets cannot be marshaled using
output_value or the functions of the Marshal
module.val create : int -> tcreate n creates a new empty weak hash set, of initial
size n. The table will grow as needed.val clear : t -> unitval merge : t -> data -> datamerge t x returns an instance of x found in t if any,
or else adds x to t and return x.val add : t -> data -> unitadd t x adds x to t. If there is already an instance
of x in t, it is unspecified which one will be
returned by subsequent calls to find and merge.val remove : t -> data -> unitremove t x removes from t one instance of x. Does
nothing if there is no instance of x in t.val find : t -> data -> datafind t x returns an instance of x found in t.
Raise Not_found if there is no such element.val find_opt : t -> data -> data optionfind_opt t x returns an instance of x found in t
or None if there is no such element.val find_all : t -> data -> data listfind_all t x returns a list of all the instances of x
found in t.val mem : t -> data -> boolmem t x returns true if there is at least one instance
of x in t, false otherwise.val iter : (data -> unit) -> t -> unititer f t calls f on each element of t, in some unspecified
order. It is not specified what happens if f tries to change
t itself.val fold : (data -> 'a -> 'a) -> t -> 'a -> 'afold f t init computes (f d1 (... (f dN init))) where
d1 ... dN are the elements of t in some unspecified order.
It is not specified what happens if f tries to change t
itself.val count : t -> intcount t gives the
same result as fold (fun _ n -> n+1) t 0 but does not delay the
deallocation of the dead elements.val stats : t -> int * int * int * int * int * intmodule Make:
| Parameters: |
|
type
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) ->
'a t -> unit
val filter_map_inplace : f:(key:key -> data:'a -> 'a option) ->
'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) ->
'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> MoreLabels.Hashtbl.statistics ocaml-doc-4.05/ocaml.html/libref/Format.html 0000644 0001750 0001750 00000213015 13131636444 017664 0 ustar mehdi mehdi
module Format:sig..end
This module implements a pretty-printing facility to format values within 'pretty-printing boxes'. The pretty-printer splits lines at specified break hints, and indents lines according to the box structure.
For a gentle introduction to the basics of pretty-printing using
Format, read
http://caml.inria.fr/resources/doc/guides/format.en.html.
You may consider this module as providing an extension to the
printf facility to provide automatic line splitting. The addition of
pretty-printing annotations to your regular printf formats gives you
fancy indentation and line breaks.
Pretty-printing annotations are described below in the documentation of
the function Format.fprintf.
You may also use the explicit box management and printing functions
provided by this module. This style is more basic but more verbose
than the fprintf concise formats.
For instance, the sequence
open_box 0; print_string "x ="; print_space ();
that prints
print_int 1; close_box (); print_newline ()x = 1 within a pretty-printing box, can be
abbreviated as printf "@[%s@ %i@]@." "x =" 1, or even shorter
printf "@[x =@ %i@]@." 1.
Rule of thumb for casual users of this library:
open_box 0);print_cut () that outputs a
simple break hint, or by print_space () that outputs a space
indicating a break hint);print_int and print_string);close_box () to
close the box;print_newline ().open_ functions below must be closed using close_box
for proper formatting. Otherwise, some of the material printed in the
boxes may not be output, or may be formatted incorrectly.
In case of interactive use, the system closes all opened boxes and
flushes all pending text (as with the print_newline function)
after each phrase. Each phrase is therefore executed in the initial
state of the pretty-printer.
Warning: the material output by the following functions is delayed
in the pretty-printer queue in order to compute the proper line
splitting. Hence, you should not mix calls to the printing functions
of the basic I/O system with calls to the functions of this module:
this could result in some strange output seemingly unrelated with
the evaluation order of printing commands.
val open_box : int -> unitopen_box d opens a new pretty-printing box
with offset d.
This box prints material as much as possible on every line.
A break hint splits the line if there is no more room on the line to print the remainder of the box. A break hint also splits the line if the splitting ``moves to the left'' (i.e. it gives an indentation smaller than the one of the current line).
This box is the general purpose pretty-printing box.
If the pretty-printer splits the line in the box, offset d is added to
the current indentation.
val close_box : unit -> unitval print_string : string -> unitprint_string str prints str in the current box.val print_as : int -> string -> unitprint_as len str prints str in the
current box. The pretty-printer formats str as if
it were of length len.val print_int : int -> unitval print_float : float -> unitval print_char : char -> unitval print_bool : bool -> unitBreak hints are used to separate printing items and are mandatory to let the pretty-printer correctly split lines and indent items.
Simple break hints are:
val print_space : unit -> unitprint_space () the 'space' break hint:
the pretty-printer may split the line at this
point, otherwise it prints one space.
It is equivalent to print_break 1 0.val print_cut : unit -> unitprint_cut () the 'cut' break hint:
the pretty-printer may split the line at this
point, otherwise it prints nothing.
It is equivalent to print_break 0 0.val print_break : int -> int -> unitprint_break nspaces offset the 'full' break hint:
the pretty-printer may split the line at this
point, otherwise it prints nspaces spaces.
If the pretty-printer splits the line, offset is added to
the current indentation.
val print_flush : unit -> unitval print_newline : unit -> unitprint_flush followed by a new line.val force_newline : unit -> unitval print_if_newline : unit -> unitval set_margin : int -> unitset_margin d sets the right margin to d (in characters):
the pretty-printer splits lines that overflow the right margin according to
the break hints given.
Nothing happens if d is smaller than 2.
If d is too large, the right margin is set to the maximum
admissible value (which is greater than 10^9).val get_margin : unit -> intval set_max_indent : int -> unitset_max_indent d sets the maximum indentation limit of lines to d (in
characters):
once this limit is reached, new boxes are rejected to the left,
if they do not fit on the current line.
Nothing happens if d is smaller than 2.
If d is too large, the limit is set to the maximum
admissible value (which is greater than 10 ^ 9).val get_max_indent : unit -> intval set_max_boxes : int -> unitset_max_boxes max sets the maximum number of boxes simultaneously
opened.
Material inside boxes nested deeper is printed as an ellipsis (more
precisely as the text returned by get_ellipsis_text ()).
Nothing happens if max is smaller than 2.val get_max_boxes : unit -> intval over_max_boxes : unit -> boolval open_hbox : unit -> unitopen_hbox () opens a new 'horizontal' pretty-printing box.
This box prints material on a single line.
Break hints in a horizontal box never split the line.
(Line splitting may still occur inside boxes nested deeper).
val open_vbox : int -> unitopen_vbox d opens a new 'vertical' pretty-printing box
with offset d.
This box prints material on as many lines as break hints in the box.
Every break hint in a vertical box splits the line.
If the pretty-printer splits the line in the box, d is added to the
current indentation.
val open_hvbox : int -> unitopen_hvbox d opens a new 'horizontal-vertical' pretty-printing box
with offset d.
This box behaves as an horizontal box if it fits on a single line, otherwise it behaves as a vertical box.
If the pretty-printer splits the line in the box, d is added to the
current indentation.
val open_hovbox : int -> unitopen_hovbox d opens a new 'horizontal-or-vertical' pretty-printing box
with offset d.
This box prints material as much as possible on every line.
A break hint splits the line if there is no more room on the line to print the remainder of the box.
If the pretty-printer splits the line in the box, d is added to the
current indentation.
val set_ellipsis_text : string -> unit., by default).val get_ellipsis_text : unit -> stringtypetag =string
By default, those tags do not influence line splitting calculation: the tag 'markers' are not considered as part of the printing material that drives line splitting (in other words, the length of those strings is considered as zero for line splitting).
Thus, tag handling is in some sense transparent to pretty-printing
and does not interfere with usual indentation. Hence, a single
pretty printing routine can output both simple 'verbatim'
material or richer decorated output depending on the treatment of
tags. By default, tags are not active, hence the output is not
decorated with tag information. Once set_tags is set to true,
the pretty printer engine honours tags and decorates the output
accordingly.
When a tag has been opened (or closed), it is both and successively 'printed' and 'marked'. Printing a tag means calling a formatter specific function with the name of the tag as argument: that 'tag printing' function can then print any regular material to the formatter (so that this material is enqueued as usual in the formatter queue for further line splitting computation). Marking a tag means to output an arbitrary string (the 'tag marker'), directly into the output device of the formatter. Hence, the formatter specific 'tag marking' function must return the tag marker string associated to its tag argument. Being flushed directly into the output device of the formatter, tag marker strings are not considered as part of the printing material that drives line splitting (in other words, the length of the strings corresponding to tag markers is considered as zero for line splitting). In addition, advanced users may take advantage of the specificity of tag markers to be precisely output when the pretty printer has already decided where to split the lines, and precisely when the queue is flushed into the output device.
In the spirit of HTML tags, the default tag marking functions
output tags enclosed in "<" and ">": hence, the opening marker of
tag t is "<t>" and the closing marker "</t>".
Default tag printing functions just do nothing.
Tag marking and tag printing functions are user definable and can
be set by calling set_formatter_tag_functions.
val open_tag : tag -> unitopen_tag t opens the tag named t; the print_open_tag
function of the formatter is called with t as argument;
the tag marker mark_open_tag t will be flushed into the output
device of the formatter.val close_tag : unit -> unitclose_tag () closes the most recently opened tag t.
In addition, the print_close_tag function of the formatter is called
with t as argument. The marker mark_close_tag t will be flushed
into the output device of the formatter. : bool -> unitset_tags b turns on or off the treatment of tags (default is off). : bool -> unitset_print_tags b turns on or off the printing of tags. : bool -> unitset_mark_tags b turns on or off the output of tag markers. : unit -> bool : unit -> boolval set_formatter_out_channel : out_channel -> unitval set_formatter_output_functions : (string -> int -> int -> unit) -> (unit -> unit) -> unitset_formatter_output_functions out flush redirects the
pretty-printer output functions to the functions out and
flush.
The out function performs all the pretty-printer string output.
It is called with a string s, a start position p, and a number of
characters n; it is supposed to output characters p to p + n - 1 of
s.
The flush function is called whenever the pretty-printer is flushed
(via conversion %!, or pretty-printing indications @? or @., or
using low level functions print_flush or print_newline).
val get_formatter_output_functions : unit -> (string -> int -> int -> unit) * (unit -> unit)Format module is versatile enough to let you completely redefine
the meaning of pretty printing: you may provide your own functions to define
how to handle indentation, line splitting, and even printing of all the
characters that have to be printed!type
|
out_string : |
|
out_flush : |
|
out_newline : |
|
out_spaces : |
val set_formatter_out_functions : formatter_out_functions -> unitset_formatter_out_functions f
Redirect the pretty-printer output to the functions f.out_string
and f.out_flush as described in
set_formatter_output_functions. In addition, the pretty-printer function
that outputs a newline is set to the function f.out_newline and
the function that outputs indentation spaces is set to the function
f.out_spaces.
This way, you can change the meaning of indentation (which can be
something else than just printing space characters) and the meaning of new
lines opening (which can be connected to any other action needed by the
application at hand). The two functions f.out_spaces and f.out_newline
are normally connected to f.out_string and f.out_flush: respective
default values for f.out_space and f.out_newline are
f.out_string (String.make n ' ') 0 n and f.out_string "\n" 0 1.
Since 4.01.0
val get_formatter_out_functions : unit -> formatter_out_functionstype
|
mark_open_tag : |
|
mark_close_tag : |
|
print_open_tag : |
|
print_close_tag : |
mark versions are the 'tag marking' functions that associate a string
marker to a tag in order for the pretty-printing engine to flush
those markers as 0 length tokens in the output device of the formatter.
print versions are the 'tag printing' functions that can perform
regular printing when a tag is closed or opened.val set_formatter_tag_functions : formatter_tag_functions -> unitset_formatter_tag_functions tag_funs changes the meaning of
opening and closing tags to use the functions in tag_funs.
When opening a tag name t, the string t is passed to the
opening tag marking function (the mark_open_tag field of the
record tag_funs), that must return the opening tag marker for
that name. When the next call to close_tag () happens, the tag
name t is sent back to the closing tag marking function (the
mark_close_tag field of record tag_funs), that must return a
closing tag marker for that name.
The print_ field of the record contains the functions that are
called at tag opening and tag closing time, to output regular
material in the pretty-printer queue.
val get_formatter_tag_functions : unit -> formatter_tag_functionstype
Defining new pretty-printers permits unrelated output of material in
parallel on several output channels.
All the parameters of a pretty-printer are local to a formatter:
margin, maximum indentation limit, maximum number of boxes
simultaneously opened, ellipsis, and so on, are specific to
each pretty-printer and may be fixed independently.
Given a out_channel output channel oc, a new formatter
writing to that channel is simply obtained by calling
formatter_of_out_channel oc.
Alternatively, the make_formatter function allocates a new
formatter with explicit output and flushing functions
(convenient to output material to strings for instance).
val formatter_of_out_channel : out_channel -> formatterformatter_of_out_channel oc returns a new formatter that
writes to the corresponding channel oc.val std_formatter : formatterformatter_of_out_channel stdout.val err_formatter : formatterformatter_of_out_channel stderr.val formatter_of_buffer : Buffer.t -> formatterformatter_of_buffer b returns a new formatter writing to
buffer b. As usual, the formatter has to be flushed at
the end of pretty printing, using pp_print_flush or
pp_print_newline, to display all the pending material.val stdbuf : Buffer.tstr_formatter writes.val str_formatter : formatterstdbuf string buffer.
str_formatter is defined as formatter_of_buffer stdbuf.val flush_str_formatter : unit -> stringstr_formatter, flushes
the formatter and resets the corresponding buffer.val make_formatter : (string -> int -> int -> unit) -> (unit -> unit) -> formattermake_formatter out flush returns a new formatter that writes according
to the output function out, and the flushing function flush. For
instance, a formatter to the out_channel oc is returned by
make_formatter (Pervasives.output oc) (fun () -> Pervasives.flush oc).val pp_open_hbox : formatter -> unit -> unit
val pp_open_vbox : formatter -> int -> unit
val pp_open_hvbox : formatter -> int -> unit
val pp_open_hovbox : formatter -> int -> unit
val pp_open_box : formatter -> int -> unit
val pp_close_box : formatter -> unit -> unit
val pp_open_tag : formatter -> string -> unit
val pp_close_tag : formatter -> unit -> unit
val pp_print_string : formatter -> string -> unit
val pp_print_as : formatter -> int -> string -> unit
val pp_print_int : formatter -> int -> unit
val pp_print_float : formatter -> float -> unit
val pp_print_char : formatter -> char -> unit
val pp_print_bool : formatter -> bool -> unit
val pp_print_break : formatter -> int -> int -> unit
val pp_print_cut : formatter -> unit -> unit
val pp_print_space : formatter -> unit -> unit
val pp_force_newline : formatter -> unit -> unit
val pp_print_flush : formatter -> unit -> unit
val pp_print_newline : formatter -> unit -> unit
val pp_print_if_newline : formatter -> unit -> unit
: formatter -> bool -> unit
: formatter -> bool -> unit
: formatter -> bool -> unit
: formatter -> unit -> bool
: formatter -> unit -> bool
val pp_set_margin : formatter -> int -> unit
val pp_get_margin : formatter -> unit -> int
val pp_set_max_indent : formatter -> int -> unit
val pp_get_max_indent : formatter -> unit -> int
val pp_set_max_boxes : formatter -> int -> unit
val pp_get_max_boxes : formatter -> unit -> int
val pp_over_max_boxes : formatter -> unit -> bool
val pp_set_ellipsis_text : formatter -> string -> unit
val pp_get_ellipsis_text : formatter -> unit -> string
val pp_set_formatter_out_channel : formatter -> out_channel -> unit
val pp_set_formatter_output_functions : formatter -> (string -> int -> int -> unit) -> (unit -> unit) -> unit
val pp_get_formatter_output_functions : formatter -> unit -> (string -> int -> int -> unit) * (unit -> unit)
val pp_set_formatter_tag_functions : formatter -> formatter_tag_functions -> unit
val pp_get_formatter_tag_functions : formatter -> unit -> formatter_tag_functions
val pp_set_formatter_out_functions : formatter -> formatter_out_functions -> unitval pp_get_formatter_out_functions : formatter -> unit -> formatter_out_functionsprint_string is equal to pp_print_string std_formatter.val pp_flush_formatter : formatter -> unitpp_flush_formatter fmt flushes fmt's internal queue, ensuring that all
the printing and flushing actions have been performed. In addition, this
operation will close all boxes and reset the state of the formatter.
This will not flush fmt's output. In most cases, the user may want to use
Format.pp_print_flush instead.
Since 4.04.0
val pp_print_list : ?pp_sep:(formatter -> unit -> unit) ->
(formatter -> 'a -> unit) -> formatter -> 'a list -> unitpp_print_list ?pp_sep pp_v ppf l prints items of list l,
using pp_v to print each item, and calling pp_sep
between items (pp_sep defaults to Format.pp_print_cut).
Does nothing on empty lists.val pp_print_text : formatter -> string -> unitpp_print_text ppf s prints s with spaces and newlines
respectively printed with Format.pp_print_space and
Format.pp_force_newline.printf like functions for pretty-printing.val fprintf : formatter -> ('a, formatter, unit) format -> 'afprintf ff fmt arg1 ... argN formats the arguments arg1 to argN
according to the format string fmt, and outputs the resulting string on
the formatter ff.
The format fmt is a character string which contains three types of
objects: plain characters and conversion specifications as specified in
the Printf module, and pretty-printing indications specific to the
Format module.
The pretty-printing indication characters are introduced by
a @ character, and their meanings are:
@[: open a pretty-printing box. The type and offset of the
box may be optionally specified with the following syntax:
the < character, followed by an optional box type indication,
then an optional integer offset, and the closing > character.
Box type is one of h, v, hv, b, or hov.
'h' stands for an 'horizontal' box,
'v' stands for a 'vertical' box,
'hv' stands for an 'horizontal-vertical' box,
'b' stands for an 'horizontal-or-vertical' box demonstrating indentation,
'hov' stands a simple 'horizontal-or-vertical' box.
For instance, @[<hov 2> opens an 'horizontal-or-vertical'
box with indentation 2 as obtained with open_hovbox 2.
For more details about boxes, see the various box opening
functions open_*box.@]: close the most recently opened pretty-printing box.@,: output a 'cut' break hint, as with print_cut ().@ : output a 'space' break hint, as with print_space ().@;: output a 'full' break hint as with print_break. The
nspaces and offset parameters of the break hint may be
optionally specified with the following syntax:
the < character, followed by an integer nspaces value,
then an integer offset, and a closing > character.
If no parameters are provided, the good break defaults to a
'space' break hint.@.: flush the pretty printer and split the line, as with
print_newline ().@<n>: print the following item as if it were of length n.
Hence, printf "@<0>%s" arg prints arg as a zero length string.
If @<n> is not followed by a conversion specification,
then the following character of the format is printed as if
it were of length n.@{: open a tag. The name of the tag may be optionally
specified with the following syntax:
the < character, followed by an optional string
specification, and the closing > character. The string
specification is any character string that does not contain the
closing character '>'. If omitted, the tag name defaults to the
empty string.
For more details about tags, see the functions open_tag and
close_tag.@}: close the most recently opened tag.@?: flush the pretty printer as with print_flush ().
This is equivalent to the conversion %!.@\n: force a newline, as with force_newline (), not the normal way
of pretty-printing, you should prefer using break hints inside a vertical
box.@ character as a
pretty-printing indication, you must escape it with a % character.
Old quotation mode @@ is deprecated since it is not compatible with
formatted input interpretation of character '@'.
Example: printf "@[%s@ %d@]@." "x =" 1 is equivalent to
open_box (); print_string "x ="; print_space ();.
It prints
print_int 1; close_box (); print_newline ()x = 1 within a pretty-printing 'horizontal-or-vertical' box.
val printf : ('a, formatter, unit) format -> 'afprintf above, but output on std_formatter.val eprintf : ('a, formatter, unit) format -> 'afprintf above, but output on err_formatter.val sprintf : ('a, unit, string) format -> 'aprintf above, but instead of printing on a formatter,
returns a string containing the result of formatting the arguments.
Note that the pretty-printer queue is flushed at the end of each
call to sprintf.
In case of multiple and related calls to sprintf to output
material on a single string, you should consider using fprintf
with the predefined formatter str_formatter and call
flush_str_formatter () to get the final result.
Alternatively, you can use Format.fprintf with a formatter writing to a
buffer of your own: flushing the formatter and the buffer at the end of
pretty-printing returns the desired string.
val asprintf : ('a, formatter, unit, string) format4 -> 'aprintf above, but instead of printing on a formatter,
returns a string containing the result of formatting the arguments.
The type of asprintf is general enough to interact nicely with %a
conversions.val ifprintf : formatter -> ('a, formatter, unit) format -> 'afprintf above, but does not print anything.
Useful to ignore some material when conditionally printing.val kfprintf : (formatter -> 'a) ->
formatter -> ('b, formatter, unit, 'a) format4 -> 'bfprintf above, but instead of returning immediately,
passes the formatter to its first argument at the end of printing.val ikfprintf : (formatter -> 'a) ->
formatter -> ('b, formatter, unit, 'a) format4 -> 'bkfprintf above, but does not print anything.
Useful to ignore some material when conditionally printing.val ksprintf : (string -> 'a) -> ('b, unit, string, 'a) format4 -> 'bsprintf above, but instead of returning the string,
passes it to the first argument.val kasprintf : (string -> 'a) -> ('b, formatter, unit, 'a) format4 -> 'basprintf above, but instead of returning the string,
passes it to the first argument.val bprintf : Buffer.t -> ('a, formatter, unit) format -> 'a
If you need to print to some buffer b, you must first define a
formatter writing to b, using let to_b = formatter_of_buffer b; then
use regular calls to Format.fprintf on formatter to_b.
val kprintf : (string -> 'a) -> ('b, unit, string, 'a) format4 -> 'bksprintf.val set_all_formatter_output_functions : out:(string -> int -> int -> unit) ->
flush:(unit -> unit) ->
newline:(unit -> unit) -> spaces:(int -> unit) -> unitset_formatter_out_functions.val get_all_formatter_output_functions : unit ->
(string -> int -> int -> unit) * (unit -> unit) * (unit -> unit) *
(int -> unit)get_formatter_out_functions.val pp_set_all_formatter_output_functions : formatter ->
out:(string -> int -> int -> unit) ->
flush:(unit -> unit) ->
newline:(unit -> unit) -> spaces:(int -> unit) -> unitpp_set_formatter_out_functions.val pp_get_all_formatter_output_functions : formatter ->
unit ->
(string -> int -> int -> unit) * (unit -> unit) * (unit -> unit) *
(int -> unit)pp_get_formatter_out_functions.val pp_open_tbox : formatter -> unit -> unitval pp_close_tbox : formatter -> unit -> unitval pp_print_tbreak : formatter -> int -> int -> unitval pp_set_tab : formatter -> unit -> unitval pp_print_tab : formatter -> unit -> unitval open_tbox : unit -> unitval close_tbox : unit -> unitval print_tbreak : int -> int -> unitval set_tab : unit -> unitval print_tab : unit -> unitsig
type t = float
module T :
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
val to_string : t -> string
val of_list : elt list -> t
val map : (elt -> elt) -> t -> t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map : 'a t -> f:(key -> 'a -> 'b option) -> 'b t
val of_list : (key * 'a) list -> 'a t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) -> 'a t -> 'a t -> 'a t
val union_right : 'a t -> 'a t -> 'a t
val union_left : 'a t -> 'a t -> 'a t
val union_merge : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val rename : key t -> key -> key
val map_keys : (key -> key) -> 'a t -> 'a t
val keys : 'a t -> Set.t
val data : 'a t -> 'a list
val of_set : (key -> 'a) -> Set.t -> 'a t
val transpose_keys_and_data : key t -> key t
val transpose_keys_and_data_set : key t -> Set.t t
val print :
(Format.formatter -> 'a -> unit) -> Format.formatter -> 'a t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a t -> (T.t * 'a) list
val of_list : (T.t * 'a) list -> 'a t
val to_map : 'a t -> 'a Map.t
val of_map : 'a Map.t -> 'a t
val memoize : 'a t -> (key -> 'a) -> key -> 'a
val map : 'a t -> ('a -> 'b) -> 'b t
end
end ocaml-doc-4.05/ocaml.html/libref/type_Warnings.html 0000644 0001750 0001750 00000043716 13131636452 021275 0 ustar mehdi mehdi
sig
type t =
Comment_start
| Comment_not_end
| Deprecated of string
| Fragile_match of string
| Partial_application
| Labels_omitted of string list
| Method_override of string list
| Partial_match of string
| Non_closed_record_pattern of string
| Statement_type
| Unused_match
| Unused_pat
| Instance_variable_override of string list
| Illegal_backslash
| Implicit_public_methods of string list
| Unerasable_optional_argument
| Undeclared_virtual_method of string
| Not_principal of string
| Without_principality of string
| Unused_argument
| Nonreturning_statement
| Preprocessor of string
| Useless_record_with
| Bad_module_name of string
| All_clauses_guarded
| Unused_var of string
| Unused_var_strict of string
| Wildcard_arg_to_constant_constr
| Eol_in_string
| Duplicate_definitions of string * string * string * string
| Multiple_definition of string * string * string
| Unused_value_declaration of string
| Unused_open of string
| Unused_type_declaration of string
| Unused_for_index of string
| Unused_ancestor of string
| Unused_constructor of string * bool * bool
| Unused_extension of string * bool * bool * bool
| Unused_rec_flag
| Name_out_of_scope of string * string list * bool
| Ambiguous_name of string list * string list * bool
| Disambiguated_name of string
| Nonoptional_label of string
| Open_shadow_identifier of string * string
| Open_shadow_label_constructor of string * string
| Bad_env_variable of string * string
| Attribute_payload of string * string
| Eliminated_optional_arguments of string list
| No_cmi_file of string * string option
| Bad_docstring of bool
| Expect_tailcall
| Fragile_literal_pattern
| Misplaced_attribute of string
| Duplicated_attribute of string
| Inlining_impossible of string
| Unreachable_case
| Ambiguous_pattern of string list
| No_cmx_file of string
| Assignment_to_non_mutable_value
| Unused_module of string
| Unboxable_type_in_prim_decl of string
val parse_options : bool -> string -> unit
val is_active : Warnings.t -> bool
val is_error : Warnings.t -> bool
val defaults_w : string
val defaults_warn_error : string
val print : Format.formatter -> Warnings.t -> unit
exception Errors of int
val check_fatal : unit -> unit
val reset_fatal : unit -> unit
val help_warnings : unit -> unit
type state
val backup : unit -> Warnings.state
val restore : Warnings.state -> unit
end ocaml-doc-4.05/ocaml.html/libref/Lexer.html 0000644 0001750 0001750 00000027655 13131636445 017531 0 ustar mehdi mehdi
module Lexer:sig..end
val init : unit -> unit
val token : Lexing.lexbuf -> Parser.token
val skip_hash_bang : Lexing.lexbuf -> unit
type
| |
Illegal_character of |
| |
Illegal_escape of |
| |
Unterminated_comment of |
| |
Unterminated_string |
| |
Unterminated_string_in_comment of |
| |
Keyword_as_label of |
| |
Invalid_literal of |
| |
Invalid_directive of |
exception Error of error * Location.t
val report_error : Format.formatter -> error -> unit
val in_comment : unit -> bool
val in_string : unit -> bool
val print_warnings : bool ref
val handle_docstrings : bool ref
val comments : unit -> (string * Location.t) list
val token_with_comments : Lexing.lexbuf -> Parser.token
val set_preprocessor : (unit -> unit) ->
((Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parser.token) -> unit ocaml-doc-4.05/ocaml.html/libref/type_Int64.html 0000644 0001750 0001750 00000033674 13131636445 020415 0 ustar mehdi mehdi
sig
val zero : int64
val one : int64
val minus_one : int64
external neg : int64 -> int64 = "%int64_neg"
external add : int64 -> int64 -> int64 = "%int64_add"
external sub : int64 -> int64 -> int64 = "%int64_sub"
external mul : int64 -> int64 -> int64 = "%int64_mul"
external div : int64 -> int64 -> int64 = "%int64_div"
external rem : int64 -> int64 -> int64 = "%int64_mod"
val succ : int64 -> int64
val pred : int64 -> int64
val abs : int64 -> int64
val max_int : int64
val min_int : int64
external logand : int64 -> int64 -> int64 = "%int64_and"
external logor : int64 -> int64 -> int64 = "%int64_or"
external logxor : int64 -> int64 -> int64 = "%int64_xor"
val lognot : int64 -> int64
external shift_left : int64 -> int -> int64 = "%int64_lsl"
external shift_right : int64 -> int -> int64 = "%int64_asr"
external shift_right_logical : int64 -> int -> int64 = "%int64_lsr"
external of_int : int -> int64 = "%int64_of_int"
external to_int : int64 -> int = "%int64_to_int"
external of_float : float -> int64 = "caml_int64_of_float"
"caml_int64_of_float_unboxed" [@@unboxed] [@@noalloc]
external to_float : int64 -> float = "caml_int64_to_float"
"caml_int64_to_float_unboxed" [@@unboxed] [@@noalloc]
external of_int32 : int32 -> int64 = "%int64_of_int32"
external to_int32 : int64 -> int32 = "%int64_to_int32"
external of_nativeint : nativeint -> int64 = "%int64_of_nativeint"
external to_nativeint : int64 -> nativeint = "%int64_to_nativeint"
external of_string : string -> int64 = "caml_int64_of_string"
val of_string_opt : string -> int64 option
val to_string : int64 -> string
external bits_of_float : float -> int64 = "caml_int64_bits_of_float"
"caml_int64_bits_of_float_unboxed" [@@unboxed] [@@noalloc]
external float_of_bits : int64 -> float = "caml_int64_float_of_bits"
"caml_int64_float_of_bits_unboxed" [@@unboxed] [@@noalloc]
type t = int64
val compare : Int64.t -> Int64.t -> int
val equal : Int64.t -> Int64.t -> bool
external format : string -> int64 -> string = "caml_int64_format"
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Vb.html 0000644 0001750 0001750 00000017307 13131636441 021073 0 ustar mehdi mehdi
module Vb:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Parsetree.pattern -> Parsetree.expression -> Parsetree.value_binding ocaml-doc-4.05/ocaml.html/libref/type_Map.html 0000644 0001750 0001750 00000113347 13131636445 020222 0 ustar mehdi mehdi
sig
module type OrderedType =
sig
type t
val compare : Map.OrderedType.t -> Map.OrderedType.t -> int
end
module type S =
sig
type key
type +'a t
val empty : 'a Map.S.t
val is_empty : 'a Map.S.t -> bool
val mem : Map.S.key -> 'a Map.S.t -> bool
val add : Map.S.key -> 'a -> 'a Map.S.t -> 'a Map.S.t
val singleton : Map.S.key -> 'a -> 'a Map.S.t
val remove : Map.S.key -> 'a Map.S.t -> 'a Map.S.t
val merge :
(Map.S.key -> 'a option -> 'b option -> 'c option) ->
'a Map.S.t -> 'b Map.S.t -> 'c Map.S.t
val union :
(Map.S.key -> 'a -> 'a -> 'a option) ->
'a Map.S.t -> 'a Map.S.t -> 'a Map.S.t
val compare : ('a -> 'a -> int) -> 'a Map.S.t -> 'a Map.S.t -> int
val equal : ('a -> 'a -> bool) -> 'a Map.S.t -> 'a Map.S.t -> bool
val iter : (Map.S.key -> 'a -> unit) -> 'a Map.S.t -> unit
val fold : (Map.S.key -> 'a -> 'b -> 'b) -> 'a Map.S.t -> 'b -> 'b
val for_all : (Map.S.key -> 'a -> bool) -> 'a Map.S.t -> bool
val exists : (Map.S.key -> 'a -> bool) -> 'a Map.S.t -> bool
val filter : (Map.S.key -> 'a -> bool) -> 'a Map.S.t -> 'a Map.S.t
val partition :
(Map.S.key -> 'a -> bool) -> 'a Map.S.t -> 'a Map.S.t * 'a Map.S.t
val cardinal : 'a Map.S.t -> int
val bindings : 'a Map.S.t -> (Map.S.key * 'a) list
val min_binding : 'a Map.S.t -> Map.S.key * 'a
val min_binding_opt : 'a Map.S.t -> (Map.S.key * 'a) option
val max_binding : 'a Map.S.t -> Map.S.key * 'a
val max_binding_opt : 'a Map.S.t -> (Map.S.key * 'a) option
val choose : 'a Map.S.t -> Map.S.key * 'a
val choose_opt : 'a Map.S.t -> (Map.S.key * 'a) option
val split :
Map.S.key -> 'a Map.S.t -> 'a Map.S.t * 'a option * 'a Map.S.t
val find : Map.S.key -> 'a Map.S.t -> 'a
val find_opt : Map.S.key -> 'a Map.S.t -> 'a option
val find_first : (Map.S.key -> bool) -> 'a Map.S.t -> Map.S.key * 'a
val find_first_opt :
(Map.S.key -> bool) -> 'a Map.S.t -> (Map.S.key * 'a) option
val find_last : (Map.S.key -> bool) -> 'a Map.S.t -> Map.S.key * 'a
val find_last_opt :
(Map.S.key -> bool) -> 'a Map.S.t -> (Map.S.key * 'a) option
val map : ('a -> 'b) -> 'a Map.S.t -> 'b Map.S.t
val mapi : (Map.S.key -> 'a -> 'b) -> 'a Map.S.t -> 'b Map.S.t
end
module Make :
functor (Ord : OrderedType) ->
sig
type key = Ord.t
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end
end ocaml-doc-4.05/ocaml.html/libref/type_Format.html 0000644 0001750 0001750 00000115215 13131636444 020730 0 ustar mehdi mehdi
sig
val open_box : int -> unit
val close_box : unit -> unit
val print_string : string -> unit
val print_as : int -> string -> unit
val print_int : int -> unit
val print_float : float -> unit
val print_char : char -> unit
val print_bool : bool -> unit
val print_space : unit -> unit
val print_cut : unit -> unit
val print_break : int -> int -> unit
val print_flush : unit -> unit
val print_newline : unit -> unit
val force_newline : unit -> unit
val print_if_newline : unit -> unit
val set_margin : int -> unit
val get_margin : unit -> int
val set_max_indent : int -> unit
val get_max_indent : unit -> int
val set_max_boxes : int -> unit
val get_max_boxes : unit -> int
val over_max_boxes : unit -> bool
val open_hbox : unit -> unit
val open_vbox : int -> unit
val open_hvbox : int -> unit
val open_hovbox : int -> unit
val set_ellipsis_text : string -> unit
val get_ellipsis_text : unit -> string
type tag = string
val open_tag : Format.tag -> unit
val close_tag : unit -> unit
val set_tags : bool -> unit
val set_print_tags : bool -> unit
val set_mark_tags : bool -> unit
val get_print_tags : unit -> bool
val get_mark_tags : unit -> bool
val set_formatter_out_channel : Pervasives.out_channel -> unit
val set_formatter_output_functions :
(string -> int -> int -> unit) -> (unit -> unit) -> unit
val get_formatter_output_functions :
unit -> (string -> int -> int -> unit) * (unit -> unit)
type formatter_out_functions = {
out_string : string -> int -> int -> unit;
out_flush : unit -> unit;
out_newline : unit -> unit;
out_spaces : int -> unit;
}
val set_formatter_out_functions : Format.formatter_out_functions -> unit
val get_formatter_out_functions : unit -> Format.formatter_out_functions
type formatter_tag_functions = {
mark_open_tag : Format.tag -> string;
mark_close_tag : Format.tag -> string;
print_open_tag : Format.tag -> unit;
print_close_tag : Format.tag -> unit;
}
val set_formatter_tag_functions : Format.formatter_tag_functions -> unit
val get_formatter_tag_functions : unit -> Format.formatter_tag_functions
type formatter
val formatter_of_out_channel : Pervasives.out_channel -> Format.formatter
val std_formatter : Format.formatter
val err_formatter : Format.formatter
val formatter_of_buffer : Buffer.t -> Format.formatter
val stdbuf : Buffer.t
val str_formatter : Format.formatter
val flush_str_formatter : unit -> string
val make_formatter :
(string -> int -> int -> unit) -> (unit -> unit) -> Format.formatter
val pp_open_hbox : Format.formatter -> unit -> unit
val pp_open_vbox : Format.formatter -> int -> unit
val pp_open_hvbox : Format.formatter -> int -> unit
val pp_open_hovbox : Format.formatter -> int -> unit
val pp_open_box : Format.formatter -> int -> unit
val pp_close_box : Format.formatter -> unit -> unit
val pp_open_tag : Format.formatter -> string -> unit
val pp_close_tag : Format.formatter -> unit -> unit
val pp_print_string : Format.formatter -> string -> unit
val pp_print_as : Format.formatter -> int -> string -> unit
val pp_print_int : Format.formatter -> int -> unit
val pp_print_float : Format.formatter -> float -> unit
val pp_print_char : Format.formatter -> char -> unit
val pp_print_bool : Format.formatter -> bool -> unit
val pp_print_break : Format.formatter -> int -> int -> unit
val pp_print_cut : Format.formatter -> unit -> unit
val pp_print_space : Format.formatter -> unit -> unit
val pp_force_newline : Format.formatter -> unit -> unit
val pp_print_flush : Format.formatter -> unit -> unit
val pp_print_newline : Format.formatter -> unit -> unit
val pp_print_if_newline : Format.formatter -> unit -> unit
val pp_set_tags : Format.formatter -> bool -> unit
val pp_set_print_tags : Format.formatter -> bool -> unit
val pp_set_mark_tags : Format.formatter -> bool -> unit
val pp_get_print_tags : Format.formatter -> unit -> bool
val pp_get_mark_tags : Format.formatter -> unit -> bool
val pp_set_margin : Format.formatter -> int -> unit
val pp_get_margin : Format.formatter -> unit -> int
val pp_set_max_indent : Format.formatter -> int -> unit
val pp_get_max_indent : Format.formatter -> unit -> int
val pp_set_max_boxes : Format.formatter -> int -> unit
val pp_get_max_boxes : Format.formatter -> unit -> int
val pp_over_max_boxes : Format.formatter -> unit -> bool
val pp_set_ellipsis_text : Format.formatter -> string -> unit
val pp_get_ellipsis_text : Format.formatter -> unit -> string
val pp_set_formatter_out_channel :
Format.formatter -> Pervasives.out_channel -> unit
val pp_set_formatter_output_functions :
Format.formatter ->
(string -> int -> int -> unit) -> (unit -> unit) -> unit
val pp_get_formatter_output_functions :
Format.formatter ->
unit -> (string -> int -> int -> unit) * (unit -> unit)
val pp_set_formatter_tag_functions :
Format.formatter -> Format.formatter_tag_functions -> unit
val pp_get_formatter_tag_functions :
Format.formatter -> unit -> Format.formatter_tag_functions
val pp_set_formatter_out_functions :
Format.formatter -> Format.formatter_out_functions -> unit
val pp_get_formatter_out_functions :
Format.formatter -> unit -> Format.formatter_out_functions
val pp_flush_formatter : Format.formatter -> unit
val pp_print_list :
?pp_sep:(Format.formatter -> unit -> unit) ->
(Format.formatter -> 'a -> unit) -> Format.formatter -> 'a list -> unit
val pp_print_text : Format.formatter -> string -> unit
val fprintf :
Format.formatter -> ('a, Format.formatter, unit) Pervasives.format -> 'a
val printf : ('a, Format.formatter, unit) Pervasives.format -> 'a
val eprintf : ('a, Format.formatter, unit) Pervasives.format -> 'a
val sprintf : ('a, unit, string) Pervasives.format -> 'a
val asprintf :
('a, Format.formatter, unit, string) Pervasives.format4 -> 'a
val ifprintf :
Format.formatter -> ('a, Format.formatter, unit) Pervasives.format -> 'a
val kfprintf :
(Format.formatter -> 'a) ->
Format.formatter ->
('b, Format.formatter, unit, 'a) Pervasives.format4 -> 'b
val ikfprintf :
(Format.formatter -> 'a) ->
Format.formatter ->
('b, Format.formatter, unit, 'a) Pervasives.format4 -> 'b
val ksprintf :
(string -> 'a) -> ('b, unit, string, 'a) Pervasives.format4 -> 'b
val kasprintf :
(string -> 'a) ->
('b, Format.formatter, unit, 'a) Pervasives.format4 -> 'b
val bprintf :
Buffer.t -> ('a, Format.formatter, unit) Pervasives.format -> 'a
val kprintf :
(string -> 'a) -> ('b, unit, string, 'a) Pervasives.format4 -> 'b
val set_all_formatter_output_functions :
out:(string -> int -> int -> unit) ->
flush:(unit -> unit) ->
newline:(unit -> unit) -> spaces:(int -> unit) -> unit
val get_all_formatter_output_functions :
unit ->
(string -> int -> int -> unit) * (unit -> unit) * (unit -> unit) *
(int -> unit)
val pp_set_all_formatter_output_functions :
Format.formatter ->
out:(string -> int -> int -> unit) ->
flush:(unit -> unit) ->
newline:(unit -> unit) -> spaces:(int -> unit) -> unit
val pp_get_all_formatter_output_functions :
Format.formatter ->
unit ->
(string -> int -> int -> unit) * (unit -> unit) * (unit -> unit) *
(int -> unit)
val pp_open_tbox : Format.formatter -> unit -> unit
val pp_close_tbox : Format.formatter -> unit -> unit
val pp_print_tbreak : Format.formatter -> int -> int -> unit
val pp_set_tab : Format.formatter -> unit -> unit
val pp_print_tab : Format.formatter -> unit -> unit
val open_tbox : unit -> unit
val close_tbox : unit -> unit
val print_tbreak : int -> int -> unit
val set_tab : unit -> unit
val print_tab : unit -> unit
end ocaml-doc-4.05/ocaml.html/libref/Numbers.Float.html 0000644 0001750 0001750 00000020036 13131636447 021115 0 ustar mehdi mehdi
module Float:Identifiable.Swith type t = float
type
module T:Identifiable.Thingwith type t = t
include Identifiable.Thing
module Set:sig..end
module Map:sig..end
module Tbl:ocaml-doc-4.05/ocaml.html/libref/Pervasives.LargeFile.html 0000644 0001750 0001750 00000020613 13131636450 022411 0 ustar mehdi mehdisig..end
module LargeFile:sig..end
int64) instead of
regular integers (type int), these alternate functions allow
operating on files whose sizes are greater than max_int.val seek_out : out_channel -> int64 -> unit
val pos_out : out_channel -> int64
val out_channel_length : out_channel -> int64
val seek_in : in_channel -> int64 -> unit
val pos_in : in_channel -> int64
val in_channel_length : in_channel -> int64 ocaml-doc-4.05/ocaml.html/libref/Ephemeron.S.html 0000644 0001750 0001750 00000021445 13131636443 020562 0 ustar mehdi mehdi
module type S =sig..end
Ephemeron.K1.Make and Ephemeron.K2.Make.
These hash tables are weak in the keys. If all the keys of a binding are
alive the binding is kept, but if one of the keys of the binding
is dead then the binding is removed.mem h k is true, a subsequent
find h k may raise Not_found because the garbage collector
can run between the two.
Moreover, the table shouldn't be modified during a call to iter.
Use filter_map_inplace in this case.
include Hashtbl.S
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingssig
type t
val create : unit -> Mutex.t
val lock : Mutex.t -> unit
val try_lock : Mutex.t -> bool
val unlock : Mutex.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/index_exceptions.html 0000644 0001750 0001750 00000030502 13131636452 022001 0 ustar mehdi mehdi
B | |
| Bad [Arg] |
Functions in
spec or anon_fun can raise Arg.Bad with an error
message to reject invalid arguments.
|
| Break [Sys] |
Exception raised on interactive interrupt if
Sys.catch_break
is on.
|
E | |
| Empty [Stack] | |
| Empty [Queue] |
Raised when
Queue.take or Queue.peek is applied to an empty queue.
|
| Error [Syntaxerr] | |
| Error [Stream] |
Raised by parsers when the first component of a stream pattern is
accepted, but one of the following components is rejected.
|
| Error [Location] | |
| Error [Lexer] | |
| Error [Dynlink] |
Errors in dynamic linking are reported by raising the
Error
exception with a description of the error.
|
| Error [Attr_helper] | |
| Errors [Warnings] | |
| Escape_error [Syntaxerr] | |
| Exit [Pervasives] |
The
Exit exception is not raised by any library function.
|
F | |
| Failure [Stream] |
Raised by parsers when none of the first components of the stream
patterns is accepted.
|
| Fatal_error [Misc] | |
G | |
| Graphic_failure [Graphics] |
Raised by the functions below when they encounter an error.
|
H | |
| Help [Arg] |
Raised by
Arg.parse_argv when the user asks for help.
|
| HookExnWrapper [Misc] |
An exception raised by a hook will be wrapped into a
HookExnWrapper constructor by the hook machinery.
|
I | |
| Inconsistency [Consistbl] | |
N | |
| Not_available [Consistbl] | |
P | |
| Parse_error [Parsing] |
Raised when a parser encounters a syntax error.
|
S | |
| Scan_failure [Scanf] |
When the input can not be read according to the format string
specification, formatted input functions typically raise exception
Scan_failure.
|
U | |
| Undefined [Lazy] | |
| Undefined [CamlinternalLazy] | |
| Unix_error [UnixLabels] |
Raised by the system calls below when an error is encountered.
|
| Unix_error [Unix] |
Raised by the system calls below when an error is encountered.
|
module Lazy:sig..end
type'at ='a lazy_t
'a Lazy.t is a deferred computation, called
a suspension, that has a result of type 'a. The special
expression syntax lazy (expr) makes a suspension of the
computation of expr, without computing expr itself yet.
"Forcing" the suspension will then compute expr and return its
result.
Note: lazy_t is the built-in type constructor used by the compiler
for the lazy keyword. You should not use it directly. Always use
Lazy.t instead.
Note: Lazy.force is not thread-safe. If you use this module in
a multi-threaded program, you will need to add some locks.
Note: if the program is compiled with the -rectypes option,
ill-founded recursive definitions of the form let rec x = lazy x
or let rec x = lazy(lazy(...(lazy x))) are accepted by the type-checker
and lead, when forced, to ill-formed values that trigger infinite
loops in the garbage collector and other parts of the run-time system.
Without the -rectypes option, such ill-founded recursive definitions
are rejected by the type-checker.
exception Undefined
val force : 'a t -> 'aforce x forces the suspension x and returns its result.
If x has already been forced, Lazy.force x returns the
same value again without recomputing it. If it raised an exception,
the same exception is raised again.
Raise Lazy.Undefined if the forcing of x tries to force x itself
recursively.val force_val : 'a t -> 'aforce_val x forces the suspension x and returns its
result. If x has already been forced, force_val x
returns the same value again without recomputing it.
Raise Lazy.Undefined if the forcing of x tries to force x itself
recursively.
If the computation of x raises an exception, it is unspecified
whether force_val x raises the same exception or Lazy.Undefined.val from_fun : (unit -> 'a) -> 'a tfrom_fun f is the same as lazy (f ()) but slightly more efficient.
from_fun should only be used if the function f is already defined.
In particular it is always less efficient to write
from_fun (fun () -> expr) than lazy expr.
Since 4.00.0
val from_val : 'a -> 'a tfrom_val v returns an already-forced suspension of v.
This is for special purposes only and should not be confused with
lazy (v).val is_val : 'a t -> boolis_val x returns true if x has already been forced and
did not raise an exception.val lazy_from_fun : (unit -> 'a) -> 'a tfrom_fun.val lazy_from_val : 'a -> 'a tfrom_val.val lazy_is_val : 'a t -> boolis_val.sig
type space_formatter = (unit, Format.formatter, unit) Pervasives.format
val toplevel_phrase : Format.formatter -> Parsetree.toplevel_phrase -> unit
val expression : Format.formatter -> Parsetree.expression -> unit
val string_of_expression : Parsetree.expression -> string
val top_phrase : Format.formatter -> Parsetree.toplevel_phrase -> unit
val core_type : Format.formatter -> Parsetree.core_type -> unit
val pattern : Format.formatter -> Parsetree.pattern -> unit
val signature : Format.formatter -> Parsetree.signature -> unit
val structure : Format.formatter -> Parsetree.structure -> unit
val string_of_structure : Parsetree.structure -> string
end ocaml-doc-4.05/ocaml.html/libref/Arith_status.html 0000644 0001750 0001750 00000026156 13131636441 021113 0 ustar mehdi mehdi
module Arith_status:sig..end
val arith_status : unit -> unitval get_error_when_null_denominator : unit -> bool
val set_error_when_null_denominator : bool -> unitnull_denominator. When on, attempting to
create a rational with a null denominator raises an exception.
When off, rationals with null denominators are accepted.
Initially: on.val get_normalize_ratio : unit -> bool
val set_normalize_ratio : bool -> unitnormalize_ratio. When on, rational
numbers are normalized after each operation. When off,
rational numbers are not normalized until printed.
Initially: off.val get_normalize_ratio_when_printing : unit -> bool
val set_normalize_ratio_when_printing : bool -> unitnormalize_ratio_when_printing.
When on, rational numbers are normalized before being printed.
When off, rational numbers are printed as is, without normalization.
Initially: on.val get_approx_printing : unit -> bool
val set_approx_printing : bool -> unitapprox_printing.
When on, rational numbers are printed as a decimal approximation.
When off, rational numbers are printed as a fraction.
Initially: off.val get_floating_precision : unit -> int
val set_floating_precision : int -> unitfloating_precision.
This parameter is the number of digits displayed when
approx_printing is on.
Initially: 12.sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> int -> int -> ('a, 'b, 'c) Bigarray.Array3.t
external dim1 : ('a, 'b, 'c) Bigarray.Array3.t -> int = "%caml_ba_dim_1"
external dim2 : ('a, 'b, 'c) Bigarray.Array3.t -> int = "%caml_ba_dim_2"
external dim3 : ('a, 'b, 'c) Bigarray.Array3.t -> int = "%caml_ba_dim_3"
external kind : ('a, 'b, 'c) Bigarray.Array3.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array3.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array3.t -> int
external get : ('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a
= "%caml_ba_ref_3"
external set :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a -> unit
= "%caml_ba_set_3"
external sub_left :
('a, 'b, Bigarray.c_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array3.t
= "caml_ba_sub"
external sub_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t
= "caml_ba_sub"
val slice_left_1 :
('a, 'b, Bigarray.c_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t
val slice_right_1 :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.t
val slice_left_2 :
('a, 'b, Bigarray.c_layout) Bigarray.Array3.t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array2.t
val slice_right_2 :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t
external blit :
('a, 'b, 'c) Bigarray.Array3.t -> ('a, 'b, 'c) Bigarray.Array3.t -> unit
= "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array3.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
'a array array array -> ('a, 'b, 'c) Bigarray.Array3.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int -> int -> int -> ('a, 'b, 'c) Bigarray.Array3.t
external unsafe_get :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a
= "%caml_ba_unsafe_ref_3"
external unsafe_set :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a -> unit
= "%caml_ba_unsafe_set_3"
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Incl.html 0000644 0001750 0001750 00000016052 13131636441 022446 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs -> 'a -> 'a Parsetree.include_infos
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Map.html 0000644 0001750 0001750 00000125135 13131636446 022245 0 ustar mehdi mehdi
sig
module type OrderedType = Map.OrderedType
module type S =
sig
type key
and +'a t
val empty : 'a MoreLabels.Map.S.t
val is_empty : 'a MoreLabels.Map.S.t -> bool
val mem : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> bool
val add :
key:MoreLabels.Map.S.key ->
data:'a -> 'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val singleton : MoreLabels.Map.S.key -> 'a -> 'a MoreLabels.Map.S.t
val remove :
MoreLabels.Map.S.key ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val merge :
f:(MoreLabels.Map.S.key -> 'a option -> 'b option -> 'c option) ->
'a MoreLabels.Map.S.t ->
'b MoreLabels.Map.S.t -> 'c MoreLabels.Map.S.t
val union :
f:(MoreLabels.Map.S.key -> 'a -> 'a -> 'a option) ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val compare :
cmp:('a -> 'a -> int) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> int
val equal :
cmp:('a -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> bool
val iter :
f:(key:MoreLabels.Map.S.key -> data:'a -> unit) ->
'a MoreLabels.Map.S.t -> unit
val fold :
f:(key:MoreLabels.Map.S.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Map.S.t -> init:'b -> 'b
val for_all :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> bool
val exists :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> bool
val filter :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val partition :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t * 'a MoreLabels.Map.S.t
val cardinal : 'a MoreLabels.Map.S.t -> int
val bindings :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) list
val min_binding : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val min_binding_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val max_binding : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val max_binding_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val choose : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val choose_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val split :
MoreLabels.Map.S.key ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t * 'a option * 'a MoreLabels.Map.S.t
val find : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a
val find_opt :
MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a option
val find_first :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val find_first_opt :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val find_last :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val find_last_opt :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val map :
f:('a -> 'b) -> 'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t
val mapi :
f:(MoreLabels.Map.S.key -> 'a -> 'b) ->
'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t
end
module Make :
functor (Ord : OrderedType) ->
sig
type key = Ord.t
and +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key:key -> data:'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
f:(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : f:(key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val for_all : f:(key -> 'a -> bool) -> 'a t -> bool
val exists : f:(key -> 'a -> bool) -> 'a t -> bool
val filter : f:(key -> 'a -> bool) -> 'a t -> 'a t
val partition : f:(key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : f:(key -> bool) -> 'a t -> key * 'a
val find_first_opt : f:(key -> bool) -> 'a t -> (key * 'a) option
val find_last : f:(key -> bool) -> 'a t -> key * 'a
val find_last_opt : f:(key -> bool) -> 'a t -> (key * 'a) option
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key -> 'a -> 'b) -> 'a t -> 'b t
end
end ocaml-doc-4.05/ocaml.html/libref/type_Misc.StringSet.html 0000644 0001750 0001750 00000032050 13131636446 022311 0 ustar mehdi mehdi
sig
type elt = string
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Cl.html 0000644 0001750 0001750 00000026075 13131636441 021064 0 ustar mehdi mehdi
module Cl:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.class_expr_desc -> Parsetree.class_expr
val attr : Parsetree.class_expr -> Parsetree.attribute -> Parsetree.class_expr
val constr : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.class_expr
val structure : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.class_structure -> Parsetree.class_expr
val fun_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.expression option ->
Parsetree.pattern -> Parsetree.class_expr -> Parsetree.class_expr
val apply : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr ->
(Asttypes.arg_label * Parsetree.expression) list -> Parsetree.class_expr
val let_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.rec_flag ->
Parsetree.value_binding list -> Parsetree.class_expr -> Parsetree.class_expr
val constraint_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr -> Parsetree.class_type -> Parsetree.class_expr
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_expr ocaml-doc-4.05/ocaml.html/libref/Misc.Stdlib.Option.html 0000644 0001750 0001750 00000020160 13131636445 022014 0 ustar mehdi mehdi
module Option:sig..end
type'at ='a option
val equal : ('a -> 'a -> bool) ->
'a t -> 'a t -> bool
val iter : ('a -> unit) -> 'a t -> unit
val map : ('a -> 'b) -> 'a t -> 'b t
val fold : ('a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val value_default : ('a -> 'b) -> default:'b -> 'a t -> 'b ocaml-doc-4.05/ocaml.html/libref/Bigarray.Array1.html 0000644 0001750 0001750 00000041401 13131636442 021326 0 ustar mehdi mehdi
module Array1:sig..end
Array1 structure provides operations
similar to those of
Bigarray.Genarray, but specialized to the case of one-dimensional arrays.
(The Bigarray.Array2 and Bigarray.Array3 structures below provide operations
specialized for two- and three-dimensional arrays.)
Statically knowing the number of dimensions of the array allows
faster operations, and more precise static type-checking.type ('a, 'b, 'c) t
'a, representation kind 'b, and memory layout 'c.val create : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> ('a, 'b, 'c) tArray1.create kind layout dim returns a new bigarray of
one dimension, whose size is dim. kind and layout
determine the array element kind and the array layout
as described for Bigarray.Genarray.create.val dim : ('a, 'b, 'c) t -> intval kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kindval layout : ('a, 'b, 'c) t -> 'c Bigarray.layoutval size_in_bytes : ('a, 'b, 'c) t -> intsize_in_bytes a is the number of elements in a
multiplied by a's Bigarray.kind_size_in_bytes.val get : ('a, 'b, 'c) t -> int -> 'aArray1.get a x, or alternatively a.{x},
returns the element of a at index x.
x must be greater or equal than 0 and strictly less than
Array1.dim a if a has C layout. If a has Fortran layout,
x must be greater or equal than 1 and less or equal than
Array1.dim a. Otherwise, Invalid_argument is raised.val set : ('a, 'b, 'c) t -> int -> 'a -> unitArray1.set a x v, also written a.{x} <- v,
stores the value v at index x in a.
x must be inside the bounds of a as described in
Bigarray.Array1.get;
otherwise, Invalid_argument is raised.val sub : ('a, 'b, 'c) t ->
int -> int -> ('a, 'b, 'c) tBigarray.Genarray.sub_left for more details.val slice : ('a, 'b, 'c) t -> int -> ('a, 'b, 'c) Bigarray.Array0.tBigarray.Genarray.slice_left and
Bigarray.Genarray.slice_right for more details.val blit : ('a, 'b, 'c) t -> ('a, 'b, 'c) t -> unitBigarray.Genarray.blit for more details.val fill : ('a, 'b, 'c) t -> 'a -> unitBigarray.Genarray.fill for more details.val of_array : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array -> ('a, 'b, 'c) tval map_file : Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> bool -> int -> ('a, 'b, 'c) tBigarray.Genarray.map_file for more details.val unsafe_get : ('a, 'b, 'c) t -> int -> 'aBigarray.Array1.get, but bounds checking is not always performed.
Use with caution and only when the program logic guarantees that
the access is within bounds.val unsafe_set : ('a, 'b, 'c) t -> int -> 'a -> unitBigarray.Array1.set, but bounds checking is not always performed.
Use with caution and only when the program logic guarantees that
the access is within bounds.sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
?cstrs:(Parsetree.core_type * Parsetree.core_type * Ast_helper.loc) list ->
?kind:Parsetree.type_kind ->
?priv:Asttypes.private_flag ->
?manifest:Parsetree.core_type ->
Ast_helper.str -> Parsetree.type_declaration
val constructor :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?info:Docstrings.info ->
?args:Parsetree.constructor_arguments ->
?res:Parsetree.core_type ->
Ast_helper.str -> Parsetree.constructor_declaration
val field :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?info:Docstrings.info ->
?mut:Asttypes.mutable_flag ->
Ast_helper.str -> Parsetree.core_type -> Parsetree.label_declaration
end ocaml-doc-4.05/ocaml.html/libref/type_StdLabels.String.html 0000644 0001750 0001750 00000014705 13131636450 022621 0 ustar mehdi mehdi
(module StringLabels) ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.Kn.MakeSeeded.html 0000644 0001750 0001750 00000027441 13131636443 023761 0 ustar mehdi mehdi
functor (H : Hashtbl.SeededHashedType) ->
sig
type key = H.t array
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_Depend.StringMap.html 0000644 0001750 0001750 00000042550 13131636443 022602 0 ustar mehdi mehdi
sig
type key = string
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end ocaml-doc-4.05/ocaml.html/libref/Random.State.html 0000644 0001750 0001750 00000022276 13131636450 020737 0 ustar mehdi mehdi
module State:sig..end
type
val make : int array -> tval make_self_init : unit -> tval copy : t -> tval bits : t -> int
val int : t -> int -> int
val int32 : t -> Int32.t -> Int32.t
val nativeint : t -> Nativeint.t -> Nativeint.t
val int64 : t -> Int64.t -> Int64.t
val float : t -> float -> float
val bool : t -> boolsig
external length : bytes -> int = "%bytes_length"
external get : bytes -> int -> char = "%bytes_safe_get"
external set : bytes -> int -> char -> unit = "%bytes_safe_set"
external create : int -> bytes = "caml_create_bytes"
val make : int -> char -> bytes
val init : int -> (int -> char) -> bytes
val empty : bytes
val copy : bytes -> bytes
val of_string : string -> bytes
val to_string : bytes -> string
val sub : bytes -> int -> int -> bytes
val sub_string : bytes -> int -> int -> string
val extend : bytes -> int -> int -> bytes
val fill : bytes -> int -> int -> char -> unit
val blit : bytes -> int -> bytes -> int -> int -> unit
val blit_string : string -> int -> bytes -> int -> int -> unit
val concat : bytes -> bytes list -> bytes
val cat : bytes -> bytes -> bytes
val iter : (char -> unit) -> bytes -> unit
val iteri : (int -> char -> unit) -> bytes -> unit
val map : (char -> char) -> bytes -> bytes
val mapi : (int -> char -> char) -> bytes -> bytes
val trim : bytes -> bytes
val escaped : bytes -> bytes
val index : bytes -> char -> int
val index_opt : bytes -> char -> int option
val rindex : bytes -> char -> int
val rindex_opt : bytes -> char -> int option
val index_from : bytes -> int -> char -> int
val index_from_opt : bytes -> int -> char -> int option
val rindex_from : bytes -> int -> char -> int
val rindex_from_opt : bytes -> int -> char -> int option
val contains : bytes -> char -> bool
val contains_from : bytes -> int -> char -> bool
val rcontains_from : bytes -> int -> char -> bool
val uppercase : bytes -> bytes
val lowercase : bytes -> bytes
val capitalize : bytes -> bytes
val uncapitalize : bytes -> bytes
val uppercase_ascii : bytes -> bytes
val lowercase_ascii : bytes -> bytes
val capitalize_ascii : bytes -> bytes
val uncapitalize_ascii : bytes -> bytes
type t = bytes
val compare : Bytes.t -> Bytes.t -> int
val equal : Bytes.t -> Bytes.t -> bool
val unsafe_to_string : bytes -> string
val unsafe_of_string : string -> bytes
external unsafe_get : bytes -> int -> char = "%bytes_unsafe_get"
external unsafe_set : bytes -> int -> char -> unit = "%bytes_unsafe_set"
external unsafe_blit : bytes -> int -> bytes -> int -> int -> unit
= "caml_blit_bytes" [@@noalloc]
external unsafe_fill : bytes -> int -> int -> char -> unit
= "caml_fill_bytes" [@@noalloc]
end ocaml-doc-4.05/ocaml.html/libref/Misc.StringMap.html 0000644 0001750 0001750 00000070143 13131636446 021237 0 ustar mehdi mehdi
module StringMap:Map.Swith type key = string
type
type +'a t
key to type 'a.val empty : 'a tval is_empty : 'a t -> boolval mem : key -> 'a t -> boolmem x m returns true if m contains a binding for x,
and false otherwise.val add : key -> 'a -> 'a t -> 'a tadd x y m returns a map containing the same bindings as
m, plus a binding of x to y. If x was already bound
in m to a value that is physically equal to y,
m is returned unchanged (the result of the function is
then physically equal to m). Otherwise, the previous binding
of x in m disappears.val singleton : key -> 'a -> 'a tsingleton x y returns the one-element map that contains a binding y
for x.val remove : key -> 'a t -> 'a tremove x m returns a map containing the same bindings as
m, except for x which is unbound in the returned map.
If x was not in m, m is returned unchanged
(the result of the function is then physically equal to m).val merge : (key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c tmerge f m1 m2 computes a map whose keys is a subset of keys of m1
and of m2. The presence of each such binding, and the corresponding
value, is determined with the function f.
In terms of the find_opt operation, we have
find_opt x (merge f m1 m2) = f (find_opt x m1) (find_opt x m2)
for any key x, provided that f None None = None.val union : (key -> 'a -> 'a -> 'a option) ->
'a t -> 'a t -> 'a tunion f m1 m2 computes a map whose keys is the union of keys
of m1 and of m2. When the same binding is defined in both
arguments, the function f is used to combine them.
This is a special case of merge: union f m1 m2 is equivalent
to merge f' m1 m2, wheref' None None = Nonef' (Some v) None = Some vf' None (Some v) = Some vf' (Some v1) (Some v2) = f v1 v2val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> intval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> boolequal cmp m1 m2 tests whether the maps m1 and m2 are
equal, that is, contain equal keys and associate them with
equal data. cmp is the equality predicate used to compare
the data associated with the keys.val iter : (key -> 'a -> unit) -> 'a t -> unititer f m applies f to all bindings in map m.
f receives the key as first argument, and the associated value
as second argument. The bindings are passed to f in increasing
order with respect to the ordering over the type of the keys.val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'bfold f m a computes (f kN dN ... (f k1 d1 a)...),
where k1 ... kN are the keys of all bindings in m
(in increasing order), and d1 ... dN are the associated data.val for_all : (key -> 'a -> bool) -> 'a t -> boolfor_all p m checks if all the bindings of the map
satisfy the predicate p.val exists : (key -> 'a -> bool) -> 'a t -> boolexists p m checks if at least one binding of the map
satisfies the predicate p.val filter : (key -> 'a -> bool) -> 'a t -> 'a tfilter p m returns the map with all the bindings in m
that satisfy predicate p. If p satisfies every binding in m,
m is returned unchanged (the result of the function is then
physically equal to m)val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a tpartition p m returns a pair of maps (m1, m2), where
m1 contains all the bindings of s that satisfy the
predicate p, and m2 is the map with all the bindings of
s that do not satisfy p.val cardinal : 'a t -> intval bindings : 'a t -> (key * 'a) listOrd.compare, where Ord is the argument
given to Map.Make.val min_binding : 'a t -> key * 'aOrd.compare ordering), or raise
Not_found if the map is empty.val min_binding_opt : 'a t -> (key * 'a) optionOrd.compare ordering), or None
if the map is empty.val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'aNot_found if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val choose_opt : 'a t -> (key * 'a) optionNone if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val split : key -> 'a t -> 'a t * 'a option * 'a tsplit x m returns a triple (l, data, r), where
l is the map with all the bindings of m whose key
is strictly less than x;
r is the map with all the bindings of m whose key
is strictly greater than x;
data is None if m contains no binding for x,
or Some v if m binds v to x.val find : key -> 'a t -> 'afind x m returns the current binding of x in m,
or raises Not_found if no such binding exists.val find_opt : key -> 'a t -> 'a optionfind_opt x m returns Some v if the current binding of x
in m is v, or None if no such binding exists.val find_first : (key -> bool) -> 'a t -> key * 'afind_first f m, where f is a monotonically increasing function,
returns the binding of m with the lowest key k such that f k,
or raises Not_found if no such key exists.
For example, find_first (fun k -> Ord.compare k x >= 0) m will return
the first binding k, v of m where Ord.compare k x >= 0
(intuitively: k >= x), or raise Not_found if x is greater than any
element of m.
Since 4.05
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_first_opt f m, where f is a monotonically increasing function,
returns an option containing the binding of m with the lowest key k
such that f k, or None if no such key exists.val find_last : (key -> bool) -> 'a t -> key * 'afind_last f m, where f is a monotonically decreasing function,
returns the binding of m with the highest key k such that f k,
or raises Not_found if no such key exists.val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_last_opt f m, where f is a monotonically decreasing function,
returns an option containing the binding of m with the highest key k
such that f k, or None if no such key exists.val map : ('a -> 'b) -> 'a t -> 'b tmap f m returns a map with same domain as m, where the
associated value a of all bindings of m has been
replaced by the result of the application of f to a.
The bindings are passed to f in increasing order
with respect to the ordering over the type of the keys.val mapi : (key -> 'a -> 'b) -> 'a t -> 'b tMap.S.map, but the function receives as arguments both the
key and the associated value for each binding of the map.module type SeededS =sig..end
type
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t ->
key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t ->
key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t ->
key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) ->
'a t -> unit
val filter_map_inplace : f:(key:key -> data:'a -> 'a option) ->
'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) ->
'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> MoreLabels.Hashtbl.statistics ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.SeededS.html 0000644 0001750 0001750 00000026361 13131636443 022737 0 ustar mehdi mehdi
sig
type key
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_Config.html 0000644 0001750 0001750 00000026657 13131636443 020717 0 ustar mehdi mehdi
sig
val version : string
val standard_library : string
val standard_runtime : string
val ccomp_type : string
val bytecomp_c_compiler : string
val bytecomp_c_libraries : string
val native_c_compiler : string
val native_c_libraries : string
val native_pack_linker : string
val mkdll : string
val mkexe : string
val mkmaindll : string
val ranlib : string
val ar : string
val cc_profile : string
val load_path : string list Pervasives.ref
val interface_suffix : string Pervasives.ref
val exec_magic_number : string
val cmi_magic_number : string
val cmo_magic_number : string
val cma_magic_number : string
val cmx_magic_number : string
val cmxa_magic_number : string
val ast_intf_magic_number : string
val ast_impl_magic_number : string
val cmxs_magic_number : string
val cmt_magic_number : string
val max_tag : int
val lazy_tag : int
val max_young_wosize : int
val stack_threshold : int
val stack_safety_margin : int
val architecture : string
val model : string
val system : string
val asm : string
val asm_cfi_supported : bool
val with_frame_pointers : bool
val ext_obj : string
val ext_asm : string
val ext_lib : string
val ext_dll : string
val default_executable_name : string
val systhread_supported : bool
val flexdll_dirs : string list
val host : string
val target : string
val print_config : Pervasives.out_channel -> unit
val profiling : bool
val flambda : bool
val spacetime : bool
val profinfo : bool
val profinfo_width : int
val libunwind_available : bool
val libunwind_link_flags : string
val safe_string : bool
val afl_instrument : bool
end ocaml-doc-4.05/ocaml.html/libref/Hashtbl.HashedType.html 0000644 0001750 0001750 00000022074 13131636444 022061 0 ustar mehdi mehdi
module type HashedType =sig..end
Hashtbl.Make.type
val equal : t -> t -> boolval hash : t -> intequal, then they have identical hash values
as computed by hash.
Examples: suitable (equal, hash) pairs for arbitrary key
types include(=), Hashtbl.hash) for comparing objects by structure
(provided objects do not contain floats)(fun x y -> compare x y = 0), Hashtbl.hash)
for comparing objects by structure
and handling nan correctly(==), Hashtbl.hash) for comparing objects by physical
equality (e.g. for mutable or cyclic objects).functor (H : Hashtbl.SeededHashedType) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_CamlinternalLazy.html 0000644 0001750 0001750 00000016553 13131636443 022755 0 ustar mehdi mehdi
sig
exception Undefined
val force_lazy_block : 'a lazy_t -> 'a
val force_val_lazy_block : 'a lazy_t -> 'a
val force : 'a lazy_t -> 'a
val force_val : 'a lazy_t -> 'a
end ocaml-doc-4.05/ocaml.html/libref/type_Hashtbl.SeededHashedType.html 0000644 0001750 0001750 00000016201 13131636444 024227 0 ustar mehdi mehdi
sig
type t
val equal :
Hashtbl.SeededHashedType.t -> Hashtbl.SeededHashedType.t -> bool
val hash : int -> Hashtbl.SeededHashedType.t -> int
end ocaml-doc-4.05/ocaml.html/libref/type_Arg_helper.Make.html 0000644 0001750 0001750 00000066741 13131636440 022431 0 ustar mehdi mehdi
functor
(S : sig
module Key :
sig
type t
val of_string : string -> Arg_helper.Make.Key.t
module Map :
sig
type key = t
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union :
(key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt :
(key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt :
(key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end
end
module Value :
sig type t val of_string : string -> Arg_helper.Make.Value.t end
end) ->
sig
type parsed
val default : S.Value.t -> Arg_helper.Make.parsed
val set_base_default :
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val add_base_override :
S.Key.t ->
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val reset_base_overrides :
Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val set_user_default :
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val add_user_override :
S.Key.t ->
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val parse :
string -> string -> Arg_helper.Make.parsed Pervasives.ref -> unit
type parse_result = Ok | Parse_failed of exn
val parse_no_error :
string ->
Arg_helper.Make.parsed Pervasives.ref -> Arg_helper.Make.parse_result
val get : key:S.Key.t -> Arg_helper.Make.parsed -> S.Value.t
end ocaml-doc-4.05/ocaml.html/libref/Ast_invariants.html 0000644 0001750 0001750 00000016725 13131636441 021427 0 ustar mehdi mehdi
module Ast_invariants:sig..end
val structure : Parsetree.structure -> unit
val signature : Parsetree.signature -> unit ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.Pair.html 0000644 0001750 0001750 00000017503 13131636444 022752 0 ustar mehdi mehdi
functor (A : Thing) (B : Thing) ->
sig
type t = A.t * B.t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Filename.html 0000644 0001750 0001750 00000023030 13131636444 021211 0 ustar mehdi mehdi
sig
val current_dir_name : string
val parent_dir_name : string
val dir_sep : string
val concat : string -> string -> string
val is_relative : string -> bool
val is_implicit : string -> bool
val check_suffix : string -> string -> bool
val chop_suffix : string -> string -> string
val extension : string -> string
val remove_extension : string -> string
val chop_extension : string -> string
val basename : string -> string
val dirname : string -> string
val temp_file : ?temp_dir:string -> string -> string -> string
val open_temp_file :
?mode:Pervasives.open_flag list ->
?perms:int ->
?temp_dir:string -> string -> string -> string * Pervasives.out_channel
val get_temp_dir_name : unit -> string
val set_temp_dir_name : string -> unit
val temp_dir_name : string
val quote : string -> string
end ocaml-doc-4.05/ocaml.html/libref/Strongly_connected_components.S.html 0000644 0001750 0001750 00000021757 13131636451 024755 0 ustar mehdi mehdi
module type S =sig..end
module Id:Identifiable.S
typedirected_graph =Id.Set.t Id.Map.t
a to every element of set. It is assumed that no edge
points to a vertex not represented in the map.type
| |
Has_loop of |
| |
No_loop of |
val connected_components_sorted_from_roots_to_leaf : directed_graph ->
component array
val component_graph : directed_graph ->
(component * int list) array ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.S.Map.html 0000644 0001750 0001750 00000061370 13131636451 022774 0 ustar mehdi mehdi
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map :
'a Identifiable.S.t -> f:(key -> 'a -> 'b option) -> 'b Identifiable.S.t
val of_list : (key * 'a) list -> 'a Identifiable.S.t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_right :
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_left :
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_merge :
('a -> 'a -> 'a) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val rename : key Identifiable.S.t -> key -> key
val map_keys : (key -> key) -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val keys : 'a Identifiable.S.t -> Identifiable.S.Set.t
val data : 'a Identifiable.S.t -> 'a list
val of_set : (key -> 'a) -> Identifiable.S.Set.t -> 'a Identifiable.S.t
val transpose_keys_and_data : key Identifiable.S.t -> key Identifiable.S.t
val transpose_keys_and_data_set :
key Identifiable.S.t -> Identifiable.S.Set.t Identifiable.S.t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a Identifiable.S.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Typ.html 0000644 0001750 0001750 00000035624 13131636441 022343 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type_desc -> Parsetree.core_type
val attr :
Parsetree.core_type -> Parsetree.attribute -> Parsetree.core_type
val any :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.core_type
val var :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> string -> Parsetree.core_type
val arrow :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.core_type
val tuple :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type list -> Parsetree.core_type
val constr :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
val object_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.str * Parsetree.attributes * Parsetree.core_type) list ->
Asttypes.closed_flag -> Parsetree.core_type
val class_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
val alias :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> string -> Parsetree.core_type
val variant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.row_field list ->
Asttypes.closed_flag -> Asttypes.label list option -> Parsetree.core_type
val poly :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str list -> Parsetree.core_type -> Parsetree.core_type
val package :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid ->
(Ast_helper.lid * Parsetree.core_type) list -> Parsetree.core_type
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.core_type
val force_poly : Parsetree.core_type -> Parsetree.core_type
val varify_constructors :
Ast_helper.str list -> Parsetree.core_type -> Parsetree.core_type
end ocaml-doc-4.05/ocaml.html/libref/Obj.html 0000644 0001750 0001750 00000034313 13131636447 017153 0 ustar mehdi mehdi
module Obj:sig..end
Not for the casual user.
type
val repr : 'a -> t
val obj : t -> 'a
val magic : 'a -> 'b
val is_block : t -> bool
val is_int : t -> bool
val tag : t -> int
val size : t -> int
val reachable_words : t -> int
@Since 4.04
val field : t -> int -> t
val set_field : t -> int -> t -> unit
set_field MUST NOT be called on immutable blocks. (Blocks allocated
in C stubs, or with new_block below, are always considered mutable.)
The same goes for set_double_field and set_tag. However, for
set_tag, in the case of immutable blocks where the middle-end optimizers
never see code that discriminates on their tag (for example records), the
operation should be safe. Such uses are nonetheless discouraged.
For experts only:
set_field et al can be made safe by first wrapping the block in
Sys.opaque_identity, so any information about its contents will not
be propagated.
val set_tag : t -> int -> unit
val double_field : t -> int -> float
val set_double_field : t -> int -> float -> unit
val new_block : int -> int -> t
val dup : t -> t
val truncate : t -> int -> unit
val add_offset : t -> Int32.t -> t
val first_non_constant_constructor_tag : int
val last_non_constant_constructor_tag : int
val lazy_tag : int
val closure_tag : int
val object_tag : int
val infix_tag : int
val forward_tag : int
val no_scan_tag : int
val abstract_tag : int
val string_tag : int
val double_tag : int
val double_array_tag : int
val custom_tag : int
val final_tag : int
val int_tag : int
val out_of_heap_tag : int
val unaligned_tag : int
val extension_constructor : 'a -> extension_constructor
val extension_name : extension_constructor -> string
val extension_id : extension_constructor -> intMarshal
instead.val marshal : t -> bytes
val unmarshal : bytes -> int -> t * int
module Ephemeron:ocaml-doc-4.05/ocaml.html/libref/type_StdLabels.Array.html 0000644 0001750 0001750 00000014703 13131636450 022427 0 ustar mehdi mehdisig..end
(module ArrayLabels) ocaml-doc-4.05/ocaml.html/libref/Strongly_connected_components.S.Id.html 0000644 0001750 0001750 00000020030 13131636451 025267 0 ustar mehdi mehdi
module Id:Identifiable.S
type
module T:Identifiable.Thingwith type t = t
include Identifiable.Thing
module Set:sig..end
module Map:sig..end
module Tbl:ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Set.Make.html 0000644 0001750 0001750 00000033365 13131636446 023142 0 ustar mehdi mehdisig..end
functor (Ord : OrderedType) ->
sig
type elt = Ord.t
and t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : f:(elt -> unit) -> t -> unit
val map : f:(elt -> elt) -> t -> t
val fold : f:(elt -> 'a -> 'a) -> t -> init:'a -> 'a
val for_all : f:(elt -> bool) -> t -> bool
val exists : f:(elt -> bool) -> t -> bool
val filter : f:(elt -> bool) -> t -> t
val partition : f:(elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : f:(elt -> bool) -> t -> elt
val find_first_opt : f:(elt -> bool) -> t -> elt option
val find_last : f:(elt -> bool) -> t -> elt
val find_last_opt : f:(elt -> bool) -> t -> elt option
val of_list : elt list -> t
end ocaml-doc-4.05/ocaml.html/libref/Buffer.html 0000644 0001750 0001750 00000043354 13131636442 017652 0 ustar mehdi mehdi
module Buffer:sig..end
This module implements buffers that automatically expand
as necessary. It provides accumulative concatenation of strings
in quasi-linear time (instead of quadratic time when strings are
concatenated pairwise).
type
val create : int -> tcreate n returns a fresh buffer, initially empty.
The n parameter is the initial size of the internal byte sequence
that holds the buffer contents. That byte sequence is automatically
reallocated when more than n characters are stored in the buffer,
but shrinks back to n characters when reset is called.
For best performance, n should be of the same order of magnitude
as the number of characters that are expected to be stored in
the buffer (for instance, 80 for a buffer that holds one output
line). Nothing bad will happen if the buffer grows beyond that
limit, however. In doubt, take n = 16 for instance.
If n is not between 1 and Sys.max_string_length, it will
be clipped to that interval.val contents : t -> stringval to_bytes : t -> bytesval sub : t -> int -> int -> stringBuffer.sub b off len returns a copy of len bytes from the
current contents of the buffer b, starting at offset off.
Raise Invalid_argument if srcoff and len do not designate a valid
range of b.
val blit : t -> int -> bytes -> int -> int -> unitBuffer.blit src srcoff dst dstoff len copies len characters from
the current contents of the buffer src, starting at offset srcoff
to dst, starting at character dstoff.
Raise Invalid_argument if srcoff and len do not designate a valid
range of src, or if dstoff and len do not designate a valid
range of dst.
Since 3.11.2
val nth : t -> int -> charInvalid_argument if
index out of boundsval length : t -> intval clear : t -> unitval reset : t -> unitn that was allocated by Buffer.create n.
For long-lived buffers that may have grown a lot, reset allows
faster reclamation of the space used by the buffer.val add_char : t -> char -> unitadd_char b c appends the character c at the end of buffer b.val add_string : t -> string -> unitadd_string b s appends the string s at the end of buffer b.val add_bytes : t -> bytes -> unitadd_bytes b s appends the byte sequence s at the end of buffer b.val add_substring : t -> string -> int -> int -> unitadd_substring b s ofs len takes len characters from offset
ofs in string s and appends them at the end of buffer b.val add_subbytes : t -> bytes -> int -> int -> unitadd_subbytes b s ofs len takes len characters from offset
ofs in byte sequence s and appends them at the end of buffer b.val add_substitute : t -> (string -> string) -> string -> unitadd_substitute b f s appends the string pattern s at the end
of buffer b with substitution.
The substitution process looks for variables into
the pattern and substitutes each variable name by its value, as
obtained by applying the mapping f to the variable name. Inside the
string pattern, a variable name immediately follows a non-escaped
$ character and is one of the following:_ characters,$ character is a $ that immediately follows a backslash
character; it then stands for a plain $.
Raise Not_found if the closing character of a parenthesized variable
cannot be found.val add_buffer : t -> t -> unitadd_buffer b1 b2 appends the current contents of buffer b2
at the end of buffer b1. b2 is not modified.val add_channel : t -> in_channel -> int -> unitadd_channel b ic n reads at most n characters from the
input channel ic and stores them at the end of buffer b.
Raise End_of_file if the channel contains fewer than n
characters. In this case, the characters are still added to
the buffer, so as to avoid loss of data.val output_buffer : out_channel -> t -> unitoutput_buffer oc b writes the current contents of buffer b
on the output channel oc.val truncate : t -> int -> unittruncate b len truncates the length of b to len
Note: the internal byte sequence is not shortened.
Raise Invalid_argument if len < 0 or len > length b.module Array: ArrayLabelsval length : 'a array -> intval get : 'a array -> int -> 'aArray.get a n returns the element number n of array a.
The first element has number 0.
The last element has number Array.length a - 1.
You can also write a.(n) instead of Array.get a n.
Raise Invalid_argument "index out of bounds"
if n is outside the range 0 to (Array.length a - 1).
val set : 'a array -> int -> 'a -> unitArray.set a n x modifies array a in place, replacing
element number n with x.
You can also write a.(n) <- x instead of Array.set a n x.
Raise Invalid_argument "index out of bounds"
if n is outside the range 0 to Array.length a - 1.
val make : int -> 'a -> 'a arrayArray.make n x returns a fresh array of length n,
initialized with x.
All the elements of this new array are initially
physically equal to x (in the sense of the == predicate).
Consequently, if x is mutable, it is shared among all elements
of the array, and modifying x through one of the array entries
will modify all other entries at the same time.
Raise Invalid_argument if n < 0 or n > Sys.max_array_length.
If the value of x is a floating-point number, then the maximum
size is only Sys.max_array_length / 2.
val create : int -> 'a -> 'a array
val init : int -> f:(int -> 'a) -> 'a arrayArray.init n f returns a fresh array of length n,
with element number i initialized to the result of f i.
In other terms, Array.init n f tabulates the results of f
applied to the integers 0 to n-1.
Raise Invalid_argument if n < 0 or n > Sys.max_array_length.
If the return type of f is float, then the maximum
size is only Sys.max_array_length / 2.
val make_matrix : dimx:int -> dimy:int -> 'a -> 'a array arrayArray.make_matrix dimx dimy e returns a two-dimensional array
(an array of arrays) with first dimension dimx and
second dimension dimy. All the elements of this new matrix
are initially physically equal to e.
The element (x,y) of a matrix m is accessed
with the notation m.(x).(y).
Raise Invalid_argument if dimx or dimy is negative or
greater than Sys.max_array_length.
If the value of e is a floating-point number, then the maximum
size is only Sys.max_array_length / 2.
val create_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
val append : 'a array -> 'a array -> 'a arrayArray.append v1 v2 returns a fresh array containing the
concatenation of the arrays v1 and v2.val concat : 'a array list -> 'a arrayArray.append, but concatenates a list of arrays.val sub : 'a array -> pos:int -> len:int -> 'a arrayArray.sub a start len returns a fresh array of length len,
containing the elements number start to start + len - 1
of array a.
Raise Invalid_argument "Array.sub" if start and len do not
designate a valid subarray of a; that is, if
start < 0, or len < 0, or start + len > Array.length a.
val copy : 'a array -> 'a arrayArray.copy a returns a copy of a, that is, a fresh array
containing the same elements as a.val fill : 'a array -> pos:int -> len:int -> 'a -> unitArray.fill a ofs len x modifies the array a in place,
storing x in elements number ofs to ofs + len - 1.
Raise Invalid_argument "Array.fill" if ofs and len do not
designate a valid subarray of a.
val blit : src:'a array -> src_pos:int -> dst:'a array -> dst_pos:int -> len:int -> unitArray.blit v1 o1 v2 o2 len copies len elements
from array v1, starting at element number o1, to array v2,
starting at element number o2. It works correctly even if
v1 and v2 are the same array, and the source and
destination chunks overlap.
Raise Invalid_argument "Array.blit" if o1 and len do not
designate a valid subarray of v1, or if o2 and len do not
designate a valid subarray of v2.
val to_list : 'a array -> 'a listArray.to_list a returns the list of all the elements of a.val of_list : 'a list -> 'a arrayArray.of_list l returns a fresh array containing the elements
of l.val iter : f:('a -> unit) -> 'a array -> unitArray.iter f a applies function f in turn to all
the elements of a. It is equivalent to
f a.(0); f a.(1); ...; f a.(Array.length a - 1); ().val map : f:('a -> 'b) -> 'a array -> 'b arrayArray.map f a applies function f to all the elements of a,
and builds an array with the results returned by f:
[| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |].val iteri : f:(int -> 'a -> unit) -> 'a array -> unitArray.iter, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.val mapi : f:(int -> 'a -> 'b) -> 'a array -> 'b arrayArray.map, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b array -> 'aArray.fold_left f x a computes
f (... (f (f x a.(0)) a.(1)) ...) a.(n-1),
where n is the length of the array a.val fold_right : f:('b -> 'a -> 'a) -> 'b array -> init:'a -> 'aArray.fold_right f a x computes
f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...)),
where n is the length of the array a.val iter2 : f:('a -> 'b -> unit) -> 'a array -> 'b array -> unitArray.iter2 f a b applies function f to all the elements of a
and b.
Raise Invalid_argument if the arrays are not the same size.val map2 : f:('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c arrayArray.map2 f a b applies function f to all the elements of a
and b, and builds an array with the results returned by f:
[| f a.(0) b.(0); ...; f a.(Array.length a - 1) b.(Array.length b - 1)|].
Raise Invalid_argument if the arrays are not the same size.val exists : f:('a -> bool) -> 'a array -> boolArray.exists p [|a1; ...; an|] checks if at least one element of
the array satisfies the predicate p. That is, it returns
(p a1) || (p a2) || ... || (p an).val for_all : f:('a -> bool) -> 'a array -> boolArray.for_all p [|a1; ...; an|] checks if all elements of the array
satisfy the predicate p. That is, it returns
(p a1) && (p a2) && ... && (p an).val mem : 'a -> set:'a array -> boolmem x a is true if and only if x is equal
to an element of a.val memq : 'a -> set:'a array -> boolArray.mem, but uses physical equality instead of structural
equality to compare list elements.val create_float : int -> float arrayArray.create_float n returns a fresh float array of length n,
with uninitialized data.val make_float : int -> float array
val sort : cmp:('a -> 'a -> int) -> 'a array -> unitcompare is
a suitable comparison function, provided there are no floating-point
NaN values in the data. After calling Array.sort, the
array is sorted in place in increasing order.
Array.sort is guaranteed to run in constant heap space
and (at most) logarithmic stack space.
The current implementation uses Heap Sort. It runs in constant stack space.
Specification of the comparison function:
Let a be the array and cmp the comparison function. The following
must be true for all x, y, z in a :
cmp x y > 0 if and only if cmp y x < 0cmp x y >= 0 and cmp y z >= 0 then cmp x z >= 0Array.sort returns, a contains the same elements as before,
reordered in such a way that for all i and j valid indices of a :cmp a.(i) a.(j) >= 0 if and only if i >= jval stable_sort : cmp:('a -> 'a -> int) -> 'a array -> unitArray.sort, but the sorting algorithm is stable (i.e.
elements that compare equal are kept in their original order) and
not guaranteed to run in constant heap space.
The current implementation uses Merge Sort. It uses n/2
words of heap space, where n is the length of the array.
It is usually faster than the current implementation of Array.sort.
val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
ocaml-doc-4.05/ocaml.html/libref/type_Gc.html 0000644 0001750 0001750 00000031752 13131636444 020034 0 ustar mehdi mehdi
sig
type stat = {
minor_words : float;
promoted_words : float;
major_words : float;
minor_collections : int;
major_collections : int;
heap_words : int;
heap_chunks : int;
live_words : int;
live_blocks : int;
free_words : int;
free_blocks : int;
largest_free : int;
fragments : int;
compactions : int;
top_heap_words : int;
stack_size : int;
}
type control = {
mutable minor_heap_size : int;
mutable major_heap_increment : int;
mutable space_overhead : int;
mutable verbose : int;
mutable max_overhead : int;
mutable stack_limit : int;
mutable allocation_policy : int;
window_size : int;
}
external stat : unit -> Gc.stat = "caml_gc_stat"
external quick_stat : unit -> Gc.stat = "caml_gc_quick_stat"
external counters : unit -> float * float * float = "caml_gc_counters"
external minor_words : unit -> (float [@unboxed]) = "caml_gc_minor_words"
"caml_gc_minor_words_unboxed"
external get : unit -> Gc.control = "caml_gc_get"
external set : Gc.control -> unit = "caml_gc_set"
external minor : unit -> unit = "caml_gc_minor"
external major_slice : int -> int = "caml_gc_major_slice"
external major : unit -> unit = "caml_gc_major"
external full_major : unit -> unit = "caml_gc_full_major"
external compact : unit -> unit = "caml_gc_compaction"
val print_stat : Pervasives.out_channel -> unit
val allocated_bytes : unit -> float
external get_minor_free : unit -> int = "caml_get_minor_free"
external get_bucket : int -> int = "caml_get_major_bucket" [@@noalloc]
external get_credit : unit -> int = "caml_get_major_credit" [@@noalloc]
external huge_fallback_count : unit -> int = "caml_gc_huge_fallback_count"
val finalise : ('a -> unit) -> 'a -> unit
val finalise_last : (unit -> unit) -> 'a -> unit
val finalise_release : unit -> unit
type alarm
val create_alarm : (unit -> unit) -> Gc.alarm
val delete_alarm : Gc.alarm -> unit
end ocaml-doc-4.05/ocaml.html/libref/Filename.html 0000644 0001750 0001750 00000044753 13131636444 020167 0 ustar mehdi mehdi
module Filename:sig..end
val current_dir_name : string. in Unix).val parent_dir_name : string.. in Unix).val dir_sep : string/ in Unix).val concat : string -> string -> stringconcat dir file returns a file name that designates file
file in directory dir.val is_relative : string -> booltrue if the file name is relative to the current
directory, false if it is absolute (i.e. in Unix, starts
with /).val is_implicit : string -> booltrue if the file name is relative and does not start
with an explicit reference to the current directory (./ or
../ in Unix), false if it starts with an explicit reference
to the root directory or the current directory.val check_suffix : string -> string -> boolcheck_suffix name suff returns true if the filename name
ends with the suffix suff.val chop_suffix : string -> string -> stringchop_suffix name suff removes the suffix suff from
the filename name. The behavior is undefined if name does not
end with the suffix suff.val extension : string -> stringextension name is the shortest suffix ext of name0 where:
name0 is the longest suffix of name that does not
contain a directory separator;ext starts with a period;ext is preceded by at least one non-period character
in name0.extension name is the empty
string.val remove_extension : string -> stringFilename.extension. If the extension is empty, the function
returns the given file name.
The following invariant holds for any file name s:
remove_extension s ^ extension s = s
Since 4.04
val chop_extension : string -> stringFilename.remove_extension, but raise Invalid_argument
if the given name has an empty extension.val basename : string -> stringname is a valid file name, then concat (dirname name) (basename name)
returns a file name which is equivalent to name. Moreover,
after setting the current directory to dirname name (with Sys.chdir),
references to basename name (which is a relative file name)
designate the same file as name before the call to Sys.chdir.
This function conforms to the specification of POSIX.1-2008 for the
basename utility.
val dirname : string -> stringFilename.basename.
This function conforms to the specification of POSIX.1-2008 for the
dirname utility.val temp_file : ?temp_dir:string -> string -> string -> stringtemp_file prefix suffix returns the name of a
fresh temporary file in the temporary directory.
The base name of the temporary file is formed by concatenating
prefix, then a suitably chosen integer number, then suffix.
The optional argument temp_dir indicates the temporary directory
to use, defaulting to the current result of Filename.get_temp_dir_name.
The temporary file is created empty, with permissions 0o600
(readable and writable only by the file owner). The file is
guaranteed to be different from any other file that existed when
temp_file was called.
Raise Sys_error if the file could not be created.val open_temp_file : ?mode:open_flag list ->
?perms:int ->
?temp_dir:string -> string -> string -> string * out_channelFilename.temp_file, but returns both the name of a fresh
temporary file, and an output channel opened (atomically) on
this file. This function is more secure than temp_file: there
is no risk that the temporary file will be modified (e.g. replaced
by a symbolic link) before the program opens it. The optional argument
mode is a list of additional flags to control the opening of the file.
It can contain one or several of Open_append, Open_binary,
and Open_text. The default is [Open_text] (open in text mode). The
file is created with permissions perms (defaults to readable and
writable only by the file owner, 0o600).Sys_error if the file could not be opened.val get_temp_dir_name : unit -> stringTMPDIR environment variable, or "/tmp"
if the variable is not set.
Under Windows, the value of the TEMP environment variable, or "."
if the variable is not set.
The temporary directory can be changed with Filename.set_temp_dir_name.val set_temp_dir_name : string -> unitFilename.get_temp_dir_name
and used by Filename.temp_file and Filename.open_temp_file.val temp_dir_name : stringFilename.get_temp_dir_name instead.TMPDIR environment variable, or "/tmp"
if the variable is not set.
Under Windows, the value of the TEMP environment variable, or "."
if the variable is not set.val quote : string -> stringmodule K1:sig..end
type ('k, 'd) t
val create : unit -> ('k, 'd) tEphemeron.K1.create () creates an ephemeron with one key. The
data and the key are emptyval get_key : ('k, 'd) t -> 'k optionEphemeron.K1.get_key eph returns None if the key of eph is
empty, Some x (where x is the key) if it is full.val get_key_copy : ('k, 'd) t -> 'k optionEphemeron.K1.get_key_copy eph returns None if the key of eph is
empty, Some x (where x is a (shallow) copy of the key) if
it is full. This function has the same GC friendliness as Weak.get_copy
If the element is a custom block it is not copied.
val set_key : ('k, 'd) t -> 'k -> unitEphemeron.K1.set_key eph el sets the key of eph to be a
(full) key to elval unset_key : ('k, 'd) t -> unitEphemeron.K1.unset_key eph el sets the key of eph to be an
empty key. Since there is only one key, the ephemeron starts
behaving like a reference on the data.val check_key : ('k, 'd) t -> boolEphemeron.K1.check_key eph returns true if the key of the eph
is full, false if it is empty. Note that even if
Ephemeron.K1.check_key eph returns true, a subsequent
Ephemeron.K1.get_keyeph can return None.val blit_key : ('k, 'a) t -> ('k, 'b) t -> unitEphemeron.K1.blit_key eph1 eph2 sets the key of eph2 with
the key of eph1. Contrary to using Ephemeron.K1.get_key
followed by Ephemeron.K1.set_key or Ephemeron.K1.unset_key
this function does not prevent the incremental GC from erasing
the value in its current cycle.val get_data : ('k, 'd) t -> 'd optionEphemeron.K1.get_data eph returns None if the data of eph is
empty, Some x (where x is the data) if it is full.val get_data_copy : ('k, 'd) t -> 'd optionEphemeron.K1.get_data_copy eph returns None if the data of eph is
empty, Some x (where x is a (shallow) copy of the data) if
it is full. This function has the same GC friendliness as Weak.get_copy
If the element is a custom block it is not copied.
val set_data : ('k, 'd) t -> 'd -> unitEphemeron.K1.set_data eph el sets the data of eph to be a
(full) data to elval unset_data : ('k, 'd) t -> unitEphemeron.K1.unset_data eph el sets the key of eph to be an
empty key. The ephemeron starts behaving like a weak pointer.val check_data : ('k, 'd) t -> boolEphemeron.K1.check_data eph returns true if the data of the eph
is full, false if it is empty. Note that even if
Ephemeron.K1.check_data eph returns true, a subsequent
Ephemeron.K1.get_dataeph can return None.val blit_data : ('a, 'd) t -> ('b, 'd) t -> unitEphemeron.K1.blit_data eph1 eph2 sets the data of eph2 with
the data of eph1. Contrary to using Ephemeron.K1.get_data
followed by Ephemeron.K1.set_data or Ephemeron.K1.unset_data
this function does not prevent the incremental GC from erasing
the value in its current cycle.module Make:
module MakeSeeded:
module Cty:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.class_type_desc -> Parsetree.class_type
val attr : Parsetree.class_type -> Parsetree.attribute -> Parsetree.class_type
val constr : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.class_type
val signature : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.class_signature -> Parsetree.class_type
val arrow : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.core_type -> Parsetree.class_type -> Parsetree.class_type
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_type ocaml-doc-4.05/ocaml.html/libref/type_Genlex.html 0000644 0001750 0001750 00000017277 13131636444 020733 0 ustar mehdi mehdi
sig
type token =
Kwd of string
| Ident of string
| Int of int
| Float of float
| String of string
| Char of char
val make_lexer : string list -> char Stream.t -> Genlex.token Stream.t
end ocaml-doc-4.05/ocaml.html/libref/Targetint.html 0000644 0001750 0001750 00000054562 13131636451 020405 0 ustar mehdi mehdi
module Targetint:sig..end
This module provides operations on the type of
signed 32-bit integers (on 32-bit target platforms) or
signed 64-bit integers (on 64-bit target platforms).
This integer type has exactly the same width as that of a
pointer type in the C compiler. All arithmetic operations over
are taken modulo 232 or 264 depending
on the word size of the target architecture.
type
val zero : tval one : tval minus_one : tval neg : t -> tval add : t -> t -> tval sub : t -> t -> tval mul : t -> t -> tval div : t -> t -> tDivision_by_zero if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for (/).val rem : t -> t -> ty is not zero, the result
of Targetint.rem x y satisfies the following properties:
Targetint.zero <= Nativeint.rem x y < Targetint.abs y and
x = Targetint.add (Targetint.mul (Targetint.div x y) y)
(Targetint.rem x y).
If y = 0, Targetint.rem x y raises Division_by_zero.val succ : t -> tTargetint.succ x is Targetint.add x Targetint.one.val pred : t -> tTargetint.pred x is Targetint.sub x Targetint.one.val abs : t -> tval size : intval max_int : tval min_int : tval logand : t -> t -> tval logor : t -> t -> tval logxor : t -> t -> tval lognot : t -> tval shift_left : t -> int -> tTargetint.shift_left x y shifts x to the left by y bits.
The result is unspecified if y < 0 or y >= bitsize,
where bitsize is 32 on a 32-bit platform and
64 on a 64-bit platform.val shift_right : t -> int -> tTargetint.shift_right x y shifts x to the right by y bits.
This is an arithmetic shift: the sign bit of x is replicated
and inserted in the vacated bits.
The result is unspecified if y < 0 or y >= bitsize.val shift_right_logical : t -> int -> tTargetint.shift_right_logical x y shifts x to the right
by y bits.
This is a logical shift: zeroes are inserted in the vacated bits
regardless of the sign of x.
The result is unspecified if y < 0 or y >= bitsize.val of_int : int -> tint) to a target integer
(type t), module the target word size.val of_int_exn : int -> tint) to a target integer
(type t). Raises a fatal error if the conversion is not exact.val to_int : t -> intt) to an
integer (type int). The high-order bit is lost during
the conversion.val of_float : float -> tTargetint.min_int, Targetint.max_int].val to_float : t -> floatval of_int32 : int32 -> tint32)
to a target integer.val to_int32 : t -> int32int32). On 64-bit platforms,
the 64-bit native integer is taken modulo 232,
i.e. the top 32 bits are lost. On 32-bit platforms,
the conversion is exact.val of_int64 : int64 -> tint64)
to a target integer.val to_int64 : t -> int64int64).val of_string : string -> t0x, 0o or 0b
respectively.
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 nativeint.val to_string : t -> stringval compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module Targetint to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> booltype
| |
Int32 of |
| |
Int64 of |
val repr : t -> reprmodule Scanning:sig..end
type
Scanf module:
those channels provide all the machinery necessary to read from any source
of characters, including a in_channel value.
A Scanf.Scanning.in_channel value is also called a formatted input
channel or equivalently a scanning buffer.
The type Scanf.Scanning.scanbuf below is an alias for Scanning.in_channel.typescanbuf =in_channel
Note: a scanning action may often require to examine one character in
advance; when this 'lookahead' character does not belong to the token
read, it is stored back in the scanning buffer and becomes the next
character yet to be read.
val stdin : in_channelScanf module.
Scanning.stdin is the Scanf.Scanning.in_channel formatted input channel
attached to stdin.
Note: in the interactive system, when input is read from
stdin, the newline character that triggers evaluation is
part of the input; thus, the scanning specifications must properly skip
this additional newline character (for instance, simply add a '\n' as
the last character of the format string).
Since 3.12.0
typefile_name =string
val open_in : file_name -> in_channelScanning.open_in fname returns a Scanf.Scanning.in_channel formatted input
channel for bufferized reading in text mode from file fname.
Note:
open_in returns a formatted input channel that efficiently reads
characters in large chunks; in contrast, from_channel below returns
formatted input channels that must read one character at a time, leading
to a much slower scanning rate.
Since 3.12.0
val open_in_bin : file_name -> in_channelScanning.open_in_bin fname returns a Scanf.Scanning.in_channel formatted
input channel for bufferized reading in binary mode from file fname.val close_in : in_channel -> unitin_channel associated with the given
Scanf.Scanning.in_channel formatted input channel.val from_file : file_name -> in_channelScanf.Scanning.open_in above.val from_file_bin : string -> in_channelScanf.Scanning.open_in_bin above.val from_string : string -> in_channelScanning.from_string s returns a Scanf.Scanning.in_channel formatted
input channel which reads from the given string.
Reading starts from the first character in the string.
The end-of-input condition is set when the end of the string is reached.val from_function : (unit -> char) -> in_channelScanning.from_function f returns a Scanf.Scanning.in_channel formatted
input channel with the given function as its reading method.
When scanning needs one more character, the given function is called.
When the function has no more character to provide, it must signal an
end-of-input condition by raising the exception End_of_file.
val from_channel : in_channel -> in_channelScanning.from_channel ic returns a Scanf.Scanning.in_channel formatted
input channel which reads from the regular in_channel input
channel ic argument.
Reading starts at current reading position of ic.val end_of_input : in_channel -> boolScanning.end_of_input ic tests the end-of-input condition of the given
Scanf.Scanning.in_channel formatted input channel.val beginning_of_input : in_channel -> boolScanning.beginning_of_input ic tests the beginning of input condition
of the given Scanf.Scanning.in_channel formatted input channel.val name_of_input : in_channel -> stringScanning.name_of_input ic returns the name of the character source
for the given Scanf.Scanning.in_channel formatted input channel.val stdib : in_channel
ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Vb.html 0000644 0001750 0001750 00000016413 13131636441 022131 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Parsetree.pattern -> Parsetree.expression -> Parsetree.value_binding
end ocaml-doc-4.05/ocaml.html/libref/List.html 0000644 0001750 0001750 00000100640 13131636445 017347 0 ustar mehdi mehdi
module List:sig..end
Some functions are flagged as not tail-recursive. A tail-recursive function uses constant stack space, while a non-tail-recursive function uses stack space proportional to the length of its list argument, which can be a problem with very long lists. When the function takes several list arguments, an approximate formula giving stack usage (in some unspecified constant unit) is shown in parentheses.
The above considerations can usually be ignored if your lists are not
longer than about 10000 elements.
val length : 'a list -> intval compare_lengths : 'a list -> 'b list -> intcompare_lengths l1 l2 is
equivalent to compare (length l1) (length l2), except that
the computation stops after itering on the shortest list.val compare_length_with : 'a list -> int -> intcompare_length_with l n is
equivalent to compare (length l) n, except that
the computation stops after at most n iterations on the list.val cons : 'a -> 'a list -> 'a listcons x xs is x :: xsval hd : 'a list -> 'aFailure "hd" if the list is empty.val tl : 'a list -> 'a listFailure "tl" if the list is empty.val nth : 'a list -> int -> 'an-th element of the given list.
The first element (head of the list) is at position 0.
Raise Failure "nth" if the list is too short.
Raise Invalid_argument "List.nth" if n is negative.val nth_opt : 'a list -> int -> 'a optionn-th element of the given list.
The first element (head of the list) is at position 0.
Return None if the list is too short.
Raise Invalid_argument "List.nth" if n is negative.val rev : 'a list -> 'a listval append : 'a list -> 'a list -> 'a list@.
Not tail-recursive (length of the first argument).val rev_append : 'a list -> 'a list -> 'a listList.rev_append l1 l2 reverses l1 and concatenates it to l2.
This is equivalent to List.rev l1 @ l2, but rev_append is
tail-recursive and more efficient.val concat : 'a list list -> 'a listval flatten : 'a list list -> 'a listconcat.val iter : ('a -> unit) -> 'a list -> unitList.iter f [a1; ...; an] applies function f in turn to
a1; ...; an. It is equivalent to
begin f a1; f a2; ...; f an; () end.val iteri : (int -> 'a -> unit) -> 'a list -> unitList.iter, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.val map : ('a -> 'b) -> 'a list -> 'b listList.map f [a1; ...; an] applies function f to a1, ..., an,
and builds the list [f a1; ...; f an]
with the results returned by f. Not tail-recursive.val mapi : (int -> 'a -> 'b) -> 'a list -> 'b listList.map, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument. Not tail-recursive.val rev_map : ('a -> 'b) -> 'a list -> 'b listList.rev_map f l gives the same result as
List.rev (List.map f l), but is tail-recursive and
more efficient.val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b list -> 'aList.fold_left f a [b1; ...; bn] is
f (... (f (f a b1) b2) ...) bn.val fold_right : ('a -> 'b -> 'b) -> 'a list -> 'b -> 'bList.fold_right f [a1; ...; an] b is
f a1 (f a2 (... (f an b) ...)). Not tail-recursive.val iter2 : ('a -> 'b -> unit) -> 'a list -> 'b list -> unitList.iter2 f [a1; ...; an] [b1; ...; bn] calls in turn
f a1 b1; ...; f an bn.
Raise Invalid_argument if the two lists are determined
to have different lengths.val map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c listList.map2 f [a1; ...; an] [b1; ...; bn] is
[f a1 b1; ...; f an bn].
Raise Invalid_argument if the two lists are determined
to have different lengths. Not tail-recursive.val rev_map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c listList.rev_map2 f l1 l2 gives the same result as
List.rev (List.map2 f l1 l2), but is tail-recursive and
more efficient.val fold_left2 : ('a -> 'b -> 'c -> 'a) -> 'a -> 'b list -> 'c list -> 'aList.fold_left2 f a [b1; ...; bn] [c1; ...; cn] is
f (... (f (f a b1 c1) b2 c2) ...) bn cn.
Raise Invalid_argument if the two lists are determined
to have different lengths.val fold_right2 : ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'cList.fold_right2 f [a1; ...; an] [b1; ...; bn] c is
f a1 b1 (f a2 b2 (... (f an bn c) ...)).
Raise Invalid_argument if the two lists are determined
to have different lengths. Not tail-recursive.val for_all : ('a -> bool) -> 'a list -> boolfor_all p [a1; ...; an] checks if all elements of the list
satisfy the predicate p. That is, it returns
(p a1) && (p a2) && ... && (p an).val exists : ('a -> bool) -> 'a list -> boolexists p [a1; ...; an] checks if at least one element of
the list satisfies the predicate p. That is, it returns
(p a1) || (p a2) || ... || (p an).val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> boolList.for_all, but for a two-argument predicate.
Raise Invalid_argument if the two lists are determined
to have different lengths.val exists2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> boolList.exists, but for a two-argument predicate.
Raise Invalid_argument if the two lists are determined
to have different lengths.val mem : 'a -> 'a list -> boolmem a l is true if and only if a is equal
to an element of l.val memq : 'a -> 'a list -> boolList.mem, but uses physical equality instead of structural
equality to compare list elements.val find : ('a -> bool) -> 'a list -> 'afind p l returns the first element of the list l
that satisfies the predicate p.
Raise Not_found if there is no value that satisfies p in the
list l.val find_opt : ('a -> bool) -> 'a list -> 'a optionfind_opt p l returns the first element of the list l that
satisfies the predicate p, or None if there is no value that
satisfies p in the list l.val filter : ('a -> bool) -> 'a list -> 'a listfilter p l returns all the elements of the list l
that satisfy the predicate p. The order of the elements
in the input list is preserved.val find_all : ('a -> bool) -> 'a list -> 'a list
val partition : ('a -> bool) -> 'a list -> 'a list * 'a listpartition p l returns a pair of lists (l1, l2), where
l1 is the list of all the elements of l that
satisfy the predicate p, and l2 is the list of all the
elements of l that do not satisfy p.
The order of the elements in the input list is preserved.val assoc : 'a -> ('a * 'b) list -> 'bassoc a l returns the value associated with key a in the list of
pairs l. That is,
assoc a [ ...; (a,b); ...] = b
if (a,b) is the leftmost binding of a in list l.
Raise Not_found if there is no value associated with a in the
list l.val assoc_opt : 'a -> ('a * 'b) list -> 'b optionassoc_opt a l returns the value associated with key a in the list of
pairs l. That is,
assoc_opt a [ ...; (a,b); ...] = b
if (a,b) is the leftmost binding of a in list l.
Returns None if there is no value associated with a in the
list l.val assq : 'a -> ('a * 'b) list -> 'bList.assoc, but uses physical equality instead of structural
equality to compare keys.val assq_opt : 'a -> ('a * 'b) list -> 'b optionList.assoc_opt, but uses physical equality instead of structural
equality to compare keys.val mem_assoc : 'a -> ('a * 'b) list -> boolList.assoc, but simply return true if a binding exists,
and false if no bindings exist for the given key.val mem_assq : 'a -> ('a * 'b) list -> boolList.mem_assoc, but uses physical equality instead of
structural equality to compare keys.val remove_assoc : 'a -> ('a * 'b) list -> ('a * 'b) listremove_assoc a l returns the list of
pairs l without the first pair with key a, if any.
Not tail-recursive.val remove_assq : 'a -> ('a * 'b) list -> ('a * 'b) listList.remove_assoc, but uses physical equality instead
of structural equality to compare keys. Not tail-recursive.val split : ('a * 'b) list -> 'a list * 'b listsplit [(a1,b1); ...; (an,bn)] is ([a1; ...; an], [b1; ...; bn]).
Not tail-recursive.val combine : 'a list -> 'b list -> ('a * 'b) listcombine [a1; ...; an] [b1; ...; bn] is
[(a1,b1); ...; (an,bn)].
Raise Invalid_argument if the two lists
have different lengths. Not tail-recursive.val sort : ('a -> 'a -> int) -> 'a list -> 'a listcompare is a suitable comparison function.
The resulting list is sorted in increasing order.
List.sort is guaranteed to run in constant heap space
(in addition to the size of the result list) and logarithmic
stack space.
The current implementation uses Merge Sort. It runs in constant
heap space and logarithmic stack space.
val stable_sort : ('a -> 'a -> int) -> 'a list -> 'a listList.sort, but the sorting algorithm is guaranteed to
be stable (i.e. elements that compare equal are kept in their
original order) .
The current implementation uses Merge Sort. It runs in constant
heap space and logarithmic stack space.
val fast_sort : ('a -> 'a -> int) -> 'a list -> 'a list
val sort_uniq : ('a -> 'a -> int) -> 'a list -> 'a list
val merge : ('a -> 'a -> int) -> 'a list -> 'a list -> 'a listl1 and l2 are sorted according to the
comparison function cmp, merge cmp l1 l2 will return a
sorted list containting all the elements of l1 and l2.
If several elements compare equal, the elements of l1 will be
before the elements of l2.
Not tail-recursive (sum of the lengths of the arguments).module Big_int:sig..end
Big integers (type big_int) are signed integers of arbitrary size.
type
val zero_big_int : big_int0.val unit_big_int : big_int1.val minus_big_int : big_int -> big_intval abs_big_int : big_int -> big_intval add_big_int : big_int -> big_int -> big_intval succ_big_int : big_int -> big_intval add_int_big_int : int -> big_int -> big_intval sub_big_int : big_int -> big_int -> big_intval pred_big_int : big_int -> big_intval mult_big_int : big_int -> big_int -> big_intval mult_int_big_int : int -> big_int -> big_intval square_big_int : big_int -> big_intval sqrt_big_int : big_int -> big_intsqrt_big_int a returns the integer square root of a,
that is, the largest big integer r such that r * r <= a.
Raise Invalid_argument if a is negative.val quomod_big_int : big_int -> big_int -> big_int * big_int(q,r) = quomod_big_int a b, we have
a = q * b + r and 0 <= r < |b|.
Raise Division_by_zero if the divisor is zero.val div_big_int : big_int -> big_int -> big_intq of quomod_big_int (see above).val mod_big_int : big_int -> big_int -> big_intr of quomod_big_int (see above).val gcd_big_int : big_int -> big_int -> big_intval power_int_positive_int : int -> int -> big_int
val power_big_int_positive_int : big_int -> int -> big_int
val power_int_positive_big_int : int -> big_int -> big_int
val power_big_int_positive_big_int : big_int -> big_int -> big_inta raised to the power b
(the second argument). Depending
on the function, a and b can be either small integers
or big integers. Raise Invalid_argument if b is negative.val sign_big_int : big_int -> int0 if the given big integer is zero,
1 if it is positive, and -1 if it is negative.val compare_big_int : big_int -> big_int -> intcompare_big_int a b returns 0 if a and b are equal,
1 if a is greater than b, and -1 if a is smaller
than b.val eq_big_int : big_int -> big_int -> bool
val le_big_int : big_int -> big_int -> bool
val ge_big_int : big_int -> big_int -> bool
val lt_big_int : big_int -> big_int -> bool
val gt_big_int : big_int -> big_int -> boolval max_big_int : big_int -> big_int -> big_intval min_big_int : big_int -> big_int -> big_intval num_digits_big_int : big_int -> intval num_bits_big_int : big_int -> intnum_bits_big_int a
returns 0 if a is 0; otherwise it returns a positive
integer n such that 2^(n-1) <= |a| < 2^n.val string_of_big_int : big_int -> stringval big_int_of_string : string -> big_int- or + sign,
followed by one or several decimal digits.val big_int_of_string_opt : string -> big_int option- or + sign,
followed by one or several decimal digits. Other the function
returns None.val big_int_of_int : int -> big_intval is_int_big_int : big_int -> boolint)
without loss of precision. On a 32-bit platform,
is_int_big_int a returns true if and only if
a is between 230 and 230-1. On a 64-bit platform,
is_int_big_int a returns true if and only if
a is between -262 and 262-1.val int_of_big_int : big_int -> intint).
Raises Failure "int_of_big_int" if the big integer
is not representable as a small integer.val int_of_big_int_opt : big_int -> int optionint). Return
None if the big integer is not representable as a small
integer.val big_int_of_int32 : int32 -> big_intval big_int_of_nativeint : nativeint -> big_intval big_int_of_int64 : int64 -> big_intval int32_of_big_int : big_int -> int32Failure if the big integer is outside the
range [-231, 231-1].val int32_of_big_int_opt : big_int -> int32 optionNone if the
big integer is outside the range [-231, 231-1].val nativeint_of_big_int : big_int -> nativeintFailure if the big integer is outside the
range [Nativeint.min_int, Nativeint.max_int].val nativeint_of_big_int_opt : big_int -> nativeint optionNone if the
big integer is outside the range [Nativeint.min_int,
Nativeint.max_int];val int64_of_big_int : big_int -> int64Failure if the big integer is outside the
range [-263, 263-1].val int64_of_big_int_opt : big_int -> int64 optionNone if the
big integer is outside the range [-263, 263-1].val float_of_big_int : big_int -> floatval and_big_int : big_int -> big_int -> big_intval or_big_int : big_int -> big_int -> big_intval xor_big_int : big_int -> big_int -> big_intval shift_left_big_int : big_int -> int -> big_intshift_left_big_int b n returns b shifted left by n bits.
Equivalent to multiplication by 2^n.val shift_right_big_int : big_int -> int -> big_intshift_right_big_int b n returns b shifted right by n bits.
Equivalent to division by 2^n with the result being
rounded towards minus infinity.val shift_right_towards_zero_big_int : big_int -> int -> big_intshift_right_towards_zero_big_int b n returns b shifted
right by n bits. The shift is performed on the absolute
value of b, and the result has the same sign as b.
Equivalent to division by 2^n with the result being
rounded towards zero.val extract_big_int : big_int -> int -> int -> big_intextract_big_int bi ofs n returns a nonnegative number
corresponding to bits ofs to ofs + n - 1 of the
binary representation of bi. If bi is negative,
a two's complement representation is used.sig
val interface : Format.formatter -> Parsetree.signature_item list -> unit
val implementation :
Format.formatter -> Parsetree.structure_item list -> unit
val top_phrase : Format.formatter -> Parsetree.toplevel_phrase -> unit
val expression : int -> Format.formatter -> Parsetree.expression -> unit
val structure : int -> Format.formatter -> Parsetree.structure -> unit
val payload : int -> Format.formatter -> Parsetree.payload -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Ccomp.html 0000644 0001750 0001750 00000020302 13131636443 020530 0 ustar mehdi mehdi
sig
val command : string -> int
val run_command : string -> unit
val compile_file : string -> int
val create_archive : string -> string list -> int
val expand_libname : string -> string
val quote_files : string list -> string
val quote_optfile : string option -> string
type link_mode = Exe | Dll | MainDll | Partial
val call_linker :
Ccomp.link_mode -> string -> string list -> string -> bool
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Cstr.html 0000644 0001750 0001750 00000016476 13131636441 021445 0 ustar mehdi mehdi
module Cstr:sig..end
val mk : Parsetree.pattern -> Parsetree.class_field list -> Parsetree.class_structure ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Mty.html 0000644 0001750 0001750 00000025233 13131636441 021272 0 ustar mehdi mehdi
module Mty:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_type_desc -> Parsetree.module_type
val attr : Parsetree.module_type -> Parsetree.attribute -> Parsetree.module_type
val ident : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
val alias : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
val signature : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.signature -> Parsetree.module_type
val functor_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_type option ->
Parsetree.module_type -> Parsetree.module_type
val with_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_type ->
Parsetree.with_constraint list -> Parsetree.module_type
val typeof_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.module_expr -> Parsetree.module_type
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.module_type ocaml-doc-4.05/ocaml.html/libref/Identifiable.S.html 0000644 0001750 0001750 00000020155 13131636444 021215 0 ustar mehdi mehdi
module type S =sig..end
type
module T:Identifiable.Thingwith type t = t
include Identifiable.Thing
module Set:sig..end
module Map:sig..end
module Tbl:ocaml-doc-4.05/ocaml.html/libref/MoreLabels.Set.Make.html 0000644 0001750 0001750 00000037331 13131636446 022076 0 ustar mehdi mehdisig..end
module Make:
| Parameters: |
|
type
type
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : f:(elt -> unit) -> t -> unit
val map : f:(elt -> elt) ->
t -> t
val fold : f:(elt -> 'a -> 'a) -> t -> init:'a -> 'a
val for_all : f:(elt -> bool) -> t -> bool
val exists : f:(elt -> bool) -> t -> bool
val filter : f:(elt -> bool) -> t -> t
val partition : f:(elt -> bool) ->
t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt ->
t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : f:(elt -> bool) ->
t -> elt
val find_first_opt : f:(elt -> bool) ->
t -> elt option
val find_last : f:(elt -> bool) ->
t -> elt
val find_last_opt : f:(elt -> bool) ->
t -> elt option
val of_list : elt list -> t ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Ci.html 0000644 0001750 0001750 00000017162 13131636441 022117 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?virt:Asttypes.virtual_flag ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
Ast_helper.str -> 'a -> 'a Parsetree.class_infos
end ocaml-doc-4.05/ocaml.html/libref/Strongly_connected_components.html 0000644 0001750 0001750 00000020056 13131636451 024543 0 ustar mehdi mehdi
module Strongly_connected_components:sig..end
module type S =sig..end
module Make:ocaml-doc-4.05/ocaml.html/libref/Sort.html 0000644 0001750 0001750 00000021345 13131636450 017363 0 ustar mehdi mehdi
module Sort:sig..end
Array and List should be used instead.
The new functions are faster and use less memory.val list : ('a -> 'a -> bool) -> 'a list -> 'a listtrue if its first argument is
less than or equal to its second argument.val array : ('a -> 'a -> bool) -> 'a array -> unittrue if its first argument is
less than or equal to its second argument.
The array is sorted in place.val merge : ('a -> 'a -> bool) -> 'a list -> 'a list -> 'a listmerge returns a sorted list containing the elements
from the two lists. The behavior is undefined if the two
argument lists were not sorted.sig
val zero : int32
val one : int32
val minus_one : int32
external neg : int32 -> int32 = "%int32_neg"
external add : int32 -> int32 -> int32 = "%int32_add"
external sub : int32 -> int32 -> int32 = "%int32_sub"
external mul : int32 -> int32 -> int32 = "%int32_mul"
external div : int32 -> int32 -> int32 = "%int32_div"
external rem : int32 -> int32 -> int32 = "%int32_mod"
val succ : int32 -> int32
val pred : int32 -> int32
val abs : int32 -> int32
val max_int : int32
val min_int : int32
external logand : int32 -> int32 -> int32 = "%int32_and"
external logor : int32 -> int32 -> int32 = "%int32_or"
external logxor : int32 -> int32 -> int32 = "%int32_xor"
val lognot : int32 -> int32
external shift_left : int32 -> int -> int32 = "%int32_lsl"
external shift_right : int32 -> int -> int32 = "%int32_asr"
external shift_right_logical : int32 -> int -> int32 = "%int32_lsr"
external of_int : int -> int32 = "%int32_of_int"
external to_int : int32 -> int = "%int32_to_int"
external of_float : float -> int32 = "caml_int32_of_float"
"caml_int32_of_float_unboxed" [@@unboxed] [@@noalloc]
external to_float : int32 -> float = "caml_int32_to_float"
"caml_int32_to_float_unboxed" [@@unboxed] [@@noalloc]
external of_string : string -> int32 = "caml_int32_of_string"
val of_string_opt : string -> int32 option
val to_string : int32 -> string
external bits_of_float : float -> int32 = "caml_int32_bits_of_float"
"caml_int32_bits_of_float_unboxed" [@@unboxed] [@@noalloc]
external float_of_bits : int32 -> float = "caml_int32_float_of_bits"
"caml_int32_float_of_bits_unboxed" [@@unboxed] [@@noalloc]
type t = int32
val compare : Int32.t -> Int32.t -> int
val equal : Int32.t -> Int32.t -> bool
external format : string -> int32 -> string = "caml_int32_format"
end ocaml-doc-4.05/ocaml.html/libref/type_Printf.html 0000644 0001750 0001750 00000027115 13131636450 020740 0 ustar mehdi mehdi
sig
val fprintf :
Pervasives.out_channel ->
('a, Pervasives.out_channel, unit) Pervasives.format -> 'a
val printf : ('a, Pervasives.out_channel, unit) Pervasives.format -> 'a
val eprintf : ('a, Pervasives.out_channel, unit) Pervasives.format -> 'a
val sprintf : ('a, unit, string) Pervasives.format -> 'a
val bprintf : Buffer.t -> ('a, Buffer.t, unit) Pervasives.format -> 'a
val ifprintf : 'b -> ('a, 'b, 'c, unit) Pervasives.format4 -> 'a
val kfprintf :
(Pervasives.out_channel -> 'd) ->
Pervasives.out_channel ->
('a, Pervasives.out_channel, unit, 'd) Pervasives.format4 -> 'a
val ikfprintf :
('b -> 'd) -> 'b -> ('a, 'b, 'c, 'd) Pervasives.format4 -> 'a
val ksprintf :
(string -> 'd) -> ('a, unit, string, 'd) Pervasives.format4 -> 'a
val kbprintf :
(Buffer.t -> 'd) ->
Buffer.t -> ('a, Buffer.t, unit, 'd) Pervasives.format4 -> 'a
val kprintf :
(string -> 'b) -> ('a, unit, string, 'b) Pervasives.format4 -> 'a
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Map.OrderedType.html 0000644 0001750 0001750 00000014710 13131636446 024466 0 ustar mehdi mehdi
Map.OrderedType ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.Kn.Make.html 0000644 0001750 0001750 00000027327 13131636443 022652 0 ustar mehdi mehdi
functor (H : Hashtbl.HashedType) ->
sig
type key = H.t array
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/Ccomp.html 0000644 0001750 0001750 00000022244 13131636443 017476 0 ustar mehdi mehdi
module Ccomp:sig..end
val command : string -> int
val run_command : string -> unit
val compile_file : string -> int
val create_archive : string -> string list -> int
val expand_libname : string -> string
val quote_files : string list -> string
val quote_optfile : string option -> string
type
| |
Exe |
| |
Dll |
| |
MainDll |
| |
Partial |
val call_linker : link_mode -> string -> string list -> string -> bool ocaml-doc-4.05/ocaml.html/libref/BytesLabels.html 0000644 0001750 0001750 00000075246 13131636442 020657 0 ustar mehdi mehdi
module BytesLabels:sig..end
val length : bytes -> intval get : bytes -> int -> charget s n returns the byte at index n in argument s.
Raise Invalid_argument if n is not a valid index in s.
val set : bytes -> int -> char -> unitset s n c modifies s in place, replacing the byte at index n
with c.
Raise Invalid_argument if n is not a valid index in s.
val create : int -> bytescreate n returns a new byte sequence of length n. The
sequence is uninitialized and contains arbitrary bytes.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val make : int -> char -> bytesmake n c returns a new byte sequence of length n, filled with
the byte c.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val init : int -> f:(int -> char) -> bytesinit n f returns a fresh byte sequence of length n,
with character i initialized to the result of f i.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val empty : bytesval copy : bytes -> bytesval of_string : string -> bytesval to_string : bytes -> stringval sub : bytes -> pos:int -> len:int -> bytessub s start len returns a new byte sequence of length len,
containing the subsequence of s that starts at position start
and has length len.
Raise Invalid_argument if start and len do not designate a
valid range of s.
val sub_string : bytes -> int -> int -> stringsub but return a string instead of a byte sequence.val extend : bytes -> left:int -> right:int -> bytesextend s left right returns a new byte sequence that contains
the bytes of s, with left uninitialized bytes prepended and
right uninitialized bytes appended to it. If left or right
is negative, then bytes are removed (instead of appended) from
the corresponding side of s.
Raise Invalid_argument if the result length is negative or
longer than Sys.max_string_length bytes.
Since 4.05.0
val fill : bytes -> pos:int -> len:int -> char -> unitfill s start len c modifies s in place, replacing len
characters with c, starting at start.
Raise Invalid_argument if start and len do not designate a
valid range of s.
val blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitblit src srcoff dst dstoff len copies len bytes from sequence
src, starting at index srcoff, to sequence dst, starting at
index dstoff. It works correctly even if src and dst are the
same byte sequence, and the source and destination intervals
overlap.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
val blit_string : src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitblit src srcoff dst dstoff len copies len bytes from string
src, starting at index srcoff, to byte sequence dst,
starting at index dstoff.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
Since 4.05.0
val concat : sep:bytes -> bytes list -> bytesconcat sep sl concatenates the list of byte sequences sl,
inserting the separator byte sequence sep between each, and
returns the result as a new byte sequence.val cat : bytes -> bytes -> bytescat s1 s2 concatenates s1 and s2 and returns the result
as new byte sequence.
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
Since 4.05.0
val iter : f:(char -> unit) -> bytes -> unititer f s applies function f in turn to all the bytes of s.
It is equivalent to f (get s 0); f (get s 1); ...; f (get s
(length s - 1)); ().val iteri : f:(int -> char -> unit) -> bytes -> unitBytes.iter, but the function is applied to the index of
the byte as first argument and the byte itself as second
argument.val map : f:(char -> char) -> bytes -> bytesmap f s applies function f in turn to all the bytes of s and
stores the resulting bytes in a new sequence that is returned as
the result.val mapi : f:(int -> char -> char) -> bytes -> bytesmapi f s calls f with each character of s and its
index (in increasing index order) and stores the resulting bytes
in a new sequence that is returned as the result.val trim : bytes -> bytes' ', '\012', '\n', '\r', and '\t'.val escaped : bytes -> bytesval index : bytes -> char -> intindex s c returns the index of the first occurrence of byte c
in s.
Raise Not_found if c does not occur in s.
val index_opt : bytes -> char -> int optionindex_opt s c returns the index of the first occurrence of byte c
in s or None if c does not occur in s.val rindex : bytes -> char -> intrindex s c returns the index of the last occurrence of byte c
in s.
Raise Not_found if c does not occur in s.
val rindex_opt : bytes -> char -> int optionrindex_opt s c returns the index of the last occurrence of byte c
in s or None if c does not occur in s.val index_from : bytes -> int -> char -> intindex_from s i c returns the index of the first occurrence of
byte c in s after position i. Bytes.index s c is
equivalent to Bytes.index_from s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Raise Not_found if c does not occur in s after position i.
val index_from_opt : bytes -> int -> char -> int optionindex_from _opts i c returns the index of the first occurrence of
byte c in s after position i or None if c does not occur in s after position i.
Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Since 4.05
val rindex_from : bytes -> int -> char -> intrindex_from s i c returns the index of the last occurrence of
byte c in s before position i+1. rindex s c is equivalent
to rindex_from s (Bytes.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Raise Not_found if c does not occur in s before position i+1.
val rindex_from_opt : bytes -> int -> char -> int optionrindex_from_opt s i c returns the index of the last occurrence
of byte c in s before position i+1 or None if c does not
occur in s before position i+1. rindex_opt s c is equivalent to
rindex_from s (Bytes.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Since 4.05
val contains : bytes -> char -> boolcontains s c tests if byte c appears in s.val contains_from : bytes -> int -> char -> boolcontains_from s start c tests if byte c appears in s after
position start. contains s c is equivalent to contains_from
s 0 c.
Raise Invalid_argument if start is not a valid position in s.
val rcontains_from : bytes -> int -> char -> boolrcontains_from s stop c tests if byte c appears in s before
position stop+1.
Raise Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.
val uppercase : bytes -> bytesval lowercase : bytes -> bytesval capitalize : bytes -> bytesval uncapitalize : bytes -> bytesval uppercase_ascii : bytes -> bytesval lowercase_ascii : bytes -> bytesval capitalize_ascii : bytes -> bytesval uncapitalize_ascii : bytes -> bytestypet =bytes
val compare : t -> t -> intcompare. Along with the type t,
this function compare allows the module Bytes to be passed as
argument to the functors Set.Make and Map.Make.val equal : t -> t -> boolmodule Int64:sig..end
This module provides operations on the type int64 of
signed 64-bit integers. Unlike the built-in int type,
the type int64 is guaranteed to be exactly 64-bit wide on all
platforms. All arithmetic operations over int64 are taken
modulo 264
Performance notice: values of type int64 occupy more memory
space than values of type int, and arithmetic operations on
int64 are generally slower than those on int. Use int64
only when the application requires exact 64-bit arithmetic.
val zero : int64val one : int64val minus_one : int64val neg : int64 -> int64val add : int64 -> int64 -> int64val sub : int64 -> int64 -> int64val mul : int64 -> int64 -> int64val div : int64 -> int64 -> int64Division_by_zero if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for (/).val rem : int64 -> int64 -> int64y is not zero, the result
of Int64.rem x y satisfies the following property:
x = Int64.add (Int64.mul (Int64.div x y) y) (Int64.rem x y).
If y = 0, Int64.rem x y raises Division_by_zero.val succ : int64 -> int64Int64.succ x is Int64.add x Int64.one.val pred : int64 -> int64Int64.pred x is Int64.sub x Int64.one.val abs : int64 -> int64val max_int : int64val min_int : int64val logand : int64 -> int64 -> int64val logor : int64 -> int64 -> int64val logxor : int64 -> int64 -> int64val lognot : int64 -> int64val shift_left : int64 -> int -> int64Int64.shift_left x y shifts x to the left by y bits.
The result is unspecified if y < 0 or y >= 64.val shift_right : int64 -> int -> int64Int64.shift_right x y shifts x to the right by y bits.
This is an arithmetic shift: the sign bit of x is replicated
and inserted in the vacated bits.
The result is unspecified if y < 0 or y >= 64.val shift_right_logical : int64 -> int -> int64Int64.shift_right_logical x y shifts x to the right by y bits.
This is a logical shift: zeroes are inserted in the vacated bits
regardless of the sign of x.
The result is unspecified if y < 0 or y >= 64.val of_int : int -> int64int) to a 64-bit integer
(type int64).val to_int : int64 -> intint64) to an
integer (type int). On 64-bit platforms, the 64-bit integer
is taken modulo 263, i.e. the high-order bit is lost
during the conversion. On 32-bit platforms, the 64-bit integer
is taken modulo 231, i.e. the top 33 bits are lost
during the conversion.val of_float : float -> int64Int64.min_int, Int64.max_int].val to_float : int64 -> floatval of_int32 : int32 -> int64int32)
to a 64-bit integer (type int64).val to_int32 : int64 -> int32int64) to a
32-bit integer (type int32). The 64-bit integer
is taken modulo 232, i.e. the top 32 bits are lost
during the conversion.val of_nativeint : nativeint -> int64nativeint)
to a 64-bit integer (type int64).val to_nativeint : int64 -> nativeintint64) to a
native integer. On 32-bit platforms, the 64-bit integer
is taken modulo 232. On 64-bit platforms,
the conversion is exact.val of_string : string -> int640x, 0o or 0b
respectively.
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 int64.val of_string_opt : string -> int64 optionof_string, but return None instead of raising.val to_string : int64 -> stringval bits_of_float : float -> int64val float_of_bits : int64 -> floatint64.typet =int64
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module Int64 to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolmodule Warnings:sig..end
type
| |
Comment_start |
| |
Comment_not_end |
| |
Deprecated of |
| |
Fragile_match of |
| |
Partial_application |
| |
Labels_omitted of |
| |
Method_override of |
| |
Partial_match of |
| |
Non_closed_record_pattern of |
| |
Statement_type |
| |
Unused_match |
| |
Unused_pat |
| |
Instance_variable_override of |
| |
Illegal_backslash |
| |
Implicit_public_methods of |
| |
Unerasable_optional_argument |
| |
Undeclared_virtual_method of |
| |
Not_principal of |
| |
Without_principality of |
| |
Unused_argument |
| |
Nonreturning_statement |
| |
Preprocessor of |
| |
Useless_record_with |
| |
Bad_module_name of |
| |
All_clauses_guarded |
| |
Unused_var of |
| |
Unused_var_strict of |
| |
Wildcard_arg_to_constant_constr |
| |
Eol_in_string |
| |
Duplicate_definitions of |
| |
Multiple_definition of |
| |
Unused_value_declaration of |
| |
Unused_open of |
| |
Unused_type_declaration of |
| |
Unused_for_index of |
| |
Unused_ancestor of |
| |
Unused_constructor of |
| |
Unused_extension of |
| |
Unused_rec_flag |
| |
Name_out_of_scope of |
| |
Ambiguous_name of |
| |
Disambiguated_name of |
| |
Nonoptional_label of |
| |
Open_shadow_identifier of |
| |
Open_shadow_label_constructor of |
| |
Bad_env_variable of |
| |
Attribute_payload of |
| |
Eliminated_optional_arguments of |
| |
No_cmi_file of |
| |
Bad_docstring of |
| |
Expect_tailcall |
| |
Fragile_literal_pattern |
| |
Misplaced_attribute of |
| |
Duplicated_attribute of |
| |
Inlining_impossible of |
| |
Unreachable_case |
| |
Ambiguous_pattern of |
| |
No_cmx_file of |
| |
Assignment_to_non_mutable_value |
| |
Unused_module of |
| |
Unboxable_type_in_prim_decl of |
val parse_options : bool -> string -> unit
val is_active : t -> bool
val is_error : t -> bool
val defaults_w : string
val defaults_warn_error : string
val print : Format.formatter -> t -> unit
exception Errors of int
val check_fatal : unit -> unit
val reset_fatal : unit -> unit
val help_warnings : unit -> unit
type
val backup : unit -> state
val restore : state -> unit ocaml-doc-4.05/ocaml.html/libref/index_modules.html 0000644 0001750 0001750 00000077706 13131636452 021311 0 ustar mehdi mehdi
A | |
| Arg |
Parsing of command line arguments.
|
| Arg_helper |
Decipher command line arguments of the form
<value> | <key>=<value>
,...
(as used for example for the specification of inlining parameters
varying by simplification round).
|
| Arith_status |
Flags that control rational arithmetic.
|
| Array [StdLabels] | |
| Array |
Array operations.
|
| Array0 [Bigarray] |
Zero-dimensional arrays.
|
| Array1 [Bigarray] |
One-dimensional arrays.
|
| Array2 [Bigarray] |
Two-dimensional arrays.
|
| Array3 [Bigarray] |
Three-dimensional arrays.
|
| ArrayLabels |
Array operations.
|
| Ast_helper |
Helpers to produce Parsetree fragments
|
| Ast_invariants |
Check AST invariants
|
| Ast_iterator | Ast_iterator.iterator allows to implement AST inspection using open recursion.
|
| Ast_mapper |
The interface of a -ppx rewriter
|
| Asttypes |
Auxiliary AST types used by parsetree and typedtree.
|
| Attr_helper |
Helpers for attributes
|
B | |
| Big_int |
Operations on arbitrary-precision integers.
|
| Bigarray |
Large, multi-dimensional, numerical arrays.
|
| Buffer |
Extensible buffers.
|
| Builtin_attributes | |
| Bytes [StdLabels] | |
| Bytes |
Byte sequence operations.
|
| BytesLabels |
Byte sequence operations.
|
C | |
| Callback |
Registering OCaml values with the C runtime.
|
| CamlinternalFormat | |
| CamlinternalFormatBasics | |
| CamlinternalLazy |
Run-time support for lazy values.
|
| CamlinternalMod |
Run-time support for recursive modules.
|
| CamlinternalOO |
Run-time support for objects and classes.
|
| Ccomp | |
| Cf [Ast_helper] |
Class fields
|
| Char |
Character operations.
|
| Ci [Ast_helper] |
Classes
|
| Cl [Ast_helper] |
Class expressions
|
| Clflags |
Optimization parameters represented as ints indexed by round number.
|
| Color [Misc] | |
| Complex |
Complex numbers.
|
| Condition |
Condition variables to synchronize between threads.
|
| Config | |
| Consistbl | |
| Const [Ast_helper] | |
| Csig [Ast_helper] |
Class signatures
|
| Cstr [Ast_helper] |
Class structures
|
| Ctf [Ast_helper] |
Class type fields
|
| Cty [Ast_helper] |
Class type expressions
|
D | |
| Depend |
Module dependencies.
|
| Digest |
MD5 message digest.
|
| Docstrings |
Documentation comments
|
| Dynlink |
Dynamic loading of object files.
|
E | |
| Ephemeron [Obj] | |
| Ephemeron |
Ephemerons and weak hash table
|
| Event |
First-class synchronous communication.
|
| Exp [Ast_helper] |
Expressions
|
F | |
| Filename |
Operations on file names.
|
| Float [Numbers] | |
| Float_arg_helper [Clflags] |
Optimization parameters represented as floats indexed by round number.
|
| Format |
Pretty printing.
|
G | |
| Gc |
Memory management control and statistics; finalised values.
|
| GenHashTable [Ephemeron] | |
| Genarray [Bigarray] | |
| Genlex |
A generic lexical analyzer.
|
| Graphics |
Machine-independent graphics primitives.
|
| GraphicsX11 |
Additional graphics primitives for the X Windows system.
|
H | |
| Hashtbl [MoreLabels] | |
| Hashtbl |
Hash tables and hash functions.
|
I | |
| Id [Strongly_connected_components.S] | |
| Identifiable |
Uniform interface for common data structures over various things.
|
| Incl [Ast_helper] |
Includes
|
| Int [Numbers] | |
| Int32 |
32-bit integers.
|
| Int64 |
64-bit integers.
|
| Int_arg_helper [Clflags] | |
| Int_literal_converter [Misc] | |
K | |
| K1 [Ephemeron] | |
| K2 [Ephemeron] | |
| Kn [Ephemeron] | |
L | |
| LargeFile [UnixLabels] |
File operations on large files.
|
| LargeFile [Unix] |
File operations on large files.
|
| LargeFile [Pervasives] |
Operations on large files.
|
| Lazy |
Deferred computations.
|
| Lexer | |
| Lexing |
The run-time library for lexers generated by
ocamllex.
|
| List [StdLabels] | |
| List [Misc.Stdlib] | |
| List |
List operations.
|
| ListLabels |
List operations.
|
| Location |
Source code locations (ranges of positions), used in parsetree.
|
| LongString [Misc] | |
| Longident |
Long identifiers, used in parsetree.
|
M | |
| Make [Weak] |
Functor building an implementation of the weak hash set structure.
|
| Make [Strongly_connected_components] | |
| Make [Set] |
Functor building an implementation of the set structure
given a totally ordered type.
|
| Make [MoreLabels.Set] | |
| Make [MoreLabels.Map] | |
| Make [MoreLabels.Hashtbl] | |
| Make [Map] |
Functor building an implementation of the map structure
given a totally ordered type.
|
| Make [Identifiable] | |
| Make [Hashtbl] |
Functor building an implementation of the hashtable structure.
|
| Make [Ephemeron.Kn] |
Functor building an implementation of a weak hash table
|
| Make [Ephemeron.K2] |
Functor building an implementation of a weak hash table
|
| Make [Ephemeron.K1] |
Functor building an implementation of a weak hash table
|
| Make [Arg_helper] | |
| MakeHooks [Misc] | |
| MakeSeeded [MoreLabels.Hashtbl] | |
| MakeSeeded [Hashtbl] |
Functor building an implementation of the hashtable structure.
|
| MakeSeeded [Ephemeron.GenHashTable] |
Functor building an implementation of an hash table that use the container
for keeping the information given
|
| MakeSeeded [Ephemeron.Kn] |
Functor building an implementation of a weak hash table.
|
| MakeSeeded [Ephemeron.K2] |
Functor building an implementation of a weak hash table.
|
| MakeSeeded [Ephemeron.K1] |
Functor building an implementation of a weak hash table.
|
| Map [MoreLabels] | |
| Map |
Association tables over ordered types.
|
| Map [Identifiable.S] | |
| Marshal |
Marshaling of data structures.
|
| Mb [Ast_helper] |
Module bindings
|
| Md [Ast_helper] |
Module declarations
|
| Misc | protect_refs l f temporarily sets r to v for each R (r, v) in l
while executing f.
|
| Mod [Ast_helper] |
Module expressions
|
| MoreLabels |
Extra labeled libraries.
|
| Mtd [Ast_helper] |
Module type declarations
|
| Mty [Ast_helper] |
Module type expressions
|
| Mutex |
Locks for mutual exclusion.
|
N | |
| Nativeint |
Processor-native integers.
|
| Num |
Operation on arbitrary-precision numbers.
|
| Numbers |
Modules about numbers that satisfy
Identifiable.S.
|
O | |
| Obj |
Operations on internal representations of values.
|
| Oo |
Operations on objects
|
| Opn [Ast_helper] |
Opens
|
| Option [Misc.Stdlib] | |
P | |
| Pair [Identifiable] | |
| Parse |
Entry points in the parser
|
| Parser | |
| Parsetree |
Abstract syntax tree produced by parsing
|
| Parsing |
The run-time library for parsers generated by
ocamlyacc.
|
| Pat [Ast_helper] |
Patterns
|
| Pervasives |
The initially opened module.
|
| Pprintast | |
| Printast | |
| Printexc |
Facilities for printing exceptions and inspecting current call stack.
|
| Printf |
Formatted output functions.
|
Q | |
| Queue |
First-in first-out queues.
|
R | |
| Random |
Pseudo-random number generators (PRNG).
|
| Ratio |
Operation on rational numbers.
|
S | |
| Scanf |
Formatted input functions.
|
| Scanning [Scanf] | |
| Series [Spacetime] | |
| Set |
Sets over ordered types.
|
| Set [MoreLabels] | |
| Set [Identifiable.S] | |
| Sig [Ast_helper] |
Signature items
|
| Slot [Printexc] | |
| Snapshot [Spacetime] | |
| Sort |
Sorting and merging lists.
|
| Spacetime |
Profiling of a program's space behaviour over time.
|
| Stack |
Last-in first-out stacks.
|
| State [Random] | |
| StdLabels |
Standard labeled libraries.
|
| Stdlib [Misc] | |
| Str |
Regular expressions and high-level string processing
|
| Str [Ast_helper] |
Structure items
|
| Stream |
Streams and parsers.
|
| String |
String operations.
|
| String [StdLabels] | |
| StringLabels |
String operations.
|
| StringMap [Misc] | |
| StringMap [Depend] | |
| StringSet [Misc] | |
| StringSet [Depend] | |
| Strongly_connected_components |
Kosaraju's algorithm for strongly connected components.
|
| Syntaxerr |
Auxiliary type for reporting syntax errors
|
| Sys |
System interface.
|
T | |
| T [Identifiable.S] | |
| Targetint |
Target processor-native integers.
|
| Tbl | |
| Tbl [Identifiable.S] | |
| Te [Ast_helper] |
Type extensions
|
| Terminfo | |
| Thread |
Lightweight threads for Posix
1003.1c and Win32.
|
| ThreadUnix |
Thread-compatible system calls.
|
| Timings |
Compiler performance recording
|
| Typ [Ast_helper] |
Type expressions
|
| Type [Ast_helper] |
Type declarations
|
U | |
| Uchar |
Unicode characters.
|
| Unix |
Interface to the Unix system.
|
| UnixLabels |
Interface to the Unix system.
|
V | |
| Val [Ast_helper] |
Value declarations
|
| Vb [Ast_helper] |
Value bindings
|
W | |
| Warnings | |
| Weak |
Arrays of weak pointers and hash sets of weak pointers.
|
sig
type shape =
Function
| Lazy
| Class
| Module of CamlinternalMod.shape array
| Value of Obj.t
val init_mod : string * int * int -> CamlinternalMod.shape -> Obj.t
val update_mod : CamlinternalMod.shape -> Obj.t -> Obj.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Graphics.html 0000644 0001750 0001750 00000052412 13131636444 021237 0 ustar mehdi mehdi
sig
exception Graphic_failure of string
val open_graph : string -> unit
val close_graph : unit -> unit
val set_window_title : string -> unit
val resize_window : int -> int -> unit
external clear_graph : unit -> unit = "caml_gr_clear_graph"
external size_x : unit -> int = "caml_gr_size_x"
external size_y : unit -> int = "caml_gr_size_y"
type color = int
val rgb : int -> int -> int -> Graphics.color
external set_color : Graphics.color -> unit = "caml_gr_set_color"
val background : Graphics.color
val foreground : Graphics.color
val black : Graphics.color
val white : Graphics.color
val red : Graphics.color
val green : Graphics.color
val blue : Graphics.color
val yellow : Graphics.color
val cyan : Graphics.color
val magenta : Graphics.color
external plot : int -> int -> unit = "caml_gr_plot"
val plots : (int * int) array -> unit
external point_color : int -> int -> Graphics.color = "caml_gr_point_color"
external moveto : int -> int -> unit = "caml_gr_moveto"
val rmoveto : int -> int -> unit
external current_x : unit -> int = "caml_gr_current_x"
external current_y : unit -> int = "caml_gr_current_y"
val current_point : unit -> int * int
external lineto : int -> int -> unit = "caml_gr_lineto"
val rlineto : int -> int -> unit
val curveto : int * int -> int * int -> int * int -> unit
val draw_rect : int -> int -> int -> int -> unit
val draw_poly_line : (int * int) array -> unit
val draw_poly : (int * int) array -> unit
val draw_segments : (int * int * int * int) array -> unit
val draw_arc : int -> int -> int -> int -> int -> int -> unit
val draw_ellipse : int -> int -> int -> int -> unit
val draw_circle : int -> int -> int -> unit
val set_line_width : int -> unit
external draw_char : char -> unit = "caml_gr_draw_char"
external draw_string : string -> unit = "caml_gr_draw_string"
external set_font : string -> unit = "caml_gr_set_font"
val set_text_size : int -> unit
external text_size : string -> int * int = "caml_gr_text_size"
val fill_rect : int -> int -> int -> int -> unit
external fill_poly : (int * int) array -> unit = "caml_gr_fill_poly"
val fill_arc : int -> int -> int -> int -> int -> int -> unit
val fill_ellipse : int -> int -> int -> int -> unit
val fill_circle : int -> int -> int -> unit
type image
val transp : Graphics.color
external make_image : Graphics.color array array -> Graphics.image
= "caml_gr_make_image"
external dump_image : Graphics.image -> Graphics.color array array
= "caml_gr_dump_image"
external draw_image : Graphics.image -> int -> int -> unit
= "caml_gr_draw_image"
val get_image : int -> int -> int -> int -> Graphics.image
external create_image : int -> int -> Graphics.image
= "caml_gr_create_image"
external blit_image : Graphics.image -> int -> int -> unit
= "caml_gr_blit_image"
type status = {
mouse_x : int;
mouse_y : int;
button : bool;
keypressed : bool;
key : char;
}
type event = Button_down | Button_up | Key_pressed | Mouse_motion | Poll
external wait_next_event : Graphics.event list -> Graphics.status
= "caml_gr_wait_event"
val loop_at_exit : Graphics.event list -> (Graphics.status -> unit) -> unit
val mouse_pos : unit -> int * int
val button_down : unit -> bool
val read_key : unit -> char
val key_pressed : unit -> bool
external sound : int -> int -> unit = "caml_gr_sound"
val auto_synchronize : bool -> unit
external synchronize : unit -> unit = "caml_gr_synchronize"
external display_mode : bool -> unit = "caml_gr_display_mode"
external remember_mode : bool -> unit = "caml_gr_remember_mode"
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.html 0000644 0001750 0001750 00000037256 13131636441 020532 0 ustar mehdi mehdi
module Ast_helper:sig..end
typelid =Longident.t Asttypes.loc
typestr =string Asttypes.loc
typeloc =Location.t
typeattrs =Parsetree.attribute list
val default_loc : loc refval with_default_loc : loc -> (unit -> 'a) -> 'adefault_loc within the scope of the execution
of the provided function.module Const:sig..end
module Typ:sig..end
module Pat:sig..end
module Exp:sig..end
module Val:sig..end
module Type:sig..end
module Te:sig..end
module Mty:sig..end
module Mod:sig..end
module Sig:sig..end
module Str:sig..end
module Md:sig..end
module Mtd:sig..end
module Mb:sig..end
module Opn:sig..end
module Incl:sig..end
module Vb:sig..end
module Cty:sig..end
module Ctf:sig..end
module Cl:sig..end
module Cf:sig..end
module Ci:sig..end
module Csig:sig..end
module Cstr:sig..end
module Array2:sig..end
Array2 structure provides operations
similar to those of Bigarray.Genarray, but specialized to the
case of two-dimensional arrays.type ('a, 'b, 'c) t
'a, representation kind 'b, and memory layout 'c.val create : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> int -> ('a, 'b, 'c) tArray2.create kind layout dim1 dim2 returns a new bigarray of
two dimension, whose size is dim1 in the first dimension
and dim2 in the second dimension. kind and layout
determine the array element kind and the array layout
as described for Bigarray.Genarray.create.val dim1 : ('a, 'b, 'c) t -> intval dim2 : ('a, 'b, 'c) t -> intval kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kindval layout : ('a, 'b, 'c) t -> 'c Bigarray.layoutval size_in_bytes : ('a, 'b, 'c) t -> intsize_in_bytes a is the number of elements in a
multiplied by a's Bigarray.kind_size_in_bytes.val get : ('a, 'b, 'c) t -> int -> int -> 'aArray2.get a x y, also written a.{x,y},
returns the element of a at coordinates (x, y).
x and y must be within the bounds
of a, as described for Bigarray.Genarray.get;
otherwise, Invalid_argument is raised.val set : ('a, 'b, 'c) t -> int -> int -> 'a -> unitArray2.set a x y v, or alternatively a.{x,y} <- v,
stores the value v at coordinates (x, y) in a.
x and y must be within the bounds of a,
as described for Bigarray.Genarray.set;
otherwise, Invalid_argument is raised.val sub_left : ('a, 'b, Bigarray.c_layout) t ->
int -> int -> ('a, 'b, Bigarray.c_layout) tBigarray.Genarray.sub_left for more details.
Array2.sub_left applies only to arrays with C layout.val sub_right : ('a, 'b, Bigarray.fortran_layout) t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) tBigarray.Genarray.sub_right for more details.
Array2.sub_right applies only to arrays with Fortran layout.val slice_left : ('a, 'b, Bigarray.c_layout) t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.tBigarray.Genarray.slice_left for more details.
Array2.slice_left applies only to arrays with C layout.val slice_right : ('a, 'b, Bigarray.fortran_layout) t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.tBigarray.Genarray.slice_right
for more details. Array2.slice_right applies only to arrays
with Fortran layout.val blit : ('a, 'b, 'c) t -> ('a, 'b, 'c) t -> unitBigarray.Genarray.blit for more details.val fill : ('a, 'b, 'c) t -> 'a -> unitBigarray.Genarray.fill for more details.val of_array : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array array -> ('a, 'b, 'c) tval map_file : Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> bool -> int -> int -> ('a, 'b, 'c) tBigarray.Genarray.map_file for more details.val unsafe_get : ('a, 'b, 'c) t -> int -> int -> 'aBigarray.Array2.get, but bounds checking is not always
performed.val unsafe_set : ('a, 'b, 'c) t -> int -> int -> 'a -> unitBigarray.Array2.set, but bounds checking is not always
performed.sig
val enabled : bool
module Series :
sig
type t
val create : path:string -> Spacetime.Series.t
val save_event :
?time:float -> Spacetime.Series.t -> event_name:string -> unit
val save_and_close : ?time:float -> Spacetime.Series.t -> unit
end
module Snapshot :
sig val take : ?time:float -> Spacetime.Series.t -> unit end
val save_event_for_automatic_snapshots : event_name:string -> unit
end ocaml-doc-4.05/ocaml.html/libref/style.css 0000644 0001750 0001750 00000004100 13131636452 017410 0 ustar mehdi mehdi a:visited {color : #416DFF; text-decoration : none; }
a:link {color : #416DFF; text-decoration : none;}
a:hover {color : Red; text-decoration : none; background-color: #5FFF88}
a:active {color : Red; text-decoration : underline; }
.keyword { font-weight : bold ; color : Red }
.keywordsign { color : #C04600 }
.comment { color : Green }
.constructor { color : Blue }
.type { color : #5C6585 }
.string { color : Maroon }
.warning { color : Red ; font-weight : bold }
.info { margin-left : 3em; margin-right : 3em }
.code { color : #465F91 ; }
h1 { font-size : 20pt ; text-align: center; }
h2 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ;padding: 2px; }
h3 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90DDFF ;padding: 2px; }
h4 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90EDFF ;padding: 2px; }
h5 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90FDFF ;padding: 2px; }
h6 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90BDFF ; padding: 2px; }
div.h7 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #90DDFF ; padding: 2px; }
div.h8 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #F0FFFF ; padding: 2px; }
div.h9 { font-size : 20pt ; border: 1px solid #000000; margin-top: 5px; margin-bottom: 2px;text-align: center; background-color: #FFFFFF ; padding: 2px; }
.typetable { border-style : hidden }
.indextable { border-style : hidden }
.paramstable { border-style : hidden ; padding: 5pt 5pt}
body { background-color : White }
tr { background-color : White }
td.typefieldcomment { background-color : #FFFFFF }
pre { margin-bottom: 4px }
div.sig_block {margin-left: 2em} ocaml-doc-4.05/ocaml.html/libref/type_Unix.LargeFile.html 0000644 0001750 0001750 00000021213 13131636451 022244 0 ustar mehdi mehdi
sig
val lseek : Unix.file_descr -> int64 -> Unix.seek_command -> int64
val truncate : string -> int64 -> unit
val ftruncate : Unix.file_descr -> int64 -> unit
type stats = {
st_dev : int;
st_ino : int;
st_kind : Unix.file_kind;
st_perm : Unix.file_perm;
st_nlink : int;
st_uid : int;
st_gid : int;
st_rdev : int;
st_size : int64;
st_atime : float;
st_mtime : float;
st_ctime : float;
}
val stat : string -> Unix.LargeFile.stats
val lstat : string -> Unix.LargeFile.stats
val fstat : Unix.file_descr -> Unix.LargeFile.stats
end ocaml-doc-4.05/ocaml.html/libref/Ephemeron.SeededS.html 0000644 0001750 0001750 00000020211 13131636443 021662 0 ustar mehdi mehdi
module type SeededS =sig..end
include Hashtbl.SeededS
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingssig
type t = {
loc_start : Lexing.position;
loc_end : Lexing.position;
loc_ghost : bool;
}
val none : Location.t
val in_file : string -> Location.t
val init : Lexing.lexbuf -> string -> unit
val curr : Lexing.lexbuf -> Location.t
val symbol_rloc : unit -> Location.t
val symbol_gloc : unit -> Location.t
val rhs_loc : int -> Location.t
val input_name : string Pervasives.ref
val input_lexbuf : Lexing.lexbuf option Pervasives.ref
val get_pos_info : Lexing.position -> string * int * int
val print_loc : Format.formatter -> Location.t -> unit
val print_error : Format.formatter -> Location.t -> unit
val print_error_cur_file : Format.formatter -> unit -> unit
val print_warning : Location.t -> Format.formatter -> Warnings.t -> unit
val formatter_for_warnings : Format.formatter Pervasives.ref
val prerr_warning : Location.t -> Warnings.t -> unit
val echo_eof : unit -> unit
val reset : unit -> unit
val warning_printer :
(Location.t -> Format.formatter -> Warnings.t -> unit) Pervasives.ref
val default_warning_printer :
Location.t -> Format.formatter -> Warnings.t -> unit
val highlight_locations : Format.formatter -> Location.t list -> bool
type 'a loc = { txt : 'a; loc : Location.t; }
val mknoloc : 'a -> 'a Location.loc
val mkloc : 'a -> Location.t -> 'a Location.loc
val print : Format.formatter -> Location.t -> unit
val print_compact : Format.formatter -> Location.t -> unit
val print_filename : Format.formatter -> string -> unit
val absolute_path : string -> string
val show_filename : string -> string
val absname : bool Pervasives.ref
type error = {
loc : Location.t;
msg : string;
sub : Location.error list;
if_highlight : string;
}
exception Error of Location.error
val print_error_prefix : Format.formatter -> unit -> unit
val error :
?loc:Location.t ->
?sub:Location.error list ->
?if_highlight:string -> string -> Location.error
val errorf :
?loc:Location.t ->
?sub:Location.error list ->
?if_highlight:string ->
('a, Format.formatter, unit, Location.error) Pervasives.format4 -> 'a
val raise_errorf :
?loc:Location.t ->
?sub:Location.error list ->
?if_highlight:string ->
('a, Format.formatter, unit, 'b) Pervasives.format4 -> 'a
val error_of_printer :
Location.t -> (Format.formatter -> 'a -> unit) -> 'a -> Location.error
val error_of_printer_file :
(Format.formatter -> 'a -> unit) -> 'a -> Location.error
val error_of_exn : exn -> Location.error option
val register_error_of_exn : (exn -> Location.error option) -> unit
val report_error : Format.formatter -> Location.error -> unit
val error_reporter :
(Format.formatter -> Location.error -> unit) Pervasives.ref
val default_error_reporter : Format.formatter -> Location.error -> unit
val report_exception : Format.formatter -> exn -> unit
end ocaml-doc-4.05/ocaml.html/libref/Complex.html 0000644 0001750 0001750 00000032467 13131636443 020054 0 ustar mehdi mehdi
module Complex:sig..end
This module provides arithmetic operations on complex numbers.
Complex numbers are represented by their real and imaginary parts
(cartesian representation). Each part is represented by a
double-precision floating-point number (type float).
type
|
re : |
|
im : |
re is the real part and im the
imaginary part.val zero : t0.val one : t1.val i : ti.val neg : t -> tval conj : t -> tx + i.y, returns x - i.y.val add : t -> t -> tval sub : t -> t -> tval mul : t -> t -> tval inv : t -> t1/z).val div : t -> t -> tval sqrt : t -> tx + i.y is such that x > 0 or
x = 0 and y >= 0.
This function has a discontinuity along the negative real axis.val norm2 : t -> floatx + i.y, returns x^2 + y^2.val norm : t -> floatx + i.y, returns sqrt(x^2 + y^2).val arg : t -> float-pi to pi. This function has a discontinuity along the
negative real axis.val polar : float -> float -> tpolar norm arg returns the complex having norm norm
and argument arg.val exp : t -> texp z returns e to the z power.val log : t -> te).val pow : t -> t -> tpow z1 z2 returns z1 to the z2 power.sig
type key
type +'a t
val empty : 'a Map.S.t
val is_empty : 'a Map.S.t -> bool
val mem : Map.S.key -> 'a Map.S.t -> bool
val add : Map.S.key -> 'a -> 'a Map.S.t -> 'a Map.S.t
val singleton : Map.S.key -> 'a -> 'a Map.S.t
val remove : Map.S.key -> 'a Map.S.t -> 'a Map.S.t
val merge :
(Map.S.key -> 'a option -> 'b option -> 'c option) ->
'a Map.S.t -> 'b Map.S.t -> 'c Map.S.t
val union :
(Map.S.key -> 'a -> 'a -> 'a option) ->
'a Map.S.t -> 'a Map.S.t -> 'a Map.S.t
val compare : ('a -> 'a -> int) -> 'a Map.S.t -> 'a Map.S.t -> int
val equal : ('a -> 'a -> bool) -> 'a Map.S.t -> 'a Map.S.t -> bool
val iter : (Map.S.key -> 'a -> unit) -> 'a Map.S.t -> unit
val fold : (Map.S.key -> 'a -> 'b -> 'b) -> 'a Map.S.t -> 'b -> 'b
val for_all : (Map.S.key -> 'a -> bool) -> 'a Map.S.t -> bool
val exists : (Map.S.key -> 'a -> bool) -> 'a Map.S.t -> bool
val filter : (Map.S.key -> 'a -> bool) -> 'a Map.S.t -> 'a Map.S.t
val partition :
(Map.S.key -> 'a -> bool) -> 'a Map.S.t -> 'a Map.S.t * 'a Map.S.t
val cardinal : 'a Map.S.t -> int
val bindings : 'a Map.S.t -> (Map.S.key * 'a) list
val min_binding : 'a Map.S.t -> Map.S.key * 'a
val min_binding_opt : 'a Map.S.t -> (Map.S.key * 'a) option
val max_binding : 'a Map.S.t -> Map.S.key * 'a
val max_binding_opt : 'a Map.S.t -> (Map.S.key * 'a) option
val choose : 'a Map.S.t -> Map.S.key * 'a
val choose_opt : 'a Map.S.t -> (Map.S.key * 'a) option
val split : Map.S.key -> 'a Map.S.t -> 'a Map.S.t * 'a option * 'a Map.S.t
val find : Map.S.key -> 'a Map.S.t -> 'a
val find_opt : Map.S.key -> 'a Map.S.t -> 'a option
val find_first : (Map.S.key -> bool) -> 'a Map.S.t -> Map.S.key * 'a
val find_first_opt :
(Map.S.key -> bool) -> 'a Map.S.t -> (Map.S.key * 'a) option
val find_last : (Map.S.key -> bool) -> 'a Map.S.t -> Map.S.key * 'a
val find_last_opt :
(Map.S.key -> bool) -> 'a Map.S.t -> (Map.S.key * 'a) option
val map : ('a -> 'b) -> 'a Map.S.t -> 'b Map.S.t
val mapi : (Map.S.key -> 'a -> 'b) -> 'a Map.S.t -> 'b Map.S.t
end ocaml-doc-4.05/ocaml.html/libref/Misc.Stdlib.html 0000644 0001750 0001750 00000016671 13131636445 020561 0 ustar mehdi mehdi
module Stdlib:sig..end
module List:sig..end
module Option:ocaml-doc-4.05/ocaml.html/libref/Pprintast.html 0000644 0001750 0001750 00000022603 13131636450 020416 0 ustar mehdi mehdisig..end
module Pprintast:sig..end
typespace_formatter =(unit, Format.formatter, unit) format
val toplevel_phrase : Format.formatter -> Parsetree.toplevel_phrase -> unit
val expression : Format.formatter -> Parsetree.expression -> unit
val string_of_expression : Parsetree.expression -> string
val top_phrase : Format.formatter -> Parsetree.toplevel_phrase -> unit
val core_type : Format.formatter -> Parsetree.core_type -> unit
val pattern : Format.formatter -> Parsetree.pattern -> unit
val signature : Format.formatter -> Parsetree.signature -> unit
val structure : Format.formatter -> Parsetree.structure -> unit
val string_of_structure : Parsetree.structure -> string ocaml-doc-4.05/ocaml.html/libref/type_Arith_status.html 0000644 0001750 0001750 00000020032 13131636441 022137 0 ustar mehdi mehdi
sig
val arith_status : unit -> unit
val get_error_when_null_denominator : unit -> bool
val set_error_when_null_denominator : bool -> unit
val get_normalize_ratio : unit -> bool
val set_normalize_ratio : bool -> unit
val get_normalize_ratio_when_printing : unit -> bool
val set_normalize_ratio_when_printing : bool -> unit
val get_approx_printing : unit -> bool
val set_approx_printing : bool -> unit
val get_floating_precision : unit -> int
val set_floating_precision : int -> unit
end ocaml-doc-4.05/ocaml.html/libref/Uchar.html 0000644 0001750 0001750 00000030227 13131636451 017476 0 ustar mehdi mehdi
module Uchar:sig..end
type
A value of this type represents an Unicode
scalar
value which is an integer in the ranges 0x0000...0xD7FF or
0xE000...0x10FFFF.
val min : tmin is U+0000.val max : tmax is U+10FFFF.val succ : t -> tsucc u is the scalar value after u in the set of Unicode scalar
values.Invalid_argument if u is Uchar.max.val pred : t -> tpred u is the scalar value before u in the set of Unicode scalar
values.Invalid_argument if u is Uchar.min.val is_valid : int -> boolis_valid n is true iff n is an Unicode scalar value
(i.e. in the ranges 0x0000...0xD7FF or 0xE000...0x10FFFF).val of_int : int -> tof_int i is i as an Unicode character.Invalid_argument if i does not satisfy Uchar.is_valid.val to_int : t -> intto_int u is u as an integer.val is_char : t -> boolis_char u is true iff u is a latin1 OCaml character.val of_char : char -> tof_char c is c as an Unicode character.val to_char : t -> charto_char u is u as an OCaml latin1 character.Invalid_argument if u does not satisfy Uchar.is_char.val equal : t -> t -> boolequal u u' is u = u'.val compare : t -> t -> intcompare u u' is Pervasives.compare u u'.val hash : t -> inthash u associates a non-negative integer to u.module Ast_mapper:sig..end
A -ppx rewriter is a program that accepts a serialized abstract syntax tree and outputs another, possibly modified, abstract syntax tree. This module encapsulates the interface between the compiler and the -ppx rewriters, handling such details as the serialization format, forwarding of command-line flags, and storing state.
Ast_mapper.mapper allows to implement AST rewriting using open recursion.
A typical mapper would be based on Ast_mapper.default_mapper, a deep
identity mapper, and will fall back on it for handling the syntax it
does not modify. For example:
open Asttypes
open Parsetree
open Ast_mapper
let test_mapper argv =
{ default_mapper with
expr = fun mapper expr ->
match expr with
| { pexp_desc = Pexp_extension ({ txt = "test" }, PStr [])} ->
Ast_helper.Exp.constant (Const_int 42)
| other -> default_mapper.expr mapper other; }
let () =
register "ppx_test" test_mapper
This -ppx rewriter, which replaces [%test] in expressions with
the constant 42, can be compiled using
ocamlc -o ppx_test -I +compiler-libs ocamlcommon.cma ppx_test.ml.
type val default_mapper : mapperval tool_name : unit -> string"ocamlc", "ocamlopt", "ocamldoc", "ocamldep",
"ocaml", ... Some global variables that reflect command-line
options are automatically synchronized between the calling tool
and the ppx preprocessor: Clflags.include_dirs,
Config.load_path, Clflags.open_modules, Clflags.for_package,
Clflags.debug.val apply : source:string -> target:string -> mapper -> unitsource file and put the result in the
target file. The structure or signature field of the mapper
is applied to the implementation or interface.val run_main : (string list -> mapper) -> unitLocation.input_name. This
function implements proper error reporting for uncaught
exceptions.val register_function : (string -> (string list -> mapper) -> unit) ref
val register : string -> (string list -> mapper) -> unitregister_function. The default behavior is to run the
mapper immediately, taking arguments from the process command
line. This is to support a scenario where a mapper is linked as a
stand-alone executable.
It is possible to overwrite the register_function to define
"-ppx drivers", which combine several mappers in a single process.
Typically, a driver starts by defining register_function to a
custom implementation, then lets ppx rewriters (linked statically
or dynamically) register themselves, and then run all or some of
them. It is also possible to have -ppx drivers apply rewriters to
only specific parts of an AST.
The first argument to register is a symbolic name to be used by
the ppx driver.
val map_opt : ('a -> 'b) -> 'a option -> 'b option
val extension_of_error : Location.error -> Parsetree.extensionval attribute_of_warning : Location.t -> string -> Parsetree.attributeval add_ppx_context_str : tool_name:string -> Parsetree.structure -> Parsetree.structureval add_ppx_context_sig : tool_name:string -> Parsetree.signature -> Parsetree.signatureadd_ppx_context_str, but for signatures.val drop_ppx_context_str : restore:bool -> Parsetree.structure -> Parsetree.structurerestore is true, also restore the associated data in the current
process.val drop_ppx_context_sig : restore:bool -> Parsetree.signature -> Parsetree.signaturedrop_ppx_context_str, but for signatures. : string -> Parsetree.expression -> unit
: string -> Parsetree.expression option ocaml-doc-4.05/ocaml.html/libref/Random.html 0000644 0001750 0001750 00000030621 13131636450 017651 0 ustar mehdi mehdi
module Random:sig..end
val init : int -> unitval full_init : int array -> unitRandom.init but takes more data as seed.val self_init : unit -> unit/dev/urandom is available on
the host machine, it is used to provide a highly random initial
seed. Otherwise, a less random seed is computed from system
parameters (current time, process IDs).val bits : unit -> intval int : int -> intRandom.int bound returns a random integer between 0 (inclusive)
and bound (exclusive). bound must be greater than 0 and less
than 230.val int32 : Int32.t -> Int32.tRandom.int32 bound returns a random integer between 0 (inclusive)
and bound (exclusive). bound must be greater than 0.val nativeint : Nativeint.t -> Nativeint.tRandom.nativeint bound returns a random integer between 0 (inclusive)
and bound (exclusive). bound must be greater than 0.val int64 : Int64.t -> Int64.tRandom.int64 bound returns a random integer between 0 (inclusive)
and bound (exclusive). bound must be greater than 0.val float : float -> floatRandom.float bound returns a random floating-point number
between 0 and bound (inclusive). If bound is
negative, the result is negative or zero. If bound is 0,
the result is 0.val bool : unit -> boolRandom.bool () returns true or false with probability 0.5 each.Random.State manipulate the current state
of the random generator explicitly.
This allows using one or several deterministic PRNGs,
even in a multi-threaded program, without interference from
other parts of the program.module State:sig..end
val get_state : unit -> State.tval set_state : State.t -> unitmodule type S =sig..end
type
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key:key ->
data:'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge : f:(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : f:(key -> 'a -> 'a -> 'a option) ->
'a t -> 'a t -> 'a t
val compare : cmp:('a -> 'a -> int) ->
'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) ->
'a t -> 'a t -> bool
val iter : f:(key:key -> data:'a -> unit) ->
'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) ->
'a t -> init:'b -> 'b
val for_all : f:(key -> 'a -> bool) -> 'a t -> bool
val exists : f:(key -> 'a -> bool) -> 'a t -> bool
val filter : f:(key -> 'a -> bool) ->
'a t -> 'a t
val partition : f:(key -> 'a -> bool) ->
'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key ->
'a t ->
'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : f:(key -> bool) ->
'a t -> key * 'a
val find_first_opt : f:(key -> bool) ->
'a t -> (key * 'a) option
val find_last : f:(key -> bool) ->
'a t -> key * 'a
val find_last_opt : f:(key -> bool) ->
'a t -> (key * 'a) option
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key -> 'a -> 'b) ->
'a t -> 'b t ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Exp.html 0000644 0001750 0001750 00000072645 13131636441 022327 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression_desc -> Parsetree.expression
val attr :
Parsetree.expression -> Parsetree.attribute -> Parsetree.expression
val ident :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.expression
val constant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.constant -> Parsetree.expression
val let_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.rec_flag ->
Parsetree.value_binding list ->
Parsetree.expression -> Parsetree.expression
val fun_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.expression option ->
Parsetree.pattern -> Parsetree.expression -> Parsetree.expression
val function_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.case list -> Parsetree.expression
val apply :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
(Asttypes.arg_label * Parsetree.expression) list -> Parsetree.expression
val match_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.case list -> Parsetree.expression
val try_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.case list -> Parsetree.expression
val tuple :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression list -> Parsetree.expression
val construct :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.expression option -> Parsetree.expression
val variant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.label -> Parsetree.expression option -> Parsetree.expression
val record :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.lid * Parsetree.expression) list ->
Parsetree.expression option -> Parsetree.expression
val field :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Ast_helper.lid -> Parsetree.expression
val setfield :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Ast_helper.lid -> Parsetree.expression -> Parsetree.expression
val array :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression list -> Parsetree.expression
val ifthenelse :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.expression ->
Parsetree.expression option -> Parsetree.expression
val sequence :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression -> Parsetree.expression
val while_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression -> Parsetree.expression
val for_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern ->
Parsetree.expression ->
Parsetree.expression ->
Asttypes.direction_flag -> Parsetree.expression -> Parsetree.expression
val coerce :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.core_type option -> Parsetree.core_type -> Parsetree.expression
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.core_type -> Parsetree.expression
val send :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Ast_helper.str -> Parsetree.expression
val new_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.expression
val setinstvar :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str -> Parsetree.expression -> Parsetree.expression
val override :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.str * Parsetree.expression) list -> Parsetree.expression
val letmodule :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_expr -> Parsetree.expression -> Parsetree.expression
val letexception :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension_constructor ->
Parsetree.expression -> Parsetree.expression
val assert_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.expression
val lazy_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.expression
val poly :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.core_type option -> Parsetree.expression
val object_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_structure -> Parsetree.expression
val newtype :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str -> Parsetree.expression -> Parsetree.expression
val pack :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.module_expr -> Parsetree.expression
val open_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.override_flag ->
Ast_helper.lid -> Parsetree.expression -> Parsetree.expression
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.expression
val unreachable :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.expression
val case :
Parsetree.pattern ->
?guard:Parsetree.expression -> Parsetree.expression -> Parsetree.case
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Opn.html 0000644 0001750 0001750 00000016260 13131636441 022316 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?override:Asttypes.override_flag ->
Ast_helper.lid -> Parsetree.open_description
end ocaml-doc-4.05/ocaml.html/libref/type_Asttypes.html 0000644 0001750 0001750 00000024140 13131636441 021305 0 ustar mehdi mehdi
sig
type constant =
Const_int of int
| Const_char of char
| Const_string of string * string option
| Const_float of string
| Const_int32 of int32
| Const_int64 of int64
| Const_nativeint of nativeint
type rec_flag = Nonrecursive | Recursive
type direction_flag = Upto | Downto
type private_flag = Private | Public
type mutable_flag = Immutable | Mutable
type virtual_flag = Virtual | Concrete
type override_flag = Override | Fresh
type closed_flag = Closed | Open
type label = string
type arg_label = Nolabel | Labelled of string | Optional of string
type 'a loc = 'a Location.loc = { txt : 'a; loc : Location.t; }
type variance = Covariant | Contravariant | Invariant
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Exp.html 0000644 0001750 0001750 00000060252 13131636441 021255 0 ustar mehdi mehdi
module Exp:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression_desc -> Parsetree.expression
val attr : Parsetree.expression -> Parsetree.attribute -> Parsetree.expression
val ident : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.expression
val constant : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.constant -> Parsetree.expression
val let_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.rec_flag ->
Parsetree.value_binding list -> Parsetree.expression -> Parsetree.expression
val fun_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.expression option ->
Parsetree.pattern -> Parsetree.expression -> Parsetree.expression
val function_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.case list -> Parsetree.expression
val apply : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
(Asttypes.arg_label * Parsetree.expression) list -> Parsetree.expression
val match_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.case list -> Parsetree.expression
val try_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.case list -> Parsetree.expression
val tuple : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression list -> Parsetree.expression
val construct : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.expression option -> Parsetree.expression
val variant : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.label -> Parsetree.expression option -> Parsetree.expression
val record : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.lid * Parsetree.expression) list ->
Parsetree.expression option -> Parsetree.expression
val field : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Ast_helper.lid -> Parsetree.expression
val setfield : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Ast_helper.lid -> Parsetree.expression -> Parsetree.expression
val array : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression list -> Parsetree.expression
val ifthenelse : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.expression -> Parsetree.expression option -> Parsetree.expression
val sequence : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression -> Parsetree.expression
val while_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression -> Parsetree.expression
val for_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern ->
Parsetree.expression ->
Parsetree.expression ->
Asttypes.direction_flag -> Parsetree.expression -> Parsetree.expression
val coerce : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.core_type option -> Parsetree.core_type -> Parsetree.expression
val constraint_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.core_type -> Parsetree.expression
val send : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Ast_helper.str -> Parsetree.expression
val new_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.expression
val setinstvar : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str -> Parsetree.expression -> Parsetree.expression
val override : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.str * Parsetree.expression) list -> Parsetree.expression
val letmodule : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_expr -> Parsetree.expression -> Parsetree.expression
val letexception : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension_constructor ->
Parsetree.expression -> Parsetree.expression
val assert_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.expression
val lazy_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.expression
val poly : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.core_type option -> Parsetree.expression
val object_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.class_structure -> Parsetree.expression
val newtype : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str -> Parsetree.expression -> Parsetree.expression
val pack : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.module_expr -> Parsetree.expression
val open_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.override_flag ->
Ast_helper.lid -> Parsetree.expression -> Parsetree.expression
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.expression
val unreachable : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.expression
val case : Parsetree.pattern ->
?guard:Parsetree.expression -> Parsetree.expression -> Parsetree.case ocaml-doc-4.05/ocaml.html/libref/Sys.html 0000644 0001750 0001750 00000067313 13131636451 017220 0 ustar mehdi mehdi
module Sys:sig..end
Every function in this module raises Sys_error with an
informative message when the underlying system call signal
an error.
val argv : string arrayval executable_name : stringval file_exists : string -> boolval is_directory : string -> booltrue if the given name refers to a directory,
false if it refers to another kind of file.
Raise Sys_error if no file exists with the given name.val remove : string -> unitval rename : string -> string -> unitrename may replace it, or raise an
exception, depending on your operating system.val getenv : string -> stringNot_found if the variable is unbound.val getenv_opt : string -> string optionNone if the variable is unbound.val command : string -> intval time : unit -> floatval chdir : string -> unitval getcwd : unit -> stringval readdir : string -> string array"." and ".." in Unix) are not returned. Each string in the
result is a file name rather than a complete path. There is no
guarantee that the name strings in the resulting array will appear
in any specific order; they are not, in particular, guaranteed to
appear in alphabetical order.val interactive : bool reffalse in standalone
programs and to true if the code is being executed under
the interactive toplevel system ocaml.val os_type : string"Unix" (for all Unix versions, including Linux and Mac OS X),"Win32" (for MS-Windows, OCaml compiled with MSVC++ or Mingw),"Cygwin" (for MS-Windows, OCaml compiled with Cygwin).type
| |
Native |
| |
Bytecode |
| |
Other of |
Native and
Bytecode, but it can be other backends with alternative
compilers, for example, javascript.val backend_type : backend_typeval unix : boolSys.os_type = "Unix".val win32 : boolSys.os_type = "Win32".val cygwin : boolSys.os_type = "Cygwin".val word_size : intval int_size : intval big_endian : boolval max_string_length : intval max_array_length : intmax_array_length/2 on 32-bit machines and
max_array_length on 64-bit machines.val runtime_variant : unit -> string-runtime-variant at compile
time, but for byte-code it can be changed after compilation.val runtime_parameters : unit -> stringOCAMLRUNPARAM environment variable.type
| |
Signal_default |
| |
Signal_ignore |
| |
Signal_handle of |
Signal_default: take the default behavior
(usually: abort the program)Signal_ignore: ignore the signalSignal_handle f: call function f, giving it the signal
number as argument.val signal : int -> signal_behavior -> signal_behaviorInvalid_argument
exception is raised.val set_signal : int -> signal_behavior -> unitSys.signal but return value is ignored.val sigabrt : intval sigalrm : intval sigfpe : intval sighup : intval sigill : intval sigint : intval sigkill : intval sigpipe : intval sigquit : intval sigsegv : intval sigterm : intval sigusr1 : intval sigusr2 : intval sigchld : intval sigcont : intval sigstop : intval sigtstp : intval sigttin : intval sigttou : intval sigvtalrm : intval sigprof : intval sigbus : intval sigpoll : intval sigsys : intval sigtrap : intval sigurg : intval sigxcpu : intval sigxfsz : intexception Break
Sys.catch_break
is on.val catch_break : bool -> unitcatch_break governs whether interactive interrupt (ctrl-C)
terminates the program or raises the Break exception.
Call catch_break true to enable raising Break,
and catch_break false to let the system
terminate the program on user interrupt.val ocaml_version : stringocaml_version is the version of OCaml.
It is a string of the form "major.minor[.patchlevel][+additional-info]",
where major, minor, and patchlevel are integers, and
additional-info is an arbitrary string. The [.patchlevel] and
[+additional-info] parts may be absent.val enable_runtime_warnings : bool -> unitopen_* functions is finalized without
being closed. Runtime warnings are enabled by default.val runtime_warnings_enabled : unit -> boolval opaque_identity : 'a -> 'aopaque_identity behaves like an
unknown (and thus possibly side-effecting) function.
At runtime, opaque_identity disappears altogether.
A typical use of this function is to prevent pure computations from being optimized away in benchmarking loops. For example:
for _round = 1 to 100_000 do
ignore (Sys.opaque_identity (my_pure_computation ()))
done
module Make:
| Parameters: |
|
mem h k is true, a subsequent
find h k may raise Not_found because the garbage collector
can run between the two.
Moreover, the table shouldn't be modified during a call to iter.
Use filter_map_inplace in this case.
include Hashtbl.S
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingsmodule Incl:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs -> 'a -> 'a Parsetree.include_infos ocaml-doc-4.05/ocaml.html/libref/type_Clflags.Int_arg_helper.html 0000644 0001750 0001750 00000017633 13131636443 024000 0 ustar mehdi mehdi
sig
type parsed
val parse :
string -> string -> Clflags.Int_arg_helper.parsed Pervasives.ref -> unit
type parse_result = Ok | Parse_failed of exn
val parse_no_error :
string ->
Clflags.Int_arg_helper.parsed Pervasives.ref ->
Clflags.Int_arg_helper.parse_result
val get : key:int -> Clflags.Int_arg_helper.parsed -> int
end ocaml-doc-4.05/ocaml.html/libref/Printast.html 0000644 0001750 0001750 00000020771 13131636450 020242 0 ustar mehdi mehdi
module Printast:sig..end
val interface : Format.formatter -> Parsetree.signature_item list -> unit
val implementation : Format.formatter -> Parsetree.structure_item list -> unit
val top_phrase : Format.formatter -> Parsetree.toplevel_phrase -> unit
val expression : int -> Format.formatter -> Parsetree.expression -> unit
val structure : int -> Format.formatter -> Parsetree.structure -> unit
val payload : int -> Format.formatter -> Parsetree.payload -> unit ocaml-doc-4.05/ocaml.html/libref/Weak.S.html 0000644 0001750 0001750 00000033155 13131636452 017530 0 ustar mehdi mehdi
module type S =sig..end
Weak.Make.type
type
data.
Note that weak hash sets cannot be marshaled using
output_value or the functions of the Marshal
module.val create : int -> tcreate n creates a new empty weak hash set, of initial
size n. The table will grow as needed.val clear : t -> unitval merge : t -> data -> datamerge t x returns an instance of x found in t if any,
or else adds x to t and return x.val add : t -> data -> unitadd t x adds x to t. If there is already an instance
of x in t, it is unspecified which one will be
returned by subsequent calls to find and merge.val remove : t -> data -> unitremove t x removes from t one instance of x. Does
nothing if there is no instance of x in t.val find : t -> data -> datafind t x returns an instance of x found in t.
Raise Not_found if there is no such element.val find_opt : t -> data -> data optionfind_opt t x returns an instance of x found in t
or None if there is no such element.val find_all : t -> data -> data listfind_all t x returns a list of all the instances of x
found in t.val mem : t -> data -> boolmem t x returns true if there is at least one instance
of x in t, false otherwise.val iter : (data -> unit) -> t -> unititer f t calls f on each element of t, in some unspecified
order. It is not specified what happens if f tries to change
t itself.val fold : (data -> 'a -> 'a) -> t -> 'a -> 'afold f t init computes (f d1 (... (f dN init))) where
d1 ... dN are the elements of t in some unspecified order.
It is not specified what happens if f tries to change t
itself.val count : t -> intcount t gives the
same result as fold (fun _ n -> n+1) t 0 but does not delay the
deallocation of the dead elements.val stats : t -> int * int * int * int * int * intsig
type ('a, 'b) t
val empty : ('a, 'b) Tbl.t
val add : 'a -> 'b -> ('a, 'b) Tbl.t -> ('a, 'b) Tbl.t
val find : 'a -> ('a, 'b) Tbl.t -> 'b
val mem : 'a -> ('a, 'b) Tbl.t -> bool
val remove : 'a -> ('a, 'b) Tbl.t -> ('a, 'b) Tbl.t
val iter : ('a -> 'b -> unit) -> ('a, 'b) Tbl.t -> unit
val map : ('a -> 'b -> 'c) -> ('a, 'b) Tbl.t -> ('a, 'c) Tbl.t
val fold : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) Tbl.t -> 'c -> 'c
val print :
(Format.formatter -> 'a -> unit) ->
(Format.formatter -> 'b -> unit) ->
Format.formatter -> ('a, 'b) Tbl.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/Tbl.html 0000644 0001750 0001750 00000021514 13131636451 017154 0 ustar mehdi mehdi
module Tbl:sig..end
type ('a, 'b) t
val empty : ('a, 'b) t
val add : 'a -> 'b -> ('a, 'b) t -> ('a, 'b) t
val find : 'a -> ('a, 'b) t -> 'b
val mem : 'a -> ('a, 'b) t -> bool
val remove : 'a -> ('a, 'b) t -> ('a, 'b) t
val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unit
val map : ('a -> 'b -> 'c) -> ('a, 'b) t -> ('a, 'c) t
val fold : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'c
val print : (Format.formatter -> 'a -> unit) ->
(Format.formatter -> 'b -> unit) ->
Format.formatter -> ('a, 'b) t -> unit ocaml-doc-4.05/ocaml.html/libref/CamlinternalLazy.html 0000644 0001750 0001750 00000017610 13131636443 021707 0 ustar mehdi mehdi
module CamlinternalLazy:sig..end
exception Undefined
val force_lazy_block : 'a lazy_t -> 'a
val force_val_lazy_block : 'a lazy_t -> 'a
val force : 'a lazy_t -> 'a
val force_val : 'a lazy_t -> 'a ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.GenHashTable.MakeSeeded.html 0000644 0001750 0001750 00000040144 13131636443 025671 0 ustar mehdi mehdi
functor
(H : sig
type t
type 'a container
val hash : int -> Ephemeron.GenHashTable.MakeSeeded.t -> int
val equal :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t ->
Ephemeron.GenHashTable.equal
val create :
Ephemeron.GenHashTable.MakeSeeded.t ->
'a -> 'a Ephemeron.GenHashTable.MakeSeeded.container
val get_key :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t option
val get_data :
'a Ephemeron.GenHashTable.MakeSeeded.container -> 'a option
val set_key_data :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t -> 'a -> unit
val check_key :
'a Ephemeron.GenHashTable.MakeSeeded.container -> bool
end) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/Identifiable.Make.html 0000644 0001750 0001750 00000021402 13131636444 021664 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
type
module T:Identifiable.Thingwith type t = t
include Identifiable.Thing
module Set:sig..end
module Map:sig..end
module Tbl:ocaml-doc-4.05/ocaml.html/libref/Identifiable.Thing.html 0000644 0001750 0001750 00000017314 13131636444 022067 0 ustar mehdi mehdisig..end
module type Thing =sig..end
type
include Hashtbl.HashedType
include Map.OrderedType
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Sig.html 0000644 0001750 0001750 00000030407 13131636441 022303 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
Parsetree.signature_item_desc -> Parsetree.signature_item
val value :
?loc:Ast_helper.loc ->
Parsetree.value_description -> Parsetree.signature_item
val type_ :
?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.type_declaration list -> Parsetree.signature_item
val type_extension :
?loc:Ast_helper.loc ->
Parsetree.type_extension -> Parsetree.signature_item
val exception_ :
?loc:Ast_helper.loc ->
Parsetree.extension_constructor -> Parsetree.signature_item
val module_ :
?loc:Ast_helper.loc ->
Parsetree.module_declaration -> Parsetree.signature_item
val rec_module :
?loc:Ast_helper.loc ->
Parsetree.module_declaration list -> Parsetree.signature_item
val modtype :
?loc:Ast_helper.loc ->
Parsetree.module_type_declaration -> Parsetree.signature_item
val open_ :
?loc:Ast_helper.loc ->
Parsetree.open_description -> Parsetree.signature_item
val include_ :
?loc:Ast_helper.loc ->
Parsetree.include_description -> Parsetree.signature_item
val class_ :
?loc:Ast_helper.loc ->
Parsetree.class_description list -> Parsetree.signature_item
val class_type :
?loc:Ast_helper.loc ->
Parsetree.class_type_declaration list -> Parsetree.signature_item
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.signature_item
val attribute :
?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.signature_item
val text : Docstrings.text -> Parsetree.signature_item list
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Ci.html 0000644 0001750 0001750 00000017546 13131636441 021064 0 ustar mehdi mehdi
module Ci:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?virt:Asttypes.virtual_flag ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
Ast_helper.str -> 'a -> 'a Parsetree.class_infos ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Ctf.html 0000644 0001750 0001750 00000026561 13131636441 022303 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
Parsetree.class_type_field_desc -> Parsetree.class_type_field
val attr :
Parsetree.class_type_field ->
Parsetree.attribute -> Parsetree.class_type_field
val inherit_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_type -> Parsetree.class_type_field
val val_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.mutable_flag ->
Asttypes.virtual_flag ->
Parsetree.core_type -> Parsetree.class_type_field
val method_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.private_flag ->
Asttypes.virtual_flag ->
Parsetree.core_type -> Parsetree.class_type_field
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.class_type_field
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.class_type_field
val attribute :
?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.class_type_field
val text : Docstrings.text -> Parsetree.class_type_field list
end ocaml-doc-4.05/ocaml.html/libref/type_Hashtbl.html 0000644 0001750 0001750 00000123407 13131636444 021067 0 ustar mehdi mehdi
sig
type ('a, 'b) t
val create : ?random:bool -> int -> ('a, 'b) Hashtbl.t
val clear : ('a, 'b) Hashtbl.t -> unit
val reset : ('a, 'b) Hashtbl.t -> unit
val copy : ('a, 'b) Hashtbl.t -> ('a, 'b) Hashtbl.t
val add : ('a, 'b) Hashtbl.t -> 'a -> 'b -> unit
val find : ('a, 'b) Hashtbl.t -> 'a -> 'b
val find_opt : ('a, 'b) Hashtbl.t -> 'a -> 'b option
val find_all : ('a, 'b) Hashtbl.t -> 'a -> 'b list
val mem : ('a, 'b) Hashtbl.t -> 'a -> bool
val remove : ('a, 'b) Hashtbl.t -> 'a -> unit
val replace : ('a, 'b) Hashtbl.t -> 'a -> 'b -> unit
val iter : ('a -> 'b -> unit) -> ('a, 'b) Hashtbl.t -> unit
val filter_map_inplace :
('a -> 'b -> 'b option) -> ('a, 'b) Hashtbl.t -> unit
val fold : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) Hashtbl.t -> 'c -> 'c
val length : ('a, 'b) Hashtbl.t -> int
val randomize : unit -> unit
val is_randomized : unit -> bool
type statistics = {
num_bindings : int;
num_buckets : int;
max_bucket_length : int;
bucket_histogram : int array;
}
val stats : ('a, 'b) Hashtbl.t -> Hashtbl.statistics
module type HashedType =
sig
type t
val equal : Hashtbl.HashedType.t -> Hashtbl.HashedType.t -> bool
val hash : Hashtbl.HashedType.t -> int
end
module type S =
sig
type key
type 'a t
val create : int -> 'a Hashtbl.S.t
val clear : 'a Hashtbl.S.t -> unit
val reset : 'a Hashtbl.S.t -> unit
val copy : 'a Hashtbl.S.t -> 'a Hashtbl.S.t
val add : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a -> unit
val remove : 'a Hashtbl.S.t -> Hashtbl.S.key -> unit
val find : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a
val find_opt : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a option
val find_all : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a list
val replace : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a -> unit
val mem : 'a Hashtbl.S.t -> Hashtbl.S.key -> bool
val iter : (Hashtbl.S.key -> 'a -> unit) -> 'a Hashtbl.S.t -> unit
val filter_map_inplace :
(Hashtbl.S.key -> 'a -> 'a option) -> 'a Hashtbl.S.t -> unit
val fold :
(Hashtbl.S.key -> 'a -> 'b -> 'b) -> 'a Hashtbl.S.t -> 'b -> 'b
val length : 'a Hashtbl.S.t -> int
val stats : 'a Hashtbl.S.t -> Hashtbl.statistics
end
module Make :
functor (H : HashedType) ->
sig
type key = H.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end
module type SeededHashedType =
sig
type t
val equal :
Hashtbl.SeededHashedType.t -> Hashtbl.SeededHashedType.t -> bool
val hash : int -> Hashtbl.SeededHashedType.t -> int
end
module type SeededS =
sig
type key
type 'a t
val create : ?random:bool -> int -> 'a Hashtbl.SeededS.t
val clear : 'a Hashtbl.SeededS.t -> unit
val reset : 'a Hashtbl.SeededS.t -> unit
val copy : 'a Hashtbl.SeededS.t -> 'a Hashtbl.SeededS.t
val add : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a -> unit
val remove : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> unit
val find : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a
val find_opt : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a option
val find_all : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a list
val replace : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a -> unit
val mem : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> bool
val iter :
(Hashtbl.SeededS.key -> 'a -> unit) -> 'a Hashtbl.SeededS.t -> unit
val filter_map_inplace :
(Hashtbl.SeededS.key -> 'a -> 'a option) ->
'a Hashtbl.SeededS.t -> unit
val fold :
(Hashtbl.SeededS.key -> 'a -> 'b -> 'b) ->
'a Hashtbl.SeededS.t -> 'b -> 'b
val length : 'a Hashtbl.SeededS.t -> int
val stats : 'a Hashtbl.SeededS.t -> Hashtbl.statistics
end
module MakeSeeded :
functor (H : SeededHashedType) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end
val hash : 'a -> int
val seeded_hash : int -> 'a -> int
val hash_param : int -> int -> 'a -> int
val seeded_hash_param : int -> int -> int -> 'a -> int
end ocaml-doc-4.05/ocaml.html/libref/Nativeint.html 0000644 0001750 0001750 00000050074 13131636447 020404 0 ustar mehdi mehdi
module Nativeint:sig..end
This module provides operations on the type nativeint of
signed 32-bit integers (on 32-bit platforms) or
signed 64-bit integers (on 64-bit platforms).
This integer type has exactly the same width as that of a
pointer type in the C compiler. All arithmetic operations over
nativeint are taken modulo 232 or 264 depending
on the word size of the architecture.
Performance notice: values of type nativeint occupy more memory
space than values of type int, and arithmetic operations on
nativeint are generally slower than those on int. Use nativeint
only when the application requires the extra bit of precision
over the int type.
val zero : nativeintval one : nativeintval minus_one : nativeintval neg : nativeint -> nativeintval add : nativeint -> nativeint -> nativeintval sub : nativeint -> nativeint -> nativeintval mul : nativeint -> nativeint -> nativeintval div : nativeint -> nativeint -> nativeintDivision_by_zero if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for (/).val rem : nativeint -> nativeint -> nativeinty is not zero, the result
of Nativeint.rem x y satisfies the following properties:
Nativeint.zero <= Nativeint.rem x y < Nativeint.abs y and
x = Nativeint.add (Nativeint.mul (Nativeint.div x y) y)
(Nativeint.rem x y).
If y = 0, Nativeint.rem x y raises Division_by_zero.val succ : nativeint -> nativeintNativeint.succ x is Nativeint.add x Nativeint.one.val pred : nativeint -> nativeintNativeint.pred x is Nativeint.sub x Nativeint.one.val abs : nativeint -> nativeintval size : int32
on a 32-bit platform and to 64 on a 64-bit platform.val max_int : nativeintval min_int : nativeintval logand : nativeint -> nativeint -> nativeintval logor : nativeint -> nativeint -> nativeintval logxor : nativeint -> nativeint -> nativeintval lognot : nativeint -> nativeintval shift_left : nativeint -> int -> nativeintNativeint.shift_left x y shifts x to the left by y bits.
The result is unspecified if y < 0 or y >= bitsize,
where bitsize is 32 on a 32-bit platform and
64 on a 64-bit platform.val shift_right : nativeint -> int -> nativeintNativeint.shift_right x y shifts x to the right by y bits.
This is an arithmetic shift: the sign bit of x is replicated
and inserted in the vacated bits.
The result is unspecified if y < 0 or y >= bitsize.val shift_right_logical : nativeint -> int -> nativeintNativeint.shift_right_logical x y shifts x to the right
by y bits.
This is a logical shift: zeroes are inserted in the vacated bits
regardless of the sign of x.
The result is unspecified if y < 0 or y >= bitsize.val of_int : int -> nativeintint) to a native integer
(type nativeint).val to_int : nativeint -> intnativeint) to an
integer (type int). The high-order bit is lost during
the conversion.val of_float : float -> nativeintNativeint.min_int, Nativeint.max_int].val to_float : nativeint -> floatval of_int32 : int32 -> nativeintint32)
to a native integer.val to_int32 : nativeint -> int32int32). On 64-bit platforms,
the 64-bit native integer is taken modulo 232,
i.e. the top 32 bits are lost. On 32-bit platforms,
the conversion is exact.val of_string : string -> nativeint0x, 0o or 0b
respectively.
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 nativeint.val of_string_opt : string -> nativeint optionof_string, but return None instead of raising.val to_string : nativeint -> stringtypet =nativeint
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module Nativeint to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolsig
val int : string -> int
val int32 : string -> int32
val int64 : string -> int64
val nativeint : string -> nativeint
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Hashtbl.Make.html 0000644 0001750 0001750 00000026473 13131636446 023776 0 ustar mehdi mehdi
functor (H : HashedType) ->
sig
type key = H.t
and 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val filter_map_inplace :
f:(key:key -> data:'a -> 'a option) -> 'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end ocaml-doc-4.05/ocaml.html/libref/Pervasives.html 0000644 0001750 0001750 00000306401 13131636450 020562 0 ustar mehdi mehdi
module Pervasives:sig..end
This module provides the basic operations over the built-in types (numbers, booleans, byte sequences, strings, exceptions, references, lists, arrays, input-output channels, ...).
This module is automatically opened at the beginning of each compilation.
All components of this module can therefore be referred by their short
name, without prefixing them by Pervasives.
val raise : exn -> 'aval raise_notrace : exn -> 'araise which does not record the backtrace.val invalid_arg : string -> 'aInvalid_argument with the given string.val failwith : string -> 'aFailure with the given string.exception Exit
Exit exception is not raised by any library function. It is
provided for use in your programs.val (=) : 'a -> 'a -> boole1 = e2 tests for structural equality of e1 and e2.
Mutable structures (e.g. references and arrays) are equal
if and only if their current contents are structurally equal,
even if the two mutable objects are not the same physical object.
Equality between functional values raises Invalid_argument.
Equality between cyclic data structures may not terminate.val (<>) : 'a -> 'a -> bool(=).val (<) : 'a -> 'a -> bool(>=).val (>) : 'a -> 'a -> bool(>=).val (<=) : 'a -> 'a -> bool(>=).val (>=) : 'a -> 'a -> bool( = ). As in the case
of ( = ), mutable structures are compared by contents.
Comparison between functional values raises Invalid_argument.
Comparison between cyclic structures may not terminate.val compare : 'a -> 'a -> intcompare x y returns 0 if x is equal to y,
a negative integer if x is less than y, and a positive integer
if x is greater than y. The ordering implemented by compare
is compatible with the comparison predicates =, < and >
defined above, with one difference on the treatment of the float value
nan. Namely, the comparison predicates treat nan
as different from any other float value, including itself;
while compare treats nan as equal to itself and less than any
other float value. This treatment of nan ensures that compare
defines a total ordering relation.
compare applied to functional values may raise Invalid_argument.
compare applied to cyclic structures may not terminate.
The compare function can be used as the comparison function
required by the Set.Make and Map.Make functors, as well as
the List.sort and Array.sort functions.
val min : 'a -> 'a -> 'anan.val max : 'a -> 'a -> 'anan.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 -> bool(==).val not : bool -> boolval (&&) : bool -> bool -> boole1 && e2, e1 is evaluated first, and if it returns false,
e2 is not evaluated at all.val (&) : bool -> bool -> bool
val (||) : bool -> bool -> boole1 || e2, e1 is evaluated first, and if it returns true,
e2 is not evaluated at all.val (or) : bool -> bool -> bool
val __LOC__ : string__LOC__ returns the location at which this expression appears in
the file currently being parsed by the compiler, with the standard
error format of OCaml: "File %S, line %d, characters %d-%d".val __FILE__ : string__FILE__ returns the name of the file currently being
parsed by the compiler.val __LINE__ : int__LINE__ returns the line number at which this expression
appears in the file currently being parsed by the compiler.val __MODULE__ : string__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 __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__ 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 (loc,expr), 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.val (|>) : 'a -> ('a -> 'b) -> 'bx |> f |> g is exactly equivalent
to g (f (x)).val (@@) : ('a -> 'b) -> 'a -> 'bg @@ f @@ x is exactly equivalent to
g (f (x)).val (~-) : int -> int- e instead of ~- e.val (~+) : int -> int+ e instead of ~+ e.val succ : int -> intsucc x is x + 1.val pred : int -> intpred x is x - 1.val (+) : int -> int -> intval (-) : int -> int -> intval ( * ) : int -> int -> intval (/) : int -> int -> intDivision_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 -> inty is not zero, the result
of x mod y satisfies the following properties:
x = (x / y) * y + x mod y and
abs(x mod y) <= abs(y) - 1.
If y = 0, x mod y raises Division_by_zero.
Note that x mod y is negative only if x < 0.
Raise Division_by_zero if y is zero.val abs : int -> intmin_int.val max_int : intval min_int : intval (land) : int -> int -> intval (lor) : int -> int -> intval (lxor) : int -> int -> intval lnot : int -> intval (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.
OCaml's floating-point numbers follow the
IEEE 754 standard, using double precision (64 bits) numbers.
Floating-point operations never raise an exception on overflow,
underflow, division by zero, etc. Instead, special IEEE numbers
are returned as appropriate, such as infinity for 1.0 /. 0.0,
neg_infinity for -1.0 /. 0.0, and nan ('not a number')
for 0.0 /. 0.0. These special numbers then propagate through
floating-point computations as expected: for instance,
1.0 /. infinity is 0.0, and any arithmetic operation with nan
as argument returns nan as result.
val (~-.) : float -> float-. e instead of ~-. e.val (~+.) : float -> float+. e instead of ~+. e.val (+.) : float -> float -> floatval (-.) : float -> float -> floatval ( *. ) : float -> float -> floatval (/.) : float -> float -> floatval ( ** ) : float -> float -> floatval sqrt : float -> floatval exp : float -> floatval log : 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.val cos : float -> floatval sin : float -> floatval tan : float -> floatval acos : float -> float[-1.0, 1.0].
Result is in radians and is between 0.0 and pi.val asin : float -> float[-1.0, 1.0].
Result is in radians and is between -pi/2 and pi/2.val atan : float -> float-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. If one of x or y is infinite, returns infinity
even if the other is nan.val cosh : float -> floatval sinh : float -> floatval tanh : float -> floatval ceil : float -> floatceil f returns the least integer value greater than or equal to f.
The result is returned as a float.val floor : float -> floatfloor 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.val float : int -> floatfloat_of_int.val float_of_int : int -> floatval truncate : float -> intint_of_float.val int_of_float : float -> intnan or falls outside the
range of representable integers.val infinity : floatval neg_infinity : floatval nan : float0.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.val max_float : floatfloat.val min_float : floatfloat.val epsilon_float : float1.0 and the smallest exactly representable
floating-point number greater than 1.0.type
| |
FP_normal |
(* |
Normal number, none of the below
| *) |
| |
FP_subnormal |
(* |
Number very close to 0.0, has reduced precision
| *) |
| |
FP_zero |
(* |
Number is 0.0 or -0.0
| *) |
| |
FP_infinite |
(* |
Number is positive or negative infinity
| *) |
| |
FP_nan |
(* |
Not a number: result of an undefined operation
| *) |
classify_float function.val classify_float : float -> fpclass
More string operations are provided in module String.
val (^) : string -> string -> string
More character operations are provided in module Char.
val int_of_char : char -> intval char_of_int : int -> charInvalid_argument "char_of_int" if the argument is
outside the range 0--255.val ignore : 'a -> unit().
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.val string_of_bool : bool -> stringval bool_of_string : string -> boolInvalid_argument "bool_of_string" if the string is not
"true" or "false".val bool_of_string_opt : string -> bool optionNone if the string is not
"true" or "false".val string_of_int : int -> stringval int_of_string : string -> int0x or 0X), in octal (if it begins with 0o or 0O),
or in binary (if it begins with 0b or 0B).
The _ (underscore) character can appear anywhere in the string
and is ignored.
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 int_of_string_opt : string -> int optionint_of_string, but returs None instead of raising.val string_of_float : float -> stringval float_of_string : string -> float0x or 0X).
The format of decimal floating-point numbers is
[-] dd.ddd (e|E) [+|-] dd , where d stands for a decimal digit.
The format of hexadecimal floating-point numbers is
[-] 0(x|X) hh.hhh (p|P) [+|-] dd , where h stands for an
hexadecimal digit and d for a decimal digit.
In both cases, at least one of the integer and fractional parts must be
given; the exponent part is optional.
The _ (underscore) character can appear anywhere in the string
and is ignored.
Depending on the execution platforms, other representations of
floating-point numbers can be accepted, but should not be relied upon.
Raise Failure "float_of_string" if the given string is not a valid
representation of a float.val float_of_string_opt : string -> float optionfloat_of_string, but returns None instead of raising.val fst : 'a * 'b -> 'aval snd : 'a * 'b -> 'b
More list operations are provided in module List.
val (@) : 'a list -> 'a list -> 'a listSys_error when the system
calls they invoke fail.type
type
val stdin : in_channelval stdout : out_channelval stderr : out_channelval print_char : char -> unitval print_string : string -> unitval print_bytes : bytes -> unitval print_int : int -> unitval print_float : float -> unitval print_endline : string -> unitval print_newline : unit -> unitval prerr_char : char -> unitval prerr_string : string -> unitval prerr_bytes : bytes -> unitval prerr_int : int -> unitval prerr_float : float -> unitval prerr_endline : string -> unitval prerr_newline : unit -> unitval read_line : unit -> stringval read_int : unit -> intFailure "int_of_string"
if the line read is not a valid representation of an integer.val read_int_opt : unit -> int optionread_int_opt, but returs None instead of raising.val read_float : unit -> floatval read_float_opt : unit -> float optionNone if the line read is not a valid
representation of a floating-point number.type
| |
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.
| *) |
val open_out : string -> out_channelval open_out_bin : string -> out_channelopen_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 open_out.val open_out_gen : open_flag list -> int -> string -> out_channelopen_out_gen mode perm filename opens the named file for writing,
as described above. The extra argument mode
specifies the opening mode. The extra argument perm specifies
the file permissions, in case the file must be created.
open_out and open_out_bin are special
cases of this function.val flush : out_channel -> unitval flush_all : unit -> unitval output_char : out_channel -> char -> unitval output_string : out_channel -> string -> unitval output_bytes : out_channel -> bytes -> unitval output : 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 : out_channel -> string -> int -> int -> unitoutput but take a string as argument instead of
a byte sequence.val output_byte : out_channel -> int -> unitval output_binary_int : out_channel -> int -> unitinput_binary_int function. The format is compatible across
all machines for a given version of OCaml.val output_value : out_channel -> 'a -> unitinput_value. See the description of module
Marshal for more information. output_value is equivalent
to Marshal.to_channel with an empty list of flags.val seek_out : 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 : out_channel -> intOpen_append flag (returns
unspecified results).val out_channel_length : out_channel -> intval close_out : out_channel -> unitSys_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 : out_channel -> unitclose_out, but ignore all errors.val set_binary_mode_out : 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 -> in_channelval open_in_bin : string -> in_channelopen_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 open_in.val open_in_gen : open_flag list -> int -> string -> 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.
open_in and open_in_bin are special
cases of this function.val input_char : in_channel -> charEnd_of_file if there are no more characters to read.val input_line : in_channel -> stringEnd_of_file if the end of the file is reached
at the beginning of line.val input : in_channel -> bytes -> int -> int -> intinput 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 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.val really_input : in_channel -> bytes -> int -> int -> unitreally_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.val really_input_string : in_channel -> int -> stringreally_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.val input_byte : in_channel -> intinput_char, but return the 8-bit integer representing
the character.
Raise End_of_file if an end of file was reached.val input_binary_int : in_channel -> intoutput_binary_int.
Raise End_of_file if an end of file was reached while reading the
integer.val input_value : in_channel -> 'aoutput_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 : 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 : in_channel -> intval in_channel_length : in_channel -> intval close_in : in_channel -> unitSys_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 : in_channel -> unitclose_in, but ignore all errors.val set_binary_mode_in : 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.module LargeFile:sig..end
type 'a ref = {
|
mutable contents : |
'a.val ref : 'a -> 'a refval (!) : 'a ref -> 'a!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 -> unitfun r -> r := succ !r.val decr : int ref -> unitfun r -> r := pred !r.type ('a, 'b) result =
| |
Ok of |
| |
Error of |
Scanf and to print data with formatted output functions from modules
Printf and Format.
Format strings are made of three kinds of entities:
'%'
followed by one or more characters specifying what kind of argument to
read or print,'@'
followed by one or more characters specifying how to read or print the
argument,'%'
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.'b is also the type of the first argument given to
user's defined printing functions for %a and %t conversions,
and user's defined reading functions for %r conversion.
'c is the type of the result of the %a and %t printing
functions, and also the type of the argument transmitted to the
first argument of kprintf-style functions or to the
kscanf-style functions.'d is the type of parameters for the scanf-style functions.'e is the type of the receiver function for the scanf-style functions.'f is the final result type of a formatted input/output function
invocation: for the printf-style functions, it is typically unit;
for the scanf-style functions, it is typically the result type of the
receiver function.type('a, 'b, 'c, 'd, 'e, 'f)format6 =('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6
type('a, 'b, 'c, 'd)format4 =('a, 'b, 'c, 'c, 'c, 'd) format6
type('a, 'b, 'c)format =('a, 'b, 'c, 'c) format4
val string_of_format : ('a, 'b, 'c, 'd, 'e, 'f) format6 -> stringval format_of_string : ('a, 'b, 'c, 'd, 'e, 'f) format6 ->
('a, 'b, 'c, 'd, 'e, 'f) format6format_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.val exit : int -> 'aflush_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) -> unitat_exit
will be called when the program executes 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.sig
type t = { re : float; im : float; }
val zero : Complex.t
val one : Complex.t
val i : Complex.t
val neg : Complex.t -> Complex.t
val conj : Complex.t -> Complex.t
val add : Complex.t -> Complex.t -> Complex.t
val sub : Complex.t -> Complex.t -> Complex.t
val mul : Complex.t -> Complex.t -> Complex.t
val inv : Complex.t -> Complex.t
val div : Complex.t -> Complex.t -> Complex.t
val sqrt : Complex.t -> Complex.t
val norm2 : Complex.t -> float
val norm : Complex.t -> float
val arg : Complex.t -> float
val polar : float -> float -> Complex.t
val exp : Complex.t -> Complex.t
val log : Complex.t -> Complex.t
val pow : Complex.t -> Complex.t -> Complex.t
end ocaml-doc-4.05/ocaml.html/libref/type_Condition.html 0000644 0001750 0001750 00000016357 13131636443 021434 0 ustar mehdi mehdi
sig
type t
val create : unit -> Condition.t
val wait : Condition.t -> Mutex.t -> unit
val signal : Condition.t -> unit
val broadcast : Condition.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Clflags.html 0000644 0001750 0001750 00000100657 13131636443 021056 0 ustar mehdi mehdi
sig
module Int_arg_helper :
sig
type parsed
val parse :
string ->
string -> Clflags.Int_arg_helper.parsed Pervasives.ref -> unit
type parse_result = Ok | Parse_failed of exn
val parse_no_error :
string ->
Clflags.Int_arg_helper.parsed Pervasives.ref ->
Clflags.Int_arg_helper.parse_result
val get : key:int -> Clflags.Int_arg_helper.parsed -> int
end
module Float_arg_helper :
sig
type parsed
val parse :
string ->
string -> Clflags.Float_arg_helper.parsed Pervasives.ref -> unit
type parse_result = Ok | Parse_failed of exn
val parse_no_error :
string ->
Clflags.Float_arg_helper.parsed Pervasives.ref ->
Clflags.Float_arg_helper.parse_result
val get : key:int -> Clflags.Float_arg_helper.parsed -> float
end
type inlining_arguments = {
inline_call_cost : int option;
inline_alloc_cost : int option;
inline_prim_cost : int option;
inline_branch_cost : int option;
inline_indirect_cost : int option;
inline_lifting_benefit : int option;
inline_branch_factor : float option;
inline_max_depth : int option;
inline_max_unroll : int option;
inline_threshold : float option;
inline_toplevel_threshold : int option;
}
val classic_arguments : Clflags.inlining_arguments
val o1_arguments : Clflags.inlining_arguments
val o2_arguments : Clflags.inlining_arguments
val o3_arguments : Clflags.inlining_arguments
val use_inlining_arguments_set :
?round:int -> Clflags.inlining_arguments -> unit
val objfiles : string list Pervasives.ref
val ccobjs : string list Pervasives.ref
val dllibs : string list Pervasives.ref
val compile_only : bool Pervasives.ref
val output_name : string option Pervasives.ref
val include_dirs : string list Pervasives.ref
val no_std_include : bool Pervasives.ref
val print_types : bool Pervasives.ref
val make_archive : bool Pervasives.ref
val debug : bool Pervasives.ref
val fast : bool Pervasives.ref
val link_everything : bool Pervasives.ref
val custom_runtime : bool Pervasives.ref
val no_check_prims : bool Pervasives.ref
val bytecode_compatible_32 : bool Pervasives.ref
val output_c_object : bool Pervasives.ref
val output_complete_object : bool Pervasives.ref
val all_ccopts : string list Pervasives.ref
val classic : bool Pervasives.ref
val nopervasives : bool Pervasives.ref
val open_modules : string list Pervasives.ref
val preprocessor : string option Pervasives.ref
val all_ppx : string list Pervasives.ref
val annotations : bool Pervasives.ref
val binary_annotations : bool Pervasives.ref
val use_threads : bool Pervasives.ref
val use_vmthreads : bool Pervasives.ref
val noassert : bool Pervasives.ref
val verbose : bool Pervasives.ref
val noprompt : bool Pervasives.ref
val nopromptcont : bool Pervasives.ref
val init_file : string option Pervasives.ref
val noinit : bool Pervasives.ref
val noversion : bool Pervasives.ref
val use_prims : string Pervasives.ref
val use_runtime : string Pervasives.ref
val principal : bool Pervasives.ref
val real_paths : bool Pervasives.ref
val recursive_types : bool Pervasives.ref
val strict_sequence : bool Pervasives.ref
val strict_formats : bool Pervasives.ref
val applicative_functors : bool Pervasives.ref
val make_runtime : bool Pervasives.ref
val gprofile : bool Pervasives.ref
val c_compiler : string option Pervasives.ref
val no_auto_link : bool Pervasives.ref
val dllpaths : string list Pervasives.ref
val make_package : bool Pervasives.ref
val for_package : string option Pervasives.ref
val error_size : int Pervasives.ref
val float_const_prop : bool Pervasives.ref
val transparent_modules : bool Pervasives.ref
val dump_source : bool Pervasives.ref
val dump_parsetree : bool Pervasives.ref
val dump_typedtree : bool Pervasives.ref
val dump_rawlambda : bool Pervasives.ref
val dump_lambda : bool Pervasives.ref
val dump_rawclambda : bool Pervasives.ref
val dump_clambda : bool Pervasives.ref
val dump_rawflambda : bool Pervasives.ref
val dump_flambda : bool Pervasives.ref
val dump_flambda_let : int option Pervasives.ref
val dump_instr : bool Pervasives.ref
val keep_asm_file : bool Pervasives.ref
val optimize_for_speed : bool Pervasives.ref
val dump_cmm : bool Pervasives.ref
val dump_selection : bool Pervasives.ref
val dump_cse : bool Pervasives.ref
val dump_live : bool Pervasives.ref
val dump_spill : bool Pervasives.ref
val dump_split : bool Pervasives.ref
val dump_interf : bool Pervasives.ref
val dump_prefer : bool Pervasives.ref
val dump_regalloc : bool Pervasives.ref
val dump_reload : bool Pervasives.ref
val dump_scheduling : bool Pervasives.ref
val dump_linear : bool Pervasives.ref
val keep_startup_file : bool Pervasives.ref
val dump_combine : bool Pervasives.ref
val native_code : bool Pervasives.ref
val default_inline_threshold : float
val inline_threshold : Clflags.Float_arg_helper.parsed Pervasives.ref
val inlining_report : bool Pervasives.ref
val simplify_rounds : int option Pervasives.ref
val default_simplify_rounds : int Pervasives.ref
val rounds : unit -> int
val default_inline_max_unroll : int
val inline_max_unroll : Clflags.Int_arg_helper.parsed Pervasives.ref
val default_inline_toplevel_threshold : int
val inline_toplevel_threshold :
Clflags.Int_arg_helper.parsed Pervasives.ref
val default_inline_call_cost : int
val default_inline_alloc_cost : int
val default_inline_prim_cost : int
val default_inline_branch_cost : int
val default_inline_indirect_cost : int
val default_inline_lifting_benefit : int
val inline_call_cost : Clflags.Int_arg_helper.parsed Pervasives.ref
val inline_alloc_cost : Clflags.Int_arg_helper.parsed Pervasives.ref
val inline_prim_cost : Clflags.Int_arg_helper.parsed Pervasives.ref
val inline_branch_cost : Clflags.Int_arg_helper.parsed Pervasives.ref
val inline_indirect_cost : Clflags.Int_arg_helper.parsed Pervasives.ref
val inline_lifting_benefit : Clflags.Int_arg_helper.parsed Pervasives.ref
val default_inline_branch_factor : float
val inline_branch_factor : Clflags.Float_arg_helper.parsed Pervasives.ref
val dont_write_files : bool Pervasives.ref
val std_include_flag : string -> string
val std_include_dir : unit -> string list
val shared : bool Pervasives.ref
val dlcode : bool Pervasives.ref
val pic_code : bool Pervasives.ref
val runtime_variant : string Pervasives.ref
val force_slash : bool Pervasives.ref
val keep_docs : bool Pervasives.ref
val keep_locs : bool Pervasives.ref
val unsafe_string : bool Pervasives.ref
val opaque : bool Pervasives.ref
val print_timings : bool Pervasives.ref
val flambda_invariant_checks : bool Pervasives.ref
val unbox_closures : bool Pervasives.ref
val unbox_closures_factor : int Pervasives.ref
val default_unbox_closures_factor : int
val unbox_free_vars_of_closures : bool Pervasives.ref
val unbox_specialised_args : bool Pervasives.ref
val clambda_checks : bool Pervasives.ref
val default_inline_max_depth : int
val inline_max_depth : Clflags.Int_arg_helper.parsed Pervasives.ref
val remove_unused_arguments : bool Pervasives.ref
val dump_flambda_verbose : bool Pervasives.ref
val classic_inlining : bool Pervasives.ref
val afl_instrument : bool Pervasives.ref
val afl_inst_ratio : int Pervasives.ref
val all_passes : string list Pervasives.ref
val dumped_pass : string -> bool
val set_dumped_pass : string -> bool -> unit
val parse_color_setting : string -> Misc.Color.setting option
val color : Misc.Color.setting option Pervasives.ref
val unboxed_types : bool Pervasives.ref
val arg_spec : (string * Arg.spec * string) list Pervasives.ref
val add_arguments : string -> (string * Arg.spec * string) list -> unit
val parse_arguments : Arg.anon_fun -> string -> unit
val print_arguments : string -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.K1.Make.html 0000644 0001750 0001750 00000027314 13131636443 022551 0 ustar mehdi mehdi
functor (H : Hashtbl.HashedType) ->
sig
type key = H.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Cstr.html 0000644 0001750 0001750 00000015465 13131636441 022503 0 ustar mehdi mehdi
sig
val mk :
Parsetree.pattern ->
Parsetree.class_field list -> Parsetree.class_structure
end ocaml-doc-4.05/ocaml.html/libref/type_Lexer.html 0000644 0001750 0001750 00000025003 13131636445 020553 0 ustar mehdi mehdi
sig
val init : unit -> unit
val token : Lexing.lexbuf -> Parser.token
val skip_hash_bang : Lexing.lexbuf -> unit
type error =
Illegal_character of char
| Illegal_escape of string
| Unterminated_comment of Location.t
| Unterminated_string
| Unterminated_string_in_comment of Location.t * Location.t
| Keyword_as_label of string
| Invalid_literal of string
| Invalid_directive of string * string option
exception Error of Lexer.error * Location.t
val report_error : Format.formatter -> Lexer.error -> unit
val in_comment : unit -> bool
val in_string : unit -> bool
val print_warnings : bool Pervasives.ref
val handle_docstrings : bool Pervasives.ref
val comments : unit -> (string * Location.t) list
val token_with_comments : Lexing.lexbuf -> Parser.token
val set_preprocessor :
(unit -> unit) ->
((Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parser.token) ->
unit
end ocaml-doc-4.05/ocaml.html/libref/Ephemeron.K2.MakeSeeded.html 0000644 0001750 0001750 00000022441 13131636443 022617 0 ustar mehdi mehdi
module MakeSeeded:
Hashtbl.MakeSeeded.| Parameters: |
|
include Hashtbl.SeededS
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingssig
type elt
and t
val empty : MoreLabels.Set.S.t
val is_empty : MoreLabels.Set.S.t -> bool
val mem : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> bool
val add : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val singleton : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t
val remove :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val union : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val inter : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val diff : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val compare : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> int
val equal : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> bool
val subset : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> bool
val iter : f:(MoreLabels.Set.S.elt -> unit) -> MoreLabels.Set.S.t -> unit
val map :
f:(MoreLabels.Set.S.elt -> MoreLabels.Set.S.elt) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val fold :
f:(MoreLabels.Set.S.elt -> 'a -> 'a) ->
MoreLabels.Set.S.t -> init:'a -> 'a
val for_all :
f:(MoreLabels.Set.S.elt -> bool) -> MoreLabels.Set.S.t -> bool
val exists : f:(MoreLabels.Set.S.elt -> bool) -> MoreLabels.Set.S.t -> bool
val filter :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val partition :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t * MoreLabels.Set.S.t
val cardinal : MoreLabels.Set.S.t -> int
val elements : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt list
val min_elt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val min_elt_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val max_elt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val max_elt_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val choose : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val choose_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val split :
MoreLabels.Set.S.elt ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t * bool * MoreLabels.Set.S.t
val find :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_opt :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val find_first :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_first_opt :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val find_last :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_last_opt :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val of_list : MoreLabels.Set.S.elt list -> MoreLabels.Set.S.t
end ocaml-doc-4.05/ocaml.html/libref/Mutex.html 0000644 0001750 0001750 00000022243 13131636447 017542 0 ustar mehdi mehdi
module Mutex:sig..end
Mutexes (mutual-exclusion locks) are used to implement critical sections
and protect shared mutable data structures against concurrent accesses.
The typical use is (if m is the mutex associated with the data structure
D):
Mutex.lock m;
(* Critical section that operates over D *);
Mutex.unlock m
type
val create : unit -> tval lock : t -> unitval try_lock : t -> boolMutex.lock, but does not suspend the calling thread if
the mutex is already locked: just return false immediately
in that case. If the mutex is unlocked, lock it and
return true.val unlock : t -> unitmodule Longident:sig..end
type
| |
Lident of |
| |
Ldot of |
| |
Lapply of |
val flatten : t -> string list
val last : t -> string
val parse : string -> t ocaml-doc-4.05/ocaml.html/libref/CamlinternalMod.html 0000644 0001750 0001750 00000022176 13131636443 021512 0 ustar mehdi mehdi
module CamlinternalMod:sig..end
type
| |
Function |
| |
Lazy |
| |
Class |
| |
Module of |
| |
Value of |
val init_mod : string * int * int -> shape -> Obj.t
val update_mod : shape -> Obj.t -> Obj.t -> unit ocaml-doc-4.05/ocaml.html/libref/type_StringLabels.html 0000644 0001750 0001750 00000040205 13131636451 022063 0 ustar mehdi mehdi
sig
external length : string -> int = "%string_length"
external get : string -> int -> char = "%string_safe_get"
external set : bytes -> int -> char -> unit = "%string_safe_set"
external create : int -> bytes = "caml_create_string"
val make : int -> char -> string
val init : int -> f:(int -> char) -> string
val copy : string -> string
val sub : string -> pos:int -> len:int -> string
val fill : bytes -> pos:int -> len:int -> char -> unit
val blit :
src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
val concat : sep:string -> string list -> string
val iter : f:(char -> unit) -> string -> unit
val iteri : f:(int -> char -> unit) -> string -> unit
val map : f:(char -> char) -> string -> string
val mapi : f:(int -> char -> char) -> string -> string
val trim : string -> string
val escaped : string -> string
val index : string -> char -> int
val index_opt : string -> char -> int option
val rindex : string -> char -> int
val rindex_opt : string -> char -> int option
val index_from : string -> int -> char -> int
val index_from_opt : string -> int -> char -> int option
val rindex_from : string -> int -> char -> int
val rindex_from_opt : string -> int -> char -> int option
val contains : string -> char -> bool
val contains_from : string -> int -> char -> bool
val rcontains_from : string -> int -> char -> bool
val uppercase : string -> string
val lowercase : string -> string
val capitalize : string -> string
val uncapitalize : string -> string
val uppercase_ascii : string -> string
val lowercase_ascii : string -> string
val capitalize_ascii : string -> string
val uncapitalize_ascii : string -> string
type t = string
val compare : StringLabels.t -> StringLabels.t -> int
val equal : StringLabels.t -> StringLabels.t -> bool
val split_on_char : sep:char -> string -> string list
external unsafe_get : string -> int -> char = "%string_unsafe_get"
external unsafe_set : bytes -> int -> char -> unit = "%string_unsafe_set"
external unsafe_blit :
src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
= "caml_blit_string" [@@noalloc]
external unsafe_fill : bytes -> pos:int -> len:int -> char -> unit
= "caml_fill_string" [@@noalloc]
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Hashtbl.html 0000644 0001750 0001750 00000132351 13131636446 023113 0 ustar mehdi mehdi
sig
type ('a, 'b) t = ('a, 'b) Hashtbl.t
val create : ?random:bool -> int -> ('a, 'b) MoreLabels.Hashtbl.t
val clear : ('a, 'b) MoreLabels.Hashtbl.t -> unit
val reset : ('a, 'b) MoreLabels.Hashtbl.t -> unit
val copy : ('a, 'b) MoreLabels.Hashtbl.t -> ('a, 'b) MoreLabels.Hashtbl.t
val add : ('a, 'b) MoreLabels.Hashtbl.t -> key:'a -> data:'b -> unit
val find : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> 'b
val find_opt : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> 'b option
val find_all : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> 'b list
val mem : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> bool
val remove : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> unit
val replace : ('a, 'b) MoreLabels.Hashtbl.t -> key:'a -> data:'b -> unit
val iter :
f:(key:'a -> data:'b -> unit) -> ('a, 'b) MoreLabels.Hashtbl.t -> unit
val filter_map_inplace :
f:(key:'a -> data:'b -> 'b option) ->
('a, 'b) MoreLabels.Hashtbl.t -> unit
val fold :
f:(key:'a -> data:'b -> 'c -> 'c) ->
('a, 'b) MoreLabels.Hashtbl.t -> init:'c -> 'c
val length : ('a, 'b) MoreLabels.Hashtbl.t -> int
val randomize : unit -> unit
val is_randomized : unit -> bool
type statistics = Hashtbl.statistics
val stats : ('a, 'b) MoreLabels.Hashtbl.t -> MoreLabels.Hashtbl.statistics
module type HashedType = Hashtbl.HashedType
module type SeededHashedType = Hashtbl.SeededHashedType
module type S =
sig
type key
and 'a t
val create : int -> 'a MoreLabels.Hashtbl.S.t
val clear : 'a MoreLabels.Hashtbl.S.t -> unit
val reset : 'a MoreLabels.Hashtbl.S.t -> unit
val copy : 'a MoreLabels.Hashtbl.S.t -> 'a MoreLabels.Hashtbl.S.t
val add :
'a MoreLabels.Hashtbl.S.t ->
key:MoreLabels.Hashtbl.S.key -> data:'a -> unit
val remove :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> unit
val find : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a
val find_opt :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a option
val find_all :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a list
val replace :
'a MoreLabels.Hashtbl.S.t ->
key:MoreLabels.Hashtbl.S.key -> data:'a -> unit
val mem : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> bool
val iter :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> unit) ->
'a MoreLabels.Hashtbl.S.t -> unit
val filter_map_inplace :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> 'a option) ->
'a MoreLabels.Hashtbl.S.t -> unit
val fold :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Hashtbl.S.t -> init:'b -> 'b
val length : 'a MoreLabels.Hashtbl.S.t -> int
val stats : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.statistics
end
module type SeededS =
sig
type key
and 'a t
val create : ?random:bool -> int -> 'a MoreLabels.Hashtbl.SeededS.t
val clear : 'a MoreLabels.Hashtbl.SeededS.t -> unit
val reset : 'a MoreLabels.Hashtbl.SeededS.t -> unit
val copy :
'a MoreLabels.Hashtbl.SeededS.t -> 'a MoreLabels.Hashtbl.SeededS.t
val add :
'a MoreLabels.Hashtbl.SeededS.t ->
key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit
val remove :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> unit
val find :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a
val find_opt :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a option
val find_all :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a list
val replace :
'a MoreLabels.Hashtbl.SeededS.t ->
key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit
val mem :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> bool
val iter :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit) ->
'a MoreLabels.Hashtbl.SeededS.t -> unit
val filter_map_inplace :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> 'a option) ->
'a MoreLabels.Hashtbl.SeededS.t -> unit
val fold :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Hashtbl.SeededS.t -> init:'b -> 'b
val length : 'a MoreLabels.Hashtbl.SeededS.t -> int
val stats :
'a MoreLabels.Hashtbl.SeededS.t -> MoreLabels.Hashtbl.statistics
end
module Make :
functor (H : HashedType) ->
sig
type key = H.t
and 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val filter_map_inplace :
f:(key:key -> data:'a -> 'a option) -> 'a t -> unit
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end
module MakeSeeded :
functor (H : SeededHashedType) ->
sig
type key = H.t
and 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val filter_map_inplace :
f:(key:key -> data:'a -> 'a option) -> 'a t -> unit
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end
val hash : 'a -> int
val seeded_hash : int -> 'a -> int
val hash_param : int -> int -> 'a -> int
val seeded_hash_param : int -> int -> int -> 'a -> int
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_invariants.html 0000644 0001750 0001750 00000015436 13131636441 022466 0 ustar mehdi mehdi
sig
val structure : Parsetree.structure -> unit
val signature : Parsetree.signature -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_GraphicsX11.html 0000644 0001750 0001750 00000016375 13131636444 021541 0 ustar mehdi mehdi
sig
type window_id = string
val window_id : unit -> GraphicsX11.window_id
val open_subwindow :
x:int -> y:int -> width:int -> height:int -> GraphicsX11.window_id
val close_subwindow : GraphicsX11.window_id -> unit
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Csig.html 0000644 0001750 0001750 00000016713 13131636441 021411 0 ustar mehdi mehdi
module Csig:sig..end
val mk : Parsetree.core_type ->
Parsetree.class_type_field list -> Parsetree.class_signature ocaml-doc-4.05/ocaml.html/libref/Char.html 0000644 0001750 0001750 00000025130 13131636443 017307 0 ustar mehdi mehdi
module Char:sig..end
val code : char -> intval chr : int -> charInvalid_argument "Char.chr" if the argument is
outside the range 0--255.val escaped : char -> stringval lowercase : char -> charval uppercase : char -> charval lowercase_ascii : char -> charval uppercase_ascii : char -> chartypet =char
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module Char to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolmodule type S =sig..end
Hashtbl.Make.type
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unitval copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a optionval find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unitval fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statisticsfunctor (H : Hashtbl.HashedType) ->
sig
type data = H.t
type t
val create : int -> t
val clear : t -> unit
val merge : t -> data -> data
val add : t -> data -> unit
val remove : t -> data -> unit
val find : t -> data -> data
val find_opt : t -> data -> data option
val find_all : t -> data -> data list
val mem : t -> data -> bool
val iter : (data -> unit) -> t -> unit
val fold : (data -> 'a -> 'a) -> t -> 'a -> 'a
val count : t -> int
val stats : t -> int * int * int * int * int * int
end ocaml-doc-4.05/ocaml.html/libref/Str.html 0000644 0001750 0001750 00000077400 13131636450 017207 0 ustar mehdi mehdi
module Str:sig..end
type
val regexp : string -> regexp. Matches any character except newline.* (postfix) Matches the preceding expression zero, one or
several times+ (postfix) Matches the preceding expression one or
several times? (postfix) Matches the preceding expression once or
not at all[..] Character set. Ranges are denoted with -, as in [a-z].
An initial ^, as in [^0-9], complements the set.
To include a ] character in a set, make it the first
character of the set. To include a - character in a set,
make it the first or the last character of the set.^ Matches at beginning of line: either at the beginning of
the matched string, or just after a '\n' character.$ Matches at end of line: either at the end of the matched
string, or just before a '\n' character.\| (infix) Alternative between two expressions.\(..\) Grouping and naming of the enclosed expression.\1 The text matched by the first \(...\) expression
(\2 for the second expression, and so on up to \9).\b Matches word boundaries.\ Quotes special characters. The special characters
are $^\.*+?[].regexp is usually a string literal. In this
case, any backslash character in the regular expression must be
doubled to make it past the OCaml string parser. For example, the
following expression:
let r = Str.regexp "hello \\([A-Za-z]+\\)" in
Str.replace_first r "\\1" "hello world" "world".
In particular, if you want a regular expression that matches a single
backslash character, you need to quote it in the argument to regexp
(according to the last item of the list above) by adding a second
backslash. Then you need to quote both backslashes (according to the
syntax of string constants in OCaml) by doubling them again, so you
need to write four backslash characters: Str.regexp "\\\\".
val regexp_case_fold : string -> regexpregexp, but the compiled expression will match text
in a case-insensitive way: uppercase and lowercase letters will
be considered equivalent.val quote : string -> stringStr.quote s returns a regexp string that matches exactly
s and nothing else.val regexp_string : string -> regexpStr.regexp_string s returns a regular expression
that matches exactly s and nothing else.val regexp_string_case_fold : string -> regexpStr.regexp_string_case_fold is similar to Str.regexp_string,
but the regexp matches in a case-insensitive way.val string_match : regexp -> string -> int -> boolstring_match r s start tests whether a substring of s that
starts at position start matches the regular expression r.
The first character of a string has position 0, as usual.val search_forward : regexp -> string -> int -> intsearch_forward r s start searches the string s for a substring
matching the regular expression r. The search starts at position
start and proceeds towards the end of the string.
Return the position of the first character of the matched
substring.Not_found if no substring matches.val search_backward : regexp -> string -> int -> intsearch_backward r s last searches the string s for a
substring matching the regular expression r. The search first
considers substrings that start at position last and proceeds
towards the beginning of string. Return the position of the first
character of the matched substring.Not_found if no substring matches.val string_partial_match : regexp -> string -> int -> boolStr.string_match, but also returns true if
the argument string is a prefix of a string that matches.
This includes the case of a true complete match.val matched_string : string -> stringmatched_string s returns the substring of s that was matched
by the last call to one of the following matching or searching
functions:Str.string_matchStr.search_forwardStr.search_backwardStr.string_partial_matchStr.global_substituteStr.substitute_firstStr.global_replaceStr.replace_firstStr.splitStr.bounded_splitStr.split_delimStr.bounded_split_delimStr.full_splitStr.bounded_full_splitglobal_substitute and substitute_first,
a call to matched_string is only valid within the subst argument,
not after global_substitute or substitute_first returns.
The user must make sure that the parameter s is the same string
that was passed to the matching or searching function.
val match_beginning : unit -> intmatch_beginning() returns the position of the first character
of the substring that was matched by the last call to a matching
or searching function (see Str.matched_string for details).val match_end : unit -> intmatch_end() returns the position of the character following the
last character of the substring that was matched by the last call
to a matching or searching function (see Str.matched_string for
details).val matched_group : int -> string -> stringmatched_group n s returns the substring of s that was matched
by the nth group \(...\) of the regular expression that was
matched by the last call to a matching or searching function (see
Str.matched_string for details).
The user must make sure that the parameter s is the same string
that was passed to the matching or searching function.Not_found if the nth group
of the regular expression was not matched. This can happen
with groups inside alternatives \|, options ?
or repetitions *. For instance, the empty string will match
\(a\)*, but matched_group 1 "" will raise Not_found
because the first group itself was not matched.val group_beginning : int -> intgroup_beginning n returns the position of the first character
of the substring that was matched by the nth group of
the regular expression that was matched by the last call to a
matching or searching function (see Str.matched_string for details).Not_found if the nth group of the regular expression
was not matched.Invalid_argument if there are fewer than n groups in
the regular expression.val group_end : int -> intgroup_end n returns
the position of the character following the last character of
substring that was matched by the nth group of the regular
expression that was matched by the last call to a matching or
searching function (see Str.matched_string for details).Not_found if the nth group of the regular expression
was not matched.Invalid_argument if there are fewer than n groups in
the regular expression.val global_replace : regexp -> string -> string -> stringglobal_replace regexp templ s returns a string identical to s,
except that all substrings of s that match regexp have been
replaced by templ. The replacement template templ can contain
\1, \2, etc; these sequences will be replaced by the text
matched by the corresponding group in the regular expression.
\0 stands for the text matched by the whole regular expression.val replace_first : regexp -> string -> string -> stringStr.global_replace, except that only the first substring
matching the regular expression is replaced.val global_substitute : regexp -> (string -> string) -> string -> stringglobal_substitute regexp subst s returns a string identical
to s, except that all substrings of s that match regexp
have been replaced by the result of function subst. The
function subst is called once for each matching substring,
and receives s (the whole text) as argument.val substitute_first : regexp -> (string -> string) -> string -> stringStr.global_substitute, except that only the first substring
matching the regular expression is replaced.val replace_matched : string -> string -> stringreplace_matched repl s returns the replacement text repl
in which \1, \2, etc. have been replaced by the text
matched by the corresponding groups in the regular expression
that was matched by the last call to a matching or searching
function (see Str.matched_string for details).
s must be the same string that was passed to the matching or
searching function.val split : regexp -> string -> string listsplit r s splits s into substrings, taking as delimiters
the substrings that match r, and returns the list of substrings.
For instance, split (regexp "[ \t]+") s splits s into
blank-separated words. An occurrence of the delimiter at the
beginning or at the end of the string is ignored.val bounded_split : regexp -> string -> int -> string list
val split_delim : regexp -> string -> string listStr.split but occurrences of the
delimiter at the beginning and at the end of the string are
recognized and returned as empty strings in the result.
For instance, split_delim (regexp " ") " abc "
returns [""; "abc"; ""], while split with the same
arguments returns ["abc"].val bounded_split_delim : regexp -> string -> int -> string listStr.bounded_split, but occurrences of the
delimiter at the beginning and at the end of the string are
recognized and returned as empty strings in the result.type
| |
Text of |
| |
Delim of |
val full_split : regexp -> string -> split_result listStr.split_delim, but returns
the delimiters as well as the substrings contained between
delimiters. The former are tagged Delim in the result list;
the latter are tagged Text. For instance,
full_split (regexp "[{}]") "{ab}" returns
[Delim "{"; Text "ab"; Delim "}"].val bounded_full_split : regexp -> string -> int -> split_result listStr.bounded_split_delim, but returns
the delimiters as well as the substrings contained between
delimiters. The former are tagged Delim in the result list;
the latter are tagged Text.val string_before : string -> int -> stringstring_before s n returns the substring of all characters of s
that precede position n (excluding the character at
position n).val string_after : string -> int -> stringstring_after s n returns the substring of all characters of s
that follow position n (including the character at
position n).val first_chars : string -> int -> stringfirst_chars s n returns the first n characters of s.
This is the same function as Str.string_before.val last_chars : string -> int -> stringlast_chars s n returns the last n characters of s.sig
type t
val add_hook :
string -> (Misc.hook_info -> Misc.HookSig.t -> Misc.HookSig.t) -> unit
val apply_hooks : Misc.hook_info -> Misc.HookSig.t -> Misc.HookSig.t
end ocaml-doc-4.05/ocaml.html/libref/type_Weak.html 0000644 0001750 0001750 00000043465 13131636452 020375 0 ustar mehdi mehdi
sig
type 'a t
val create : int -> 'a Weak.t
val length : 'a Weak.t -> int
val set : 'a Weak.t -> int -> 'a option -> unit
val get : 'a Weak.t -> int -> 'a option
val get_copy : 'a Weak.t -> int -> 'a option
val check : 'a Weak.t -> int -> bool
val fill : 'a Weak.t -> int -> int -> 'a option -> unit
val blit : 'a Weak.t -> int -> 'a Weak.t -> int -> int -> unit
module type S =
sig
type data
type t
val create : int -> Weak.S.t
val clear : Weak.S.t -> unit
val merge : Weak.S.t -> Weak.S.data -> Weak.S.data
val add : Weak.S.t -> Weak.S.data -> unit
val remove : Weak.S.t -> Weak.S.data -> unit
val find : Weak.S.t -> Weak.S.data -> Weak.S.data
val find_opt : Weak.S.t -> Weak.S.data -> Weak.S.data option
val find_all : Weak.S.t -> Weak.S.data -> Weak.S.data list
val mem : Weak.S.t -> Weak.S.data -> bool
val iter : (Weak.S.data -> unit) -> Weak.S.t -> unit
val fold : (Weak.S.data -> 'a -> 'a) -> Weak.S.t -> 'a -> 'a
val count : Weak.S.t -> int
val stats : Weak.S.t -> int * int * int * int * int * int
end
module Make :
functor (H : Hashtbl.HashedType) ->
sig
type data = H.t
type t
val create : int -> t
val clear : t -> unit
val merge : t -> data -> data
val add : t -> data -> unit
val remove : t -> data -> unit
val find : t -> data -> data
val find_opt : t -> data -> data option
val find_all : t -> data -> data list
val mem : t -> data -> bool
val iter : (data -> unit) -> t -> unit
val fold : (data -> 'a -> 'a) -> t -> 'a -> 'a
val count : t -> int
val stats : t -> int * int * int * int * int * int
end
end ocaml-doc-4.05/ocaml.html/libref/index_extensions.html 0000644 0001750 0001750 00000014742 13131636452 022027 0 ustar mehdi mehdi
module MakeSeeded:
Hashtbl.MakeSeeded returns a structure containing
a type key of keys and a type 'a t of hash tables
associating data of type 'a to keys of type key.
The operations perform similarly to those of the generic
interface, but use the seeded hashing and equality functions
specified in the functor argument H instead of generic
equality and hashing. The create operation of the
result structure supports the ~random optional parameter
and returns randomized hash tables if ~random:true is passed
or if randomization is globally on (see Hashtbl.randomize).| Parameters: |
|
type
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a optionval find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unitval fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics ocaml-doc-4.05/ocaml.html/libref/type_Array.html 0000644 0001750 0001750 00000044053 13131636441 020554 0 ustar mehdi mehdi
sig
external length : 'a array -> int = "%array_length"
external get : 'a array -> int -> 'a = "%array_safe_get"
external set : 'a array -> int -> 'a -> unit = "%array_safe_set"
external make : int -> 'a -> 'a array = "caml_make_vect"
external create : int -> 'a -> 'a array = "caml_make_vect"
external create_float : int -> float array = "caml_make_float_vect"
val make_float : int -> float array
val init : int -> (int -> 'a) -> 'a array
val make_matrix : int -> int -> 'a -> 'a array array
val create_matrix : int -> int -> 'a -> 'a array array
val append : 'a array -> 'a array -> 'a array
val concat : 'a array list -> 'a array
val sub : 'a array -> int -> int -> 'a array
val copy : 'a array -> 'a array
val fill : 'a array -> int -> int -> 'a -> unit
val blit : 'a array -> int -> 'a array -> int -> int -> unit
val to_list : 'a array -> 'a list
val of_list : 'a list -> 'a array
val iter : ('a -> unit) -> 'a array -> unit
val iteri : (int -> 'a -> unit) -> 'a array -> unit
val map : ('a -> 'b) -> 'a array -> 'b array
val mapi : (int -> 'a -> 'b) -> 'a array -> 'b array
val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b array -> 'a
val fold_right : ('b -> 'a -> 'a) -> 'b array -> 'a -> 'a
val iter2 : ('a -> 'b -> unit) -> 'a array -> 'b array -> unit
val map2 : ('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c array
val for_all : ('a -> bool) -> 'a array -> bool
val exists : ('a -> bool) -> 'a array -> bool
val mem : 'a -> 'a array -> bool
val memq : 'a -> 'a array -> bool
val sort : ('a -> 'a -> int) -> 'a array -> unit
val stable_sort : ('a -> 'a -> int) -> 'a array -> unit
val fast_sort : ('a -> 'a -> int) -> 'a array -> unit
external unsafe_get : 'a array -> int -> 'a = "%array_unsafe_get"
external unsafe_set : 'a array -> int -> 'a -> unit = "%array_unsafe_set"
end ocaml-doc-4.05/ocaml.html/libref/index.html 0000644 0001750 0001750 00000050520 13131636452 017542 0 ustar mehdi mehdi
| Arg |
Parsing of command line arguments.
|
| Arg_helper |
Decipher command line arguments of the form
<value> | <key>=<value>
,...
(as used for example for the specification of inlining parameters
varying by simplification round).
|
| Arith_status |
Flags that control rational arithmetic.
|
| Array |
Array operations.
|
| ArrayLabels |
Array operations.
|
| Ast_helper |
Helpers to produce Parsetree fragments
|
| Ast_invariants |
Check AST invariants
|
| Ast_iterator | Ast_iterator.iterator allows to implement AST inspection using open recursion.
|
| Ast_mapper |
The interface of a -ppx rewriter
|
| Asttypes |
Auxiliary AST types used by parsetree and typedtree.
|
| Attr_helper |
Helpers for attributes
|
| Big_int |
Operations on arbitrary-precision integers.
|
| Bigarray |
Large, multi-dimensional, numerical arrays.
|
| Buffer |
Extensible buffers.
|
| Builtin_attributes | |
| Bytes |
Byte sequence operations.
|
| BytesLabels |
Byte sequence operations.
|
| Callback |
Registering OCaml values with the C runtime.
|
| CamlinternalFormat | |
| CamlinternalFormatBasics | |
| CamlinternalLazy |
Run-time support for lazy values.
|
| CamlinternalMod |
Run-time support for recursive modules.
|
| CamlinternalOO |
Run-time support for objects and classes.
|
| Ccomp | |
| Char |
Character operations.
|
| Clflags |
Optimization parameters represented as ints indexed by round number.
|
| Complex |
Complex numbers.
|
| Condition |
Condition variables to synchronize between threads.
|
| Config | |
| Consistbl | |
| Depend |
Module dependencies.
|
| Digest |
MD5 message digest.
|
| Docstrings |
Documentation comments
|
| Dynlink |
Dynamic loading of object files.
|
| Ephemeron |
Ephemerons and weak hash table
|
| Event |
First-class synchronous communication.
|
| Filename |
Operations on file names.
|
| Format |
Pretty printing.
|
| Gc |
Memory management control and statistics; finalised values.
|
| Genlex |
A generic lexical analyzer.
|
| Graphics |
Machine-independent graphics primitives.
|
| GraphicsX11 |
Additional graphics primitives for the X Windows system.
|
| Hashtbl |
Hash tables and hash functions.
|
| Identifiable |
Uniform interface for common data structures over various things.
|
| Int32 |
32-bit integers.
|
| Int64 |
64-bit integers.
|
| Lazy |
Deferred computations.
|
| Lexer | |
| Lexing |
The run-time library for lexers generated by
ocamllex.
|
| List |
List operations.
|
| ListLabels |
List operations.
|
| Location |
Source code locations (ranges of positions), used in parsetree.
|
| Longident |
Long identifiers, used in parsetree.
|
| Map |
Association tables over ordered types.
|
| Marshal |
Marshaling of data structures.
|
| Misc | protect_refs l f temporarily sets r to v for each R (r, v) in l
while executing f.
|
| MoreLabels |
Extra labeled libraries.
|
| Mutex |
Locks for mutual exclusion.
|
| Nativeint |
Processor-native integers.
|
| Num |
Operation on arbitrary-precision numbers.
|
| Numbers |
Modules about numbers that satisfy
Identifiable.S.
|
| Obj |
Operations on internal representations of values.
|
| Oo |
Operations on objects
|
| Parse |
Entry points in the parser
|
| Parser | |
| Parsetree |
Abstract syntax tree produced by parsing
|
| Parsing |
The run-time library for parsers generated by
ocamlyacc.
|
| Pervasives |
The initially opened module.
|
| Pprintast | |
| Printast | |
| Printexc |
Facilities for printing exceptions and inspecting current call stack.
|
| Printf |
Formatted output functions.
|
| Queue |
First-in first-out queues.
|
| Random |
Pseudo-random number generators (PRNG).
|
| Ratio |
Operation on rational numbers.
|
| Scanf |
Formatted input functions.
|
| Set |
Sets over ordered types.
|
| Sort |
Sorting and merging lists.
|
| Spacetime |
Profiling of a program's space behaviour over time.
|
| Stack |
Last-in first-out stacks.
|
| StdLabels |
Standard labeled libraries.
|
| Str |
Regular expressions and high-level string processing
|
| Stream |
Streams and parsers.
|
| String |
String operations.
|
| StringLabels |
String operations.
|
| Strongly_connected_components |
Kosaraju's algorithm for strongly connected components.
|
| Syntaxerr |
Auxiliary type for reporting syntax errors
|
| Sys |
System interface.
|
| Targetint |
Target processor-native integers.
|
| Tbl | |
| Terminfo | |
| Thread |
Lightweight threads for Posix
1003.1c and Win32.
|
| ThreadUnix |
Thread-compatible system calls.
|
| Timings |
Compiler performance recording
|
| Uchar |
Unicode characters.
|
| Unix |
Interface to the Unix system.
|
| UnixLabels |
Interface to the Unix system.
|
| Warnings | |
| Weak |
Arrays of weak pointers and hash sets of weak pointers.
|
sig
type ('a, 'b, 'c) t
external create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int array -> ('a, 'b, 'c) Bigarray.Genarray.t
= "caml_ba_create"
external num_dims : ('a, 'b, 'c) Bigarray.Genarray.t -> int
= "caml_ba_num_dims"
val dims : ('a, 'b, 'c) Bigarray.Genarray.t -> int array
external nth_dim : ('a, 'b, 'c) Bigarray.Genarray.t -> int -> int
= "caml_ba_dim"
external kind : ('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Genarray.t -> 'c Bigarray.layout
= "caml_ba_layout"
external change_layout :
('a, 'b, 'c) Bigarray.Genarray.t ->
'd Bigarray.layout -> ('a, 'b, 'd) Bigarray.Genarray.t
= "caml_ba_change_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Genarray.t -> int
external get : ('a, 'b, 'c) Bigarray.Genarray.t -> int array -> 'a
= "caml_ba_get_generic"
external set : ('a, 'b, 'c) Bigarray.Genarray.t -> int array -> 'a -> unit
= "caml_ba_set_generic"
external sub_left :
('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t
= "caml_ba_sub"
external sub_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t
= "caml_ba_sub"
external slice_left :
('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t ->
int array -> ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t
= "caml_ba_slice"
external slice_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t ->
int array -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t
= "caml_ba_slice"
external blit :
('a, 'b, 'c) Bigarray.Genarray.t ->
('a, 'b, 'c) Bigarray.Genarray.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Genarray.t -> 'a -> unit
= "caml_ba_fill"
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int array -> ('a, 'b, 'c) Bigarray.Genarray.t
end ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.S.Tbl.html 0000644 0001750 0001750 00000033177 13131636451 023004 0 ustar mehdi mehdi
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a Identifiable.S.t -> (Identifiable.S.T.t * 'a) list
val of_list : (Identifiable.S.T.t * 'a) list -> 'a Identifiable.S.t
val to_map : 'a Identifiable.S.t -> 'a Identifiable.S.Map.t
val of_map : 'a Identifiable.S.Map.t -> 'a Identifiable.S.t
val memoize : 'a Identifiable.S.t -> (key -> 'a) -> key -> 'a
val map : 'a Identifiable.S.t -> ('a -> 'b) -> 'b Identifiable.S.t
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Md.html 0000644 0001750 0001750 00000017317 13131636441 021065 0 ustar mehdi mehdi
module Md:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Ast_helper.str -> Parsetree.module_type -> Parsetree.module_declaration ocaml-doc-4.05/ocaml.html/libref/Depend.StringMap.html 0000644 0001750 0001750 00000070011 13131636443 021532 0 ustar mehdi mehdi
module StringMap:Map.Swith type key = string
type
type +'a t
key to type 'a.val empty : 'a tval is_empty : 'a t -> boolval mem : key -> 'a t -> boolmem x m returns true if m contains a binding for x,
and false otherwise.val add : key -> 'a -> 'a t -> 'a tadd x y m returns a map containing the same bindings as
m, plus a binding of x to y. If x was already bound
in m to a value that is physically equal to y,
m is returned unchanged (the result of the function is
then physically equal to m). Otherwise, the previous binding
of x in m disappears.val singleton : key -> 'a -> 'a tsingleton x y returns the one-element map that contains a binding y
for x.val remove : key -> 'a t -> 'a tremove x m returns a map containing the same bindings as
m, except for x which is unbound in the returned map.
If x was not in m, m is returned unchanged
(the result of the function is then physically equal to m).val merge : (key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c tmerge f m1 m2 computes a map whose keys is a subset of keys of m1
and of m2. The presence of each such binding, and the corresponding
value, is determined with the function f.
In terms of the find_opt operation, we have
find_opt x (merge f m1 m2) = f (find_opt x m1) (find_opt x m2)
for any key x, provided that f None None = None.val union : (key -> 'a -> 'a -> 'a option) ->
'a t -> 'a t -> 'a tunion f m1 m2 computes a map whose keys is the union of keys
of m1 and of m2. When the same binding is defined in both
arguments, the function f is used to combine them.
This is a special case of merge: union f m1 m2 is equivalent
to merge f' m1 m2, wheref' None None = Nonef' (Some v) None = Some vf' None (Some v) = Some vf' (Some v1) (Some v2) = f v1 v2val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> intval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> boolequal cmp m1 m2 tests whether the maps m1 and m2 are
equal, that is, contain equal keys and associate them with
equal data. cmp is the equality predicate used to compare
the data associated with the keys.val iter : (key -> 'a -> unit) -> 'a t -> unititer f m applies f to all bindings in map m.
f receives the key as first argument, and the associated value
as second argument. The bindings are passed to f in increasing
order with respect to the ordering over the type of the keys.val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'bfold f m a computes (f kN dN ... (f k1 d1 a)...),
where k1 ... kN are the keys of all bindings in m
(in increasing order), and d1 ... dN are the associated data.val for_all : (key -> 'a -> bool) -> 'a t -> boolfor_all p m checks if all the bindings of the map
satisfy the predicate p.val exists : (key -> 'a -> bool) -> 'a t -> boolexists p m checks if at least one binding of the map
satisfies the predicate p.val filter : (key -> 'a -> bool) -> 'a t -> 'a tfilter p m returns the map with all the bindings in m
that satisfy predicate p. If p satisfies every binding in m,
m is returned unchanged (the result of the function is then
physically equal to m)val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a tpartition p m returns a pair of maps (m1, m2), where
m1 contains all the bindings of s that satisfy the
predicate p, and m2 is the map with all the bindings of
s that do not satisfy p.val cardinal : 'a t -> intval bindings : 'a t -> (key * 'a) listOrd.compare, where Ord is the argument
given to Map.Make.val min_binding : 'a t -> key * 'aOrd.compare ordering), or raise
Not_found if the map is empty.val min_binding_opt : 'a t -> (key * 'a) optionOrd.compare ordering), or None
if the map is empty.val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'aNot_found if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val choose_opt : 'a t -> (key * 'a) optionNone if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val split : key -> 'a t -> 'a t * 'a option * 'a tsplit x m returns a triple (l, data, r), where
l is the map with all the bindings of m whose key
is strictly less than x;
r is the map with all the bindings of m whose key
is strictly greater than x;
data is None if m contains no binding for x,
or Some v if m binds v to x.val find : key -> 'a t -> 'afind x m returns the current binding of x in m,
or raises Not_found if no such binding exists.val find_opt : key -> 'a t -> 'a optionfind_opt x m returns Some v if the current binding of x
in m is v, or None if no such binding exists.val find_first : (key -> bool) -> 'a t -> key * 'afind_first f m, where f is a monotonically increasing function,
returns the binding of m with the lowest key k such that f k,
or raises Not_found if no such key exists.
For example, find_first (fun k -> Ord.compare k x >= 0) m will return
the first binding k, v of m where Ord.compare k x >= 0
(intuitively: k >= x), or raise Not_found if x is greater than any
element of m.
Since 4.05
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_first_opt f m, where f is a monotonically increasing function,
returns an option containing the binding of m with the lowest key k
such that f k, or None if no such key exists.val find_last : (key -> bool) -> 'a t -> key * 'afind_last f m, where f is a monotonically decreasing function,
returns the binding of m with the highest key k such that f k,
or raises Not_found if no such key exists.val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_last_opt f m, where f is a monotonically decreasing function,
returns an option containing the binding of m with the highest key k
such that f k, or None if no such key exists.val map : ('a -> 'b) -> 'a t -> 'b tmap f m returns a map with same domain as m, where the
associated value a of all bindings of m has been
replaced by the result of the application of f to a.
The bindings are passed to f in increasing order
with respect to the ordering over the type of the keys.val mapi : (key -> 'a -> 'b) -> 'a t -> 'b tMap.S.map, but the function receives as arguments both the
key and the associated value for each binding of the map.functor (Id : Identifiable.S) ->
sig
type directed_graph = Id.Set.t Id.Map.t
type component = Has_loop of Id.t list | No_loop of Id.t
val connected_components_sorted_from_roots_to_leaf :
directed_graph -> component array
val component_graph : directed_graph -> (component * int list) array
end ocaml-doc-4.05/ocaml.html/libref/Map.OrderedType.html 0000644 0001750 0001750 00000020357 13131636445 021404 0 ustar mehdi mehdi
module type OrderedType =sig..end
Map.Make.type
val compare : t -> t -> intf such that
f e1 e2 is zero if the keys e1 and e2 are equal,
f e1 e2 is strictly negative if e1 is smaller than e2,
and f e1 e2 is strictly positive if e1 is greater than e2.
Example: a suitable ordering function is the generic structural
comparison function compare.module Set:sig..end
module type OrderedType = Set.OrderedType
module type S =sig..end
module Make:ocaml-doc-4.05/ocaml.html/libref/Strongly_connected_components.Make.html 0000644 0001750 0001750 00000023225 13131636451 025420 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
module Id:Identifiable.S
typedirected_graph =Id.Set.t Id.Map.t
a to every element of set. It is assumed that no edge
points to a vertex not represented in the map.type
| |
Has_loop of |
| |
No_loop of |
val connected_components_sorted_from_roots_to_leaf : directed_graph ->
component array
val component_graph : directed_graph ->
(component * int list) array ocaml-doc-4.05/ocaml.html/libref/Graphics.html 0000644 0001750 0001750 00000116613 13131636444 020202 0 ustar mehdi mehdi
module Graphics:sig..end
exception Graphic_failure of string
val open_graph : string -> unitval close_graph : unit -> unitval set_window_title : string -> unitval resize_window : int -> int -> unitval clear_graph : unit -> unitval size_x : unit -> intGraphics.size_y.val size_y : unit -> int0 .. size_x()-1 and 0 .. size_y()-1.
Drawings outside of this rectangle are clipped, without causing
an error. The origin (0,0) is at the lower left corner.
Some implementation (e.g. X Windows) represent coordinates by
16-bit integers, hence wrong clipping may occur with coordinates
below -32768 or above 32676.typecolor =int
0..255. The three components are packed in
an int: 0xRRGGBB, where RR are the two hexadecimal digits for
the red component, GG for the green component, BB for the
blue component.val rgb : int -> int -> int -> colorrgb r g b returns the integer encoding the color with red
component r, green component g, and blue component b.
r, g and b are in the range 0..255.val set_color : color -> unitval background : colorGraphics.foreground.val foreground : colorGraphics.clear_graph fills the screen with the background color.
The initial drawing color is foreground.val black : color
val white : color
val red : color
val green : color
val blue : color
val yellow : color
val cyan : color
val magenta : colorval plot : int -> int -> unitval plots : (int * int) array -> unitval point_color : int -> int -> colorval moveto : int -> int -> unitval rmoveto : int -> int -> unitrmoveto dx dy translates the current point by the given vector.val current_x : unit -> intval current_y : unit -> intval current_point : unit -> int * intval lineto : int -> int -> unitval rlineto : int -> int -> unitval curveto : int * int -> int * int -> int * int -> unitcurveto b c d draws a cubic Bezier curve starting from
the current point to point d, with control points b and
c, and moves the current point to d.val draw_rect : int -> int -> int -> int -> unitdraw_rect x y w h draws the rectangle with lower left corner
at x,y, width w and height h.
The current point is unchanged.
Raise Invalid_argument if w or h is negative.val draw_poly_line : (int * int) array -> unitdraw_poly_line points draws the line that joins the
points given by the array argument.
The array contains the coordinates of the vertices of the
polygonal line, which need not be closed.
The current point is unchanged.val draw_poly : (int * int) array -> unitdraw_poly polygon draws the given polygon.
The array contains the coordinates of the vertices of the
polygon.
The current point is unchanged.val draw_segments : (int * int * int * int) array -> unitdraw_segments segments draws the segments given in the array
argument. Each segment is specified as a quadruple
(x0, y0, x1, y1) where (x0, y0) and (x1, y1) are
the coordinates of the end points of the segment.
The current point is unchanged.val draw_arc : int -> int -> int -> int -> int -> int -> unitdraw_arc x y rx ry a1 a2 draws an elliptical arc with center
x,y, horizontal radius rx, vertical radius ry, from angle
a1 to angle a2 (in degrees). The current point is unchanged.
Raise Invalid_argument if rx or ry is negative.val draw_ellipse : int -> int -> int -> int -> unitdraw_ellipse x y rx ry draws an ellipse with center
x,y, horizontal radius rx and vertical radius ry.
The current point is unchanged.
Raise Invalid_argument if rx or ry is negative.val draw_circle : int -> int -> int -> unitdraw_circle x y r draws a circle with center x,y and
radius r. The current point is unchanged.
Raise Invalid_argument if r is negative.val set_line_width : int -> unitset_line_width 0 selects a width of 1 pixel
and a faster, but less precise drawing algorithm than the one
used when set_line_width 1 is specified.
Raise Invalid_argument if the argument is negative.val draw_char : char -> unitGraphics.draw_string.val draw_string : string -> unitval set_font : string -> unitset_font
is implementation-dependent.val set_text_size : int -> unitset_text_size
is implementation-dependent.val text_size : string -> int * intval fill_rect : int -> int -> int -> int -> unitfill_rect x y w h fills the rectangle with lower left corner
at x,y, width w and height h, with the current color.
Raise Invalid_argument if w or h is negative.val fill_poly : (int * int) array -> unitval fill_arc : int -> int -> int -> int -> int -> int -> unitGraphics.draw_arc.val fill_ellipse : int -> int -> int -> int -> unitGraphics.draw_ellipse.val fill_circle : int -> int -> int -> unitGraphics.draw_circle.type
val transp : colorval make_image : color array array -> imageGraphic_failure
is raised.val dump_image : image -> color array arrayval draw_image : image -> int -> int -> unitval get_image : int -> int -> int -> int -> imageGraphics.fill_rect.val create_image : int -> int -> imagecreate_image w h returns a new image w pixels wide and h
pixels tall, to be used in conjunction with blit_image.
The initial image contents are random, except that no point
is transparent.val blit_image : image -> int -> int -> unitblit_image img x y copies screen pixels into the image img,
modifying img in-place. The pixels copied are those inside the
rectangle with lower left corner at x,y, and width and height
equal to those of the image. Pixels that were transparent in
img are left unchanged.type
|
mouse_x : |
(* |
X coordinate of the mouse
| *) |
|
mouse_y : |
(* |
Y coordinate of the mouse
| *) |
|
: |
(* |
true if a mouse button is pressed
| *) |
|
keypressed : |
(* |
true if a key has been pressed
| *) |
|
key : |
(* |
the character for the key pressed
| *) |
type
| |
Button_down |
(* |
A mouse button is pressed
| *) |
| |
Button_up |
(* |
A mouse button is released
| *) |
| |
Key_pressed |
(* |
A key is pressed
| *) |
| |
Mouse_motion |
(* |
The mouse is moved
| *) |
| |
Poll |
(* |
Don't wait; return immediately
| *) |
val wait_next_event : event list -> statusPoll is given in the event list, return immediately
with the current status. If the mouse cursor is outside of the
graphics window, the mouse_x and mouse_y fields of the event are
outside the range 0..size_x()-1, 0..size_y()-1. Keypresses
are queued, and dequeued one by one when the Key_pressed
event is specified and the Poll event is not specified.val loop_at_exit : event list -> (status -> unit) -> unitval mouse_pos : unit -> int * intmouse_pos() returns a point outside of the range
0..size_x()-1, 0..size_y()-1. : unit -> booltrue if the mouse button is pressed, false otherwise.val read_key : unit -> charval key_pressed : unit -> booltrue if a keypress is available; that is, if read_key
would not block.val sound : int -> int -> unitsound freq dur plays a sound at frequency freq (in hertz)
for a duration dur (in milliseconds).val auto_synchronize : bool -> unitTo avoid flicker during animations, it is possible to turn off on-screen drawing, perform a number of drawing operations in the backing store only, then refresh the on-screen window explicitly.
auto_synchronize false turns on-screen drawing off. All
subsequent drawing commands are performed on the backing store
only.
auto_synchronize true refreshes the on-screen window from
the backing store (as per synchronize), then turns on-screen
drawing back on. All subsequent drawing commands are performed
both on screen and in the backing store.
The default drawing mode corresponds to auto_synchronize true.
val synchronize : unit -> unitval display_mode : bool -> unitGraphics.remember_mode
below). Default display mode is on.val remember_mode : bool -> unitGraphics.display_mode above).
Default remember mode is on.module CamlinternalFormatBasics:sig..end
type
| |
Left |
| |
Right |
| |
Zeros |
type
| |
Int_d |
| |
Int_pd |
| |
Int_sd |
| |
Int_i |
| |
Int_pi |
| |
Int_si |
| |
Int_x |
| |
Int_Cx |
| |
Int_X |
| |
Int_CX |
| |
Int_o |
| |
Int_Co |
| |
Int_u |
type
| |
Float_f |
| |
Float_pf |
| |
Float_sf |
| |
Float_e |
| |
Float_pe |
| |
Float_se |
| |
Float_E |
| |
Float_pE |
| |
Float_sE |
| |
Float_g |
| |
Float_pg |
| |
Float_sg |
| |
Float_G |
| |
Float_pG |
| |
Float_sG |
| |
Float_F |
| |
Float_h |
| |
Float_ph |
| |
Float_sh |
| |
Float_H |
| |
Float_pH |
| |
Float_sH |
typechar_set =string
type
| |
Line_counter |
| |
Char_counter |
| |
Token_counter |
type ('a, 'b) padding =
| |
No_padding : |
| |
Lit_padding : |
| |
Arg_padding : |
typepad_option =int option
type ('a, 'b) precision =
| |
No_precision : |
| |
Lit_precision : |
| |
Arg_precision : |
typeprec_option =int option
type ('a, 'b, 'c) custom_arity =
| |
Custom_zero : |
| |
Custom_succ : |
type
| |
Pp_hbox |
| |
Pp_vbox |
| |
Pp_hvbox |
| |
Pp_hovbox |
| |
Pp_box |
| |
Pp_fits |
type
| |
Close_box |
| |
Close_tag |
| |
Break of |
| |
FFlush |
| |
Force_newline |
| |
Flush_newline |
| |
Magic_size of |
| |
Escaped_at |
| |
Escaped_percent |
| |
Scan_indic of |
type ('a, 'b, 'c, 'd, 'e, 'f) formatting_gen =
| |
Open_tag : |
| |
Open_box : |
type('a, 'b, 'c, 'd, 'e, 'f)fmtty =('a, 'b, 'c, 'd, 'e, 'f, 'a, 'b, 'c, 'd, 'e, 'f)
fmtty_rel
type ('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2) fmtty_rel =
| |
Char_ty : |
| |
String_ty : |
| |
Int_ty : |
| |
Int32_ty : |
| |
Nativeint_ty : |
| |
Int64_ty : |
| |
Float_ty : |
| |
Bool_ty : |
| |
Format_arg_ty : |
| |
Format_subst_ty : |
| |
Alpha_ty : |
| |
Theta_ty : |
| |
Any_ty : |
| |
Reader_ty : |
| |
Ignored_reader_ty : |
| |
End_of_fmtty : |
type ('a, 'b, 'c, 'd, 'e, 'f) fmt =
| |
Char : |
| |
Caml_char : |
| |
String : |
| |
Caml_string : |
| |
Int : |
| |
Int32 : |
| |
Nativeint : |
| |
Int64 : |
| |
Float : |
| |
Bool : |
| |
Flush : |
| |
String_literal : |
| |
Char_literal : |
| |
Format_arg : |
| |
Format_subst : |
| |
Alpha : |
| |
Theta : |
| |
Formatting_lit : |
| |
Formatting_gen : |
| |
Reader : |
| |
Scan_char_set : |
| |
Scan_get_counter : |
| |
Scan_next_char : |
| |
Ignored_param : |
| |
Custom : |
| |
End_of_format : |
type ('a, 'b, 'c, 'd, 'e, 'f) ignored =
| |
Ignored_char : |
| |
Ignored_caml_char : |
| |
Ignored_string : |
| |
Ignored_caml_string : |
| |
Ignored_int : |
| |
Ignored_int32 : |
| |
Ignored_nativeint : |
| |
Ignored_int64 : |
| |
Ignored_float : |
| |
Ignored_bool : |
| |
Ignored_format_arg : |
| |
Ignored_format_subst : |
| |
Ignored_reader : |
| |
Ignored_scan_char_set : |
| |
Ignored_scan_get_counter : |
| |
Ignored_scan_next_char : |
type ('a, 'b, 'c, 'd, 'e, 'f) format6 =
| |
Format of |
val concat_fmtty : ('g1, 'b1, 'c1, 'j1, 'd1, 'a1, 'g2, 'b2, 'c2, 'j2, 'd2, 'a2)
fmtty_rel ->
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
fmtty_rel ->
('g1, 'b1, 'c1, 'j1, 'e1, 'f1, 'g2, 'b2, 'c2, 'j2, 'e2, 'f2)
fmtty_rel
val erase_rel : ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j, 'k, 'l)
fmtty_rel ->
('a, 'b, 'c, 'd, 'e, 'f) fmtty
val concat_fmt : ('a, 'b, 'c, 'd, 'e, 'f) fmt ->
('f, 'b, 'c, 'e, 'g, 'h) fmt ->
('a, 'b, 'c, 'd, 'g, 'h) fmt ocaml-doc-4.05/ocaml.html/libref/Genlex.html 0000644 0001750 0001750 00000033401 13131636444 017655 0 ustar mehdi mehdi
module Genlex:sig..end
This module implements a simple 'standard' lexical analyzer, presented as a function from character streams to token streams. It implements roughly the lexical conventions of OCaml, but is parameterized by the set of keywords of your language.
Example: a lexer suitable for a desk calculator is obtained by
let lexer = make_lexer ["+";"-";"*";"/";"let";"="; "("; ")"]
The associated parser would be a function from token stream
to, for instance, int, and would have rules such as:
let rec parse_expr = parser
| [< n1 = parse_atom; n2 = parse_remainder n1 >] -> n2
and parse_atom = parser
| [< 'Int n >] -> n
| [< 'Kwd "("; n = parse_expr; 'Kwd ")" >] -> n
and parse_remainder n1 = parser
| [< 'Kwd "+"; n2 = parse_expr >] -> n1+n2
| [< >] -> n1
One should notice that the use of the parser keyword and associated
notation for streams are only available through camlp4 extensions. This
means that one has to preprocess its sources e. g. by using the
"-pp" command-line switch of the compilers.
type
| |
Kwd of |
| |
Ident of |
| |
Int of |
| |
Float of |
| |
String of |
| |
Char of |
Int and Float
for integer and floating-point numbers; String for
string literals, enclosed in double quotes; Char for
character literals, enclosed in single quotes; Ident for
identifiers (either sequences of letters, digits, underscores
and quotes, or sequences of 'operator characters' such as
+, *, etc); and Kwd for keywords (either identifiers or
single 'special characters' such as (, }, etc).val make_lexer : string list -> char Stream.t -> token Stream.ts is returned as Kwd s if s
belongs to this list, and as Ident s otherwise.
A special character s is returned as Kwd s if s
belongs to this list, and cause a lexical error (exception
Stream.Error with the offending lexeme as its parameter) otherwise.
Blanks and newlines are skipped. Comments delimited by (* and *)
are skipped as well, and can be nested. A Stream.Failure exception
is raised if end of stream is unexpectedly reached.module MakeSeeded:
| Parameters: |
|
type
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t ->
key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t ->
key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t ->
key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) ->
'a t -> unit
val filter_map_inplace : f:(key:key -> data:'a -> 'a option) ->
'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) ->
'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> MoreLabels.Hashtbl.statistics ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Ctf.html 0000644 0001750 0001750 00000025625 13131636441 021242 0 ustar mehdi mehdi
module Ctf:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
Parsetree.class_type_field_desc -> Parsetree.class_type_field
val attr : Parsetree.class_type_field ->
Parsetree.attribute -> Parsetree.class_type_field
val inherit_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.class_type -> Parsetree.class_type_field
val val_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.mutable_flag ->
Asttypes.virtual_flag -> Parsetree.core_type -> Parsetree.class_type_field
val method_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.private_flag ->
Asttypes.virtual_flag -> Parsetree.core_type -> Parsetree.class_type_field
val constraint_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.class_type_field
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_type_field
val attribute : ?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.class_type_field
val text : Docstrings.text -> Parsetree.class_type_field list ocaml-doc-4.05/ocaml.html/libref/Ephemeron.Kn.Make.html 0000644 0001750 0001750 00000021767 13131636443 021613 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
mem h k is true, a subsequent
find h k may raise Not_found because the garbage collector
can run between the two.
Moreover, the table shouldn't be modified during a call to iter.
Use filter_map_inplace in this case.
include Hashtbl.S
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingsmodule type S =sig..end
Set.Make.type
type
val empty : tval is_empty : t -> boolval mem : elt -> t -> boolmem x s tests whether x belongs to the set s.val add : elt -> t -> tadd x s returns a set containing all elements of s,
plus x. If x was already in s, s is returned unchanged
(the result of the function is then physically equal to s).val singleton : elt -> tsingleton x returns the one-element set containing only x.val remove : elt -> t -> tremove x s returns a set containing all elements of s,
except x. If x was not in s, s is returned unchanged
(the result of the function is then physically equal to s).val union : t -> t -> tval inter : t -> t -> tval diff : t -> t -> tval compare : t -> t -> intval equal : t -> t -> boolequal s1 s2 tests whether the sets s1 and s2 are
equal, that is, contain equal elements.val subset : t -> t -> boolsubset s1 s2 tests whether the set s1 is a subset of
the set s2.val iter : (elt -> unit) -> t -> unititer f s applies f in turn to all elements of s.
The elements of s are presented to f in increasing order
with respect to the ordering over the type of the elements.val map : (elt -> elt) -> t -> tmap f s is the set whose elements are f a0,f a1... f
aN, where a0,a1...aN are the elements of s.
The elements are passed to f in increasing order
with respect to the ordering over the type of the elements.
If no element of s is changed by f, s is returned
unchanged. (If each output of f is physically equal to its
input, the returned set is physically equal to s.)
Since 4.04.0
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'afold f s a computes (f xN ... (f x2 (f x1 a))...),
where x1 ... xN are the elements of s, in increasing order.val for_all : (elt -> bool) -> t -> boolfor_all p s checks if all elements of the set
satisfy the predicate p.val exists : (elt -> bool) -> t -> boolexists p s checks if at least one element of
the set satisfies the predicate p.val filter : (elt -> bool) -> t -> tfilter p s returns the set of all elements in s
that satisfy predicate p. If p satisfies every element in s,
s is returned unchanged (the result of the function is then
physically equal to s).val partition : (elt -> bool) -> t -> t * tpartition p s returns a pair of sets (s1, s2), where
s1 is the set of all the elements of s that satisfy the
predicate p, and s2 is the set of all the elements of
s that do not satisfy p.val cardinal : t -> intval elements : t -> elt listOrd.compare, where Ord is the argument
given to Set.Make.val min_elt : t -> eltOrd.compare ordering), or raise
Not_found if the set is empty.val min_elt_opt : t -> elt optionOrd.compare ordering), or None
if the set is empty.val max_elt : t -> eltSet.S.min_elt, but returns the largest element of the
given set.val max_elt_opt : t -> elt option
val choose : t -> eltNot_found if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val choose_opt : t -> elt optionNone if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val split : elt -> t -> t * bool * tsplit x s returns a triple (l, present, r), where
l is the set of elements of s that are
strictly less than x;
r is the set of elements of s that are
strictly greater than x;
present is false if s contains no element equal to x,
or true if s contains an element equal to x.val find : elt -> t -> eltfind x s returns the element of s equal to x (according
to Ord.compare), or raise Not_found if no such element
exists.val find_opt : elt -> t -> elt optionfind_opt x s returns the element of s equal to x (according
to Ord.compare), or None if no such element
exists.val find_first : (elt -> bool) -> t -> eltfind_first f s, where f is a monotonically increasing function,
returns the lowest element e of s such that f e,
or raises Not_found if no such element exists.
For example, find_first (fun e -> Ord.compare e x >= 0) s will return
the first element e of s where Ord.compare e x >= 0 (intuitively:
e >= x), or raise Not_found if x is greater than any element of
s.
Since 4.05
val find_first_opt : (elt -> bool) -> t -> elt optionfind_first_opt f s, where f is a monotonically increasing function,
returns an option containing the lowest element e of s such that
f e, or None if no such element exists.val find_last : (elt -> bool) -> t -> eltfind_last f s, where f is a monotonically decreasing function,
returns the highest element e of s such that f e,
or raises Not_found if no such element exists.val find_last_opt : (elt -> bool) -> t -> elt optionfind_last_opt f s, where f is a monotonically decreasing function,
returns an option containing the highest element e of s such that
f e, or None if no such element exists.val of_list : elt list -> tof_list l creates a set from a list of elements.
This is usually more efficient than folding add over the list,
except perhaps for lists with many duplicated elements.module Config:sig..end
val version : string
val standard_library : string
val standard_runtime : string
val ccomp_type : string
val bytecomp_c_compiler : string
val bytecomp_c_libraries : string
val native_c_compiler : string
val native_c_libraries : string
val native_pack_linker : string
val mkdll : string
val mkexe : string
val mkmaindll : string
val ranlib : string
val ar : string
val cc_profile : string
val load_path : string list ref
val interface_suffix : string ref
val exec_magic_number : string
val cmi_magic_number : string
val cmo_magic_number : string
val cma_magic_number : string
val cmx_magic_number : string
val cmxa_magic_number : string
val ast_intf_magic_number : string
val ast_impl_magic_number : string
val cmxs_magic_number : string
val cmt_magic_number : string
val max_tag : int
val lazy_tag : int
val max_young_wosize : int
val stack_threshold : int
val stack_safety_margin : int
val architecture : string
val model : string
val system : string
val asm : string
val asm_cfi_supported : bool
val with_frame_pointers : bool
val ext_obj : string
val ext_asm : string
val ext_lib : string
val ext_dll : string
val default_executable_name : string
val systhread_supported : bool
val flexdll_dirs : string list
val host : string
val target : string
val print_config : out_channel -> unit
val profiling : bool
val flambda : bool
val spacetime : bool
val profinfo : bool
val profinfo_width : int
val libunwind_available : bool
val libunwind_link_flags : string
val safe_string : bool
val afl_instrument : bool ocaml-doc-4.05/ocaml.html/libref/Marshal.html 0000644 0001750 0001750 00000054174 13131636445 020035 0 ustar mehdi mehdi
module Marshal:sig..end
This module provides functions to encode arbitrary data structures as sequences of bytes, which can then be written on a file or sent over a pipe or network connection. The bytes can then be read back later, possibly in another process, and decoded back into a data structure. The format for the byte sequences is compatible across all machines for a given version of OCaml.
Warning: marshaling is currently not type-safe. The type
of marshaled data is not transmitted along the value of the data,
making it impossible to check that the data read back possesses the
type expected by the context. In particular, the result type of
the Marshal.from_* functions is given as 'a, but this is
misleading: the returned OCaml value does not possess type 'a
for all 'a; it has one, unique type which cannot be determined
at compile-type. The programmer should explicitly give the expected
type of the returned value, using the following syntax:
(Marshal.from_channel chan : type).
Anything can happen at run-time if the object in the file does not
belong to the given type.exn), returned by the unmarhsaller should not be
pattern-matched over through match ... with or try ... with,
because unmarshalling does not preserve the information required for
matching their constructors. Structural equalities with other
extensible variant values does not work either. Most other uses such
as Printexc.to_string, will still work as expected.
The representation of marshaled values is not human-readable,
and uses bytes that are not printable characters. Therefore,
input and output channels used in conjunction with Marshal.to_channel
and Marshal.from_channel must be opened in binary mode, using e.g.
open_out_bin or open_in_bin; channels opened in text mode will
cause unmarshaling errors on platforms where text channels behave
differently than binary channels, e.g. Windows.
type
| |
No_sharing |
(* |
Don't preserve sharing
| *) |
| |
Closures |
(* |
Send function closures
| *) |
| |
Compat_32 |
(* |
Ensure 32-bit compatibility
| *) |
Marshal.to_* functions below.val to_channel : out_channel -> 'a -> extern_flags list -> unitMarshal.to_channel chan v flags writes the representation
of v on channel chan. The flags argument is a
possibly empty list of flags that governs the marshaling
behavior with respect to sharing, functional values, and compatibility
between 32- and 64-bit platforms.
If flags does not contain Marshal.No_sharing, circularities
and sharing inside the value v are detected and preserved
in the sequence of bytes produced. In particular, this
guarantees that marshaling always terminates. Sharing
between values marshaled by successive calls to
Marshal.to_channel is neither detected nor preserved, though.
If flags contains Marshal.No_sharing, sharing is ignored.
This results in faster marshaling if v contains no shared
substructures, but may cause slower marshaling and larger
byte representations if v actually contains sharing,
or even non-termination if v contains cycles.
If flags does not contain Marshal.Closures, marshaling fails
when it encounters a functional value inside v: only 'pure' data
structures, containing neither functions nor objects, can safely be
transmitted between different programs. If flags contains
Marshal.Closures, functional values will be marshaled as a the
position in the code of the program together with the values
corresponding to the free variables captured in the closure. In
this case, the output of marshaling can only be read back in
processes that run exactly the same program, with exactly the same
compiled code. (This is checked at un-marshaling time, using an MD5
digest of the code transmitted along with the code position.)
The exact definition of which free variables are captured in a closure is not specified and can vary between bytecode and native code (and according to optimization flags). In particular, a function value accessing a global reference may or may not include the reference in its closure. If it does, unmarshaling the corresponding closure will create a new reference, different from the global one.
If flags contains Marshal.Compat_32, marshaling fails when
it encounters an integer value outside the range [-2{^30}, 2{^30}-1]
of integers that are representable on a 32-bit platform. This
ensures that marshaled data generated on a 64-bit platform can be
safely read back on a 32-bit platform. If flags does not
contain Marshal.Compat_32, integer values outside the
range [-2{^30}, 2{^30}-1] are marshaled, and can be read back on
a 64-bit platform, but will cause an error at un-marshaling time
when read back on a 32-bit platform. The Mashal.Compat_32 flag
only matters when marshaling is performed on a 64-bit platform;
it has no effect if marshaling is performed on a 32-bit platform.
val to_bytes : 'a -> extern_flags list -> bytesMarshal.to_bytes v flags returns a byte sequence containing
the representation of v.
The flags argument has the same meaning as for
Marshal.to_channel.val to_string : 'a -> extern_flags list -> stringto_bytes but return the result as a string instead of
a byte sequence.val to_buffer : bytes -> int -> int -> 'a -> extern_flags list -> intMarshal.to_buffer buff ofs len v flags marshals the value v,
storing its byte representation in the sequence buff,
starting at index ofs, and writing at most
len bytes. It returns the number of bytes
actually written to the sequence. If the byte representation
of v does not fit in len characters, the exception Failure
is raised.val from_channel : in_channel -> 'aMarshal.from_channel chan reads from channel chan the
byte representation of a structured value, as produced by
one of the Marshal.to_* functions, and reconstructs and
returns the corresponding value.
It raises End_of_file if the function has already reached the
end of file when starting to read from the channel, and raises
Failure "input_value: truncated object" if it reaches the end
of file later during the unmarshalling.
val from_bytes : bytes -> int -> 'aMarshal.from_bytes buff ofs unmarshals a structured value
like Marshal.from_channel does, except that the byte
representation is not read from a channel, but taken from
the byte sequence buff, starting at position ofs.
The byte sequence is not mutated.val from_string : string -> int -> 'afrom_bytes but take a string as argument instead of a
byte sequence.val header_size : intMarshal.header_size is the size, in bytes, of the header.
Marshal.data_size buff ofs is the size, in bytes,
of the data part, assuming a valid header is stored in
buff starting at position ofs.
Finally, Marshal.total_size buff ofs is the total size,
in bytes, of the marshaled value.
Both Marshal.data_size and Marshal.total_size raise Failure
if buff, ofs does not contain a valid header.
To read the byte representation of a marshaled value into
a byte sequence, the program needs to read first
Marshal.header_size bytes into the sequence,
then determine the length of the remainder of the
representation using Marshal.data_size,
make sure the sequence is large enough to hold the remaining
data, then read it, and finally call Marshal.from_bytes
to unmarshal the value.
val data_size : bytes -> int -> intMarshal.header_size.val total_size : bytes -> int -> intMarshal.header_size.sig
val fatal_error : string -> 'a
val fatal_errorf :
('a, Format.formatter, unit, 'b) Pervasives.format4 -> 'a
exception Fatal_error
val try_finally : (unit -> 'a) -> (unit -> unit) -> 'a
val map_end : ('a -> 'b) -> 'a list -> 'b list -> 'b list
val map_left_right : ('a -> 'b) -> 'a list -> 'b list
val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
val replicate_list : 'a -> int -> 'a list
val list_remove : 'a -> 'a list -> 'a list
val split_last : 'a list -> 'a list * 'a
val may : ('a -> unit) -> 'a option -> unit
val may_map : ('a -> 'b) -> 'a option -> 'b option
type ref_and_value = R : 'a Pervasives.ref * 'a -> Misc.ref_and_value
val protect_refs : Misc.ref_and_value list -> (unit -> 'a) -> 'a
module Stdlib :
sig
module List :
sig
type 'a t = 'a list
val compare :
('a -> 'a -> int) ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t -> int
val equal :
('a -> 'a -> bool) ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t -> bool
val filter_map :
('a -> 'b option) ->
'a Misc.Stdlib.List.t -> 'b Misc.Stdlib.List.t
val some_if_all_elements_are_some :
'a option Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t option
val map2_prefix :
('a -> 'b -> 'c) ->
'a Misc.Stdlib.List.t ->
'b Misc.Stdlib.List.t ->
'c Misc.Stdlib.List.t * 'b Misc.Stdlib.List.t
val split_at :
int ->
'a Misc.Stdlib.List.t ->
'a Misc.Stdlib.List.t * 'a Misc.Stdlib.List.t
end
module Option :
sig
type 'a t = 'a option
val equal :
('a -> 'a -> bool) ->
'a Misc.Stdlib.Option.t -> 'a Misc.Stdlib.Option.t -> bool
val iter : ('a -> unit) -> 'a Misc.Stdlib.Option.t -> unit
val map :
('a -> 'b) -> 'a Misc.Stdlib.Option.t -> 'b Misc.Stdlib.Option.t
val fold : ('a -> 'b -> 'b) -> 'a Misc.Stdlib.Option.t -> 'b -> 'b
val value_default :
('a -> 'b) -> default:'b -> 'a Misc.Stdlib.Option.t -> 'b
end
end
val find_in_path : string list -> string -> string
val find_in_path_rel : string list -> string -> string
val find_in_path_uncap : string list -> string -> string
val remove_file : string -> unit
val expand_directory : string -> string -> string
val create_hashtable : int -> ('a * 'b) list -> ('a, 'b) Hashtbl.t
val copy_file : Pervasives.in_channel -> Pervasives.out_channel -> unit
val copy_file_chunk :
Pervasives.in_channel -> Pervasives.out_channel -> int -> unit
val string_of_file : Pervasives.in_channel -> string
val log2 : int -> int
val align : int -> int -> int
val no_overflow_add : int -> int -> bool
val no_overflow_sub : int -> int -> bool
val no_overflow_mul : int -> int -> bool
val no_overflow_lsl : int -> int -> bool
module Int_literal_converter :
sig
val int : string -> int
val int32 : string -> int32
val int64 : string -> int64
val nativeint : string -> nativeint
end
val chop_extensions : string -> string
val search_substring : string -> string -> int -> int
val replace_substring : before:string -> after:string -> string -> string
val rev_split_words : string -> string list
val get_ref : 'a list Pervasives.ref -> 'a list
val fst3 : 'a * 'b * 'c -> 'a
val snd3 : 'a * 'b * 'c -> 'b
val thd3 : 'a * 'b * 'c -> 'c
val fst4 : 'a * 'b * 'c * 'd -> 'a
val snd4 : 'a * 'b * 'c * 'd -> 'b
val thd4 : 'a * 'b * 'c * 'd -> 'c
val for4 : 'a * 'b * 'c * 'd -> 'd
module LongString :
sig
type t = bytes array
val create : int -> Misc.LongString.t
val length : Misc.LongString.t -> int
val get : Misc.LongString.t -> int -> char
val set : Misc.LongString.t -> int -> char -> unit
val blit :
Misc.LongString.t -> int -> Misc.LongString.t -> int -> int -> unit
val output :
Pervasives.out_channel -> Misc.LongString.t -> int -> int -> unit
val unsafe_blit_to_bytes :
Misc.LongString.t -> int -> bytes -> int -> int -> unit
val input_bytes : Pervasives.in_channel -> int -> Misc.LongString.t
end
val edit_distance : string -> string -> int -> int option
val spellcheck : string list -> string -> string list
val did_you_mean : Format.formatter -> (unit -> string list) -> unit
val cut_at : string -> char -> string * string
module StringSet :
sig
type elt = string
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
end
module StringMap :
sig
type key = string
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end
module Color :
sig
type color =
Black
| Red
| Green
| Yellow
| Blue
| Magenta
| Cyan
| White
type style =
FG of Misc.Color.color
| BG of Misc.Color.color
| Bold
| Reset
val ansi_of_style_l : Misc.Color.style list -> string
type styles = {
error : Misc.Color.style list;
warning : Misc.Color.style list;
loc : Misc.Color.style list;
}
val default_styles : Misc.Color.styles
val get_styles : unit -> Misc.Color.styles
val set_styles : Misc.Color.styles -> unit
type setting = Auto | Always | Never
val setup : Misc.Color.setting option -> unit
val set_color_tag_handling : Format.formatter -> unit
end
val normalise_eol : string -> string
val delete_eol_spaces : string -> string
type hook_info = { sourcefile : string; }
exception HookExnWrapper of { error : exn; hook_name : string;
hook_info : Misc.hook_info;
}
val raise_direct_hook_exn : exn -> 'a
module type HookSig =
sig
type t
val add_hook :
string ->
(Misc.hook_info -> Misc.HookSig.t -> Misc.HookSig.t) -> unit
val apply_hooks : Misc.hook_info -> Misc.HookSig.t -> Misc.HookSig.t
end
module MakeHooks :
functor (M : sig type t end) ->
sig
type t = M.t
val add_hook : string -> (hook_info -> t -> t) -> unit
val apply_hooks : hook_info -> t -> t
end
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Pat.html 0000644 0001750 0001750 00000035421 13131636441 021245 0 ustar mehdi mehdi
module Pat:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern_desc -> Parsetree.pattern
val attr : Parsetree.pattern -> Parsetree.attribute -> Parsetree.pattern
val any : ?loc:Ast_helper.loc -> ?attrs:Ast_helper.attrs -> unit -> Parsetree.pattern
val var : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.str -> Parsetree.pattern
val alias : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Ast_helper.str -> Parsetree.pattern
val constant : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.constant -> Parsetree.pattern
val interval : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.constant -> Parsetree.constant -> Parsetree.pattern
val tuple : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern list -> Parsetree.pattern
val construct : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.pattern option -> Parsetree.pattern
val variant : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.label -> Parsetree.pattern option -> Parsetree.pattern
val record : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.lid * Parsetree.pattern) list ->
Asttypes.closed_flag -> Parsetree.pattern
val array : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern list -> Parsetree.pattern
val or_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Parsetree.pattern -> Parsetree.pattern
val constraint_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Parsetree.core_type -> Parsetree.pattern
val type_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.pattern
val lazy_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern -> Parsetree.pattern
val unpack : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.str -> Parsetree.pattern
val open_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.pattern -> Parsetree.pattern
val exception_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern -> Parsetree.pattern
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.pattern ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Const.html 0000644 0001750 0001750 00000020423 13131636441 022644 0 ustar mehdi mehdi
sig
val char : char -> Parsetree.constant
val string : ?quotation_delimiter:string -> string -> Parsetree.constant
val integer : ?suffix:char -> string -> Parsetree.constant
val int : ?suffix:char -> int -> Parsetree.constant
val int32 : ?suffix:char -> int32 -> Parsetree.constant
val int64 : ?suffix:char -> int64 -> Parsetree.constant
val nativeint : ?suffix:char -> nativeint -> Parsetree.constant
val float : ?suffix:char -> string -> Parsetree.constant
end ocaml-doc-4.05/ocaml.html/libref/index_methods.html 0000644 0001750 0001750 00000014750 13131636452 021272 0 ustar mehdi mehdi
sig
type status = Uninitialised | Bad_term | Good_term of int
external setup : Pervasives.out_channel -> Terminfo.status
= "caml_terminfo_setup"
external backup : int -> unit = "caml_terminfo_backup"
external standout : bool -> unit = "caml_terminfo_standout"
external resume : int -> unit = "caml_terminfo_resume"
end ocaml-doc-4.05/ocaml.html/libref/type_Arg_helper.html 0000644 0001750 0001750 00000073623 13131636441 021553 0 ustar mehdi mehdi
sig
module Make :
functor
(S : sig
module Key :
sig
type t
val of_string : string -> Arg_helper.Make.Key.t
module Map :
sig
type key = t
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union :
(key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition :
(key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt :
(key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt :
(key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end
end
module Value :
sig
type t
val of_string : string -> Arg_helper.Make.Value.t
end
end) ->
sig
type parsed
val default : S.Value.t -> Arg_helper.Make.parsed
val set_base_default :
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val add_base_override :
S.Key.t ->
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val reset_base_overrides :
Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val set_user_default :
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val add_user_override :
S.Key.t ->
S.Value.t -> Arg_helper.Make.parsed -> Arg_helper.Make.parsed
val parse :
string -> string -> Arg_helper.Make.parsed Pervasives.ref -> unit
type parse_result = Ok | Parse_failed of exn
val parse_no_error :
string ->
Arg_helper.Make.parsed Pervasives.ref ->
Arg_helper.Make.parse_result
val get : key:S.Key.t -> Arg_helper.Make.parsed -> S.Value.t
end
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Hashtbl.SeededS.html 0000644 0001750 0001750 00000035325 13131636446 024431 0 ustar mehdi mehdi
sig
type key
and 'a t
val create : ?random:bool -> int -> 'a MoreLabels.Hashtbl.SeededS.t
val clear : 'a MoreLabels.Hashtbl.SeededS.t -> unit
val reset : 'a MoreLabels.Hashtbl.SeededS.t -> unit
val copy :
'a MoreLabels.Hashtbl.SeededS.t -> 'a MoreLabels.Hashtbl.SeededS.t
val add :
'a MoreLabels.Hashtbl.SeededS.t ->
key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit
val remove :
'a MoreLabels.Hashtbl.SeededS.t -> MoreLabels.Hashtbl.SeededS.key -> unit
val find :
'a MoreLabels.Hashtbl.SeededS.t -> MoreLabels.Hashtbl.SeededS.key -> 'a
val find_opt :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a option
val find_all :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a list
val replace :
'a MoreLabels.Hashtbl.SeededS.t ->
key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit
val mem :
'a MoreLabels.Hashtbl.SeededS.t -> MoreLabels.Hashtbl.SeededS.key -> bool
val iter :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit) ->
'a MoreLabels.Hashtbl.SeededS.t -> unit
val filter_map_inplace :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> 'a option) ->
'a MoreLabels.Hashtbl.SeededS.t -> unit
val fold :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Hashtbl.SeededS.t -> init:'b -> 'b
val length : 'a MoreLabels.Hashtbl.SeededS.t -> int
val stats :
'a MoreLabels.Hashtbl.SeededS.t -> MoreLabels.Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/StdLabels.List.html 0000644 0001750 0001750 00000100104 13131636450 021212 0 ustar mehdi mehdi
module List: ListLabelsval length : 'a list -> intval hd : 'a list -> 'aFailure "hd" if the list is empty.val compare_lengths : 'a list -> 'b list -> intcompare_lengths l1 l2 is
equivalent to compare (length l1) (length l2), except that
the computation stops after itering on the shortest list.val compare_length_with : 'a list -> len:int -> intcompare_length_with l n is
equivalent to compare (length l) n, except that
the computation stops after at most n iterations on the list.val cons : 'a -> 'a list -> 'a listcons x xs is x :: xsval tl : 'a list -> 'a listFailure "tl" if the list is empty.val nth : 'a list -> int -> 'an-th element of the given list.
The first element (head of the list) is at position 0.
Raise Failure "nth" if the list is too short.
Raise Invalid_argument "List.nth" if n is negative.val nth_opt : 'a list -> int -> 'a optionn-th element of the given list.
The first element (head of the list) is at position 0.
Return None if the list is too short.
Raise Invalid_argument "List.nth" if n is negative.val rev : 'a list -> 'a listval append : 'a list -> 'a list -> 'a list@.
Not tail-recursive (length of the first argument). The @
operator is not tail-recursive either.val rev_append : 'a list -> 'a list -> 'a listList.rev_append l1 l2 reverses l1 and concatenates it to l2.
This is equivalent to List.rev l1 @ l2, but rev_append is
tail-recursive and more efficient.val concat : 'a list list -> 'a listval flatten : 'a list list -> 'a listconcat. Not tail-recursive
(length of the argument + length of the longest sub-list).val iter : f:('a -> unit) -> 'a list -> unitList.iter f [a1; ...; an] applies function f in turn to
a1; ...; an. It is equivalent to
begin f a1; f a2; ...; f an; () end.val iteri : f:(int -> 'a -> unit) -> 'a list -> unitList.iter, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.val map : f:('a -> 'b) -> 'a list -> 'b listList.map f [a1; ...; an] applies function f to a1, ..., an,
and builds the list [f a1; ...; f an]
with the results returned by f. Not tail-recursive.val mapi : f:(int -> 'a -> 'b) -> 'a list -> 'b listList.map, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.val rev_map : f:('a -> 'b) -> 'a list -> 'b listList.rev_map f l gives the same result as
List.rev (List.map f l), but is tail-recursive and
more efficient.val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b list -> 'aList.fold_left f a [b1; ...; bn] is
f (... (f (f a b1) b2) ...) bn.val fold_right : f:('a -> 'b -> 'b) -> 'a list -> init:'b -> 'bList.fold_right f [a1; ...; an] b is
f a1 (f a2 (... (f an b) ...)). Not tail-recursive.val iter2 : f:('a -> 'b -> unit) -> 'a list -> 'b list -> unitList.iter2 f [a1; ...; an] [b1; ...; bn] calls in turn
f a1 b1; ...; f an bn.
Raise Invalid_argument if the two lists are determined
to have different lengths.val map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c listList.map2 f [a1; ...; an] [b1; ...; bn] is
[f a1 b1; ...; f an bn].
Raise Invalid_argument if the two lists are determined
to have different lengths. Not tail-recursive.val rev_map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c listList.rev_map2 f l1 l2 gives the same result as
List.rev (List.map2 f l1 l2), but is tail-recursive and
more efficient.val fold_left2 : f:('a -> 'b -> 'c -> 'a) -> init:'a -> 'b list -> 'c list -> 'aList.fold_left2 f a [b1; ...; bn] [c1; ...; cn] is
f (... (f (f a b1 c1) b2 c2) ...) bn cn.
Raise Invalid_argument if the two lists are determined
to have different lengths.val fold_right2 : f:('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> init:'c -> 'cList.fold_right2 f [a1; ...; an] [b1; ...; bn] c is
f a1 b1 (f a2 b2 (... (f an bn c) ...)).
Raise Invalid_argument if the two lists are determined
to have different lengths. Not tail-recursive.val for_all : f:('a -> bool) -> 'a list -> boolfor_all p [a1; ...; an] checks if all elements of the list
satisfy the predicate p. That is, it returns
(p a1) && (p a2) && ... && (p an).val exists : f:('a -> bool) -> 'a list -> boolexists p [a1; ...; an] checks if at least one element of
the list satisfies the predicate p. That is, it returns
(p a1) || (p a2) || ... || (p an).val for_all2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> boolList.for_all, but for a two-argument predicate.
Raise Invalid_argument if the two lists are determined
to have different lengths.val exists2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> boolList.exists, but for a two-argument predicate.
Raise Invalid_argument if the two lists are determined
to have different lengths.val mem : 'a -> set:'a list -> boolmem a l is true if and only if a is equal
to an element of l.val memq : 'a -> set:'a list -> boolList.mem, but uses physical equality instead of structural
equality to compare list elements.val find : f:('a -> bool) -> 'a list -> 'afind p l returns the first element of the list l
that satisfies the predicate p.
Raise Not_found if there is no value that satisfies p in the
list l.val find_opt : f:('a -> bool) -> 'a list -> 'a optionfind p l returns the first element of the list l
that satisfies the predicate p.
Returns None if there is no value that satisfies p in the
list l.val filter : f:('a -> bool) -> 'a list -> 'a listfilter p l returns all the elements of the list l
that satisfy the predicate p. The order of the elements
in the input list is preserved.val find_all : f:('a -> bool) -> 'a list -> 'a list
val partition : f:('a -> bool) -> 'a list -> 'a list * 'a listpartition p l returns a pair of lists (l1, l2), where
l1 is the list of all the elements of l that
satisfy the predicate p, and l2 is the list of all the
elements of l that do not satisfy p.
The order of the elements in the input list is preserved.val assoc : 'a -> ('a * 'b) list -> 'bassoc a l returns the value associated with key a in the list of
pairs l. That is,
assoc a [ ...; (a,b); ...] = b
if (a,b) is the leftmost binding of a in list l.
Raise Not_found if there is no value associated with a in the
list l.val assoc_opt : 'a -> ('a * 'b) list -> 'b optionassoc_opt a l returns the value associated with key a in the list of
pairs l. That is,
assoc a [ ...; (a,b); ...] = b
if (a,b) is the leftmost binding of a in list l.
Returns None if there is no value associated with a in the
list l.val assq : 'a -> ('a * 'b) list -> 'bList.assoc, but uses physical equality instead of
structural equality to compare keys.val assq_opt : 'a -> ('a * 'b) list -> 'b optionList.assoc_opt, but uses physical equality instead of
structural equality to compare keys.val mem_assoc : 'a -> map:('a * 'b) list -> boolList.assoc, but simply return true if a binding exists,
and false if no bindings exist for the given key.val mem_assq : 'a -> map:('a * 'b) list -> boolList.mem_assoc, but uses physical equality instead of
structural equality to compare keys.val remove_assoc : 'a -> ('a * 'b) list -> ('a * 'b) listremove_assoc a l returns the list of
pairs l without the first pair with key a, if any.
Not tail-recursive.val remove_assq : 'a -> ('a * 'b) list -> ('a * 'b) listList.remove_assoc, but uses physical equality instead
of structural equality to compare keys. Not tail-recursive.val split : ('a * 'b) list -> 'a list * 'b listsplit [(a1,b1); ...; (an,bn)] is ([a1; ...; an], [b1; ...; bn]).
Not tail-recursive.val combine : 'a list -> 'b list -> ('a * 'b) listcombine [a1; ...; an] [b1; ...; bn] is
[(a1,b1); ...; (an,bn)].
Raise Invalid_argument if the two lists
have different lengths. Not tail-recursive.val sort : cmp:('a -> 'a -> int) -> 'a list -> 'a listcompare is a suitable comparison function.
The resulting list is sorted in increasing order.
List.sort is guaranteed to run in constant heap space
(in addition to the size of the result list) and logarithmic
stack space.
The current implementation uses Merge Sort. It runs in constant
heap space and logarithmic stack space.
val stable_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a listList.sort, but the sorting algorithm is guaranteed to
be stable (i.e. elements that compare equal are kept in their
original order) .
The current implementation uses Merge Sort. It runs in constant
heap space and logarithmic stack space.
val fast_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val sort_uniq : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val merge : cmp:('a -> 'a -> int) -> 'a list -> 'a list -> 'a listl1 and l2 are sorted according to the
comparison function cmp, merge cmp l1 l2 will return a
sorted list containting all the elements of l1 and l2.
If several elements compare equal, the elements of l1 will be
before the elements of l2.
Not tail-recursive (sum of the lengths of the arguments).sig
type key
and 'a t
val create : int -> 'a MoreLabels.Hashtbl.S.t
val clear : 'a MoreLabels.Hashtbl.S.t -> unit
val reset : 'a MoreLabels.Hashtbl.S.t -> unit
val copy : 'a MoreLabels.Hashtbl.S.t -> 'a MoreLabels.Hashtbl.S.t
val add :
'a MoreLabels.Hashtbl.S.t ->
key:MoreLabels.Hashtbl.S.key -> data:'a -> unit
val remove : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> unit
val find : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a
val find_opt :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a option
val find_all :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a list
val replace :
'a MoreLabels.Hashtbl.S.t ->
key:MoreLabels.Hashtbl.S.key -> data:'a -> unit
val mem : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> bool
val iter :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> unit) ->
'a MoreLabels.Hashtbl.S.t -> unit
val filter_map_inplace :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> 'a option) ->
'a MoreLabels.Hashtbl.S.t -> unit
val fold :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Hashtbl.S.t -> init:'b -> 'b
val length : 'a MoreLabels.Hashtbl.S.t -> int
val stats : 'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_ListLabels.html 0000644 0001750 0001750 00000062215 13131636445 021540 0 ustar mehdi mehdi
sig
val length : 'a list -> int
val hd : 'a list -> 'a
val compare_lengths : 'a list -> 'b list -> int
val compare_length_with : 'a list -> len:int -> int
val cons : 'a -> 'a list -> 'a list
val tl : 'a list -> 'a list
val nth : 'a list -> int -> 'a
val nth_opt : 'a list -> int -> 'a option
val rev : 'a list -> 'a list
val append : 'a list -> 'a list -> 'a list
val rev_append : 'a list -> 'a list -> 'a list
val concat : 'a list list -> 'a list
val flatten : 'a list list -> 'a list
val iter : f:('a -> unit) -> 'a list -> unit
val iteri : f:(int -> 'a -> unit) -> 'a list -> unit
val map : f:('a -> 'b) -> 'a list -> 'b list
val mapi : f:(int -> 'a -> 'b) -> 'a list -> 'b list
val rev_map : f:('a -> 'b) -> 'a list -> 'b list
val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b list -> 'a
val fold_right : f:('a -> 'b -> 'b) -> 'a list -> init:'b -> 'b
val iter2 : f:('a -> 'b -> unit) -> 'a list -> 'b list -> unit
val map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val rev_map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val fold_left2 :
f:('a -> 'b -> 'c -> 'a) -> init:'a -> 'b list -> 'c list -> 'a
val fold_right2 :
f:('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> init:'c -> 'c
val for_all : f:('a -> bool) -> 'a list -> bool
val exists : f:('a -> bool) -> 'a list -> bool
val for_all2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> bool
val exists2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> bool
val mem : 'a -> set:'a list -> bool
val memq : 'a -> set:'a list -> bool
val find : f:('a -> bool) -> 'a list -> 'a
val find_opt : f:('a -> bool) -> 'a list -> 'a option
val filter : f:('a -> bool) -> 'a list -> 'a list
val find_all : f:('a -> bool) -> 'a list -> 'a list
val partition : f:('a -> bool) -> 'a list -> 'a list * 'a list
val assoc : 'a -> ('a * 'b) list -> 'b
val assoc_opt : 'a -> ('a * 'b) list -> 'b option
val assq : 'a -> ('a * 'b) list -> 'b
val assq_opt : 'a -> ('a * 'b) list -> 'b option
val mem_assoc : 'a -> map:('a * 'b) list -> bool
val mem_assq : 'a -> map:('a * 'b) list -> bool
val remove_assoc : 'a -> ('a * 'b) list -> ('a * 'b) list
val remove_assq : 'a -> ('a * 'b) list -> ('a * 'b) list
val split : ('a * 'b) list -> 'a list * 'b list
val combine : 'a list -> 'b list -> ('a * 'b) list
val sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val stable_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val fast_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val sort_uniq : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val merge : cmp:('a -> 'a -> int) -> 'a list -> 'a list -> 'a list
end ocaml-doc-4.05/ocaml.html/libref/type_Depend.html 0000644 0001750 0001750 00000072771 13131636443 020707 0 ustar mehdi mehdi
sig
module StringSet :
sig
type elt = string
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
end
module StringMap :
sig
type key = string
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end
type map_tree = Node of Depend.StringSet.t * Depend.bound_map
and bound_map = Depend.map_tree Depend.StringMap.t
val make_leaf : string -> Depend.map_tree
val make_node : Depend.bound_map -> Depend.map_tree
val weaken_map : Depend.StringSet.t -> Depend.map_tree -> Depend.map_tree
val free_structure_names : Depend.StringSet.t Pervasives.ref
val open_module : Depend.bound_map -> Longident.t -> Depend.bound_map
val add_use_file :
Depend.bound_map -> Parsetree.toplevel_phrase list -> unit
val add_signature : Depend.bound_map -> Parsetree.signature -> unit
val add_implementation : Depend.bound_map -> Parsetree.structure -> unit
val add_implementation_binding :
Depend.bound_map -> Parsetree.structure -> Depend.bound_map
val add_signature_binding :
Depend.bound_map -> Parsetree.signature -> Depend.bound_map
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Mb.html 0000644 0001750 0001750 00000017303 13131636441 021056 0 ustar mehdi mehdi
module Mb:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Ast_helper.str -> Parsetree.module_expr -> Parsetree.module_binding ocaml-doc-4.05/ocaml.html/libref/type_Arg.html 0000644 0001750 0001750 00000040110 13131636440 020174 0 ustar mehdi mehdi
sig
type spec =
Unit of (unit -> unit)
| Bool of (bool -> unit)
| Set of bool Pervasives.ref
| Clear of bool Pervasives.ref
| String of (string -> unit)
| Set_string of string Pervasives.ref
| Int of (int -> unit)
| Set_int of int Pervasives.ref
| Float of (float -> unit)
| Set_float of float Pervasives.ref
| Tuple of Arg.spec list
| Symbol of string list * (string -> unit)
| Rest of (string -> unit)
| Expand of (string -> string array)
type key = string
type doc = string
type usage_msg = string
type anon_fun = string -> unit
val parse :
(Arg.key * Arg.spec * Arg.doc) list ->
Arg.anon_fun -> Arg.usage_msg -> unit
val parse_dynamic :
(Arg.key * Arg.spec * Arg.doc) list Pervasives.ref ->
Arg.anon_fun -> Arg.usage_msg -> unit
val parse_argv :
?current:int Pervasives.ref ->
string array ->
(Arg.key * Arg.spec * Arg.doc) list ->
Arg.anon_fun -> Arg.usage_msg -> unit
val parse_argv_dynamic :
?current:int Pervasives.ref ->
string array ->
(Arg.key * Arg.spec * Arg.doc) list Pervasives.ref ->
Arg.anon_fun -> string -> unit
val parse_and_expand_argv_dynamic :
int Pervasives.ref ->
string array Pervasives.ref ->
(Arg.key * Arg.spec * Arg.doc) list Pervasives.ref ->
Arg.anon_fun -> string -> unit
val parse_expand :
(Arg.key * Arg.spec * Arg.doc) list ->
Arg.anon_fun -> Arg.usage_msg -> unit
exception Help of string
exception Bad of string
val usage : (Arg.key * Arg.spec * Arg.doc) list -> Arg.usage_msg -> unit
val usage_string :
(Arg.key * Arg.spec * Arg.doc) list -> Arg.usage_msg -> string
val align :
?limit:int ->
(Arg.key * Arg.spec * Arg.doc) list ->
(Arg.key * Arg.spec * Arg.doc) list
val current : int Pervasives.ref
val read_arg : string -> string array
val read_arg0 : string -> string array
val write_arg : string -> string array -> unit
val write_arg0 : string -> string array -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Lexing.html 0000644 0001750 0001750 00000031652 13131636445 020731 0 ustar mehdi mehdi
sig
type position = {
pos_fname : string;
pos_lnum : int;
pos_bol : int;
pos_cnum : int;
}
val dummy_pos : Lexing.position
type lexbuf = {
refill_buff : Lexing.lexbuf -> unit;
mutable lex_buffer : bytes;
mutable lex_buffer_len : int;
mutable lex_abs_pos : int;
mutable lex_start_pos : int;
mutable lex_curr_pos : int;
mutable lex_last_pos : int;
mutable lex_last_action : int;
mutable lex_eof_reached : bool;
mutable lex_mem : int array;
mutable lex_start_p : Lexing.position;
mutable lex_curr_p : Lexing.position;
}
val from_channel : Pervasives.in_channel -> Lexing.lexbuf
val from_string : string -> Lexing.lexbuf
val from_function : (bytes -> int -> int) -> Lexing.lexbuf
val lexeme : Lexing.lexbuf -> string
val lexeme_char : Lexing.lexbuf -> int -> char
val lexeme_start : Lexing.lexbuf -> int
val lexeme_end : Lexing.lexbuf -> int
val lexeme_start_p : Lexing.lexbuf -> Lexing.position
val lexeme_end_p : Lexing.lexbuf -> Lexing.position
val new_line : Lexing.lexbuf -> unit
val flush_input : Lexing.lexbuf -> unit
val sub_lexeme : Lexing.lexbuf -> int -> int -> string
val sub_lexeme_opt : Lexing.lexbuf -> int -> int -> string option
val sub_lexeme_char : Lexing.lexbuf -> int -> char
val sub_lexeme_char_opt : Lexing.lexbuf -> int -> char option
type lex_tables = {
lex_base : string;
lex_backtrk : string;
lex_default : string;
lex_trans : string;
lex_check : string;
lex_base_code : string;
lex_backtrk_code : string;
lex_default_code : string;
lex_trans_code : string;
lex_check_code : string;
lex_code : string;
}
val engine : Lexing.lex_tables -> int -> Lexing.lexbuf -> int
val new_engine : Lexing.lex_tables -> int -> Lexing.lexbuf -> int
end ocaml-doc-4.05/ocaml.html/libref/type_Nativeint.html 0000644 0001750 0001750 00000032440 13131636447 021442 0 ustar mehdi mehdi
sig
val zero : nativeint
val one : nativeint
val minus_one : nativeint
external neg : nativeint -> nativeint = "%nativeint_neg"
external add : nativeint -> nativeint -> nativeint = "%nativeint_add"
external sub : nativeint -> nativeint -> nativeint = "%nativeint_sub"
external mul : nativeint -> nativeint -> nativeint = "%nativeint_mul"
external div : nativeint -> nativeint -> nativeint = "%nativeint_div"
external rem : nativeint -> nativeint -> nativeint = "%nativeint_mod"
val succ : nativeint -> nativeint
val pred : nativeint -> nativeint
val abs : nativeint -> nativeint
val size : int
val max_int : nativeint
val min_int : nativeint
external logand : nativeint -> nativeint -> nativeint = "%nativeint_and"
external logor : nativeint -> nativeint -> nativeint = "%nativeint_or"
external logxor : nativeint -> nativeint -> nativeint = "%nativeint_xor"
val lognot : nativeint -> nativeint
external shift_left : nativeint -> int -> nativeint = "%nativeint_lsl"
external shift_right : nativeint -> int -> nativeint = "%nativeint_asr"
external shift_right_logical : nativeint -> int -> nativeint
= "%nativeint_lsr"
external of_int : int -> nativeint = "%nativeint_of_int"
external to_int : nativeint -> int = "%nativeint_to_int"
external of_float : float -> nativeint = "caml_nativeint_of_float"
"caml_nativeint_of_float_unboxed" [@@unboxed] [@@noalloc]
external to_float : nativeint -> float = "caml_nativeint_to_float"
"caml_nativeint_to_float_unboxed" [@@unboxed] [@@noalloc]
external of_int32 : int32 -> nativeint = "%nativeint_of_int32"
external to_int32 : nativeint -> int32 = "%nativeint_to_int32"
external of_string : string -> nativeint = "caml_nativeint_of_string"
val of_string_opt : string -> nativeint option
val to_string : nativeint -> string
type t = nativeint
val compare : Nativeint.t -> Nativeint.t -> int
val equal : Nativeint.t -> Nativeint.t -> bool
external format : string -> nativeint -> string = "caml_nativeint_format"
end ocaml-doc-4.05/ocaml.html/libref/MoreLabels.html 0000644 0001750 0001750 00000020411 13131636446 020457 0 ustar mehdi mehdi
module MoreLabels:sig..end
This meta-module provides labelized version of the Hashtbl,
Map and Set modules.
They only differ by their labels. They are provided to help
porting from previous versions of OCaml.
The contents of this module are subject to change.
module Hashtbl:sig..end
module Map:sig..end
module Set:ocaml-doc-4.05/ocaml.html/libref/type_Random.html 0000644 0001750 0001750 00000026735 13131636450 020725 0 ustar mehdi mehdisig..end
sig
val init : int -> unit
val full_init : int array -> unit
val self_init : unit -> unit
val bits : unit -> int
val int : int -> int
val int32 : Int32.t -> Int32.t
val nativeint : Nativeint.t -> Nativeint.t
val int64 : Int64.t -> Int64.t
val float : float -> float
val bool : unit -> bool
module State :
sig
type t
val make : int array -> Random.State.t
val make_self_init : unit -> Random.State.t
val copy : Random.State.t -> Random.State.t
val bits : Random.State.t -> int
val int : Random.State.t -> int -> int
val int32 : Random.State.t -> Int32.t -> Int32.t
val nativeint : Random.State.t -> Nativeint.t -> Nativeint.t
val int64 : Random.State.t -> Int64.t -> Int64.t
val float : Random.State.t -> float -> float
val bool : Random.State.t -> bool
end
val get_state : unit -> Random.State.t
val set_state : Random.State.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Set.Make.html 0000644 0001750 0001750 00000033320 13131636450 021100 0 ustar mehdi mehdi
functor (Ord : OrderedType) ->
sig
type elt = Ord.t
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
end ocaml-doc-4.05/ocaml.html/libref/Identifiable.S.T.html 0000644 0001750 0001750 00000017250 13131636451 021417 0 ustar mehdi mehdi
module T:Identifiable.Thingwith type t = t
type
include Hashtbl.HashedType
include Map.OrderedType
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit ocaml-doc-4.05/ocaml.html/libref/type_Weak.S.html 0000644 0001750 0001750 00000025651 13131636452 020573 0 ustar mehdi mehdi
sig
type data
type t
val create : int -> Weak.S.t
val clear : Weak.S.t -> unit
val merge : Weak.S.t -> Weak.S.data -> Weak.S.data
val add : Weak.S.t -> Weak.S.data -> unit
val remove : Weak.S.t -> Weak.S.data -> unit
val find : Weak.S.t -> Weak.S.data -> Weak.S.data
val find_opt : Weak.S.t -> Weak.S.data -> Weak.S.data option
val find_all : Weak.S.t -> Weak.S.data -> Weak.S.data list
val mem : Weak.S.t -> Weak.S.data -> bool
val iter : (Weak.S.data -> unit) -> Weak.S.t -> unit
val fold : (Weak.S.data -> 'a -> 'a) -> Weak.S.t -> 'a -> 'a
val count : Weak.S.t -> int
val stats : Weak.S.t -> int * int * int * int * int * int
end ocaml-doc-4.05/ocaml.html/libref/Depend.StringSet.html 0000644 0001750 0001750 00000062570 13131636443 021563 0 ustar mehdi mehdi
module StringSet:Set.Swith type elt = string
type
type
val empty : tval is_empty : t -> boolval mem : elt -> t -> boolmem x s tests whether x belongs to the set s.val add : elt -> t -> tadd x s returns a set containing all elements of s,
plus x. If x was already in s, s is returned unchanged
(the result of the function is then physically equal to s).val singleton : elt -> tsingleton x returns the one-element set containing only x.val remove : elt -> t -> tremove x s returns a set containing all elements of s,
except x. If x was not in s, s is returned unchanged
(the result of the function is then physically equal to s).val union : t -> t -> tval inter : t -> t -> tval diff : t -> t -> tval compare : t -> t -> intval equal : t -> t -> boolequal s1 s2 tests whether the sets s1 and s2 are
equal, that is, contain equal elements.val subset : t -> t -> boolsubset s1 s2 tests whether the set s1 is a subset of
the set s2.val iter : (elt -> unit) -> t -> unititer f s applies f in turn to all elements of s.
The elements of s are presented to f in increasing order
with respect to the ordering over the type of the elements.val map : (elt -> elt) -> t -> tmap f s is the set whose elements are f a0,f a1... f
aN, where a0,a1...aN are the elements of s.
The elements are passed to f in increasing order
with respect to the ordering over the type of the elements.
If no element of s is changed by f, s is returned
unchanged. (If each output of f is physically equal to its
input, the returned set is physically equal to s.)
Since 4.04.0
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'afold f s a computes (f xN ... (f x2 (f x1 a))...),
where x1 ... xN are the elements of s, in increasing order.val for_all : (elt -> bool) -> t -> boolfor_all p s checks if all elements of the set
satisfy the predicate p.val exists : (elt -> bool) -> t -> boolexists p s checks if at least one element of
the set satisfies the predicate p.val filter : (elt -> bool) -> t -> tfilter p s returns the set of all elements in s
that satisfy predicate p. If p satisfies every element in s,
s is returned unchanged (the result of the function is then
physically equal to s).val partition : (elt -> bool) -> t -> t * tpartition p s returns a pair of sets (s1, s2), where
s1 is the set of all the elements of s that satisfy the
predicate p, and s2 is the set of all the elements of
s that do not satisfy p.val cardinal : t -> intval elements : t -> elt listOrd.compare, where Ord is the argument
given to Set.Make.val min_elt : t -> eltOrd.compare ordering), or raise
Not_found if the set is empty.val min_elt_opt : t -> elt optionOrd.compare ordering), or None
if the set is empty.val max_elt : t -> eltSet.S.min_elt, but returns the largest element of the
given set.val max_elt_opt : t -> elt option
val choose : t -> eltNot_found if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val choose_opt : t -> elt optionNone if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val split : elt -> t -> t * bool * tsplit x s returns a triple (l, present, r), where
l is the set of elements of s that are
strictly less than x;
r is the set of elements of s that are
strictly greater than x;
present is false if s contains no element equal to x,
or true if s contains an element equal to x.val find : elt -> t -> eltfind x s returns the element of s equal to x (according
to Ord.compare), or raise Not_found if no such element
exists.val find_opt : elt -> t -> elt optionfind_opt x s returns the element of s equal to x (according
to Ord.compare), or None if no such element
exists.val find_first : (elt -> bool) -> t -> eltfind_first f s, where f is a monotonically increasing function,
returns the lowest element e of s such that f e,
or raises Not_found if no such element exists.
For example, find_first (fun e -> Ord.compare e x >= 0) s will return
the first element e of s where Ord.compare e x >= 0 (intuitively:
e >= x), or raise Not_found if x is greater than any element of
s.
Since 4.05
val find_first_opt : (elt -> bool) -> t -> elt optionfind_first_opt f s, where f is a monotonically increasing function,
returns an option containing the lowest element e of s such that
f e, or None if no such element exists.val find_last : (elt -> bool) -> t -> eltfind_last f s, where f is a monotonically decreasing function,
returns the highest element e of s such that f e,
or raises Not_found if no such element exists.val find_last_opt : (elt -> bool) -> t -> elt optionfind_last_opt f s, where f is a monotonically decreasing function,
returns an option containing the highest element e of s such that
f e, or None if no such element exists.val of_list : elt list -> tof_list l creates a set from a list of elements.
This is usually more efficient than folding add over the list,
except perhaps for lists with many duplicated elements.module Event:sig..end
This module implements synchronous inter-thread communications over
channels. As in John Reppy's Concurrent ML system, the communication
events are first-class values: they can be built and combined
independently before being offered for communication.
type 'a channel
'a.val new_channel : unit -> 'a channeltype +'a event
'a.val send : 'a channel -> 'a -> unit eventsend ch v returns the event consisting in sending the value v
over the channel ch. The result value of this event is ().val receive : 'a channel -> 'a eventreceive ch returns the event consisting in receiving a value
from the channel ch. The result value of this event is the
value received.val always : 'a -> 'a eventalways v returns an event that is always ready for
synchronization. The result value of this event is v.val choose : 'a event list -> 'a eventchoose evl returns the event that is the alternative of
all the events in the list evl.val wrap : 'a event -> ('a -> 'b) -> 'b eventwrap ev fn returns the event that performs the same communications
as ev, then applies the post-processing function fn
on the return value.val wrap_abort : 'a event -> (unit -> unit) -> 'a eventwrap_abort ev fn returns the event that performs
the same communications as ev, but if it is not selected
the function fn is called after the synchronization.val guard : (unit -> 'a event) -> 'a eventguard fn returns the event that, when synchronized, computes
fn() and behaves as the resulting event. This allows to
compute events with side-effects at the time of the synchronization
operation.val sync : 'a event -> 'aval select : 'a event list -> 'aselect evl is shorthand for sync(choose evl).val poll : 'a event -> 'a optionEvent.sync: offer all the communication
possibilities specified in the event to the outside world,
and if one can take place immediately, perform it and return
Some r where r is the result value of that communication.
Otherwise, return None without blocking.module Identifiable:sig..end
module type Thing =sig..end
module Pair:
module type S =sig..end
module Make:ocaml-doc-4.05/ocaml.html/libref/MoreLabels.Map.Make.html 0000644 0001750 0001750 00000037434 13131636446 022064 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
type
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key:key ->
data:'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge : f:(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : f:(key -> 'a -> 'a -> 'a option) ->
'a t -> 'a t -> 'a t
val compare : cmp:('a -> 'a -> int) ->
'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) ->
'a t -> 'a t -> bool
val iter : f:(key:key -> data:'a -> unit) ->
'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) ->
'a t -> init:'b -> 'b
val for_all : f:(key -> 'a -> bool) -> 'a t -> bool
val exists : f:(key -> 'a -> bool) -> 'a t -> bool
val filter : f:(key -> 'a -> bool) ->
'a t -> 'a t
val partition : f:(key -> 'a -> bool) ->
'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key ->
'a t ->
'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : f:(key -> bool) ->
'a t -> key * 'a
val find_first_opt : f:(key -> bool) ->
'a t -> (key * 'a) option
val find_last : f:(key -> bool) ->
'a t -> key * 'a
val find_last_opt : f:(key -> bool) ->
'a t -> (key * 'a) option
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key -> 'a -> 'b) ->
'a t -> 'b t ocaml-doc-4.05/ocaml.html/libref/ArrayLabels.html 0000644 0001750 0001750 00000070627 13131636441 020644 0 ustar mehdi mehdi
module ArrayLabels:sig..end
val length : 'a array -> intval get : 'a array -> int -> 'aArray.get a n returns the element number n of array a.
The first element has number 0.
The last element has number Array.length a - 1.
You can also write a.(n) instead of Array.get a n.
Raise Invalid_argument "index out of bounds"
if n is outside the range 0 to (Array.length a - 1).
val set : 'a array -> int -> 'a -> unitArray.set a n x modifies array a in place, replacing
element number n with x.
You can also write a.(n) <- x instead of Array.set a n x.
Raise Invalid_argument "index out of bounds"
if n is outside the range 0 to Array.length a - 1.
val make : int -> 'a -> 'a arrayArray.make n x returns a fresh array of length n,
initialized with x.
All the elements of this new array are initially
physically equal to x (in the sense of the == predicate).
Consequently, if x is mutable, it is shared among all elements
of the array, and modifying x through one of the array entries
will modify all other entries at the same time.
Raise Invalid_argument if n < 0 or n > Sys.max_array_length.
If the value of x is a floating-point number, then the maximum
size is only Sys.max_array_length / 2.
val create : int -> 'a -> 'a array
val init : int -> f:(int -> 'a) -> 'a arrayArray.init n f returns a fresh array of length n,
with element number i initialized to the result of f i.
In other terms, Array.init n f tabulates the results of f
applied to the integers 0 to n-1.
Raise Invalid_argument if n < 0 or n > Sys.max_array_length.
If the return type of f is float, then the maximum
size is only Sys.max_array_length / 2.
val make_matrix : dimx:int -> dimy:int -> 'a -> 'a array arrayArray.make_matrix dimx dimy e returns a two-dimensional array
(an array of arrays) with first dimension dimx and
second dimension dimy. All the elements of this new matrix
are initially physically equal to e.
The element (x,y) of a matrix m is accessed
with the notation m.(x).(y).
Raise Invalid_argument if dimx or dimy is negative or
greater than Sys.max_array_length.
If the value of e is a floating-point number, then the maximum
size is only Sys.max_array_length / 2.
val create_matrix : dimx:int -> dimy:int -> 'a -> 'a array array
val append : 'a array -> 'a array -> 'a arrayArray.append v1 v2 returns a fresh array containing the
concatenation of the arrays v1 and v2.val concat : 'a array list -> 'a arrayArray.append, but concatenates a list of arrays.val sub : 'a array -> pos:int -> len:int -> 'a arrayArray.sub a start len returns a fresh array of length len,
containing the elements number start to start + len - 1
of array a.
Raise Invalid_argument "Array.sub" if start and len do not
designate a valid subarray of a; that is, if
start < 0, or len < 0, or start + len > Array.length a.
val copy : 'a array -> 'a arrayArray.copy a returns a copy of a, that is, a fresh array
containing the same elements as a.val fill : 'a array -> pos:int -> len:int -> 'a -> unitArray.fill a ofs len x modifies the array a in place,
storing x in elements number ofs to ofs + len - 1.
Raise Invalid_argument "Array.fill" if ofs and len do not
designate a valid subarray of a.
val blit : src:'a array -> src_pos:int -> dst:'a array -> dst_pos:int -> len:int -> unitArray.blit v1 o1 v2 o2 len copies len elements
from array v1, starting at element number o1, to array v2,
starting at element number o2. It works correctly even if
v1 and v2 are the same array, and the source and
destination chunks overlap.
Raise Invalid_argument "Array.blit" if o1 and len do not
designate a valid subarray of v1, or if o2 and len do not
designate a valid subarray of v2.
val to_list : 'a array -> 'a listArray.to_list a returns the list of all the elements of a.val of_list : 'a list -> 'a arrayArray.of_list l returns a fresh array containing the elements
of l.val iter : f:('a -> unit) -> 'a array -> unitArray.iter f a applies function f in turn to all
the elements of a. It is equivalent to
f a.(0); f a.(1); ...; f a.(Array.length a - 1); ().val map : f:('a -> 'b) -> 'a array -> 'b arrayArray.map f a applies function f to all the elements of a,
and builds an array with the results returned by f:
[| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |].val iteri : f:(int -> 'a -> unit) -> 'a array -> unitArray.iter, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.val mapi : f:(int -> 'a -> 'b) -> 'a array -> 'b arrayArray.map, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b array -> 'aArray.fold_left f x a computes
f (... (f (f x a.(0)) a.(1)) ...) a.(n-1),
where n is the length of the array a.val fold_right : f:('b -> 'a -> 'a) -> 'b array -> init:'a -> 'aArray.fold_right f a x computes
f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...)),
where n is the length of the array a.val iter2 : f:('a -> 'b -> unit) -> 'a array -> 'b array -> unitArray.iter2 f a b applies function f to all the elements of a
and b.
Raise Invalid_argument if the arrays are not the same size.val map2 : f:('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c arrayArray.map2 f a b applies function f to all the elements of a
and b, and builds an array with the results returned by f:
[| f a.(0) b.(0); ...; f a.(Array.length a - 1) b.(Array.length b - 1)|].
Raise Invalid_argument if the arrays are not the same size.val exists : f:('a -> bool) -> 'a array -> boolArray.exists p [|a1; ...; an|] checks if at least one element of
the array satisfies the predicate p. That is, it returns
(p a1) || (p a2) || ... || (p an).val for_all : f:('a -> bool) -> 'a array -> boolArray.for_all p [|a1; ...; an|] checks if all elements of the array
satisfy the predicate p. That is, it returns
(p a1) && (p a2) && ... && (p an).val mem : 'a -> set:'a array -> boolmem x a is true if and only if x is equal
to an element of a.val memq : 'a -> set:'a array -> boolArray.mem, but uses physical equality instead of structural
equality to compare list elements.val create_float : int -> float arrayArray.create_float n returns a fresh float array of length n,
with uninitialized data.val make_float : int -> float array
val sort : cmp:('a -> 'a -> int) -> 'a array -> unitcompare is
a suitable comparison function, provided there are no floating-point
NaN values in the data. After calling Array.sort, the
array is sorted in place in increasing order.
Array.sort is guaranteed to run in constant heap space
and (at most) logarithmic stack space.
The current implementation uses Heap Sort. It runs in constant stack space.
Specification of the comparison function:
Let a be the array and cmp the comparison function. The following
must be true for all x, y, z in a :
cmp x y > 0 if and only if cmp y x < 0cmp x y >= 0 and cmp y z >= 0 then cmp x z >= 0Array.sort returns, a contains the same elements as before,
reordered in such a way that for all i and j valid indices of a :cmp a.(i) a.(j) >= 0 if and only if i >= jval stable_sort : cmp:('a -> 'a -> int) -> 'a array -> unitArray.sort, but the sorting algorithm is stable (i.e.
elements that compare equal are kept in their original order) and
not guaranteed to run in constant heap space.
The current implementation uses Merge Sort. It uses n/2
words of heap space, where n is the length of the array.
It is usually faster than the current implementation of Array.sort.
val fast_sort : cmp:('a -> 'a -> int) -> 'a array -> unit
ocaml-doc-4.05/ocaml.html/libref/type_Identifiable.Make.html 0000644 0001750 0001750 00000127331 13131636444 022735 0 ustar mehdi mehdi
functor (T : Thing) ->
sig
module T :
sig
type t = T.t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
val to_string : t -> string
val of_list : elt list -> t
val map : (elt -> elt) -> t -> t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map : 'a t -> f:(key -> 'a -> 'b option) -> 'b t
val of_list : (key * 'a) list -> 'a t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) -> 'a t -> 'a t -> 'a t
val union_right : 'a t -> 'a t -> 'a t
val union_left : 'a t -> 'a t -> 'a t
val union_merge : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val rename : key t -> key -> key
val map_keys : (key -> key) -> 'a t -> 'a t
val keys : 'a t -> Set.t
val data : 'a t -> 'a list
val of_set : (key -> 'a) -> Set.t -> 'a t
val transpose_keys_and_data : key t -> key t
val transpose_keys_and_data_set : key t -> Set.t t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a t -> (T.t * 'a) list
val of_list : (T.t * 'a) list -> 'a t
val to_map : 'a t -> 'a Map.t
val of_map : 'a Map.t -> 'a t
val memoize : 'a t -> (key -> 'a) -> key -> 'a
val map : 'a t -> ('a -> 'b) -> 'b t
end
end ocaml-doc-4.05/ocaml.html/libref/Numbers.Int.html 0000644 0001750 0001750 00000016377 13131636447 020617 0 ustar mehdi mehdi
module Int:sig..end
include Identifiable.S
val zero_to_n : int -> Set.tzero_to_n n is the set of numbers {0, ..., n} (inclusive).module Attr_helper:sig..end
type
| |
Multiple_attributes of |
| |
No_payload_expected of |
val get_no_payload_attribute : string list -> Parsetree.attributes -> string Asttypes.loc optionstring list argument of the following functions is a list of
alternative names for the attribute we are looking for. For instance:
["foo"; "ocaml.foo"]
val has_no_payload_attribute : string list -> Parsetree.attributes -> bool
exception Error of Location.t * error
val report_error : Format.formatter -> error -> unit ocaml-doc-4.05/ocaml.html/libref/type_Char.html 0000644 0001750 0001750 00000020230 13131636443 020344 0 ustar mehdi mehdi
sig
external code : char -> int = "%identity"
val chr : int -> char
val escaped : char -> string
val lowercase : char -> char
val uppercase : char -> char
val lowercase_ascii : char -> char
val uppercase_ascii : char -> char
type t = char
val compare : Char.t -> Char.t -> int
val equal : Char.t -> Char.t -> bool
external unsafe_chr : int -> char = "%identity"
end ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.K2.MakeSeeded.html 0000644 0001750 0001750 00000027734 13131636443 023672 0 ustar mehdi mehdi
functor (H1 : Hashtbl.SeededHashedType) (H2 : Hashtbl.SeededHashedType) ->
sig
type key = H1.t * H2.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/Map.Make.html 0000644 0001750 0001750 00000071253 13131636445 020034 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
type
type +'a t
key to type 'a.val empty : 'a tval is_empty : 'a t -> boolval mem : key -> 'a t -> boolmem x m returns true if m contains a binding for x,
and false otherwise.val add : key -> 'a -> 'a t -> 'a tadd x y m returns a map containing the same bindings as
m, plus a binding of x to y. If x was already bound
in m to a value that is physically equal to y,
m is returned unchanged (the result of the function is
then physically equal to m). Otherwise, the previous binding
of x in m disappears.val singleton : key -> 'a -> 'a tsingleton x y returns the one-element map that contains a binding y
for x.val remove : key -> 'a t -> 'a tremove x m returns a map containing the same bindings as
m, except for x which is unbound in the returned map.
If x was not in m, m is returned unchanged
(the result of the function is then physically equal to m).val merge : (key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c tmerge f m1 m2 computes a map whose keys is a subset of keys of m1
and of m2. The presence of each such binding, and the corresponding
value, is determined with the function f.
In terms of the find_opt operation, we have
find_opt x (merge f m1 m2) = f (find_opt x m1) (find_opt x m2)
for any key x, provided that f None None = None.val union : (key -> 'a -> 'a -> 'a option) ->
'a t -> 'a t -> 'a tunion f m1 m2 computes a map whose keys is the union of keys
of m1 and of m2. When the same binding is defined in both
arguments, the function f is used to combine them.
This is a special case of merge: union f m1 m2 is equivalent
to merge f' m1 m2, wheref' None None = Nonef' (Some v) None = Some vf' None (Some v) = Some vf' (Some v1) (Some v2) = f v1 v2val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> intval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> boolequal cmp m1 m2 tests whether the maps m1 and m2 are
equal, that is, contain equal keys and associate them with
equal data. cmp is the equality predicate used to compare
the data associated with the keys.val iter : (key -> 'a -> unit) -> 'a t -> unititer f m applies f to all bindings in map m.
f receives the key as first argument, and the associated value
as second argument. The bindings are passed to f in increasing
order with respect to the ordering over the type of the keys.val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'bfold f m a computes (f kN dN ... (f k1 d1 a)...),
where k1 ... kN are the keys of all bindings in m
(in increasing order), and d1 ... dN are the associated data.val for_all : (key -> 'a -> bool) -> 'a t -> boolfor_all p m checks if all the bindings of the map
satisfy the predicate p.val exists : (key -> 'a -> bool) -> 'a t -> boolexists p m checks if at least one binding of the map
satisfies the predicate p.val filter : (key -> 'a -> bool) -> 'a t -> 'a tfilter p m returns the map with all the bindings in m
that satisfy predicate p. If p satisfies every binding in m,
m is returned unchanged (the result of the function is then
physically equal to m)val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a tpartition p m returns a pair of maps (m1, m2), where
m1 contains all the bindings of s that satisfy the
predicate p, and m2 is the map with all the bindings of
s that do not satisfy p.val cardinal : 'a t -> intval bindings : 'a t -> (key * 'a) listOrd.compare, where Ord is the argument
given to Map.Make.val min_binding : 'a t -> key * 'aOrd.compare ordering), or raise
Not_found if the map is empty.val min_binding_opt : 'a t -> (key * 'a) optionOrd.compare ordering), or None
if the map is empty.val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'aNot_found if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val choose_opt : 'a t -> (key * 'a) optionNone if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val split : key -> 'a t -> 'a t * 'a option * 'a tsplit x m returns a triple (l, data, r), where
l is the map with all the bindings of m whose key
is strictly less than x;
r is the map with all the bindings of m whose key
is strictly greater than x;
data is None if m contains no binding for x,
or Some v if m binds v to x.val find : key -> 'a t -> 'afind x m returns the current binding of x in m,
or raises Not_found if no such binding exists.val find_opt : key -> 'a t -> 'a optionfind_opt x m returns Some v if the current binding of x
in m is v, or None if no such binding exists.val find_first : (key -> bool) -> 'a t -> key * 'afind_first f m, where f is a monotonically increasing function,
returns the binding of m with the lowest key k such that f k,
or raises Not_found if no such key exists.
For example, find_first (fun k -> Ord.compare k x >= 0) m will return
the first binding k, v of m where Ord.compare k x >= 0
(intuitively: k >= x), or raise Not_found if x is greater than any
element of m.
Since 4.05
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_first_opt f m, where f is a monotonically increasing function,
returns an option containing the binding of m with the lowest key k
such that f k, or None if no such key exists.val find_last : (key -> bool) -> 'a t -> key * 'afind_last f m, where f is a monotonically decreasing function,
returns the binding of m with the highest key k such that f k,
or raises Not_found if no such key exists.val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_last_opt f m, where f is a monotonically decreasing function,
returns an option containing the binding of m with the highest key k
such that f k, or None if no such key exists.val map : ('a -> 'b) -> 'a t -> 'b tmap f m returns a map with same domain as m, where the
associated value a of all bindings of m has been
replaced by the result of the application of f to a.
The bindings are passed to f in increasing order
with respect to the ordering over the type of the keys.val mapi : (key -> 'a -> 'b) -> 'a t -> 'b tMap.S.map, but the function receives as arguments both the
key and the associated value for each binding of the map.module type S =sig..end
Map.Make.type
type +'a t
key to type 'a.val empty : 'a tval is_empty : 'a t -> boolval mem : key -> 'a t -> boolmem x m returns true if m contains a binding for x,
and false otherwise.val add : key -> 'a -> 'a t -> 'a tadd x y m returns a map containing the same bindings as
m, plus a binding of x to y. If x was already bound
in m to a value that is physically equal to y,
m is returned unchanged (the result of the function is
then physically equal to m). Otherwise, the previous binding
of x in m disappears.val singleton : key -> 'a -> 'a tsingleton x y returns the one-element map that contains a binding y
for x.val remove : key -> 'a t -> 'a tremove x m returns a map containing the same bindings as
m, except for x which is unbound in the returned map.
If x was not in m, m is returned unchanged
(the result of the function is then physically equal to m).val merge : (key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c tmerge f m1 m2 computes a map whose keys is a subset of keys of m1
and of m2. The presence of each such binding, and the corresponding
value, is determined with the function f.
In terms of the find_opt operation, we have
find_opt x (merge f m1 m2) = f (find_opt x m1) (find_opt x m2)
for any key x, provided that f None None = None.val union : (key -> 'a -> 'a -> 'a option) ->
'a t -> 'a t -> 'a tunion f m1 m2 computes a map whose keys is the union of keys
of m1 and of m2. When the same binding is defined in both
arguments, the function f is used to combine them.
This is a special case of merge: union f m1 m2 is equivalent
to merge f' m1 m2, wheref' None None = Nonef' (Some v) None = Some vf' None (Some v) = Some vf' (Some v1) (Some v2) = f v1 v2val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> intval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> boolequal cmp m1 m2 tests whether the maps m1 and m2 are
equal, that is, contain equal keys and associate them with
equal data. cmp is the equality predicate used to compare
the data associated with the keys.val iter : (key -> 'a -> unit) -> 'a t -> unititer f m applies f to all bindings in map m.
f receives the key as first argument, and the associated value
as second argument. The bindings are passed to f in increasing
order with respect to the ordering over the type of the keys.val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'bfold f m a computes (f kN dN ... (f k1 d1 a)...),
where k1 ... kN are the keys of all bindings in m
(in increasing order), and d1 ... dN are the associated data.val for_all : (key -> 'a -> bool) -> 'a t -> boolfor_all p m checks if all the bindings of the map
satisfy the predicate p.val exists : (key -> 'a -> bool) -> 'a t -> boolexists p m checks if at least one binding of the map
satisfies the predicate p.val filter : (key -> 'a -> bool) -> 'a t -> 'a tfilter p m returns the map with all the bindings in m
that satisfy predicate p. If p satisfies every binding in m,
m is returned unchanged (the result of the function is then
physically equal to m)val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a tpartition p m returns a pair of maps (m1, m2), where
m1 contains all the bindings of s that satisfy the
predicate p, and m2 is the map with all the bindings of
s that do not satisfy p.val cardinal : 'a t -> intval bindings : 'a t -> (key * 'a) listOrd.compare, where Ord is the argument
given to Map.Make.val min_binding : 'a t -> key * 'aOrd.compare ordering), or raise
Not_found if the map is empty.val min_binding_opt : 'a t -> (key * 'a) optionOrd.compare ordering), or None
if the map is empty.val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'aNot_found if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val choose_opt : 'a t -> (key * 'a) optionNone if
the map is empty. Which binding is chosen is unspecified,
but equal bindings will be chosen for equal maps.val split : key -> 'a t -> 'a t * 'a option * 'a tsplit x m returns a triple (l, data, r), where
l is the map with all the bindings of m whose key
is strictly less than x;
r is the map with all the bindings of m whose key
is strictly greater than x;
data is None if m contains no binding for x,
or Some v if m binds v to x.val find : key -> 'a t -> 'afind x m returns the current binding of x in m,
or raises Not_found if no such binding exists.val find_opt : key -> 'a t -> 'a optionfind_opt x m returns Some v if the current binding of x
in m is v, or None if no such binding exists.val find_first : (key -> bool) -> 'a t -> key * 'afind_first f m, where f is a monotonically increasing function,
returns the binding of m with the lowest key k such that f k,
or raises Not_found if no such key exists.
For example, find_first (fun k -> Ord.compare k x >= 0) m will return
the first binding k, v of m where Ord.compare k x >= 0
(intuitively: k >= x), or raise Not_found if x is greater than any
element of m.
Since 4.05
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_first_opt f m, where f is a monotonically increasing function,
returns an option containing the binding of m with the lowest key k
such that f k, or None if no such key exists.val find_last : (key -> bool) -> 'a t -> key * 'afind_last f m, where f is a monotonically decreasing function,
returns the binding of m with the highest key k such that f k,
or raises Not_found if no such key exists.val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) optionfind_last_opt f m, where f is a monotonically decreasing function,
returns an option containing the binding of m with the highest key k
such that f k, or None if no such key exists.val map : ('a -> 'b) -> 'a t -> 'b tmap f m returns a map with same domain as m, where the
associated value a of all bindings of m has been
replaced by the result of the application of f to a.
The bindings are passed to f in increasing order
with respect to the ordering over the type of the keys.val mapi : (key -> 'a -> 'b) -> 'a t -> 'b tMap.S.map, but the function receives as arguments both the
key and the associated value for each binding of the map.module Thread:sig..end
1003.1c and Win32.type
val create : ('a -> 'b) -> 'a -> tThread.create funct arg creates a new thread of control,
in which the function application funct arg
is executed concurrently with the other threads of the program.
The application of Thread.create
returns the handle of the newly created thread.
The new thread terminates when the application funct arg
returns, either normally or by raising an uncaught exception.
In the latter case, the exception is printed on standard error,
but not propagated back to the parent thread. Similarly, the
result of the application funct arg is discarded and not
directly accessible to the parent thread.val self : unit -> tval id : t -> intval exit : unit -> unitval kill : t -> unitval delay : float -> unitdelay d suspends the execution of the calling thread for
d seconds. The other program threads continue to run during
this time.val join : t -> unitjoin th suspends the execution of the calling thread
until the thread th has terminated.val wait_read : Unix.file_descr -> unitThread.wait_write.val wait_write : Unix.file_descr -> unitval wait_timed_read : Unix.file_descr -> float -> bool
val wait_timed_write : Unix.file_descr -> float -> boolwait_read) or
one character can be written without blocking (wait_write)
on the given Unix file descriptor. Wait for at most
the amount of time given as second argument (in seconds).
Return true if the file descriptor is ready for input/output
and false if the timeout expired.
These functions return immediately true in the Win32
implementation.
val select : Unix.file_descr list ->
Unix.file_descr list ->
Unix.file_descr list ->
float -> Unix.file_descr list * Unix.file_descr list * Unix.file_descr listUnix.select.
This function is not implemented yet under Win32.val wait_pid : int -> int * Unix.process_statuswait_pid p suspends the execution of the calling thread
until the process specified by the process identifier p
terminates. Returns the pid of the child caught and
its termination status, as per Unix.wait.
This function is not implemented under MacOS.val yield : unit -> unitThread.sigmask. This set is inherited at thread creation time.
Per-thread signal masks are supported only by the system thread library
under Unix, but not under Win32, nor by the VM thread library.val sigmask : Unix.sigprocmask_command -> int list -> int listsigmask cmd sigs changes the set of blocked signals for the
calling thread.
If cmd is SIG_SETMASK, blocked signals are set to those in
the list sigs.
If cmd is SIG_BLOCK, the signals in sigs are added to
the set of blocked signals.
If cmd is SIG_UNBLOCK, the signals in sigs are removed
from the set of blocked signals.
sigmask returns the set of previously blocked signals for the thread.val wait_signal : int list -> intwait_signal sigs suspends the execution of the calling thread
until the process receives one of the signals specified in the
list sigs. It then returns the number of the signal received.
Signal handlers attached to the signals in sigs will not
be invoked. The signals sigs are expected to be blocked before
calling wait_signal.module Sig:sig..end
val mk : ?loc:Ast_helper.loc ->
Parsetree.signature_item_desc -> Parsetree.signature_item
val value : ?loc:Ast_helper.loc ->
Parsetree.value_description -> Parsetree.signature_item
val type_ : ?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.type_declaration list -> Parsetree.signature_item
val type_extension : ?loc:Ast_helper.loc -> Parsetree.type_extension -> Parsetree.signature_item
val exception_ : ?loc:Ast_helper.loc ->
Parsetree.extension_constructor -> Parsetree.signature_item
val module_ : ?loc:Ast_helper.loc ->
Parsetree.module_declaration -> Parsetree.signature_item
val rec_module : ?loc:Ast_helper.loc ->
Parsetree.module_declaration list -> Parsetree.signature_item
val modtype : ?loc:Ast_helper.loc ->
Parsetree.module_type_declaration -> Parsetree.signature_item
val open_ : ?loc:Ast_helper.loc -> Parsetree.open_description -> Parsetree.signature_item
val include_ : ?loc:Ast_helper.loc ->
Parsetree.include_description -> Parsetree.signature_item
val class_ : ?loc:Ast_helper.loc ->
Parsetree.class_description list -> Parsetree.signature_item
val class_type : ?loc:Ast_helper.loc ->
Parsetree.class_type_declaration list -> Parsetree.signature_item
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.signature_item
val attribute : ?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.signature_item
val text : Docstrings.text -> Parsetree.signature_item list ocaml-doc-4.05/ocaml.html/libref/type_Stack.html 0000644 0001750 0001750 00000022552 13131636450 020543 0 ustar mehdi mehdi
sig
type 'a t
exception Empty
val create : unit -> 'a Stack.t
val push : 'a -> 'a Stack.t -> unit
val pop : 'a Stack.t -> 'a
val top : 'a Stack.t -> 'a
val clear : 'a Stack.t -> unit
val copy : 'a Stack.t -> 'a Stack.t
val is_empty : 'a Stack.t -> bool
val length : 'a Stack.t -> int
val iter : ('a -> unit) -> 'a Stack.t -> unit
val fold : ('b -> 'a -> 'b) -> 'b -> 'a Stack.t -> 'b
end ocaml-doc-4.05/ocaml.html/libref/type_CamlinternalFormat.html 0000644 0001750 0001750 00000075345 13131636442 023271 0 ustar mehdi mehdi
sig
val is_in_char_set : CamlinternalFormatBasics.char_set -> char -> bool
val rev_char_set :
CamlinternalFormatBasics.char_set -> CamlinternalFormatBasics.char_set
type mutable_char_set = bytes
val create_char_set : unit -> CamlinternalFormat.mutable_char_set
val add_in_char_set : CamlinternalFormat.mutable_char_set -> char -> unit
val freeze_char_set :
CamlinternalFormat.mutable_char_set -> CamlinternalFormatBasics.char_set
type ('a, 'b, 'c, 'd, 'e, 'f) param_format_ebb =
Param_format_EBB :
('x -> 'a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormat.param_format_ebb
val param_format_of_ignored_format :
('a, 'b, 'c, 'd, 'y, 'x) CamlinternalFormatBasics.ignored ->
('x, 'b, 'c, 'y, 'e, 'f) CamlinternalFormatBasics.fmt ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormat.param_format_ebb
type ('b, 'c) acc_formatting_gen =
Acc_open_tag of ('b, 'c) CamlinternalFormat.acc
| Acc_open_box of ('b, 'c) CamlinternalFormat.acc
and ('b, 'c) acc =
Acc_formatting_lit of ('b, 'c) CamlinternalFormat.acc *
CamlinternalFormatBasics.formatting_lit
| Acc_formatting_gen of ('b, 'c) CamlinternalFormat.acc *
('b, 'c) CamlinternalFormat.acc_formatting_gen
| Acc_string_literal of ('b, 'c) CamlinternalFormat.acc * string
| Acc_char_literal of ('b, 'c) CamlinternalFormat.acc * char
| Acc_data_string of ('b, 'c) CamlinternalFormat.acc * string
| Acc_data_char of ('b, 'c) CamlinternalFormat.acc * char
| Acc_delay of ('b, 'c) CamlinternalFormat.acc * ('b -> 'c)
| Acc_flush of ('b, 'c) CamlinternalFormat.acc
| Acc_invalid_arg of ('b, 'c) CamlinternalFormat.acc * string
| End_of_acc
type ('a, 'b) heter_list =
Cons : 'c *
('a, 'b) CamlinternalFormat.heter_list -> ('c -> 'a, 'b)
CamlinternalFormat.heter_list
| Nil : ('b, 'b) CamlinternalFormat.heter_list
type ('b, 'c, 'e, 'f) fmt_ebb =
Fmt_EBB :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('b, 'c, 'e,
'f)
CamlinternalFormat.fmt_ebb
val make_printf :
('b -> ('b, 'c) CamlinternalFormat.acc -> 'd) ->
'b ->
('b, 'c) CamlinternalFormat.acc ->
('a, 'b, 'c, 'c, 'c, 'd) CamlinternalFormatBasics.fmt -> 'a
val make_iprintf :
('b -> 'f) ->
'b -> ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> 'a
val output_acc :
Pervasives.out_channel ->
(Pervasives.out_channel, unit) CamlinternalFormat.acc -> unit
val bufput_acc :
Buffer.t -> (Buffer.t, unit) CamlinternalFormat.acc -> unit
val strput_acc : Buffer.t -> (unit, string) CamlinternalFormat.acc -> unit
val type_format :
('x, 'b, 'c, 't, 'u, 'v) CamlinternalFormatBasics.fmt ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt
val fmt_ebb_of_string :
?legacy_behavior:bool ->
string -> ('b, 'c, 'e, 'f) CamlinternalFormat.fmt_ebb
val format_of_string_fmtty :
string ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6
val format_of_string_format :
string ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6 ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6
val char_of_iconv : CamlinternalFormatBasics.int_conv -> char
val string_of_formatting_lit :
CamlinternalFormatBasics.formatting_lit -> string
val string_of_formatting_gen :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.formatting_gen ->
string
val string_of_fmtty :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty -> string
val string_of_fmt :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> string
val open_box_of_string :
string -> int * CamlinternalFormatBasics.block_type
val symm :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('a2, 'b2, 'c2, 'd2, 'e2, 'f2, 'a1, 'b1, 'c1, 'd1, 'e1, 'f1)
CamlinternalFormatBasics.fmtty_rel
val trans :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('a2, 'b2, 'c2, 'd2, 'e2, 'f2, 'a3, 'b3, 'c3, 'd3, 'e3, 'f3)
CamlinternalFormatBasics.fmtty_rel ->
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a3, 'b3, 'c3, 'd3, 'e3, 'f3)
CamlinternalFormatBasics.fmtty_rel
val recast :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1) CamlinternalFormatBasics.fmt ->
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('a2, 'b2, 'c2, 'd2, 'e2, 'f2) CamlinternalFormatBasics.fmt
end ocaml-doc-4.05/ocaml.html/libref/type_Bigarray.html 0000644 0001750 0001750 00000236626 13131636442 021250 0 ustar mehdi mehdi
sig
type float32_elt = Float32_elt
type float64_elt = Float64_elt
type int8_signed_elt = Int8_signed_elt
type int8_unsigned_elt = Int8_unsigned_elt
type int16_signed_elt = Int16_signed_elt
type int16_unsigned_elt = Int16_unsigned_elt
type int32_elt = Int32_elt
type int64_elt = Int64_elt
type int_elt = Int_elt
type nativeint_elt = Nativeint_elt
type complex32_elt = Complex32_elt
type complex64_elt = Complex64_elt
type ('a, 'b) kind =
Float32 : (float, Bigarray.float32_elt) Bigarray.kind
| Float64 : (float, Bigarray.float64_elt) Bigarray.kind
| Int8_signed : (int, Bigarray.int8_signed_elt) Bigarray.kind
| Int8_unsigned : (int, Bigarray.int8_unsigned_elt) Bigarray.kind
| Int16_signed : (int, Bigarray.int16_signed_elt) Bigarray.kind
| Int16_unsigned : (int, Bigarray.int16_unsigned_elt) Bigarray.kind
| Int32 : (int32, Bigarray.int32_elt) Bigarray.kind
| Int64 : (int64, Bigarray.int64_elt) Bigarray.kind
| Int : (int, Bigarray.int_elt) Bigarray.kind
| Nativeint : (nativeint, Bigarray.nativeint_elt) Bigarray.kind
| Complex32 : (Complex.t, Bigarray.complex32_elt) Bigarray.kind
| Complex64 : (Complex.t, Bigarray.complex64_elt) Bigarray.kind
| Char : (char, Bigarray.int8_unsigned_elt) Bigarray.kind
val float32 : (float, Bigarray.float32_elt) Bigarray.kind
val float64 : (float, Bigarray.float64_elt) Bigarray.kind
val complex32 : (Complex.t, Bigarray.complex32_elt) Bigarray.kind
val complex64 : (Complex.t, Bigarray.complex64_elt) Bigarray.kind
val int8_signed : (int, Bigarray.int8_signed_elt) Bigarray.kind
val int8_unsigned : (int, Bigarray.int8_unsigned_elt) Bigarray.kind
val int16_signed : (int, Bigarray.int16_signed_elt) Bigarray.kind
val int16_unsigned : (int, Bigarray.int16_unsigned_elt) Bigarray.kind
val int : (int, Bigarray.int_elt) Bigarray.kind
val int32 : (int32, Bigarray.int32_elt) Bigarray.kind
val int64 : (int64, Bigarray.int64_elt) Bigarray.kind
val nativeint : (nativeint, Bigarray.nativeint_elt) Bigarray.kind
val char : (char, Bigarray.int8_unsigned_elt) Bigarray.kind
val kind_size_in_bytes : ('a, 'b) Bigarray.kind -> int
type c_layout = C_layout_typ
type fortran_layout = Fortran_layout_typ
type 'a layout =
C_layout : Bigarray.c_layout Bigarray.layout
| Fortran_layout : Bigarray.fortran_layout Bigarray.layout
val c_layout : Bigarray.c_layout Bigarray.layout
val fortran_layout : Bigarray.fortran_layout Bigarray.layout
module Genarray :
sig
type ('a, 'b, 'c) t
external create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int array -> ('a, 'b, 'c) Bigarray.Genarray.t
= "caml_ba_create"
external num_dims : ('a, 'b, 'c) Bigarray.Genarray.t -> int
= "caml_ba_num_dims"
val dims : ('a, 'b, 'c) Bigarray.Genarray.t -> int array
external nth_dim : ('a, 'b, 'c) Bigarray.Genarray.t -> int -> int
= "caml_ba_dim"
external kind :
('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout :
('a, 'b, 'c) Bigarray.Genarray.t -> 'c Bigarray.layout
= "caml_ba_layout"
external change_layout :
('a, 'b, 'c) Bigarray.Genarray.t ->
'd Bigarray.layout -> ('a, 'b, 'd) Bigarray.Genarray.t
= "caml_ba_change_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Genarray.t -> int
external get : ('a, 'b, 'c) Bigarray.Genarray.t -> int array -> 'a
= "caml_ba_get_generic"
external set :
('a, 'b, 'c) Bigarray.Genarray.t -> int array -> 'a -> unit
= "caml_ba_set_generic"
external sub_left :
('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t
= "caml_ba_sub"
external sub_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t
= "caml_ba_sub"
external slice_left :
('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t ->
int array -> ('a, 'b, Bigarray.c_layout) Bigarray.Genarray.t
= "caml_ba_slice"
external slice_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t ->
int array -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Genarray.t
= "caml_ba_slice"
external blit :
('a, 'b, 'c) Bigarray.Genarray.t ->
('a, 'b, 'c) Bigarray.Genarray.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Genarray.t -> 'a -> unit
= "caml_ba_fill"
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int array -> ('a, 'b, 'c) Bigarray.Genarray.t
end
module Array0 :
sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> ('a, 'b, 'c) Bigarray.Array0.t
external kind :
('a, 'b, 'c) Bigarray.Array0.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array0.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array0.t -> int
val get : ('a, 'b, 'c) Bigarray.Array0.t -> 'a
val set : ('a, 'b, 'c) Bigarray.Array0.t -> 'a -> unit
external blit :
('a, 'b, 'c) Bigarray.Array0.t ->
('a, 'b, 'c) Bigarray.Array0.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array0.t -> 'a -> unit
= "caml_ba_fill"
val of_value :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a -> ('a, 'b, 'c) Bigarray.Array0.t
end
module Array1 :
sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> ('a, 'b, 'c) Bigarray.Array1.t
external dim : ('a, 'b, 'c) Bigarray.Array1.t -> int = "%caml_ba_dim_1"
external kind :
('a, 'b, 'c) Bigarray.Array1.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array1.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array1.t -> int
external get : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a
= "%caml_ba_ref_1"
external set : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a -> unit
= "%caml_ba_set_1"
external sub :
('a, 'b, 'c) Bigarray.Array1.t ->
int -> int -> ('a, 'b, 'c) Bigarray.Array1.t = "caml_ba_sub"
val slice :
('a, 'b, 'c) Bigarray.Array1.t ->
int -> ('a, 'b, 'c) Bigarray.Array0.t
external blit :
('a, 'b, 'c) Bigarray.Array1.t ->
('a, 'b, 'c) Bigarray.Array1.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array1.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array -> ('a, 'b, 'c) Bigarray.Array1.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> bool -> int -> ('a, 'b, 'c) Bigarray.Array1.t
external unsafe_get : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a
= "%caml_ba_unsafe_ref_1"
external unsafe_set :
('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a -> unit
= "%caml_ba_unsafe_set_1"
end
module Array2 :
sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> int -> ('a, 'b, 'c) Bigarray.Array2.t
external dim1 : ('a, 'b, 'c) Bigarray.Array2.t -> int
= "%caml_ba_dim_1"
external dim2 : ('a, 'b, 'c) Bigarray.Array2.t -> int
= "%caml_ba_dim_2"
external kind :
('a, 'b, 'c) Bigarray.Array2.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array2.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array2.t -> int
external get : ('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a
= "%caml_ba_ref_2"
external set :
('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a -> unit
= "%caml_ba_set_2"
external sub_left :
('a, 'b, Bigarray.c_layout) Bigarray.Array2.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array2.t
= "caml_ba_sub"
external sub_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t
= "caml_ba_sub"
val slice_left :
('a, 'b, Bigarray.c_layout) Bigarray.Array2.t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t
val slice_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.t
external blit :
('a, 'b, 'c) Bigarray.Array2.t ->
('a, 'b, 'c) Bigarray.Array2.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array2.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
'a array array -> ('a, 'b, 'c) Bigarray.Array2.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int -> int -> ('a, 'b, 'c) Bigarray.Array2.t
external unsafe_get :
('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a
= "%caml_ba_unsafe_ref_2"
external unsafe_set :
('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a -> unit
= "%caml_ba_unsafe_set_2"
end
module Array3 :
sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
int -> int -> int -> ('a, 'b, 'c) Bigarray.Array3.t
external dim1 : ('a, 'b, 'c) Bigarray.Array3.t -> int
= "%caml_ba_dim_1"
external dim2 : ('a, 'b, 'c) Bigarray.Array3.t -> int
= "%caml_ba_dim_2"
external dim3 : ('a, 'b, 'c) Bigarray.Array3.t -> int
= "%caml_ba_dim_3"
external kind :
('a, 'b, 'c) Bigarray.Array3.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array3.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array3.t -> int
external get :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a
= "%caml_ba_ref_3"
external set :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a -> unit
= "%caml_ba_set_3"
external sub_left :
('a, 'b, Bigarray.c_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array3.t
= "caml_ba_sub"
external sub_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t
= "caml_ba_sub"
val slice_left_1 :
('a, 'b, Bigarray.c_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t
val slice_right_1 :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.t
val slice_left_2 :
('a, 'b, Bigarray.c_layout) Bigarray.Array3.t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array2.t
val slice_right_2 :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array3.t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t
external blit :
('a, 'b, 'c) Bigarray.Array3.t ->
('a, 'b, 'c) Bigarray.Array3.t -> unit = "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array3.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
'a array array array -> ('a, 'b, 'c) Bigarray.Array3.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int -> int -> int -> ('a, 'b, 'c) Bigarray.Array3.t
external unsafe_get :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a
= "%caml_ba_unsafe_ref_3"
external unsafe_set :
('a, 'b, 'c) Bigarray.Array3.t -> int -> int -> int -> 'a -> unit
= "%caml_ba_unsafe_set_3"
end
external genarray_of_array0 :
('a, 'b, 'c) Bigarray.Array0.t -> ('a, 'b, 'c) Bigarray.Genarray.t
= "%identity"
external genarray_of_array1 :
('a, 'b, 'c) Bigarray.Array1.t -> ('a, 'b, 'c) Bigarray.Genarray.t
= "%identity"
external genarray_of_array2 :
('a, 'b, 'c) Bigarray.Array2.t -> ('a, 'b, 'c) Bigarray.Genarray.t
= "%identity"
external genarray_of_array3 :
('a, 'b, 'c) Bigarray.Array3.t -> ('a, 'b, 'c) Bigarray.Genarray.t
= "%identity"
val array0_of_genarray :
('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b, 'c) Bigarray.Array0.t
val array1_of_genarray :
('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b, 'c) Bigarray.Array1.t
val array2_of_genarray :
('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b, 'c) Bigarray.Array2.t
val array3_of_genarray :
('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b, 'c) Bigarray.Array3.t
val reshape :
('a, 'b, 'c) Bigarray.Genarray.t ->
int array -> ('a, 'b, 'c) Bigarray.Genarray.t
val reshape_0 :
('a, 'b, 'c) Bigarray.Genarray.t -> ('a, 'b, 'c) Bigarray.Array0.t
val reshape_1 :
('a, 'b, 'c) Bigarray.Genarray.t -> int -> ('a, 'b, 'c) Bigarray.Array1.t
val reshape_2 :
('a, 'b, 'c) Bigarray.Genarray.t ->
int -> int -> ('a, 'b, 'c) Bigarray.Array2.t
val reshape_3 :
('a, 'b, 'c) Bigarray.Genarray.t ->
int -> int -> int -> ('a, 'b, 'c) Bigarray.Array3.t
end ocaml-doc-4.05/ocaml.html/libref/Location.html 0000644 0001750 0001750 00000047602 13131636445 020214 0 ustar mehdi mehdi
module Location:sig..end
type
|
loc_start : |
|
loc_end : |
|
loc_ghost : |
pos_fname = "", then use !input_name instead.
If pos_lnum = -1, then pos_bol = 0. Use pos_cnum and
re-parse the file to get the line and character numbers.
Else all fields are correct.val none : tt; describes an empty ghost range.val in_file : string -> tval init : Lexing.lexbuf -> string -> unitlexbuf to be the start
of the named file.val curr : Lexing.lexbuf -> tlexbuf.val symbol_rloc : unit -> t
val symbol_gloc : unit -> t
val rhs_loc : int -> trhs_loc n returns the location of the symbol at position n, starting
at 1, in the current parser rule.val input_name : string ref
val input_lexbuf : Lexing.lexbuf option ref
val get_pos_info : Lexing.position -> string * int * int
val print_loc : Format.formatter -> t -> unit
val print_error : Format.formatter -> t -> unit
val print_error_cur_file : Format.formatter -> unit -> unit
val print_warning : t -> Format.formatter -> Warnings.t -> unit
val formatter_for_warnings : Format.formatter ref
val prerr_warning : t -> Warnings.t -> unit
val echo_eof : unit -> unit
val reset : unit -> unit
val warning_printer : (t -> Format.formatter -> Warnings.t -> unit) refval default_warning_printer : t -> Format.formatter -> Warnings.t -> unitval highlight_locations : Format.formatter -> t list -> bool
type 'a loc = {
|
txt : |
|
loc : |
val mknoloc : 'a -> 'a loc
val mkloc : 'a -> t -> 'a loc
val print : Format.formatter -> t -> unit
val print_compact : Format.formatter -> t -> unit
val print_filename : Format.formatter -> string -> unit
val absolute_path : string -> string
val show_filename : string -> stringval absname : bool ref
type
|
loc : |
|
msg : |
|
sub : |
|
if_highlight : |
exception Error of error
val print_error_prefix : Format.formatter -> unit -> unit
val error : ?loc:t ->
?sub:error list -> ?if_highlight:string -> string -> error
val errorf : ?loc:t ->
?sub:error list ->
?if_highlight:string ->
('a, Format.formatter, unit, error) format4 -> 'a
val raise_errorf : ?loc:t ->
?sub:error list ->
?if_highlight:string ->
('a, Format.formatter, unit, 'b) format4 -> 'a
val error_of_printer : t -> (Format.formatter -> 'a -> unit) -> 'a -> error
val error_of_printer_file : (Format.formatter -> 'a -> unit) -> 'a -> error
val error_of_exn : exn -> error option
val register_error_of_exn : (exn -> error option) -> unit
val report_error : Format.formatter -> error -> unit
val error_reporter : (Format.formatter -> error -> unit) refval default_error_reporter : Format.formatter -> error -> unitval report_exception : Format.formatter -> exn -> unit ocaml-doc-4.05/ocaml.html/libref/type_Numbers.Int.html 0000644 0001750 0001750 00000123721 13131636447 021650 0 ustar mehdi mehdi
sig
type t = int
module T :
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
val to_string : t -> string
val of_list : elt list -> t
val map : (elt -> elt) -> t -> t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map : 'a t -> f:(key -> 'a -> 'b option) -> 'b t
val of_list : (key * 'a) list -> 'a t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) -> 'a t -> 'a t -> 'a t
val union_right : 'a t -> 'a t -> 'a t
val union_left : 'a t -> 'a t -> 'a t
val union_merge : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val rename : key t -> key -> key
val map_keys : (key -> key) -> 'a t -> 'a t
val keys : 'a t -> Set.t
val data : 'a t -> 'a list
val of_set : (key -> 'a) -> Set.t -> 'a t
val transpose_keys_and_data : key t -> key t
val transpose_keys_and_data_set : key t -> Set.t t
val print :
(Format.formatter -> 'a -> unit) -> Format.formatter -> 'a t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a t -> (T.t * 'a) list
val of_list : (T.t * 'a) list -> 'a t
val to_map : 'a t -> 'a Map.t
val of_map : 'a Map.t -> 'a t
val memoize : 'a t -> (key -> 'a) -> key -> 'a
val map : 'a t -> ('a -> 'b) -> 'b t
end
val zero_to_n : int -> Set.t
end ocaml-doc-4.05/ocaml.html/libref/type_Misc.StringMap.html 0000644 0001750 0001750 00000042546 13131636446 022306 0 ustar mehdi mehdi
sig
type key = string
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end ocaml-doc-4.05/ocaml.html/libref/type_Scanf.Scanning.html 0000644 0001750 0001750 00000023515 13131636450 022267 0 ustar mehdi mehdi
sig
type in_channel
type scanbuf = Scanf.Scanning.in_channel
val stdin : Scanf.Scanning.in_channel
type file_name = string
val open_in : Scanf.Scanning.file_name -> Scanf.Scanning.in_channel
val open_in_bin : Scanf.Scanning.file_name -> Scanf.Scanning.in_channel
val close_in : Scanf.Scanning.in_channel -> unit
val from_file : Scanf.Scanning.file_name -> Scanf.Scanning.in_channel
val from_file_bin : string -> Scanf.Scanning.in_channel
val from_string : string -> Scanf.Scanning.in_channel
val from_function : (unit -> char) -> Scanf.Scanning.in_channel
val from_channel : Pervasives.in_channel -> Scanf.Scanning.in_channel
val end_of_input : Scanf.Scanning.in_channel -> bool
val beginning_of_input : Scanf.Scanning.in_channel -> bool
val name_of_input : Scanf.Scanning.in_channel -> string
val stdib : Scanf.Scanning.in_channel
end ocaml-doc-4.05/ocaml.html/libref/Spacetime.Series.html 0000644 0001750 0001750 00000021746 13131636450 021604 0 ustar mehdi mehdi
module Series:sig..end
type
val create : path:string -> tcreate ~path creates a series file at path.val save_event : ?time:float -> t -> event_name:string -> unitsave_event writes an event, which is an arbitrary string, into the
given series file. This may be used for identifying particular points
during program execution when analysing the profile.
The optional time parameter is as for Spacetime.Snapshot.take.val save_and_close : ?time:float -> t -> unitsave_and_close series writes information into series required for
interpeting the snapshots that series contains and then closes the
series file. This function must be called to produce a valid series
file.
The optional time parameter is as for Spacetime.Snapshot.take.module Stream:sig..end
type 'a t
'a.exception Failure
exception Error of string
val from : (int -> 'a option) -> 'a tStream.from f returns a stream built from the function f.
To create a new stream element, the function f is called with
the current stream count. The user function f must return either
Some <value> for a value or None to specify the end of the
stream.
Do note that the indices passed to f may not start at 0 in the
general case. For example, [< '0; '1; Stream.from f >] would call
f the first time with count 2.
val of_list : 'a list -> 'a tval of_string : string -> char tval of_bytes : bytes -> char tval of_channel : in_channel -> char tval iter : ('a -> unit) -> 'a t -> unitStream.iter f s scans the whole stream s, applying function f
in turn to each stream element encountered.val next : 'a t -> 'aStream.Failure if the stream is empty.val empty : 'a t -> unit
val peek : 'a t -> 'a optionSome of "the first element" of the stream, or None if
the stream is empty.val junk : 'a t -> unitval count : 'a t -> intval npeek : int -> 'a t -> 'a listnpeek n returns the list of the n first elements of
the stream, or all its remaining elements if less than n
elements are available.sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> ('a, 'b, 'c) Bigarray.Array0.t
external kind : ('a, 'b, 'c) Bigarray.Array0.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array0.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array0.t -> int
val get : ('a, 'b, 'c) Bigarray.Array0.t -> 'a
val set : ('a, 'b, 'c) Bigarray.Array0.t -> 'a -> unit
external blit :
('a, 'b, 'c) Bigarray.Array0.t -> ('a, 'b, 'c) Bigarray.Array0.t -> unit
= "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array0.t -> 'a -> unit
= "caml_ba_fill"
val of_value :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a -> ('a, 'b, 'c) Bigarray.Array0.t
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Mtd.html 0000644 0001750 0001750 00000017354 13131636441 021252 0 ustar mehdi mehdi
module Mtd:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?typ:Parsetree.module_type ->
Ast_helper.str -> Parsetree.module_type_declaration ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Hashtbl.HashedType.html 0000644 0001750 0001750 00000014716 13131636446 025154 0 ustar mehdi mehdi
Hashtbl.HashedType ocaml-doc-4.05/ocaml.html/libref/ThreadUnix.html 0000644 0001750 0001750 00000037434 13131636451 020516 0 ustar mehdi mehdi
module ThreadUnix:sig..end
Unix module. Threaded programs can now call the functions
from module Unix directly, and still get the correct behavior
(block the calling thread, if required, but do not block all threads
in the process).val execv : string -> string array -> unit
val execve : string -> string array -> string array -> unit
val execvp : string -> string array -> unit
val wait : unit -> int * Unix.process_status
val waitpid : Unix.wait_flag list -> int -> int * Unix.process_status
val system : string -> Unix.process_statusval read : Unix.file_descr -> bytes -> int -> int -> int
val write : Unix.file_descr -> bytes -> int -> int -> int
val write_substring : Unix.file_descr -> string -> int -> int -> intval timed_read : Unix.file_descr -> bytes -> int -> int -> float -> int
val timed_write : Unix.file_descr -> bytes -> int -> int -> float -> intThreadUnix.read and ThreadUnix.write, except that
Unix_error(ETIMEDOUT,_,_) is raised if no data is
available for reading or ready for writing after d seconds.
The delay d is given in the fifth argument, in seconds.val timed_write_substring : Unix.file_descr -> string -> int -> int -> float -> int
val select : Unix.file_descr list ->
Unix.file_descr list ->
Unix.file_descr list ->
float -> Unix.file_descr list * Unix.file_descr list * Unix.file_descr listval pipe : ?cloexec:bool -> unit -> Unix.file_descr * Unix.file_descr
val open_process_in : string -> in_channel
val open_process_out : string -> out_channel
val open_process : string -> in_channel * out_channelval sleep : int -> unitval socket : ?cloexec:bool ->
Unix.socket_domain -> Unix.socket_type -> int -> Unix.file_descr
val accept : ?cloexec:bool -> Unix.file_descr -> Unix.file_descr * Unix.sockaddr
val connect : Unix.file_descr -> Unix.sockaddr -> unit
val recv : Unix.file_descr -> bytes -> int -> int -> Unix.msg_flag list -> int
val recvfrom : Unix.file_descr ->
bytes -> int -> int -> Unix.msg_flag list -> int * Unix.sockaddr
val send : Unix.file_descr -> bytes -> int -> int -> Unix.msg_flag list -> int
val send_substring : Unix.file_descr -> string -> int -> int -> Unix.msg_flag list -> int
val sendto : Unix.file_descr ->
bytes -> int -> int -> Unix.msg_flag list -> Unix.sockaddr -> int
val sendto_substring : Unix.file_descr ->
string -> int -> int -> Unix.msg_flag list -> Unix.sockaddr -> int
val open_connection : Unix.sockaddr -> in_channel * out_channel ocaml-doc-4.05/ocaml.html/libref/type_List.html 0000644 0001750 0001750 00000061763 13131636445 020424 0 ustar mehdi mehdi
sig
val length : 'a list -> int
val compare_lengths : 'a list -> 'b list -> int
val compare_length_with : 'a list -> int -> int
val cons : 'a -> 'a list -> 'a list
val hd : 'a list -> 'a
val tl : 'a list -> 'a list
val nth : 'a list -> int -> 'a
val nth_opt : 'a list -> int -> 'a option
val rev : 'a list -> 'a list
val append : 'a list -> 'a list -> 'a list
val rev_append : 'a list -> 'a list -> 'a list
val concat : 'a list list -> 'a list
val flatten : 'a list list -> 'a list
val iter : ('a -> unit) -> 'a list -> unit
val iteri : (int -> 'a -> unit) -> 'a list -> unit
val map : ('a -> 'b) -> 'a list -> 'b list
val mapi : (int -> 'a -> 'b) -> 'a list -> 'b list
val rev_map : ('a -> 'b) -> 'a list -> 'b list
val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b list -> 'a
val fold_right : ('a -> 'b -> 'b) -> 'a list -> 'b -> 'b
val iter2 : ('a -> 'b -> unit) -> 'a list -> 'b list -> unit
val map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val rev_map2 : ('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c list
val fold_left2 : ('a -> 'b -> 'c -> 'a) -> 'a -> 'b list -> 'c list -> 'a
val fold_right2 : ('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> 'c -> 'c
val for_all : ('a -> bool) -> 'a list -> bool
val exists : ('a -> bool) -> 'a list -> bool
val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
val exists2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
val mem : 'a -> 'a list -> bool
val memq : 'a -> 'a list -> bool
val find : ('a -> bool) -> 'a list -> 'a
val find_opt : ('a -> bool) -> 'a list -> 'a option
val filter : ('a -> bool) -> 'a list -> 'a list
val find_all : ('a -> bool) -> 'a list -> 'a list
val partition : ('a -> bool) -> 'a list -> 'a list * 'a list
val assoc : 'a -> ('a * 'b) list -> 'b
val assoc_opt : 'a -> ('a * 'b) list -> 'b option
val assq : 'a -> ('a * 'b) list -> 'b
val assq_opt : 'a -> ('a * 'b) list -> 'b option
val mem_assoc : 'a -> ('a * 'b) list -> bool
val mem_assq : 'a -> ('a * 'b) list -> bool
val remove_assoc : 'a -> ('a * 'b) list -> ('a * 'b) list
val remove_assq : 'a -> ('a * 'b) list -> ('a * 'b) list
val split : ('a * 'b) list -> 'a list * 'b list
val combine : 'a list -> 'b list -> ('a * 'b) list
val sort : ('a -> 'a -> int) -> 'a list -> 'a list
val stable_sort : ('a -> 'a -> int) -> 'a list -> 'a list
val fast_sort : ('a -> 'a -> int) -> 'a list -> 'a list
val sort_uniq : ('a -> 'a -> int) -> 'a list -> 'a list
val merge : ('a -> 'a -> int) -> 'a list -> 'a list -> 'a list
end ocaml-doc-4.05/ocaml.html/libref/Set.Make.html 0000644 0001750 0001750 00000064041 13131636450 020043 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
type
type
val empty : tval is_empty : t -> boolval mem : elt -> t -> boolmem x s tests whether x belongs to the set s.val add : elt -> t -> tadd x s returns a set containing all elements of s,
plus x. If x was already in s, s is returned unchanged
(the result of the function is then physically equal to s).val singleton : elt -> tsingleton x returns the one-element set containing only x.val remove : elt -> t -> tremove x s returns a set containing all elements of s,
except x. If x was not in s, s is returned unchanged
(the result of the function is then physically equal to s).val union : t -> t -> tval inter : t -> t -> tval diff : t -> t -> tval compare : t -> t -> intval equal : t -> t -> boolequal s1 s2 tests whether the sets s1 and s2 are
equal, that is, contain equal elements.val subset : t -> t -> boolsubset s1 s2 tests whether the set s1 is a subset of
the set s2.val iter : (elt -> unit) -> t -> unititer f s applies f in turn to all elements of s.
The elements of s are presented to f in increasing order
with respect to the ordering over the type of the elements.val map : (elt -> elt) -> t -> tmap f s is the set whose elements are f a0,f a1... f
aN, where a0,a1...aN are the elements of s.
The elements are passed to f in increasing order
with respect to the ordering over the type of the elements.
If no element of s is changed by f, s is returned
unchanged. (If each output of f is physically equal to its
input, the returned set is physically equal to s.)
Since 4.04.0
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'afold f s a computes (f xN ... (f x2 (f x1 a))...),
where x1 ... xN are the elements of s, in increasing order.val for_all : (elt -> bool) -> t -> boolfor_all p s checks if all elements of the set
satisfy the predicate p.val exists : (elt -> bool) -> t -> boolexists p s checks if at least one element of
the set satisfies the predicate p.val filter : (elt -> bool) -> t -> tfilter p s returns the set of all elements in s
that satisfy predicate p. If p satisfies every element in s,
s is returned unchanged (the result of the function is then
physically equal to s).val partition : (elt -> bool) -> t -> t * tpartition p s returns a pair of sets (s1, s2), where
s1 is the set of all the elements of s that satisfy the
predicate p, and s2 is the set of all the elements of
s that do not satisfy p.val cardinal : t -> intval elements : t -> elt listOrd.compare, where Ord is the argument
given to Set.Make.val min_elt : t -> eltOrd.compare ordering), or raise
Not_found if the set is empty.val min_elt_opt : t -> elt optionOrd.compare ordering), or None
if the set is empty.val max_elt : t -> eltSet.S.min_elt, but returns the largest element of the
given set.val max_elt_opt : t -> elt option
val choose : t -> eltNot_found if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val choose_opt : t -> elt optionNone if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val split : elt -> t -> t * bool * tsplit x s returns a triple (l, present, r), where
l is the set of elements of s that are
strictly less than x;
r is the set of elements of s that are
strictly greater than x;
present is false if s contains no element equal to x,
or true if s contains an element equal to x.val find : elt -> t -> eltfind x s returns the element of s equal to x (according
to Ord.compare), or raise Not_found if no such element
exists.val find_opt : elt -> t -> elt optionfind_opt x s returns the element of s equal to x (according
to Ord.compare), or None if no such element
exists.val find_first : (elt -> bool) -> t -> eltfind_first f s, where f is a monotonically increasing function,
returns the lowest element e of s such that f e,
or raises Not_found if no such element exists.
For example, find_first (fun e -> Ord.compare e x >= 0) s will return
the first element e of s where Ord.compare e x >= 0 (intuitively:
e >= x), or raise Not_found if x is greater than any element of
s.
Since 4.05
val find_first_opt : (elt -> bool) -> t -> elt optionfind_first_opt f s, where f is a monotonically increasing function,
returns an option containing the lowest element e of s such that
f e, or None if no such element exists.val find_last : (elt -> bool) -> t -> eltfind_last f s, where f is a monotonically decreasing function,
returns the highest element e of s such that f e,
or raises Not_found if no such element exists.val find_last_opt : (elt -> bool) -> t -> elt optionfind_last_opt f s, where f is a monotonically decreasing function,
returns an option containing the highest element e of s such that
f e, or None if no such element exists.val of_list : elt list -> tof_list l creates a set from a list of elements.
This is usually more efficient than folding add over the list,
except perhaps for lists with many duplicated elements.sig
external length : string -> int = "%string_length"
external get : string -> int -> char = "%string_safe_get"
external set : bytes -> int -> char -> unit = "%string_safe_set"
external create : int -> bytes = "caml_create_string"
val make : int -> char -> string
val init : int -> (int -> char) -> string
val copy : string -> string
val sub : string -> int -> int -> string
val fill : bytes -> int -> int -> char -> unit
val blit : string -> int -> bytes -> int -> int -> unit
val concat : string -> string list -> string
val iter : (char -> unit) -> string -> unit
val iteri : (int -> char -> unit) -> string -> unit
val map : (char -> char) -> string -> string
val mapi : (int -> char -> char) -> string -> string
val trim : string -> string
val escaped : string -> string
val index : string -> char -> int
val index_opt : string -> char -> int option
val rindex : string -> char -> int
val rindex_opt : string -> char -> int option
val index_from : string -> int -> char -> int
val index_from_opt : string -> int -> char -> int option
val rindex_from : string -> int -> char -> int
val rindex_from_opt : string -> int -> char -> int option
val contains : string -> char -> bool
val contains_from : string -> int -> char -> bool
val rcontains_from : string -> int -> char -> bool
val uppercase : string -> string
val lowercase : string -> string
val capitalize : string -> string
val uncapitalize : string -> string
val uppercase_ascii : string -> string
val lowercase_ascii : string -> string
val capitalize_ascii : string -> string
val uncapitalize_ascii : string -> string
type t = string
val compare : String.t -> String.t -> int
val equal : String.t -> String.t -> bool
val split_on_char : char -> string -> string list
external unsafe_get : string -> int -> char = "%string_unsafe_get"
external unsafe_set : bytes -> int -> char -> unit = "%string_unsafe_set"
external unsafe_blit : string -> int -> bytes -> int -> int -> unit
= "caml_blit_string" [@@noalloc]
external unsafe_fill : bytes -> int -> int -> char -> unit
= "caml_fill_string" [@@noalloc]
end ocaml-doc-4.05/ocaml.html/libref/Unix.html 0000644 0001750 0001750 00000705613 13131636451 017367 0 ustar mehdi mehdi
module Unix:sig..end
Note: all the functions of this module (except Unix.error_message and
Unix.handle_unix_error) are liable to raise the Unix.Unix_error
exception whenever the underlying system call signals an error.
type
| |
E2BIG |
(* |
Argument list too long
| *) |
| |
EACCES |
(* |
Permission denied
| *) |
| |
EAGAIN |
(* |
Resource temporarily unavailable; try again
| *) |
| |
EBADF |
(* |
Bad file descriptor
| *) |
| |
EBUSY |
(* |
Resource unavailable
| *) |
| |
ECHILD |
(* |
No child process
| *) |
| |
EDEADLK |
(* |
Resource deadlock would occur
| *) |
| |
EDOM |
(* |
Domain error for math functions, etc.
| *) |
| |
EEXIST |
(* |
File exists
| *) |
| |
EFAULT |
(* |
Bad address
| *) |
| |
EFBIG |
(* |
File too large
| *) |
| |
EINTR |
(* |
Function interrupted by signal
| *) |
| |
EINVAL |
(* |
Invalid argument
| *) |
| |
EIO |
(* |
Hardware I/O error
| *) |
| |
EISDIR |
(* |
Is a directory
| *) |
| |
EMFILE |
(* |
Too many open files by the process
| *) |
| |
EMLINK |
(* |
Too many links
| *) |
| |
ENAMETOOLONG |
(* |
Filename too long
| *) |
| |
ENFILE |
(* |
Too many open files in the system
| *) |
| |
ENODEV |
(* |
No such device
| *) |
| |
ENOENT |
(* |
No such file or directory
| *) |
| |
ENOEXEC |
(* |
Not an executable file
| *) |
| |
ENOLCK |
(* |
No locks available
| *) |
| |
ENOMEM |
(* |
Not enough memory
| *) |
| |
ENOSPC |
(* |
No space left on device
| *) |
| |
ENOSYS |
(* |
Function not supported
| *) |
| |
ENOTDIR |
(* |
Not a directory
| *) |
| |
ENOTEMPTY |
(* |
Directory not empty
| *) |
| |
ENOTTY |
(* |
Inappropriate I/O control operation
| *) |
| |
ENXIO |
(* |
No such device or address
| *) |
| |
EPERM |
(* |
Operation not permitted
| *) |
| |
EPIPE |
(* |
Broken pipe
| *) |
| |
ERANGE |
(* |
Result too large
| *) |
| |
EROFS |
(* |
Read-only file system
| *) |
| |
ESPIPE |
(* |
Invalid seek e.g. on a pipe
| *) |
| |
ESRCH |
(* |
No such process
| *) |
| |
EXDEV |
(* |
Invalid link
| *) |
| |
EWOULDBLOCK |
(* |
Operation would block
| *) |
| |
EINPROGRESS |
(* |
Operation now in progress
| *) |
| |
EALREADY |
(* |
Operation already in progress
| *) |
| |
ENOTSOCK |
(* |
Socket operation on non-socket
| *) |
| |
EDESTADDRREQ |
(* |
Destination address required
| *) |
| |
EMSGSIZE |
(* |
Message too long
| *) |
| |
EPROTOTYPE |
(* |
Protocol wrong type for socket
| *) |
| |
ENOPROTOOPT |
(* |
Protocol not available
| *) |
| |
EPROTONOSUPPORT |
(* |
Protocol not supported
| *) |
| |
ESOCKTNOSUPPORT |
(* |
Socket type not supported
| *) |
| |
EOPNOTSUPP |
(* |
Operation not supported on socket
| *) |
| |
EPFNOSUPPORT |
(* |
Protocol family not supported
| *) |
| |
EAFNOSUPPORT |
(* |
Address family not supported by protocol family
| *) |
| |
EADDRINUSE |
(* |
Address already in use
| *) |
| |
EADDRNOTAVAIL |
(* |
Can't assign requested address
| *) |
| |
ENETDOWN |
(* |
Network is down
| *) |
| |
ENETUNREACH |
(* |
Network is unreachable
| *) |
| |
ENETRESET |
(* |
Network dropped connection on reset
| *) |
| |
ECONNABORTED |
(* |
Software caused connection abort
| *) |
| |
ECONNRESET |
(* |
Connection reset by peer
| *) |
| |
ENOBUFS |
(* |
No buffer space available
| *) |
| |
EISCONN |
(* |
Socket is already connected
| *) |
| |
ENOTCONN |
(* |
Socket is not connected
| *) |
| |
ESHUTDOWN |
(* |
Can't send after socket shutdown
| *) |
| |
ETOOMANYREFS |
(* |
Too many references: can't splice
| *) |
| |
ETIMEDOUT |
(* |
Connection timed out
| *) |
| |
ECONNREFUSED |
(* |
Connection refused
| *) |
| |
EHOSTDOWN |
(* |
Host is down
| *) |
| |
EHOSTUNREACH |
(* |
No route to host
| *) |
| |
ELOOP |
(* |
Too many levels of symbolic links
| *) |
| |
EOVERFLOW |
(* |
File size or position not representable
| *) |
| |
EUNKNOWNERR of |
(* |
Unknown error
| *) |
exception Unix_error of error * string * string
val error_message : error -> stringval handle_unix_error : ('a -> 'b) -> 'a -> 'bhandle_unix_error f x applies f to x and returns the result.
If the exception Unix.Unix_error is raised, it prints a message
describing the error and exits with code 2.val environment : unit -> string arrayval getenv : string -> stringNot_found if the variable is unbound or the process has
special privileges.
(This function is identical to Sys.getenv.
val putenv : string -> string -> unitUnix.putenv name value sets the value associated to a
variable in the process environment.
name is the name of the environment variable,
and value its new associated value.type
| |
WEXITED of |
(* |
The process terminated normally by
exit;
the argument is the return code. | *) |
| |
WSIGNALED of |
(* |
The process was killed by a signal;
the argument is the signal number.
| *) |
| |
WSTOPPED of |
(* |
The process was stopped by a signal; the argument is the
signal number.
| *) |
Sys for the
definitions of the standard signal numbers. Note that they are
not the numbers used by the OS.type
| |
WNOHANG |
(* |
Do not block if no child has
died yet, but immediately return with a pid equal to 0.
| *) |
| |
WUNTRACED |
(* |
Report also the children that receive stop signals.
| *) |
Unix.waitpid.val execv : string -> string array -> 'aexecv prog args execute the program in file prog, with
the arguments args, and the current process environment.
These execv* functions never return: on success, the current
program is replaced by the new one.Unix.Unix_error on failure.val execve : string -> string array -> string array -> 'aUnix.execv, except that the third argument provides the
environment to the program executed.val execvp : string -> string array -> 'aUnix.execv, except that
the program is searched in the path.val execvpe : string -> string array -> string array -> 'aUnix.execve, except that
the program is searched in the path.val fork : unit -> int
On Windows: not implemented, use Unix.create_process or threads.
val wait : unit -> int * process_status
On Windows: Not implemented, use Unix.waitpid.
val waitpid : wait_flag list -> int -> int * process_statusUnix.wait, but waits for the child process whose pid is given.
A pid of -1 means wait for any child.
A pid of 0 means wait for any child in the same process group
as the current process.
Negative pid arguments represent process groups.
The list of options indicates whether waitpid should return
immediately without waiting, and whether it should report stopped
children.
On Windows, this function can only wait for a given PID, not any
child process.
val system : string -> process_status/bin/sh (or the command interpreter cmd.exe on Windows) and
therefore can contain redirections, quotes, variables, etc. The
result WEXITED 127 indicates that the shell couldn't be
executed.val getpid : unit -> intval getppid : unit -> intval nice : int -> int
On Windows: not implemented.
type
val stdin : file_descrval stdout : file_descrval stderr : file_descrtype
| |
O_RDONLY |
(* |
Open for reading
| *) |
| |
O_WRONLY |
(* |
Open for writing
| *) |
| |
O_RDWR |
(* |
Open for reading and writing
| *) |
| |
O_NONBLOCK |
(* |
Open in non-blocking mode
| *) |
| |
O_APPEND |
(* |
Open for append
| *) |
| |
O_CREAT |
(* |
Create if nonexistent
| *) |
| |
O_TRUNC |
(* |
Truncate to 0 length if existing
| *) |
| |
O_EXCL |
(* |
Fail if existing
| *) |
| |
O_NOCTTY |
(* |
Don't make this dev a controlling tty
| *) |
| |
O_DSYNC |
(* |
Writes complete as `Synchronised I/O data
integrity completion'
| *) |
| |
O_SYNC |
(* |
Writes complete as `Synchronised I/O file
integrity completion'
| *) |
| |
O_RSYNC |
(* |
Reads complete as writes (depending on
O_SYNC/O_DSYNC)
| *) |
| |
O_SHARE_DELETE |
(* |
Windows only: allow the file to be deleted
while still open
| *) |
| |
O_CLOEXEC |
(* |
Set the close-on-exec flag on the
descriptor returned by
Unix.openfile.
See Unix.set_close_on_exec for more
information. | *) |
| |
O_KEEPEXEC |
(* |
Clear the close-on-exec flag.
This is currently the default.
| *) |
Unix.openfile.typefile_perm =int
0o640 is read and write for user,
read for group, none for othersval openfile : string -> open_flag list -> file_perm -> file_descrUnix.umask). Return a file descriptor on the named file.val close : file_descr -> unitval read : file_descr -> bytes -> int -> int -> intread fd buff ofs len reads len bytes from descriptor fd,
storing them in byte sequence buff, starting at position ofs in
buff. Return the number of bytes actually read.val write : file_descr -> bytes -> int -> int -> intwrite fd buff ofs len writes len bytes to descriptor fd,
taking them from byte sequence buff, starting at position ofs
in buff. Return the number of bytes actually written. write
repeats the writing operation until all bytes have been written or
an error occurs.val single_write : file_descr -> bytes -> int -> int -> intwrite, but attempts to write only once.
Thus, if an error occurs, single_write guarantees that no data
has been written.val write_substring : file_descr -> string -> int -> int -> intwrite, but take the data from a string instead of a byte
sequence.val single_write_substring : file_descr -> string -> int -> int -> intsingle_write, but take the data from a string instead of
a byte sequence.val in_channel_of_descr : file_descr -> in_channelset_binary_mode_in ic false if text mode is desired.
Text mode is supported only if the descriptor refers to a file
or pipe, but is not supported if it refers to a socket.
On Windows, set_binary_mode_in always fails on channels created
with this function.
Beware that channels are buffered so more characters may have been read from the file descriptor than those accessed using channel functions. Channels also keep a copy of the current position in the file.
You need to explicitly close all channels created with this function.
Closing the channel also closes the underlying file descriptor (unless
it was already closed).
val out_channel_of_descr : file_descr -> out_channelset_binary_mode_out oc false if text mode is desired.
Text mode is supported only if the descriptor refers to a file
or pipe, but is not supported if it refers to a socket.
On Windows, set_binary_mode_out always fails on channels created
with this function.
Beware that channels are buffered so you may have to flush them
to ensure that all data has been sent to the file descriptor.
Channels also keep a copy of the current position in the file.
You need to explicitly close all channels created with this function.
Closing the channel flushes the data and closes the underlying file
descriptor (unless it has already been closed, in which case the
buffered data is lost).
val descr_of_in_channel : in_channel -> file_descrval descr_of_out_channel : out_channel -> file_descrtype
| |
SEEK_SET |
(* |
indicates positions relative to the beginning of the file
| *) |
| |
SEEK_CUR |
(* |
indicates positions relative to the current position
| *) |
| |
SEEK_END |
(* |
indicates positions relative to the end of the file
| *) |
Unix.lseek.val lseek : file_descr -> int -> seek_command -> intval truncate : string -> int -> unit
On Windows: not implemented.
val ftruncate : file_descr -> int -> unit
On Windows: not implemented.
type
| |
S_REG |
(* |
Regular file
| *) |
| |
S_DIR |
(* |
Directory
| *) |
| |
S_CHR |
(* |
Character device
| *) |
| |
S_BLK |
(* |
Block device
| *) |
| |
S_LNK |
(* |
Symbolic link
| *) |
| |
S_FIFO |
(* |
Named pipe
| *) |
| |
S_SOCK |
(* |
Socket
| *) |
type
|
st_dev : |
(* |
Device number
| *) |
|
st_ino : |
(* |
Inode number
| *) |
|
st_kind : |
(* |
Kind of the file
| *) |
|
st_perm : |
(* |
Access rights
| *) |
|
st_nlink : |
(* |
Number of links
| *) |
|
st_uid : |
(* |
User id of the owner
| *) |
|
st_gid : |
(* |
Group ID of the file's group
| *) |
|
st_rdev : |
(* |
Device minor number
| *) |
|
st_size : |
(* |
Size in bytes
| *) |
|
st_atime : |
(* |
Last access time
| *) |
|
st_mtime : |
(* |
Last modification time
| *) |
|
st_ctime : |
(* |
Last status change time
| *) |
Unix.stat calls.val stat : string -> statsval lstat : string -> statsUnix.stat, but in case the file is a symbolic link,
return the information for the link itself.val fstat : file_descr -> statsval isatty : file_descr -> booltrue if the given file descriptor refers to a terminal or
console window, false otherwise.module LargeFile:sig..end
val unlink : string -> unitIf the named file is a directory, raises:
EPERM on POSIX compliant systemEISDIR on Linux >= 2.1.132EACCESS on Windowsval rename : string -> string -> unitrename old new changes the name of a file from old to new.val link : string -> string -> unitlink source dest creates a hard link named dest to the file
named source.type
| |
R_OK |
(* |
Read permission
| *) |
| |
W_OK |
(* |
Write permission
| *) |
| |
X_OK |
(* |
Execution permission
| *) |
| |
F_OK |
(* |
File exists
| *) |
Unix.access call.val chmod : string -> file_perm -> unitval fchmod : file_descr -> file_perm -> unitval chown : string -> int -> int -> unitval fchown : file_descr -> int -> int -> unitval umask : int -> intval access : string -> access_permission list -> unitUnix_error otherwise.
On Windows, execute permission X_OK, cannot be tested, it just
tests for read permission instead.
val dup : ?cloexec:bool -> file_descr -> file_descrUnix.set_close_on_exec for documentation on the cloexec
optional argument.val dup2 : ?cloexec:bool -> file_descr -> file_descr -> unitdup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already
opened.
See Unix.set_close_on_exec for documentation on the cloexec
optional argument.val set_nonblock : file_descr -> unitEAGAIN or EWOULDBLOCK error instead of blocking;
writing on a descriptor on which there is temporarily no room
for writing also raises EAGAIN or EWOULDBLOCK.val clear_nonblock : file_descr -> unitUnix.set_nonblock.val set_close_on_exec : file_descr -> unitexec, create_process and open_process functions.
It is often a security hole to leak file descriptors opened on, say, a private file to an external program: the program, then, gets access to the private file and can do bad things with it. Hence, it is highly recommended to set all file descriptors ``close-on-exec'', except in the very few cases where a file descriptor actually needs to be transmitted to another program.
The best way to set a file descriptor ``close-on-exec'' is to create
it in this state. To this end, the openfile function has
O_CLOEXEC and O_KEEPEXEC flags to enforce ``close-on-exec'' mode
or ``keep-on-exec'' mode, respectively. All other operations in
the Unix module that create file descriptors have an optional
argument ?cloexec:bool to indicate whether the file descriptor
should be created in ``close-on-exec'' mode (by writing
~cloexec:true) or in ``keep-on-exec'' mode (by writing
~cloexec:false). For historical reasons, the default file
descriptor creation mode is ``keep-on-exec'', if no cloexec optional
argument is given. This is not a safe default, hence it is highly
recommended to pass explicit cloexec arguments to operations that
create file descriptors.
The cloexec optional arguments and the O_KEEPEXEC flag were introduced
in OCaml 4.05. Earlier, the common practice was to create file descriptors
in the default, ``keep-on-exec'' mode, then call set_close_on_exec
on those freshly-created file descriptors. This is not as safe as
creating the file descriptor in ``close-on-exec'' mode because, in
multithreaded programs, a window of vulnerability exists between the time
when the file descriptor is created and the time set_close_on_exec
completes. If another thread spawns another program during this window,
the descriptor will leak, as it is still in the ``keep-on-exec'' mode.
Regarding the atomicity guarantees given by ~cloexec:true or by
the use of the O_CLOEXEC flag: on all platforms it is guaranteed
that a concurrently-executing Caml thread cannot leak the descriptor
by starting a new process. On Linux, this guarantee extends to
concurrently-executing C threads. As of Feb 2017, other operating
systems lack the necessary system calls and still expose a window
of vulnerability during which a C thread can see the newly-created
file descriptor in ``keep-on-exec'' mode.
val clear_close_on_exec : file_descr -> unitUnix.set_close_on_exec.val mkdir : string -> file_perm -> unitUnix.umask).val rmdir : string -> unitval chdir : string -> unitval getcwd : unit -> stringval chroot : string -> unittype
val opendir : string -> dir_handleval readdir : dir_handle -> stringEnd_of_file when the end of the directory has been reached.val rewinddir : dir_handle -> unitval closedir : dir_handle -> unitval pipe : ?cloexec:bool -> unit -> file_descr * file_descrUnix.set_close_on_exec for documentation on the cloexec
optional argument.val mkfifo : string -> file_perm -> unitUnix.umask).
On Windows: not implemented.val create_process : string ->
string array -> file_descr -> file_descr -> file_descr -> intcreate_process prog args new_stdin new_stdout new_stderr
forks a new process that executes the program
in file prog, with arguments args. The pid of the new
process is returned immediately; the new process executes
concurrently with the current process.
The standard input and outputs of the new process are connected
to the descriptors new_stdin, new_stdout and new_stderr.
Passing e.g. stdout for new_stdout prevents the redirection
and causes the new process to have the same standard output
as the current process.
The executable file prog is searched in the path.
The new process has the same environment as the current process.val create_process_env : string ->
string array ->
string array -> file_descr -> file_descr -> file_descr -> intcreate_process_env prog args env new_stdin new_stdout new_stderr
works as Unix.create_process, except that the extra argument
env specifies the environment passed to the program.val open_process_in : string -> in_channel/bin/sh
(or cmd.exe on Windows), cf. system.val open_process_out : string -> out_channelUnix.open_process_in, but redirect the standard input of
the command to a pipe. Data written to the returned output channel
is sent to the standard input of the command.
Warning: writes on output channels are buffered, hence be careful
to call flush at the right times to ensure
correct synchronization.val open_process : string -> in_channel * out_channelUnix.open_process_out, but redirects both the standard input
and standard output of the command to pipes connected to the two
returned channels. The input channel is connected to the output
of the command, and the output channel to the input of the command.val open_process_full : string ->
string array ->
in_channel * out_channel * in_channelUnix.open_process, but the second argument specifies
the environment passed to the command. The result is a triple
of channels connected respectively to the standard output, standard input,
and standard error of the command.val close_process_in : in_channel -> process_statusUnix.open_process_in,
wait for the associated command to terminate,
and return its termination status.val close_process_out : out_channel -> process_statusUnix.open_process_out,
wait for the associated command to terminate,
and return its termination status.val close_process : in_channel * out_channel -> process_statusUnix.open_process,
wait for the associated command to terminate,
and return its termination status.val close_process_full : in_channel * out_channel * in_channel ->
process_statusUnix.open_process_full,
wait for the associated command to terminate,
and return its termination status.val symlink : ?to_dir:bool -> string -> string -> unitsymlink ?to_dir source dest creates the file dest as a symbolic link
to the file source. On Windows, ~to_dir indicates if the symbolic link
points to a directory or a file; if omitted, symlink examines source
using stat and picks appropriately, if source does not exist then false
is assumed (for this reason, it is recommended that the ~to_dir parameter
be specified in new code). On Unix, ~to_dir is ignored.
Windows symbolic links are available in Windows Vista onwards. There are some important differences between Windows symlinks and their POSIX counterparts.
Windows symbolic links come in two flavours: directory and regular, which designate whether the symbolic link points to a directory or a file. The type must be correct - a directory symlink which actually points to a file cannot be selected with chdir and a file symlink which actually points to a directory cannot be read or written (note that Cygwin's emulation layer ignores this distinction).
When symbolic links are created to existing targets, this distinction doesn't
matter and symlink will automatically create the correct kind of symbolic
link. The distinction matters when a symbolic link is created to a
non-existent target.
The other caveat is that by default symbolic links are a privileged operation. Administrators will always need to be running elevated (or with UAC disabled) and by default normal user accounts need to be granted the SeCreateSymbolicLinkPrivilege via Local Security Policy (secpol.msc) or via Active Directory.
Unix.has_symlink can be used to check that a process is able to create symbolic
links.
val has_symlink : unit -> booltrue if the user is able to create symbolic links. On Windows,
this indicates that the user not only has the SeCreateSymbolicLinkPrivilege
but is also running elevated, if necessary. On other platforms, this is
simply indicates that the symlink system call is available.val readlink : string -> stringval select : file_descr list ->
file_descr list ->
file_descr list ->
float -> file_descr list * file_descr list * file_descr listtype
| |
F_ULOCK |
(* |
Unlock a region
| *) |
| |
F_LOCK |
(* |
Lock a region for writing, and block if already locked
| *) |
| |
F_TLOCK |
(* |
Lock a region for writing, or fail if already locked
| *) |
| |
F_TEST |
(* |
Test a region for other process locks
| *) |
| |
F_RLOCK |
(* |
Lock a region for reading, and block if already locked
| *) |
| |
F_TRLOCK |
(* |
Lock a region for reading, or fail if already locked
| *) |
Unix.lockf.val lockf : file_descr -> lock_command -> int -> unitlockf fd cmd size puts a lock on a region of the file opened
as fd. The region starts at the current read/write position for
fd (as set by Unix.lseek), and extends size bytes forward if
size is positive, size bytes backwards if size is negative,
or to the end of the file if size is zero.
A write lock prevents any other
process from acquiring a read or write lock on the region.
A read lock prevents any other
process from acquiring a write lock on the region, but lets
other processes acquire read locks on it.
The F_LOCK and F_TLOCK commands attempts to put a write lock
on the specified region.
The F_RLOCK and F_TRLOCK commands attempts to put a read lock
on the specified region.
If one or several locks put by another process prevent the current process
from acquiring the lock, F_LOCK and F_RLOCK block until these locks
are removed, while F_TLOCK and F_TRLOCK fail immediately with an
exception.
The F_ULOCK removes whatever locks the current process has on
the specified region.
Finally, the F_TEST command tests whether a write lock can be
acquired on the specified region, without actually putting a lock.
It returns immediately if successful, or fails otherwise.
What happens when a process tries to lock a region of a file that is
already locked by the same process depends on the OS. On POSIX-compliant
systems, the second lock operation succeeds and may "promote" the older
lock from read lock to write lock. On Windows, the second lock
operation will block or fail.
Sys.signal and Sys.set_signal.val kill : int -> int -> unitkill pid sig sends signal number sig to the process
with id pid. On Windows, only the Sys.sigkill signal
is emulated.type
| |
SIG_SETMASK |
| |
SIG_BLOCK |
| |
SIG_UNBLOCK |
val sigprocmask : sigprocmask_command -> int list -> int listsigprocmask cmd sigs changes the set of blocked signals.
If cmd is SIG_SETMASK, blocked signals are set to those in
the list sigs.
If cmd is SIG_BLOCK, the signals in sigs are added to
the set of blocked signals.
If cmd is SIG_UNBLOCK, the signals in sigs are removed
from the set of blocked signals.
sigprocmask returns the set of previously blocked signals.
On Windows: not implemented (no inter-process signals on Windows).
val sigpending : unit -> int list
On Windows: not implemented (no inter-process signals on Windows).
val sigsuspend : int list -> unitsigsuspend sigs atomically sets the blocked signals to sigs
and waits for a non-ignored, non-blocked signal to be delivered.
On return, the blocked signals are reset to their initial value.
On Windows: not implemented (no inter-process signals on Windows).
val pause : unit -> unit
On Windows: not implemented (no inter-process signals on Windows).
type
|
tms_utime : |
(* |
User time for the process
| *) |
|
tms_stime : |
(* |
System time for the process
| *) |
|
tms_cutime : |
(* |
User time for the children processes
| *) |
|
tms_cstime : |
(* |
System time for the children processes
| *) |
type
|
tm_sec : |
(* |
Seconds 0..60
| *) |
|
tm_min : |
(* |
Minutes 0..59
| *) |
|
tm_hour : |
(* |
Hours 0..23
| *) |
|
tm_mday : |
(* |
Day of month 1..31
| *) |
|
tm_mon : |
(* |
Month of year 0..11
| *) |
|
tm_year : |
(* |
Year - 1900
| *) |
|
tm_wday : |
(* |
Day of week (Sunday is 0)
| *) |
|
tm_yday : |
(* |
Day of year 0..365
| *) |
|
tm_isdst : |
(* |
Daylight time savings in effect
| *) |
val time : unit -> floatval gettimeofday : unit -> floatUnix.time, but with resolution better than 1 second.val gmtime : float -> tmUnix.time, into a date and
a time. Assumes UTC (Coordinated Universal Time), also known as GMT.
To perform the inverse conversion, set the TZ environment variable
to "UTC", use Unix.mktime, and then restore the original value of TZ.val localtime : float -> tmUnix.time, into a date and
a time. Assumes the local time zone.
The function performing the inverse conversion is Unix.mktime.val mktime : tm -> float * tmtm argument, into
a time in seconds, as returned by Unix.time. The tm_isdst,
tm_wday and tm_yday fields of tm are ignored. Also return a
normalized copy of the given tm record, with the tm_wday,
tm_yday, and tm_isdst fields recomputed from the other fields,
and the other fields normalized (so that, e.g., 40 October is
changed into 9 November). The tm argument is interpreted in the
local time zone.val alarm : int -> intSIGALRM signal after the given number of seconds.
On Windows: not implemented.
val sleep : int -> unitval sleepf : float -> unitsleep,
but fractions of seconds are supported.val times : unit -> process_timesval utimes : string -> float -> float -> unit0.0, the access
and last modification times are both set to the current time.type
| |
ITIMER_REAL |
(* |
decrements in real time, and sends the signal
SIGALRM when
expired. | *) |
| |
ITIMER_VIRTUAL |
(* |
decrements in process virtual time, and sends
SIGVTALRM
when expired. | *) |
| |
ITIMER_PROF |
(* |
(for profiling) decrements both when the process
is running and when the system is running on behalf of the
process; it sends
SIGPROF when expired. | *) |
type
|
it_interval : |
(* |
Period
| *) |
|
it_value : |
(* |
Current value of the timer
| *) |
val getitimer : interval_timer -> interval_timer_status
On Windows: not implemented.
val setitimer : interval_timer ->
interval_timer_status -> interval_timer_statussetitimer t s sets the interval timer t and returns
its previous status. The s argument is interpreted as follows:
s.it_value, if nonzero, is the time to the next timer expiration;
s.it_interval, if nonzero, specifies a value to
be used in reloading it_value when the timer expires.
Setting s.it_value to zero disables the timer.
Setting s.it_interval to zero causes the timer to be disabled
after its next expiration.
On Windows: not implemented.
val getuid : unit -> int1.val geteuid : unit -> int1.val setuid : int -> unitval getgid : unit -> int1.val getegid : unit -> int1.val setgid : int -> unitval getgroups : unit -> int array[|1|].val setgroups : int array -> unitsetgroups groups sets the supplementary group IDs for the
calling process. Appropriate privileges are required.
On Windows: not implemented.val initgroups : string -> int -> unitinitgroups user group initializes the group access list by
reading the group database /etc/group and using all groups of
which user is a member. The additional group group is also
added to the list.
On Windows: not implemented.type
|
pw_name : |
|
pw_passwd : |
|
pw_uid : |
|
pw_gid : |
|
pw_gecos : |
|
pw_dir : |
|
pw_shell : |
passwd database.type
|
gr_name : |
|
gr_passwd : |
|
gr_gid : |
|
gr_mem : |
groups database.val getlogin : unit -> stringval getpwnam : string -> passwd_entrypasswd with the given name.Not_found if no such entry exist.
On Windows, always raise Not_found.
val getgrnam : string -> group_entrygroup with the given name.Not_found if no such entry exist.
On Windows, always raise Not_found.
val getpwuid : int -> passwd_entrypasswd with the given user id.Not_found if no such entry exist.
On Windows, always raise Not_found.
val getgrgid : int -> group_entrygroup with the given group id.Not_found if no such entry exist.
On Windows, always raise Not_found.
type
val inet_addr_of_string : string -> inet_addrXXX.YYY.ZZZ.TTT)
for IPv4 addresses, and up to 8 numbers separated by colons
for IPv6 addresses.Failure when given a string that does not match these formats.val string_of_inet_addr : inet_addr -> stringUnix.inet_addr_of_string for a description of the
printable representation.val inet_addr_any : inet_addrbind, representing
all the Internet addresses that the host machine possesses.val inet_addr_loopback : inet_addr127.0.0.1).val inet6_addr_any : inet_addrbind, representing
all the Internet addresses that the host machine possesses.val inet6_addr_loopback : inet_addr::1).type
| |
PF_UNIX |
(* |
Unix domain
| *) |
| |
PF_INET |
(* |
Internet domain (IPv4)
| *) |
| |
PF_INET6 |
(* |
Internet domain (IPv6)
| *) |
PF_INET6). Windows does not support
PF_UNIX.type
| |
SOCK_STREAM |
(* |
Stream socket
| *) |
| |
SOCK_DGRAM |
(* |
Datagram socket
| *) |
| |
SOCK_RAW |
(* |
Raw socket
| *) |
| |
SOCK_SEQPACKET |
(* |
Sequenced packets socket
| *) |
SOCK_SEQPACKET is included for completeness,
but is rarely supported by the OS, and needs system calls that
are not available in this library.type
| |
ADDR_UNIX of |
|||
| |
ADDR_INET of |
(* |
The type of socket addresses.
ADDR_UNIX name is a socket
address in the Unix domain; name is a file name in the file
system. ADDR_INET(addr,port) is a socket address in the Internet
domain; addr is the Internet address of the machine, and
port is the port number. | *) |
val socket : ?cloexec:bool ->
socket_domain -> socket_type -> int -> file_descrUnix.set_close_on_exec for documentation on the cloexec
optional argument.val domain_of_sockaddr : sockaddr -> socket_domainval socketpair : ?cloexec:bool ->
socket_domain ->
socket_type -> int -> file_descr * file_descrUnix.set_close_on_exec for documentation on the cloexec
optional argument.val accept : ?cloexec:bool -> file_descr -> file_descr * sockaddrUnix.set_close_on_exec for documentation on the cloexec
optional argument.val bind : file_descr -> sockaddr -> unitval connect : file_descr -> sockaddr -> unitval listen : file_descr -> int -> unittype
| |
SHUTDOWN_RECEIVE |
(* |
Close for receiving
| *) |
| |
SHUTDOWN_SEND |
(* |
Close for sending
| *) |
| |
SHUTDOWN_ALL |
(* |
Close both
| *) |
shutdown.val shutdown : file_descr -> shutdown_command -> unitSHUTDOWN_SEND as second argument
causes reads on the other end of the connection to return
an end-of-file condition.
SHUTDOWN_RECEIVE causes writes on the other end of the connection
to return a closed pipe condition (SIGPIPE signal).val getsockname : file_descr -> sockaddrval getpeername : file_descr -> sockaddrtype
| |
MSG_OOB |
|||
| |
MSG_DONTROUTE |
|||
| |
MSG_PEEK |
(* | *) |
val recv : file_descr -> bytes -> int -> int -> msg_flag list -> intval recvfrom : file_descr ->
bytes -> int -> int -> msg_flag list -> int * sockaddrval send : file_descr -> bytes -> int -> int -> msg_flag list -> intval send_substring : file_descr -> string -> int -> int -> msg_flag list -> intsend, but take the data from a string instead of a byte
sequence.val sendto : file_descr ->
bytes -> int -> int -> msg_flag list -> sockaddr -> intval sendto_substring : file_descr ->
string -> int -> int -> msg_flag list -> sockaddr -> intsendto, but take the data from a string instead of a
byte sequence.type
| |
SO_DEBUG |
(* |
Record debugging information
| *) |
| |
SO_BROADCAST |
(* |
Permit sending of broadcast messages
| *) |
| |
SO_REUSEADDR |
(* |
Allow reuse of local addresses for bind
| *) |
| |
SO_KEEPALIVE |
(* |
Keep connection active
| *) |
| |
SO_DONTROUTE |
(* |
Bypass the standard routing algorithms
| *) |
| |
SO_OOBINLINE |
(* |
Leave out-of-band data in line
| *) |
| |
SO_ACCEPTCONN |
(* |
Report whether socket listening is enabled
| *) |
| |
TCP_NODELAY |
(* |
Control the Nagle algorithm for TCP sockets
| *) |
| |
IPV6_ONLY |
(* |
Forbid binding an IPv6 socket to an IPv4 address
| *) |
Unix.getsockopt
and modified with Unix.setsockopt. These options have a boolean
(true/false) value.type
| |
SO_SNDBUF |
(* |
Size of send buffer
| *) |
| |
SO_RCVBUF |
(* |
Size of received buffer
| *) |
| |
SO_ERROR |
(* |
Deprecated. Use
Unix.getsockopt_error instead. | *) |
| |
SO_TYPE |
(* |
Report the socket type
| *) |
| |
SO_RCVLOWAT |
(* |
Minimum number of bytes to process for input operations
| *) |
| |
SO_SNDLOWAT |
(* |
Minimum number of bytes to process for output
operations
| *) |
Unix.getsockopt_int
and modified with Unix.setsockopt_int. These options have an
integer value.type
| |
SO_LINGER |
(* |
Whether to linger on closed connections
that have data present, and for how long
(in seconds)
| *) |
Unix.getsockopt_optint
and modified with Unix.setsockopt_optint. These options have a
value of type int option, with None meaning ``disabled''.type
| |
SO_RCVTIMEO |
(* |
Timeout for input operations
| *) |
| |
SO_SNDTIMEO |
(* |
Timeout for output operations
| *) |
Unix.getsockopt_float
and modified with Unix.setsockopt_float. These options have a
floating-point value representing a time in seconds.
The value 0 means infinite timeout.val getsockopt : file_descr -> socket_bool_option -> boolval setsockopt : file_descr -> socket_bool_option -> bool -> unitval getsockopt_int : file_descr -> socket_int_option -> intUnix.getsockopt for an integer-valued socket option.val setsockopt_int : file_descr -> socket_int_option -> int -> unitUnix.setsockopt for an integer-valued socket option.val getsockopt_optint : file_descr -> socket_optint_option -> int option
val setsockopt_optint : file_descr -> socket_optint_option -> int option -> unit
val getsockopt_float : file_descr -> socket_float_option -> floatUnix.getsockopt for a socket option whose value is a
floating-point number.val setsockopt_float : file_descr -> socket_float_option -> float -> unitUnix.setsockopt for a socket option whose value is a
floating-point number.val getsockopt_error : file_descr -> error optionval open_connection : sockaddr -> in_channel * out_channelflush on the output channel at the right
times to ensure correct synchronization.val shutdown_connection : in_channel -> unitUnix.open_connection;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection. This does not fully close the
file descriptor associated with the channel, which you must remember
to free via close_in.val establish_server : (in_channel -> out_channel -> unit) ->
sockaddr -> unitUnix.establish_server
never returns normally.
On Windows, it is not implemented. Use threads.
type
|
h_name : |
|
h_aliases : |
|
h_addrtype : |
|
h_addr_list : |
hosts database.type
|
p_name : |
|
p_aliases : |
|
p_proto : |
protocols database.type
|
s_name : |
|
s_aliases : |
|
s_port : |
|
s_proto : |
services database.val gethostname : unit -> stringval gethostbyname : string -> host_entryhosts with the given name.Not_found if no such entry exist.val gethostbyaddr : inet_addr -> host_entryhosts with the given address.Not_found if no such entry exist.val getprotobyname : string -> protocol_entryprotocols with the given name.Not_found if no such entry exist.val getprotobynumber : int -> protocol_entryprotocols with the given protocol number.Not_found if no such entry exist.val getservbyname : string -> string -> service_entryservices with the given name.Not_found if no such entry exist.val getservbyport : int -> string -> service_entryservices with the given service number.Not_found if no such entry exist.type
|
ai_family : |
(* |
Socket domain
| *) |
|
ai_socktype : |
(* |
Socket type
| *) |
|
ai_protocol : |
(* |
Socket protocol number
| *) |
|
ai_addr : |
(* |
Address
| *) |
|
ai_canonname : |
(* |
Canonical host name
| *) |
Unix.getaddrinfo.type
| |
AI_FAMILY of |
(* |
Impose the given socket domain
| *) |
| |
AI_SOCKTYPE of |
(* |
Impose the given socket type
| *) |
| |
AI_PROTOCOL of |
(* |
Impose the given protocol
| *) |
| |
AI_NUMERICHOST |
(* |
Do not call name resolver,
expect numeric IP address
| *) |
| |
AI_CANONNAME |
(* |
Fill the
ai_canonname field
of the result | *) |
| |
AI_PASSIVE |
(* |
Set address to ``any'' address
for use with
Unix.bind | *) |
Unix.getaddrinfo.val getaddrinfo : string -> string -> getaddrinfo_option list -> addr_info listgetaddrinfo host service opts returns a list of Unix.addr_info
records describing socket parameters and addresses suitable for
communicating with the given host and service. The empty list is
returned if the host or service names are unknown, or the constraints
expressed in opts cannot be satisfied.
host is either a host name or the string representation of an IP
address. host can be given as the empty string; in this case,
the ``any'' address or the ``loopback'' address are used,
depending whether opts contains AI_PASSIVE.
service is either a service name or the string representation of
a port number. service can be given as the empty string;
in this case, the port field of the returned addresses is set to 0.
opts is a possibly empty list of options that allows the caller
to force a particular socket domain (e.g. IPv6 only or IPv4 only)
or a particular socket type (e.g. TCP only or UDP only).
type
|
ni_hostname : |
(* |
Name or IP address of host
| *) |
|
ni_service : |
(* |
Name of service or port number
| *) |
Unix.getnameinfo.type
| |
NI_NOFQDN |
(* |
Do not qualify local host names
| *) |
| |
NI_NUMERICHOST |
(* |
Always return host as IP address
| *) |
| |
NI_NAMEREQD |
(* |
Fail if host name cannot be determined
| *) |
| |
NI_NUMERICSERV |
(* |
Always return service as port number
| *) |
| |
NI_DGRAM |
(* |
Consider the service as UDP-based
instead of the default TCP
| *) |
Unix.getnameinfo.val getnameinfo : sockaddr -> getnameinfo_option list -> name_infogetnameinfo addr opts returns the host name and service name
corresponding to the socket address addr. opts is a possibly
empty list of options that governs how these names are obtained.Not_found if an error occurs.termios man page for a
complete description.type
|
mutable c_ignbrk : |
(* |
Ignore the break condition.
| *) |
|
mutable c_brkint : |
(* |
Signal interrupt on break condition.
| *) |
|
mutable c_ignpar : |
(* |
Ignore characters with parity errors.
| *) |
|
mutable c_parmrk : |
(* |
Mark parity errors.
| *) |
|
mutable c_inpck : |
(* |
Enable parity check on input.
| *) |
|
mutable c_istrip : |
(* |
Strip 8th bit on input characters.
| *) |
|
mutable c_inlcr : |
(* |
Map NL to CR on input.
| *) |
|
mutable c_igncr : |
(* |
Ignore CR on input.
| *) |
|
mutable c_icrnl : |
(* |
Map CR to NL on input.
| *) |
|
mutable c_ixon : |
(* |
Recognize XON/XOFF characters on input.
| *) |
|
mutable c_ixoff : |
(* |
Emit XON/XOFF chars to control input flow.
| *) |
|
mutable c_opost : |
(* |
Enable output processing.
| *) |
|
mutable c_obaud : |
(* |
Output baud rate (0 means close connection).
| *) |
|
mutable c_ibaud : |
(* |
Input baud rate.
| *) |
|
mutable c_csize : |
(* |
Number of bits per character (5-8).
| *) |
|
mutable c_cstopb : |
(* |
Number of stop bits (1-2).
| *) |
|
mutable c_cread : |
(* |
Reception is enabled.
| *) |
|
mutable c_parenb : |
(* |
Enable parity generation and detection.
| *) |
|
mutable c_parodd : |
(* |
Specify odd parity instead of even.
| *) |
|
mutable c_hupcl : |
(* |
Hang up on last close.
| *) |
|
mutable c_clocal : |
(* |
Ignore modem status lines.
| *) |
|
mutable c_isig : |
(* |
Generate signal on INTR, QUIT, SUSP.
| *) |
|
mutable c_icanon : |
(* |
Enable canonical processing
(line buffering and editing)
| *) |
|
mutable c_noflsh : |
(* |
Disable flush after INTR, QUIT, SUSP.
| *) |
|
mutable c_echo : |
(* |
Echo input characters.
| *) |
|
mutable c_echoe : |
(* |
Echo ERASE (to erase previous character).
| *) |
|
mutable c_echok : |
(* |
Echo KILL (to erase the current line).
| *) |
|
mutable c_echonl : |
(* |
Echo NL even if c_echo is not set.
| *) |
|
mutable c_vintr : |
(* |
Interrupt character (usually ctrl-C).
| *) |
|
mutable c_vquit : |
(* |
Quit character (usually ctrl-\).
| *) |
|
mutable c_verase : |
(* |
Erase character (usually DEL or ctrl-H).
| *) |
|
mutable c_vkill : |
(* |
Kill line character (usually ctrl-U).
| *) |
|
mutable c_veof : |
(* |
End-of-file character (usually ctrl-D).
| *) |
|
mutable c_veol : |
(* |
Alternate end-of-line char. (usually none).
| *) |
|
mutable c_vmin : |
(* |
Minimum number of characters to read
before the read request is satisfied.
| *) |
|
mutable c_vtime : |
(* |
Maximum read wait (in 0.1s units).
| *) |
|
mutable c_vstart : |
(* |
Start character (usually ctrl-Q).
| *) |
|
mutable c_vstop : |
(* |
Stop character (usually ctrl-S).
| *) |
val tcgetattr : file_descr -> terminal_iotype
| |
TCSANOW |
| |
TCSADRAIN |
| |
TCSAFLUSH |
val tcsetattr : file_descr -> setattr_when -> terminal_io -> unitTCSANOW),
when all pending output has been transmitted (TCSADRAIN),
or after flushing all input that has been received but not
read (TCSAFLUSH). TCSADRAIN is recommended when changing
the output parameters; TCSAFLUSH, when changing the input
parameters.
On Windows, not implemented.
val tcsendbreak : file_descr -> int -> unit
On Windows, not implemented.
val tcdrain : file_descr -> unit
On Windows, not implemented.
type
| |
TCIFLUSH |
| |
TCOFLUSH |
| |
TCIOFLUSH |
val tcflush : file_descr -> flush_queue -> unitTCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.
On Windows, not implemented.
type
| |
TCOOFF |
| |
TCOON |
| |
TCIOFF |
| |
TCION |
val tcflow : file_descr -> flow_action -> unitTCOOFF suspends output, TCOON restarts output,
TCIOFF transmits a STOP character to suspend input,
and TCION transmits a START character to restart input.
On Windows, not implemented.
val setsid : unit -> int
On Windows, not implemented.
module Map:sig..end
include Map.S
val filter_map : 'a Identifiable.S.t -> f:(key -> 'a -> 'b option) -> 'b Identifiable.S.t
val of_list : (key * 'a) list -> 'a Identifiable.S.t
val disjoint_union : ?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.tdisjoint_union m1 m2 contains all bindings from m1 and
m2. If some binding is present in both and the associated
value is not equal, a Fatal_error is raisedval union_right : 'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.tunion_right m1 m2 contains all bindings from m1 and m2. If
some binding is present in both, the one from m2 is takenval union_left : 'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.tunion_left m1 m2 = union_right m2 m1val union_merge : ('a -> 'a -> 'a) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val rename : key Identifiable.S.t -> key -> key
val map_keys : (key -> key) -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val keys : 'a Identifiable.S.t -> Identifiable.S.Set.t
val data : 'a Identifiable.S.t -> 'a list
val of_set : (key -> 'a) -> Identifiable.S.Set.t -> 'a Identifiable.S.t
val transpose_keys_and_data : key Identifiable.S.t -> key Identifiable.S.t
val transpose_keys_and_data_set : key Identifiable.S.t -> Identifiable.S.Set.t Identifiable.S.t
val print : (Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a Identifiable.S.t -> unit ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Val.html 0000644 0001750 0001750 00000017245 13131636441 021247 0 ustar mehdi mehdi
module Val:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?prim:string list ->
Ast_helper.str -> Parsetree.core_type -> Parsetree.value_description ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Cf.html 0000644 0001750 0001750 00000030545 13131636441 022114 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
Parsetree.class_field_desc -> Parsetree.class_field
val attr :
Parsetree.class_field -> Parsetree.attribute -> Parsetree.class_field
val inherit_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.override_flag ->
Parsetree.class_expr -> Ast_helper.str option -> Parsetree.class_field
val val_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.mutable_flag ->
Parsetree.class_field_kind -> Parsetree.class_field
val method_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.private_flag ->
Parsetree.class_field_kind -> Parsetree.class_field
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.class_field
val initializer_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.class_field
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_field
val attribute :
?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.class_field
val text : Docstrings.text -> Parsetree.class_field list
val virtual_ : Parsetree.core_type -> Parsetree.class_field_kind
val concrete :
Asttypes.override_flag ->
Parsetree.expression -> Parsetree.class_field_kind
end ocaml-doc-4.05/ocaml.html/libref/Hashtbl.SeededHashedType.html 0000644 0001750 0001750 00000021003 13131636444 023162 0 ustar mehdi mehdi
module type SeededHashedType =sig..end
type
val equal : t -> t -> boolval hash : int -> t -> intequal x y is true,
then hash seed x = hash seed y for any value of seed.
A suitable choice for hash is the function Hashtbl.seeded_hash
below.sig
module type Thing =
sig
type t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : Pervasives.out_channel -> Identifiable.Thing.t -> unit
val print : Format.formatter -> Identifiable.Thing.t -> unit
end
module Pair :
functor (A : Thing) (B : Thing) ->
sig
type t = A.t * B.t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
module type S =
sig
type t
module T :
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : Pervasives.out_channel -> Identifiable.S.t -> unit
val print : Format.formatter -> Identifiable.S.t -> unit
val to_string : Identifiable.S.t -> string
val of_list : elt list -> Identifiable.S.t
val map : (elt -> elt) -> Identifiable.S.t -> Identifiable.S.t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map :
'a Identifiable.S.t ->
f:(key -> 'a -> 'b option) -> 'b Identifiable.S.t
val of_list : (key * 'a) list -> 'a Identifiable.S.t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_right :
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_left :
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val union_merge :
('a -> 'a -> 'a) ->
'a Identifiable.S.t -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val rename : key Identifiable.S.t -> key -> key
val map_keys :
(key -> key) -> 'a Identifiable.S.t -> 'a Identifiable.S.t
val keys : 'a Identifiable.S.t -> Identifiable.S.Set.t
val data : 'a Identifiable.S.t -> 'a list
val of_set :
(key -> 'a) -> Identifiable.S.Set.t -> 'a Identifiable.S.t
val transpose_keys_and_data :
key Identifiable.S.t -> key Identifiable.S.t
val transpose_keys_and_data_set :
key Identifiable.S.t -> Identifiable.S.Set.t Identifiable.S.t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a Identifiable.S.t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a Identifiable.S.t -> (Identifiable.S.T.t * 'a) list
val of_list : (Identifiable.S.T.t * 'a) list -> 'a Identifiable.S.t
val to_map : 'a Identifiable.S.t -> 'a Identifiable.S.Map.t
val of_map : 'a Identifiable.S.Map.t -> 'a Identifiable.S.t
val memoize : 'a Identifiable.S.t -> (key -> 'a) -> key -> 'a
val map : 'a Identifiable.S.t -> ('a -> 'b) -> 'b Identifiable.S.t
end
end
module Make :
functor (T : Thing) ->
sig
module T :
sig
type t = T.t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
val to_string : t -> string
val of_list : elt list -> t
val map : (elt -> elt) -> t -> t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union :
(key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map : 'a t -> f:(key -> 'a -> 'b option) -> 'b t
val of_list : (key * 'a) list -> 'a t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) -> 'a t -> 'a t -> 'a t
val union_right : 'a t -> 'a t -> 'a t
val union_left : 'a t -> 'a t -> 'a t
val union_merge : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val rename : key t -> key -> key
val map_keys : (key -> key) -> 'a t -> 'a t
val keys : 'a t -> Set.t
val data : 'a t -> 'a list
val of_set : (key -> 'a) -> Set.t -> 'a t
val transpose_keys_and_data : key t -> key t
val transpose_keys_and_data_set : key t -> Set.t t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a t -> (T.t * 'a) list
val of_list : (T.t * 'a) list -> 'a t
val to_map : 'a t -> 'a Map.t
val of_map : 'a Map.t -> 'a t
val memoize : 'a t -> (key -> 'a) -> key -> 'a
val map : 'a t -> ('a -> 'b) -> 'b t
end
end
end ocaml-doc-4.05/ocaml.html/libref/type_Random.State.html 0000644 0001750 0001750 00000022107 13131636450 021771 0 ustar mehdi mehdi
sig
type t
val make : int array -> Random.State.t
val make_self_init : unit -> Random.State.t
val copy : Random.State.t -> Random.State.t
val bits : Random.State.t -> int
val int : Random.State.t -> int -> int
val int32 : Random.State.t -> Int32.t -> Int32.t
val nativeint : Random.State.t -> Nativeint.t -> Nativeint.t
val int64 : Random.State.t -> Int64.t -> Int64.t
val float : Random.State.t -> float -> float
val bool : Random.State.t -> bool
end ocaml-doc-4.05/ocaml.html/libref/Num.html 0000644 0001750 0001750 00000057675 13131636447 017220 0 ustar mehdi mehdi
module Num:sig..end
Numbers (type num) are arbitrary-precision rational numbers,
plus the special elements 1/0 (infinity) and 0/0 (undefined).
type
| |
Int of |
| |
Big_int of |
| |
Ratio of |
val (+/) : num -> num -> numNum.add_num.val add_num : num -> num -> numval minus_num : num -> numval (-/) : num -> num -> numNum.sub_num.val sub_num : num -> num -> numval ( */ ) : num -> num -> numNum.mult_num.val mult_num : num -> num -> numval square_num : num -> numval (//) : num -> num -> numNum.div_num.val div_num : num -> num -> numval quo_num : num -> num -> numval mod_num : num -> num -> numval ( **/ ) : num -> num -> numNum.power_num.val power_num : num -> num -> numval abs_num : num -> numval succ_num : num -> numsucc n is n+1val pred_num : num -> numpred n is n-1val incr_num : num ref -> unitincr r is r:=!r+1, where r is a reference to a number.val decr_num : num ref -> unitdecr r is r:=!r-1, where r is a reference to a number.val is_integer_num : num -> boolval integer_num : num -> numinteger_num n returns the integer closest to n. In case of ties,
rounds towards zero.val floor_num : num -> numfloor_num n returns the largest integer smaller or equal to n.val round_num : num -> numround_num n returns the integer closest to n. In case of ties,
rounds off zero.val ceiling_num : num -> numceiling_num n returns the smallest integer bigger or equal to n.val sign_num : num -> int-1, 0 or 1 according to the sign of the argument.val (=/) : num -> num -> bool
val (</) : num -> num -> bool
val (>/) : num -> num -> bool
val (<=/) : num -> num -> bool
val (>=/) : num -> num -> bool
val (<>/) : num -> num -> bool
val eq_num : num -> num -> bool
val lt_num : num -> num -> bool
val le_num : num -> num -> bool
val gt_num : num -> num -> bool
val ge_num : num -> num -> bool
val compare_num : num -> num -> int-1, 0 or 1 if the first argument is less than,
equal to, or greater than the second argument.val max_num : num -> num -> numval min_num : num -> num -> numval string_of_num : num -> stringval approx_num_fix : int -> num -> stringNum.approx_num_exp.val approx_num_exp : int -> num -> stringNum.approx_num_fix uses decimal notation; the first
argument is the number of digits after the decimal point.
approx_num_exp uses scientific (exponential) notation; the
first argument is the number of digits in the mantissa.val num_of_string : string -> numFailure "num_of_string" if the given string is not
a valid representation of an integerval num_of_string_opt : string -> num optionNone if the given string is not
a valid representation of an integer.val int_of_num : num -> int
val int_of_num_opt : num -> int optionval num_of_int : int -> num
val nat_of_num : num -> Nat.nat
val nat_of_num_opt : num -> Nat.nat optionval num_of_nat : Nat.nat -> num
val num_of_big_int : Big_int.big_int -> num
val big_int_of_num : num -> Big_int.big_int
val big_int_of_num_opt : num -> Big_int.big_int optionval ratio_of_num : num -> Ratio.ratio
val num_of_ratio : Ratio.ratio -> num
val float_of_num : num -> float ocaml-doc-4.05/ocaml.html/libref/StringLabels.html 0000644 0001750 0001750 00000075126 13131636451 021034 0 ustar mehdi mehdi
module StringLabels:sig..end
val length : string -> intval get : string -> int -> charString.get s n returns the character at index n in string s.
You can also write s.[n] instead of String.get s n.
Raise Invalid_argument if n not a valid index in s.
val set : bytes -> int -> char -> unitBytesLabels.set.String.set s n c modifies byte sequence s in place,
replacing the byte at index n with c.
You can also write s.[n] <- c instead of String.set s n c.
Raise Invalid_argument if n is not a valid index in s.
val create : int -> bytesBytesLabels.create.String.create n returns a fresh byte sequence of length n.
The sequence is uninitialized and contains arbitrary bytes.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val make : int -> char -> stringString.make n c returns a fresh string of length n,
filled with the character c.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val init : int -> f:(int -> char) -> stringinit n f returns a string of length n,
with character i initialized to the result of f i.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
Since 4.02.0
val copy : string -> stringval sub : string -> pos:int -> len:int -> stringString.sub s start len returns a fresh string of length len,
containing the substring of s that starts at position start and
has length len.
Raise Invalid_argument if start and len do not
designate a valid substring of s.
val fill : bytes -> pos:int -> len:int -> char -> unitBytesLabels.fill.String.fill s start len c modifies byte sequence s in place,
replacing len bytes by c, starting at start.
Raise Invalid_argument if start and len do not
designate a valid substring of s.
val blit : src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitString.blit src srcoff dst dstoff len copies len bytes
from the string src, starting at index srcoff,
to byte sequence dst, starting at character number dstoff.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
val concat : sep:string -> string list -> stringString.concat sep sl concatenates the list of strings sl,
inserting the separator string sep between each.val iter : f:(char -> unit) -> string -> unitString.iter f s applies function f in turn to all
the characters of s. It is equivalent to
f s.[0]; f s.[1]; ...; f s.[String.length s - 1]; ().val iteri : f:(int -> char -> unit) -> string -> unitString.iter, but the
function is applied to the index of the element as first argument
(counting from 0), and the character itself as second argument.val map : f:(char -> char) -> string -> stringString.map f s applies function f in turn to all
the characters of s and stores the results in a new string that
is returned.val mapi : f:(int -> char -> char) -> string -> stringString.mapi f s calls f with each character of s and its
index (in increasing index order) and stores the results in a new
string that is returned.val trim : string -> string' ',
'\012', '\n', '\r', and '\t'. If there is no leading nor
trailing whitespace character in the argument, return the original
string itself, not a copy.val escaped : string -> stringval index : string -> char -> intString.index s c returns the index of the first
occurrence of character c in string s.
Raise Not_found if c does not occur in s.
val index_opt : string -> char -> int optionString.index_opt s c returns the index of the first
occurrence of character c in string s, or
None if c does not occur in s.val rindex : string -> char -> intString.rindex s c returns the index of the last
occurrence of character c in string s.
Raise Not_found if c does not occur in s.
val rindex_opt : string -> char -> int optionString.rindex_opt s c returns the index of the last occurrence
of character c in string s, or None if c does not occur in
s.val index_from : string -> int -> char -> intString.index_from s i c returns the index of the
first occurrence of character c in string s after position i.
String.index s c is equivalent to String.index_from s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Raise Not_found if c does not occur in s after position i.
val index_from_opt : string -> int -> char -> int optionString.index_from_opt s i c returns the index of the
first occurrence of character c in string s after position i
or None if c does not occur in s after position i.
String.index_opt s c is equivalent to String.index_from_opt s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Since 4.05
val rindex_from : string -> int -> char -> intString.rindex_from s i c returns the index of the
last occurrence of character c in string s before position i+1.
String.rindex s c is equivalent to
String.rindex_from s (String.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Raise Not_found if c does not occur in s before position i+1.
val rindex_from_opt : string -> int -> char -> int optionString.rindex_from_opt s i c returns the index of the
last occurrence of character c in string s before position i+1
or None if c does not occur in s before position i+1.
String.rindex_opt s c is equivalent to
String.rindex_from_opt s (String.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Since 4.05
val contains : string -> char -> boolString.contains s c tests if character c
appears in the string s.val contains_from : string -> int -> char -> boolString.contains_from s start c tests if character c
appears in s after position start.
String.contains s c is equivalent to
String.contains_from s 0 c.
Raise Invalid_argument if start is not a valid position in s.
val rcontains_from : string -> int -> char -> boolString.rcontains_from s stop c tests if character c
appears in s before position stop+1.
Raise Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.
val uppercase : string -> stringval lowercase : string -> stringval capitalize : string -> stringval uncapitalize : string -> stringval uppercase_ascii : string -> stringval lowercase_ascii : string -> stringval capitalize_ascii : string -> stringval uncapitalize_ascii : string -> stringtypet =string
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module String to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolval split_on_char : sep:char -> string -> string listString.split_on_char sep s returns the list of all (possibly empty)
substrings of s that are delimited by the sep character.
The function's output is specified by the following invariants:
sep as a separator returns a
string equal to the input (String.concat (String.make 1 sep)
(String.split_on_char sep s) = s).sep character.sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : Pervasives.out_channel -> Identifiable.S.t -> unit
val print : Format.formatter -> Identifiable.S.t -> unit
val to_string : Identifiable.S.t -> string
val of_list : elt list -> Identifiable.S.t
val map : (elt -> elt) -> Identifiable.S.t -> Identifiable.S.t
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Mod.html 0000644 0001750 0001750 00000025350 13131636441 021240 0 ustar mehdi mehdi
module Mod:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr_desc -> Parsetree.module_expr
val attr : Parsetree.module_expr -> Parsetree.attribute -> Parsetree.module_expr
val ident : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_expr
val structure : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.structure -> Parsetree.module_expr
val functor_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_type option ->
Parsetree.module_expr -> Parsetree.module_expr
val apply : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr -> Parsetree.module_expr -> Parsetree.module_expr
val constraint_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr -> Parsetree.module_type -> Parsetree.module_expr
val unpack : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.module_expr
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.module_expr ocaml-doc-4.05/ocaml.html/libref/Parsetree.html 0000644 0001750 0001750 00000332041 13131636447 020372 0 ustar mehdi mehdi
module Parsetree:sig..end
type
| |
Pconst_integer of |
| |
Pconst_char of |
| |
Pconst_string of |
| |
Pconst_float of |
typeattribute =string Asttypes.loc * payload
typeextension =string Asttypes.loc * payload
typeattributes =attribute list
type
| |
PStr of |
| |
PSig of |
| |
PTyp of |
| |
PPat of |
type
|
ptyp_desc : |
|
ptyp_loc : |
|
ptyp_attributes : |
type
| |
Ptyp_any |
| |
Ptyp_var of |
| |
Ptyp_arrow of |
| |
Ptyp_tuple of |
| |
Ptyp_constr of |
| |
Ptyp_object of |
| |
Ptyp_class of |
| |
Ptyp_alias of |
| |
Ptyp_variant of |
| |
Ptyp_poly of |
| |
Ptyp_package of |
| |
Ptyp_extension of |
typepackage_type =Longident.t Asttypes.loc *
(Longident.t Asttypes.loc * core_type) list
type
| |
Rtag of |
| |
Rinherit of |
type
|
ppat_desc : |
|
ppat_loc : |
|
ppat_attributes : |
type
| |
Ppat_any |
| |
Ppat_var of |
| |
Ppat_alias of |
| |
Ppat_constant of |
| |
Ppat_interval of |
| |
Ppat_tuple of |
| |
Ppat_construct of |
| |
Ppat_variant of |
| |
Ppat_record of |
| |
Ppat_array of |
| |
Ppat_or of |
| |
Ppat_constraint of |
| |
Ppat_type of |
| |
Ppat_lazy of |
| |
Ppat_unpack of |
| |
Ppat_exception of |
| |
Ppat_extension of |
| |
Ppat_open of |
type
|
pexp_desc : |
|
pexp_loc : |
|
pexp_attributes : |
type
| |
Pexp_ident of |
| |
Pexp_constant of |
| |
Pexp_let of |
| |
Pexp_function of |
| |
Pexp_fun of |
| |
Pexp_apply of |
| |
Pexp_match of |
| |
Pexp_try of |
| |
Pexp_tuple of |
| |
Pexp_construct of |
| |
Pexp_variant of |
| |
Pexp_record of |
| |
Pexp_field of |
| |
Pexp_setfield of |
| |
Pexp_array of |
| |
Pexp_ifthenelse of |
| |
Pexp_sequence of |
| |
Pexp_while of |
| |
Pexp_for of |
| |
Pexp_constraint of |
| |
Pexp_coerce of |
| |
Pexp_send of |
| |
Pexp_new of |
| |
Pexp_setinstvar of |
| |
Pexp_override of |
| |
Pexp_letmodule of |
| |
Pexp_letexception of |
| |
Pexp_assert of |
| |
Pexp_lazy of |
| |
Pexp_poly of |
| |
Pexp_object of |
| |
Pexp_newtype of |
| |
Pexp_pack of |
| |
Pexp_open of |
| |
Pexp_extension of |
| |
Pexp_unreachable |
type
|
pc_lhs : |
|
pc_guard : |
|
pc_rhs : |
type
|
pval_name : |
|
pval_type : |
|
pval_prim : |
|
pval_attributes : |
|
pval_loc : |
type
|
ptype_name : |
|
ptype_params : |
|
ptype_cstrs : |
|
ptype_kind : |
|
ptype_private : |
|
ptype_manifest : |
|
ptype_attributes : |
|
ptype_loc : |
type
| |
Ptype_abstract |
| |
Ptype_variant of |
| |
Ptype_record of |
| |
Ptype_open |
type
|
pld_name : |
|
pld_mutable : |
|
pld_type : |
|
pld_loc : |
|
pld_attributes : |
type
|
pcd_name : |
|
pcd_args : |
|
pcd_res : |
|
pcd_loc : |
|
pcd_attributes : |
type
| |
Pcstr_tuple of |
| |
Pcstr_record of |
type
|
ptyext_path : |
|
ptyext_params : |
|
ptyext_constructors : |
|
ptyext_private : |
|
ptyext_attributes : |
type
|
pext_name : |
|
pext_kind : |
|
pext_loc : |
|
pext_attributes : |
type
| |
Pext_decl of |
| |
Pext_rebind of |
type
|
pcty_desc : |
|
pcty_loc : |
|
pcty_attributes : |
type
| |
Pcty_constr of |
| |
Pcty_signature of |
| |
Pcty_arrow of |
| |
Pcty_extension of |
type
|
pcsig_self : |
|
pcsig_fields : |
type
|
pctf_desc : |
|
pctf_loc : |
|
pctf_attributes : |
type
| |
Pctf_inherit of |
| |
Pctf_val of |
| |
Pctf_method of |
| |
Pctf_constraint of |
| |
Pctf_attribute of |
| |
Pctf_extension of |
type 'a class_infos = {
|
pci_virt : |
|
pci_params : |
|
pci_name : |
|
pci_expr : |
|
pci_loc : |
|
pci_attributes : |
typeclass_description =class_type class_infos
typeclass_type_declaration =class_type class_infos
type
|
pcl_desc : |
|
pcl_loc : |
|
pcl_attributes : |
type
| |
Pcl_constr of |
| |
Pcl_structure of |
| |
Pcl_fun of |
| |
Pcl_apply of |
| |
Pcl_let of |
| |
Pcl_constraint of |
| |
Pcl_extension of |
type
|
pcstr_self : |
|
pcstr_fields : |
type
|
pcf_desc : |
|
pcf_loc : |
|
pcf_attributes : |
type
| |
Pcf_inherit of |
| |
Pcf_val of |
| |
Pcf_method of |
| |
Pcf_constraint of |
| |
Pcf_initializer of |
| |
Pcf_attribute of |
| |
Pcf_extension of |
type
| |
Cfk_virtual of |
| |
Cfk_concrete of |
typeclass_declaration =class_expr class_infos
type
|
pmty_desc : |
|
pmty_loc : |
|
pmty_attributes : |
type
| |
Pmty_ident of |
| |
Pmty_signature of |
| |
Pmty_functor of |
| |
Pmty_with of |
| |
Pmty_typeof of |
| |
Pmty_extension of |
| |
Pmty_alias of |
typesignature =signature_item list
type
|
psig_desc : |
|
psig_loc : |
type
| |
Psig_value of |
| |
Psig_type of |
| |
Psig_typext of |
| |
Psig_exception of |
| |
Psig_module of |
| |
Psig_recmodule of |
| |
Psig_modtype of |
| |
Psig_open of |
| |
Psig_include of |
| |
Psig_class of |
| |
Psig_class_type of |
| |
Psig_attribute of |
| |
Psig_extension of |
type
|
pmd_name : |
|
pmd_type : |
|
pmd_attributes : |
|
pmd_loc : |
type
|
pmtd_name : |
|
pmtd_type : |
|
pmtd_attributes : |
|
pmtd_loc : |
type
|
popen_lid : |
|
popen_override : |
|
popen_loc : |
|
popen_attributes : |
type 'a include_infos = {
|
pincl_mod : |
|
pincl_loc : |
|
pincl_attributes : |
typeinclude_description =module_type include_infos
typeinclude_declaration =module_expr include_infos
type
| |
Pwith_type of |
| |
Pwith_module of |
| |
Pwith_typesubst of |
| |
Pwith_modsubst of |
type
|
pmod_desc : |
|
pmod_loc : |
|
pmod_attributes : |
type
| |
Pmod_ident of |
| |
Pmod_structure of |
| |
Pmod_functor of |
| |
Pmod_apply of |
| |
Pmod_constraint of |
| |
Pmod_unpack of |
| |
Pmod_extension of |
typestructure =structure_item list
type
|
pstr_desc : |
|
pstr_loc : |
type
| |
Pstr_eval of |
| |
Pstr_value of |
| |
Pstr_primitive of |
| |
Pstr_type of |
| |
Pstr_typext of |
| |
Pstr_exception of |
| |
Pstr_module of |
| |
Pstr_recmodule of |
| |
Pstr_modtype of |
| |
Pstr_open of |
| |
Pstr_class of |
| |
Pstr_class_type of |
| |
Pstr_include of |
| |
Pstr_attribute of |
| |
Pstr_extension of |
type
|
pvb_pat : |
|
pvb_expr : |
|
pvb_attributes : |
|
pvb_loc : |
type
|
pmb_name : |
|
pmb_expr : |
|
pmb_attributes : |
|
pmb_loc : |
type
| |
Ptop_def of |
| |
Ptop_dir of |
type
| |
Pdir_none |
| |
Pdir_string of |
| |
Pdir_int of |
| |
Pdir_ident of |
| |
Pdir_bool of |
A | |
| acc [CamlinternalFormat] | |
| acc_formatting_gen [CamlinternalFormat] | |
| access_permission [UnixLabels] |
Flags for the
UnixLabels.access call.
|
| access_permission [Unix] |
Flags for the
Unix.access call.
|
| addr_info [UnixLabels] |
Address information returned by
Unix.getaddrinfo.
|
| addr_info [Unix] |
Address information returned by
Unix.getaddrinfo.
|
| alarm [Gc] |
An alarm is a piece of data that calls a user function at the end of
each major GC cycle.
|
| anon_fun [Arg] | |
| arg_label [Asttypes] | |
| attribute [Parsetree] | |
| attributes [Parsetree] | |
| attrs [Ast_helper] | |
B | |
| backend_type [Sys] |
Currently, the official distribution only supports
Native and
Bytecode, but it can be other backends with alternative
compilers, for example, javascript.
|
| backtrace_slot [Printexc] |
The abstract type
backtrace_slot represents a single slot of
a backtrace.
|
| big_int [Big_int] |
The type of big integers.
|
| block_type [CamlinternalFormatBasics] | |
| bound_map [Depend] | |
C | |
| c_layout [Bigarray] | |
| case [Parsetree] | |
| channel [Event] |
The type of communication channels carrying values of type
'a.
|
| char_set [CamlinternalFormatBasics] | |
| class_declaration [Parsetree] | |
| class_description [Parsetree] | |
| class_expr [Parsetree] | |
| class_expr_desc [Parsetree] | |
| class_field [Parsetree] | |
| class_field_desc [Parsetree] | |
| class_field_kind [Parsetree] | |
| class_infos [Parsetree] | |
| class_signature [Parsetree] | |
| class_structure [Parsetree] | |
| class_type [Parsetree] | |
| class_type_declaration [Parsetree] | |
| class_type_desc [Parsetree] | |
| class_type_field [Parsetree] | |
| class_type_field_desc [Parsetree] | |
| closed_flag [Asttypes] | |
| closure [CamlinternalOO] | |
| color [Misc.Color] | |
| color [Graphics] |
A color is specified by its R, G, B components.
|
| compiler_pass [Timings] | |
| complex32_elt [Bigarray] | |
| complex64_elt [Bigarray] | |
| component [Strongly_connected_components.S] | |
| constant [Parsetree] | |
| constant [Asttypes] | |
| constructor_arguments [Parsetree] | |
| constructor_declaration [Parsetree] | |
| control [Gc] |
The GC parameters are given as a
control record.
|
| core_type [Parsetree] | |
| core_type_desc [Parsetree] | |
| counter [CamlinternalFormatBasics] | |
| custom_arity [CamlinternalFormatBasics] | |
D | |
| data [Weak.S] |
The type of the elements stored in the table.
|
| dir_handle [UnixLabels] |
The type of descriptors over opened directories.
|
| dir_handle [Unix] |
The type of descriptors over opened directories.
|
| directed_graph [Strongly_connected_components.S] |
If (a -> set) belongs to the map, it means that there are edges
from
a to every element of set.
|
| direction_flag [Asttypes] | |
| directive_argument [Parsetree] | |
| doc [Arg] | |
| docs [Docstrings] | |
| docstring [Docstrings] |
Documentation comments
|
E | |
| elt [MoreLabels.Set.S] | |
| elt [Set.S] |
The type of the set elements.
|
| equal [Ephemeron.GenHashTable] | |
| error [UnixLabels] |
The type of error codes.
|
| error [Unix] |
The type of error codes.
|
| error [Syntaxerr] | |
| error [Location] | |
| error [Lexer] | |
| error [Dynlink] | |
| error [Attr_helper] | |
| event [Graphics] |
To specify events to wait for.
|
| event [Event] |
The type of communication events returning a result of type
'a.
|
| expression [Parsetree] | |
| expression_desc [Parsetree] | |
| extension [Parsetree] | |
| extension_constructor [Parsetree] | |
| extension_constructor_kind [Parsetree] | |
| extern_flags [Marshal] |
The flags to the
Marshal.to_* functions below.
|
F | |
| file [Timings] | |
| file_descr [UnixLabels] |
The abstract type of file descriptors.
|
| file_descr [Unix] |
The abstract type of file descriptors.
|
| file_kind [UnixLabels] | |
| file_kind [Unix] | |
| file_name [Scanf.Scanning] |
A convenient alias to designate a file name.
|
| file_perm [UnixLabels] |
The type of file access rights, e.g.
|
| file_perm [Unix] |
The type of file access rights, e.g.
|
| float32_elt [Bigarray] | |
| float64_elt [Bigarray] | |
| float_conv [CamlinternalFormatBasics] | |
| flow_action [UnixLabels] | |
| flow_action [Unix] | |
| flush_queue [UnixLabels] | |
| flush_queue [Unix] | |
| fmt [CamlinternalFormatBasics] |
List of format elements.
|
| fmt_ebb [CamlinternalFormat] | |
| fmtty [CamlinternalFormatBasics] | |
| fmtty_rel [CamlinternalFormatBasics] | |
| format [Pervasives] | |
| format4 [Pervasives] | |
| format6 [Pervasives] | |
| format6 [CamlinternalFormatBasics] | |
| formatter [Format] |
Abstract data corresponding to a pretty-printer (also called a
formatter) and all its machinery.
|
| formatter_out_functions [Format] | |
| formatter_tag_functions [Format] |
The tag handling functions specific to a formatter:
mark versions are the 'tag marking' functions that associate a string
marker to a tag in order for the pretty-printing engine to flush
those markers as 0 length tokens in the output device of the formatter.
|
| formatting_gen [CamlinternalFormatBasics] | |
| formatting_lit [CamlinternalFormatBasics] | |
| fortran_layout [Bigarray] |
To facilitate interoperability with existing C and Fortran code,
this library supports two different memory layouts for big arrays,
one compatible with the C conventions,
the other compatible with the Fortran conventions.
|
| fpclass [Pervasives] |
The five classes of floating-point numbers, as determined by
the
classify_float function.
|
G | |
| getaddrinfo_option [UnixLabels] |
Options to
Unix.getaddrinfo.
|
| getaddrinfo_option [Unix] |
Options to
Unix.getaddrinfo.
|
| getnameinfo_option [UnixLabels] |
Options to
Unix.getnameinfo.
|
| getnameinfo_option [Unix] |
Options to
Unix.getnameinfo.
|
| group_entry [UnixLabels] |
Structure of entries in the
groups database.
|
| group_entry [Unix] |
Structure of entries in the
groups database.
|
H | |
| heter_list [CamlinternalFormat] | |
| hook_info [Misc] | |
| host_entry [UnixLabels] |
Structure of entries in the
hosts database.
|
| host_entry [Unix] |
Structure of entries in the
hosts database.
|
I | |
| ignored [CamlinternalFormatBasics] | |
| image [Graphics] |
The abstract type for images, in internal representation.
|
| impl [CamlinternalOO] | |
| in_channel [Scanf.Scanning] |
The notion of input channel for the
Scanf module:
those channels provide all the machinery necessary to read from any source
of characters, including a in_channel value.
|
| in_channel [Pervasives] |
The type of input channel.
|
| include_declaration [Parsetree] | |
| include_description [Parsetree] | |
| include_infos [Parsetree] | |
| inet_addr [UnixLabels] |
The abstract type of Internet addresses.
|
| inet_addr [Unix] |
The abstract type of Internet addresses.
|
| info [Docstrings] | |
| init_table [CamlinternalOO] | |
| inlining_arguments [Clflags] | |
| int16_signed_elt [Bigarray] | |
| int16_unsigned_elt [Bigarray] | |
| int32_elt [Bigarray] | |
| int64_elt [Bigarray] | |
| int8_signed_elt [Bigarray] | |
| int8_unsigned_elt [Bigarray] | |
| int_conv [CamlinternalFormatBasics] | |
| int_elt [Bigarray] | |
| interval_timer [UnixLabels] |
The three kinds of interval timers.
|
| interval_timer [Unix] |
The three kinds of interval timers.
|
| interval_timer_status [UnixLabels] |
The type describing the status of an interval timer
|
| interval_timer_status [Unix] |
The type describing the status of an interval timer
|
| iterator [Ast_iterator] |
A
iterator record implements one "method" per syntactic category,
using an open recursion style: each method takes as its first
argument the iterator to be applied to children in the syntax
tree.
|
K | |
| key [MoreLabels.Map.S] | |
| key [MoreLabels.Hashtbl.SeededS] | |
| key [MoreLabels.Hashtbl.S] | |
| key [Hashtbl.SeededS] | |
| key [Hashtbl.S] | |
| key [Map.S] |
The type of the map keys.
|
| key [Arg] | |
| kind [Bigarray] |
To each element kind is associated an OCaml type, which is
the type of OCaml values that can be stored in the big array
or read back from it.
|
L | |
| label [CamlinternalOO] | |
| label [Asttypes] | |
| label_declaration [Parsetree] | |
| layout [Bigarray] | |
| lexbuf [Lexing] |
The type of lexer buffers.
|
| lid [Ast_helper] | |
| link_mode [Ccomp] | |
| linking_error [Dynlink] | |
| loc [Location] | |
| loc [Asttypes] | |
| loc [Ast_helper] | |
| location [Printexc] |
The type of location information found in backtraces.
|
| lock_command [UnixLabels] |
Commands for
UnixLabels.lockf.
|
| lock_command [Unix] |
Commands for
Unix.lockf.
|
M | |
| map_tree [Depend] | |
| mapper [Ast_mapper] |
A mapper record implements one "method" per syntactic category,
using an open recursion style: each method takes as its first
argument the mapper to be applied to children in the syntax
tree.
|
| meth [CamlinternalOO] | |
| module_binding [Parsetree] | |
| module_declaration [Parsetree] | |
| module_expr [Parsetree] | |
| module_expr_desc [Parsetree] | |
| module_type [Parsetree] | |
| module_type_declaration [Parsetree] | |
| module_type_desc [Parsetree] | |
| msg_flag [UnixLabels] | |
| msg_flag [Unix] | |
| mutable_char_set [CamlinternalFormat] | |
| mutable_flag [Asttypes] | |
N | |
| name_info [UnixLabels] |
Host and service information returned by
Unix.getnameinfo.
|
| name_info [Unix] |
Host and service information returned by
Unix.getnameinfo.
|
| nativeint_elt [Bigarray] | |
| num [Num] |
The type of numbers.
|
O | |
| obj [CamlinternalOO] | |
| obj_t [Obj.Ephemeron] |
alias for
Obj.t
|
| open_description [Parsetree] | |
| open_flag [UnixLabels] |
The flags to
UnixLabels.openfile.
|
| open_flag [Unix] |
The flags to
Unix.openfile.
|
| open_flag [Pervasives] |
Opening modes for
open_out_gen and
open_in_gen.
|
| out_channel [Pervasives] |
The type of output channel.
|
| override_flag [Asttypes] | |
P | |
| package_type [Parsetree] | |
| pad_option [CamlinternalFormatBasics] | |
| padding [CamlinternalFormatBasics] | |
| padty [CamlinternalFormatBasics] | |
| param_format_ebb [CamlinternalFormat] | |
| params [CamlinternalOO] | |
| parse_result [Clflags.Float_arg_helper] | |
| parse_result [Clflags.Int_arg_helper] | |
| parse_result [Arg_helper.Make] | |
| parsed [Clflags.Float_arg_helper] | |
| parsed [Clflags.Int_arg_helper] | |
| parsed [Arg_helper.Make] | |
| passwd_entry [UnixLabels] |
Structure of entries in the
passwd database.
|
| passwd_entry [Unix] |
Structure of entries in the
passwd database.
|
| pattern [Parsetree] | |
| pattern_desc [Parsetree] | |
| payload [Parsetree] | |
| position [Lexing] |
A value of type
position describes a point in a source file.
|
| prec_option [CamlinternalFormatBasics] | |
| precision [CamlinternalFormatBasics] | |
| private_flag [Asttypes] | |
| process_status [UnixLabels] |
The termination status of a process.
|
| process_status [Unix] |
The termination status of a process.
|
| process_times [UnixLabels] |
The execution times (CPU times) of a process.
|
| process_times [Unix] |
The execution times (CPU times) of a process.
|
| protocol_entry [UnixLabels] |
Structure of entries in the
protocols database.
|
| protocol_entry [Unix] |
Structure of entries in the
protocols database.
|
R | |
| ratio [Ratio] | |
| raw_backtrace [Printexc] |
The abstract type
raw_backtrace stores a backtrace in
a low-level format, instead of directly exposing them as string as
the get_backtrace() function does.
|
| raw_backtrace_slot [Printexc] |
This type allows direct access to raw backtrace slots, without any
conversion in an OCaml-usable data-structure.
|
| rec_flag [Asttypes] | |
| ref [Pervasives] |
The type of references (mutable indirection cells) containing
a value of type
'a.
|
| ref_and_value [Misc] | |
| regexp [Str] |
The type of compiled regular expressions.
|
| repr [Targetint] | |
| result [Pervasives] | |
| row_field [Parsetree] | |
S | |
| scanbuf [Scanf.Scanning] |
The type of scanning buffers.
|
| scanner [Scanf] |
The type of formatted input scanners:
('a, 'b, 'c, 'd) scanner
is the type of a formatted input function that reads from some
formatted input channel according to some format string; more
precisely, if scan is some formatted input function, then scan applies f to all the arguments specified by format
string fmt, when scan has read those arguments from the
Scanf.Scanning.in_channel formatted input channel ic.
|
| seek_command [UnixLabels] |
Positioning modes for
UnixLabels.lseek.
|
| seek_command [Unix] |
Positioning modes for
Unix.lseek.
|
| service_entry [UnixLabels] |
Structure of entries in the
services database.
|
| service_entry [Unix] |
Structure of entries in the
services database.
|
| setattr_when [UnixLabels] | |
| setattr_when [Unix] | |
| setting [Misc.Color] | |
| shape [CamlinternalMod] | |
| shutdown_command [UnixLabels] |
The type of commands for
shutdown.
|
| shutdown_command [Unix] |
The type of commands for
shutdown.
|
| signal_behavior [Sys] |
What to do when receiving a signal:
Signal_default: take the default behavior
(usually: abort the program), Signal_ignore: ignore the signal, Signal_handle f: call function f, giving it the signal
number as argument.
|
| signature [Parsetree] | |
| signature_item [Parsetree] | |
| signature_item_desc [Parsetree] | |
| sigprocmask_command [UnixLabels] | |
| sigprocmask_command [Unix] | |
| sockaddr [UnixLabels] | |
| sockaddr [Unix] | |
| socket_bool_option [UnixLabels] |
The socket options that can be consulted with
UnixLabels.getsockopt
and modified with UnixLabels.setsockopt.
|
| socket_bool_option [Unix] |
The socket options that can be consulted with
Unix.getsockopt
and modified with Unix.setsockopt.
|
| socket_domain [UnixLabels] |
The type of socket domains.
|
| socket_domain [Unix] |
The type of socket domains.
|
| socket_float_option [UnixLabels] |
The socket options that can be consulted with
UnixLabels.getsockopt_float
and modified with UnixLabels.setsockopt_float.
|
| socket_float_option [Unix] |
The socket options that can be consulted with
Unix.getsockopt_float
and modified with Unix.setsockopt_float.
|
| socket_int_option [UnixLabels] |
The socket options that can be consulted with
UnixLabels.getsockopt_int
and modified with UnixLabels.setsockopt_int.
|
| socket_int_option [Unix] |
The socket options that can be consulted with
Unix.getsockopt_int
and modified with Unix.setsockopt_int.
|
| socket_optint_option [UnixLabels] |
The socket options that can be consulted with
Unix.getsockopt_optint
and modified with Unix.setsockopt_optint.
|
| socket_optint_option [Unix] |
The socket options that can be consulted with
Unix.getsockopt_optint
and modified with Unix.setsockopt_optint.
|
| socket_type [UnixLabels] |
The type of socket kinds, specifying the semantics of
communications.
|
| socket_type [Unix] |
The type of socket kinds, specifying the semantics of
communications.
|
| source_provenance [Timings] | |
| space_formatter [Pprintast] | |
| spec [Arg] |
The concrete type describing the behavior associated
with a keyword.
|
| split_result [Str] | |
| stat [Gc] |
The memory management counters are returned in a
stat record.
|
| state [Warnings] | |
| statistics [MoreLabels.Hashtbl] | |
| statistics [Hashtbl] | |
| stats [UnixLabels.LargeFile] | |
| stats [UnixLabels] |
The information returned by the
UnixLabels.stat calls.
|
| stats [Unix.LargeFile] | |
| stats [Unix] |
The information returned by the
Unix.stat calls.
|
| stats [CamlinternalOO] | |
| status [Terminfo] | |
| status [Graphics] |
To report events.
|
| str [Ast_helper] | |
| structure [Parsetree] | |
| structure_item [Parsetree] | |
| structure_item_desc [Parsetree] | |
| style [Misc.Color] | |
| styles [Misc.Color] | |
T | |
| t [Weak.S] |
The type of tables that contain elements of type
data.
|
| t [Weak] |
The type of arrays of weak pointers (weak arrays).
|
| t [Warnings] | |
| t [Uchar] |
The type for Unicode characters.
|
| t [Thread] |
The type of thread handles.
|
| t [Tbl] | |
| t [Targetint] |
The type of target integers.
|
| t [String] |
An alias for the type of strings.
|
| t [Stream] |
The type of streams holding values of type
'a.
|
| t [StringLabels] |
An alias for the type of strings.
|
| t [Stack] |
The type of stacks containing elements of type
'a.
|
| t [Spacetime.Series] |
Type representing a file that will hold a series of heap snapshots
together with additional information required to interpret those
snapshots.
|
| t [Random.State] |
The type of PRNG states.
|
| t [Queue] |
The type of queues containing elements of type
'a.
|
| t [Printexc.Slot] | |
| t [Obj.Ephemeron] |
an ephemeron cf
Ephemeron
|
| t [Obj] | |
| t [Nativeint] |
An alias for the type of native integers.
|
| t [Mutex] |
The type of mutexes.
|
| t [Set.OrderedType] |
The type of the set elements.
|
| t [MoreLabels.Set.S] | |
| t [MoreLabels.Map.S] | |
| t [MoreLabels.Hashtbl.SeededS] | |
| t [MoreLabels.Hashtbl.S] | |
| t [MoreLabels.Hashtbl] | |
| t [Misc.HookSig] | |
| t [Misc.LongString] | |
| t [Misc.Stdlib.Option] | |
| t [Misc.Stdlib.List] | |
| t [Map.OrderedType] |
The type of the map keys.
|
| t [Longident] | |
| t [Location] | |
| t [Lazy] |
A value of type
'a Lazy.t is a deferred computation, called
a suspension, that has a result of type 'a.
|
| t [Int64] |
An alias for the type of 64-bit integers.
|
| t [Int32] |
An alias for the type of 32-bit integers.
|
| t [Identifiable.S] | |
| t [Identifiable.Thing] | |
| t [Hashtbl.SeededHashedType] |
The type of the hashtable keys.
|
| t [Hashtbl.HashedType] |
The type of the hashtable keys.
|
| t [Hashtbl.SeededS] | |
| t [Hashtbl.S] | |
| t [Hashtbl] |
The type of hash tables from type
'a to type 'b.
|
| t [Ephemeron.Kn] |
an ephemeron with an arbitrary number of keys
of the same type
|
| t [Ephemeron.K2] |
an ephemeron with two keys
|
| t [Ephemeron.K1] |
an ephemeron with one key
|
| t [Digest] |
The type of digests: 16-character strings.
|
| t [Map.S] |
The type of maps from type
key to type 'a.
|
| t [Set.S] |
The type of sets.
|
| t [Consistbl] | |
| t [Condition] |
The type of condition variables.
|
| t [Complex] |
The type of complex numbers.
|
| t [Char] |
An alias for the type of characters.
|
| t [CamlinternalOO] | |
| t [BytesLabels] |
An alias for the type of byte sequences.
|
| t [Bytes] |
An alias for the type of byte sequences.
|
| t [Buffer] |
The abstract type of buffers.
|
| t [Bigarray.Array3] |
The type of three-dimensional big arrays whose elements have
OCaml type
'a, representation kind 'b, and memory layout 'c.
|
| t [Bigarray.Array2] |
The type of two-dimensional big arrays whose elements have
OCaml type
'a, representation kind 'b, and memory layout 'c.
|
| t [Bigarray.Array1] |
The type of one-dimensional big arrays whose elements have
OCaml type
'a, representation kind 'b, and memory layout 'c.
|
| t [Bigarray.Array0] |
The type of zero-dimensional big arrays whose elements have
OCaml type
'a, representation kind 'b, and memory layout 'c.
|
| t [Bigarray.Genarray] |
The type
Genarray.t is the type of big arrays with variable
numbers of dimensions.
|
| table [CamlinternalOO] | |
| tables [CamlinternalOO] | |
| tag [Format] | |
| tag [CamlinternalOO] | |
| terminal_io [UnixLabels] | |
| terminal_io [Unix] | |
| text [Docstrings] | |
| tm [UnixLabels] |
The type representing wallclock time and calendar date.
|
| tm [Unix] |
The type representing wallclock time and calendar date.
|
| token [Parser] | |
| token [Genlex] |
The type of tokens.
|
| toplevel_phrase [Parsetree] | |
| type_declaration [Parsetree] | |
| type_extension [Parsetree] | |
| type_kind [Parsetree] | |
U | |
| usage_msg [Arg] | |
V | |
| value_binding [Parsetree] | |
| value_description [Parsetree] | |
| variance [Asttypes] | |
| virtual_flag [Asttypes] | |
W | |
| wait_flag [UnixLabels] |
Flags for
UnixLabels.waitpid.
|
| wait_flag [Unix] |
Flags for
Unix.waitpid.
|
| window_id [GraphicsX11] | |
| with_constraint [Parsetree] |
module Map:sig..end
module type OrderedType = Map.OrderedType
module type S =sig..end
module Make:ocaml-doc-4.05/ocaml.html/libref/type_Hashtbl.S.html 0000644 0001750 0001750 00000031477 13131636444 021275 0 ustar mehdi mehdi
sig
type key
type 'a t
val create : int -> 'a Hashtbl.S.t
val clear : 'a Hashtbl.S.t -> unit
val reset : 'a Hashtbl.S.t -> unit
val copy : 'a Hashtbl.S.t -> 'a Hashtbl.S.t
val add : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a -> unit
val remove : 'a Hashtbl.S.t -> Hashtbl.S.key -> unit
val find : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a
val find_opt : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a option
val find_all : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a list
val replace : 'a Hashtbl.S.t -> Hashtbl.S.key -> 'a -> unit
val mem : 'a Hashtbl.S.t -> Hashtbl.S.key -> bool
val iter : (Hashtbl.S.key -> 'a -> unit) -> 'a Hashtbl.S.t -> unit
val filter_map_inplace :
(Hashtbl.S.key -> 'a -> 'a option) -> 'a Hashtbl.S.t -> unit
val fold : (Hashtbl.S.key -> 'a -> 'b -> 'b) -> 'a Hashtbl.S.t -> 'b -> 'b
val length : 'a Hashtbl.S.t -> int
val stats : 'a Hashtbl.S.t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.html 0000644 0001750 0001750 00000404157 13131636441 021571 0 ustar mehdi mehdi
sig
type lid = Longident.t Asttypes.loc
type str = string Asttypes.loc
type loc = Location.t
type attrs = Parsetree.attribute list
val default_loc : Ast_helper.loc Pervasives.ref
val with_default_loc : Ast_helper.loc -> (unit -> 'a) -> 'a
module Const :
sig
val char : char -> Parsetree.constant
val string :
?quotation_delimiter:string -> string -> Parsetree.constant
val integer : ?suffix:char -> string -> Parsetree.constant
val int : ?suffix:char -> int -> Parsetree.constant
val int32 : ?suffix:char -> int32 -> Parsetree.constant
val int64 : ?suffix:char -> int64 -> Parsetree.constant
val nativeint : ?suffix:char -> nativeint -> Parsetree.constant
val float : ?suffix:char -> string -> Parsetree.constant
end
module Typ :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type_desc -> Parsetree.core_type
val attr :
Parsetree.core_type -> Parsetree.attribute -> Parsetree.core_type
val any :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.core_type
val var :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> string -> Parsetree.core_type
val arrow :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.core_type
val tuple :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type list -> Parsetree.core_type
val constr :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
val object_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.str * Parsetree.attributes * Parsetree.core_type) list ->
Asttypes.closed_flag -> Parsetree.core_type
val class_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
val alias :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> string -> Parsetree.core_type
val variant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.row_field list ->
Asttypes.closed_flag ->
Asttypes.label list option -> Parsetree.core_type
val poly :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str list -> Parsetree.core_type -> Parsetree.core_type
val package :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid ->
(Ast_helper.lid * Parsetree.core_type) list -> Parsetree.core_type
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.core_type
val force_poly : Parsetree.core_type -> Parsetree.core_type
val varify_constructors :
Ast_helper.str list -> Parsetree.core_type -> Parsetree.core_type
end
module Pat :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern_desc -> Parsetree.pattern
val attr :
Parsetree.pattern -> Parsetree.attribute -> Parsetree.pattern
val any :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.pattern
val var :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.str -> Parsetree.pattern
val alias :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Ast_helper.str -> Parsetree.pattern
val constant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.constant -> Parsetree.pattern
val interval :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.constant -> Parsetree.constant -> Parsetree.pattern
val tuple :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern list -> Parsetree.pattern
val construct :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.pattern option -> Parsetree.pattern
val variant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.label -> Parsetree.pattern option -> Parsetree.pattern
val record :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.lid * Parsetree.pattern) list ->
Asttypes.closed_flag -> Parsetree.pattern
val array :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern list -> Parsetree.pattern
val or_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Parsetree.pattern -> Parsetree.pattern
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Parsetree.core_type -> Parsetree.pattern
val type_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.pattern
val lazy_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern -> Parsetree.pattern
val unpack :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.str -> Parsetree.pattern
val open_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.pattern -> Parsetree.pattern
val exception_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern -> Parsetree.pattern
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.pattern
end
module Exp :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression_desc -> Parsetree.expression
val attr :
Parsetree.expression -> Parsetree.attribute -> Parsetree.expression
val ident :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.expression
val constant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.constant -> Parsetree.expression
val let_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.rec_flag ->
Parsetree.value_binding list ->
Parsetree.expression -> Parsetree.expression
val fun_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.expression option ->
Parsetree.pattern -> Parsetree.expression -> Parsetree.expression
val function_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.case list -> Parsetree.expression
val apply :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
(Asttypes.arg_label * Parsetree.expression) list ->
Parsetree.expression
val match_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.case list -> Parsetree.expression
val try_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.case list -> Parsetree.expression
val tuple :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression list -> Parsetree.expression
val construct :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.expression option -> Parsetree.expression
val variant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.label -> Parsetree.expression option -> Parsetree.expression
val record :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.lid * Parsetree.expression) list ->
Parsetree.expression option -> Parsetree.expression
val field :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Ast_helper.lid -> Parsetree.expression
val setfield :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Ast_helper.lid -> Parsetree.expression -> Parsetree.expression
val array :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression list -> Parsetree.expression
val ifthenelse :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.expression ->
Parsetree.expression option -> Parsetree.expression
val sequence :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression -> Parsetree.expression
val while_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression -> Parsetree.expression
val for_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern ->
Parsetree.expression ->
Parsetree.expression ->
Asttypes.direction_flag ->
Parsetree.expression -> Parsetree.expression
val coerce :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.core_type option ->
Parsetree.core_type -> Parsetree.expression
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.core_type -> Parsetree.expression
val send :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Ast_helper.str -> Parsetree.expression
val new_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.expression
val setinstvar :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str -> Parsetree.expression -> Parsetree.expression
val override :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.str * Parsetree.expression) list -> Parsetree.expression
val letmodule :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_expr -> Parsetree.expression -> Parsetree.expression
val letexception :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension_constructor ->
Parsetree.expression -> Parsetree.expression
val assert_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression
val lazy_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.expression
val poly :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression ->
Parsetree.core_type option -> Parsetree.expression
val object_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_structure -> Parsetree.expression
val newtype :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str -> Parsetree.expression -> Parsetree.expression
val pack :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr -> Parsetree.expression
val open_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.override_flag ->
Ast_helper.lid -> Parsetree.expression -> Parsetree.expression
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.expression
val unreachable :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.expression
val case :
Parsetree.pattern ->
?guard:Parsetree.expression -> Parsetree.expression -> Parsetree.case
end
module Val :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?prim:string list ->
Ast_helper.str -> Parsetree.core_type -> Parsetree.value_description
end
module Type :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
?cstrs:(Parsetree.core_type * Parsetree.core_type * Ast_helper.loc)
list ->
?kind:Parsetree.type_kind ->
?priv:Asttypes.private_flag ->
?manifest:Parsetree.core_type ->
Ast_helper.str -> Parsetree.type_declaration
val constructor :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?info:Docstrings.info ->
?args:Parsetree.constructor_arguments ->
?res:Parsetree.core_type ->
Ast_helper.str -> Parsetree.constructor_declaration
val field :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?info:Docstrings.info ->
?mut:Asttypes.mutable_flag ->
Ast_helper.str -> Parsetree.core_type -> Parsetree.label_declaration
end
module Te :
sig
val mk :
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
?priv:Asttypes.private_flag ->
Ast_helper.lid ->
Parsetree.extension_constructor list -> Parsetree.type_extension
val constructor :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
Ast_helper.str ->
Parsetree.extension_constructor_kind ->
Parsetree.extension_constructor
val decl :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
?args:Parsetree.constructor_arguments ->
?res:Parsetree.core_type ->
Ast_helper.str -> Parsetree.extension_constructor
val rebind :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
Ast_helper.str -> Ast_helper.lid -> Parsetree.extension_constructor
end
module Mty :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_type_desc -> Parsetree.module_type
val attr :
Parsetree.module_type -> Parsetree.attribute -> Parsetree.module_type
val ident :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
val alias :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_type
val signature :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.signature -> Parsetree.module_type
val functor_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_type option ->
Parsetree.module_type -> Parsetree.module_type
val with_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_type ->
Parsetree.with_constraint list -> Parsetree.module_type
val typeof_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr -> Parsetree.module_type
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.module_type
end
module Mod :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr_desc -> Parsetree.module_expr
val attr :
Parsetree.module_expr -> Parsetree.attribute -> Parsetree.module_expr
val ident :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_expr
val structure :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.structure -> Parsetree.module_expr
val functor_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_type option ->
Parsetree.module_expr -> Parsetree.module_expr
val apply :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr ->
Parsetree.module_expr -> Parsetree.module_expr
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr ->
Parsetree.module_type -> Parsetree.module_expr
val unpack :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.module_expr
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.module_expr
end
module Sig :
sig
val mk :
?loc:Ast_helper.loc ->
Parsetree.signature_item_desc -> Parsetree.signature_item
val value :
?loc:Ast_helper.loc ->
Parsetree.value_description -> Parsetree.signature_item
val type_ :
?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.type_declaration list -> Parsetree.signature_item
val type_extension :
?loc:Ast_helper.loc ->
Parsetree.type_extension -> Parsetree.signature_item
val exception_ :
?loc:Ast_helper.loc ->
Parsetree.extension_constructor -> Parsetree.signature_item
val module_ :
?loc:Ast_helper.loc ->
Parsetree.module_declaration -> Parsetree.signature_item
val rec_module :
?loc:Ast_helper.loc ->
Parsetree.module_declaration list -> Parsetree.signature_item
val modtype :
?loc:Ast_helper.loc ->
Parsetree.module_type_declaration -> Parsetree.signature_item
val open_ :
?loc:Ast_helper.loc ->
Parsetree.open_description -> Parsetree.signature_item
val include_ :
?loc:Ast_helper.loc ->
Parsetree.include_description -> Parsetree.signature_item
val class_ :
?loc:Ast_helper.loc ->
Parsetree.class_description list -> Parsetree.signature_item
val class_type :
?loc:Ast_helper.loc ->
Parsetree.class_type_declaration list -> Parsetree.signature_item
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.signature_item
val attribute :
?loc:Ast_helper.loc ->
Parsetree.attribute -> Parsetree.signature_item
val text : Docstrings.text -> Parsetree.signature_item list
end
module Str :
sig
val mk :
?loc:Ast_helper.loc ->
Parsetree.structure_item_desc -> Parsetree.structure_item
val eval :
?loc:Ast_helper.loc ->
?attrs:Parsetree.attributes ->
Parsetree.expression -> Parsetree.structure_item
val value :
?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.value_binding list -> Parsetree.structure_item
val primitive :
?loc:Ast_helper.loc ->
Parsetree.value_description -> Parsetree.structure_item
val type_ :
?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.type_declaration list -> Parsetree.structure_item
val type_extension :
?loc:Ast_helper.loc ->
Parsetree.type_extension -> Parsetree.structure_item
val exception_ :
?loc:Ast_helper.loc ->
Parsetree.extension_constructor -> Parsetree.structure_item
val module_ :
?loc:Ast_helper.loc ->
Parsetree.module_binding -> Parsetree.structure_item
val rec_module :
?loc:Ast_helper.loc ->
Parsetree.module_binding list -> Parsetree.structure_item
val modtype :
?loc:Ast_helper.loc ->
Parsetree.module_type_declaration -> Parsetree.structure_item
val open_ :
?loc:Ast_helper.loc ->
Parsetree.open_description -> Parsetree.structure_item
val class_ :
?loc:Ast_helper.loc ->
Parsetree.class_declaration list -> Parsetree.structure_item
val class_type :
?loc:Ast_helper.loc ->
Parsetree.class_type_declaration list -> Parsetree.structure_item
val include_ :
?loc:Ast_helper.loc ->
Parsetree.include_declaration -> Parsetree.structure_item
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.structure_item
val attribute :
?loc:Ast_helper.loc ->
Parsetree.attribute -> Parsetree.structure_item
val text : Docstrings.text -> Parsetree.structure_item list
end
module Md :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Ast_helper.str ->
Parsetree.module_type -> Parsetree.module_declaration
end
module Mtd :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?typ:Parsetree.module_type ->
Ast_helper.str -> Parsetree.module_type_declaration
end
module Mb :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Ast_helper.str -> Parsetree.module_expr -> Parsetree.module_binding
end
module Opn :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?override:Asttypes.override_flag ->
Ast_helper.lid -> Parsetree.open_description
end
module Incl :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs -> 'a -> 'a Parsetree.include_infos
end
module Vb :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Parsetree.pattern -> Parsetree.expression -> Parsetree.value_binding
end
module Cty :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_type_desc -> Parsetree.class_type
val attr :
Parsetree.class_type -> Parsetree.attribute -> Parsetree.class_type
val constr :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.class_type
val signature :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_signature -> Parsetree.class_type
val arrow :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.core_type -> Parsetree.class_type -> Parsetree.class_type
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.class_type
end
module Ctf :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
Parsetree.class_type_field_desc -> Parsetree.class_type_field
val attr :
Parsetree.class_type_field ->
Parsetree.attribute -> Parsetree.class_type_field
val inherit_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_type -> Parsetree.class_type_field
val val_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.mutable_flag ->
Asttypes.virtual_flag ->
Parsetree.core_type -> Parsetree.class_type_field
val method_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.private_flag ->
Asttypes.virtual_flag ->
Parsetree.core_type -> Parsetree.class_type_field
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type ->
Parsetree.core_type -> Parsetree.class_type_field
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.class_type_field
val attribute :
?loc:Ast_helper.loc ->
Parsetree.attribute -> Parsetree.class_type_field
val text : Docstrings.text -> Parsetree.class_type_field list
end
module Cl :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr_desc -> Parsetree.class_expr
val attr :
Parsetree.class_expr -> Parsetree.attribute -> Parsetree.class_expr
val constr :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.class_expr
val structure :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_structure -> Parsetree.class_expr
val fun_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.expression option ->
Parsetree.pattern -> Parsetree.class_expr -> Parsetree.class_expr
val apply :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr ->
(Asttypes.arg_label * Parsetree.expression) list ->
Parsetree.class_expr
val let_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.rec_flag ->
Parsetree.value_binding list ->
Parsetree.class_expr -> Parsetree.class_expr
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr -> Parsetree.class_type -> Parsetree.class_expr
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.class_expr
end
module Cf :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
Parsetree.class_field_desc -> Parsetree.class_field
val attr :
Parsetree.class_field -> Parsetree.attribute -> Parsetree.class_field
val inherit_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.override_flag ->
Parsetree.class_expr ->
Ast_helper.str option -> Parsetree.class_field
val val_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.mutable_flag ->
Parsetree.class_field_kind -> Parsetree.class_field
val method_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.private_flag ->
Parsetree.class_field_kind -> Parsetree.class_field
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.class_field
val initializer_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.expression -> Parsetree.class_field
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.class_field
val attribute :
?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.class_field
val text : Docstrings.text -> Parsetree.class_field list
val virtual_ : Parsetree.core_type -> Parsetree.class_field_kind
val concrete :
Asttypes.override_flag ->
Parsetree.expression -> Parsetree.class_field_kind
end
module Ci :
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?virt:Asttypes.virtual_flag ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
Ast_helper.str -> 'a -> 'a Parsetree.class_infos
end
module Csig :
sig
val mk :
Parsetree.core_type ->
Parsetree.class_type_field list -> Parsetree.class_signature
end
module Cstr :
sig
val mk :
Parsetree.pattern ->
Parsetree.class_field list -> Parsetree.class_structure
end
end ocaml-doc-4.05/ocaml.html/libref/type_Syntaxerr.html 0000644 0001750 0001750 00000022403 13131636451 021471 0 ustar mehdi mehdi
sig
type error =
Unclosed of Location.t * string * Location.t * string
| Expecting of Location.t * string
| Not_expecting of Location.t * string
| Applicative_path of Location.t
| Variable_in_scope of Location.t * string
| Other of Location.t
| Ill_formed_ast of Location.t * string
| Invalid_package_type of Location.t * string
exception Error of Syntaxerr.error
exception Escape_error
val report_error : Format.formatter -> Syntaxerr.error -> unit
val location_of_error : Syntaxerr.error -> Location.t
val ill_formed_ast : Location.t -> string -> 'a
end ocaml-doc-4.05/ocaml.html/libref/Misc.Int_literal_converter.html 0000644 0001750 0001750 00000017121 13131636446 023665 0 ustar mehdi mehdi
module Int_literal_converter:sig..end
val int : string -> int
val int32 : string -> int32
val int64 : string -> int64
val nativeint : string -> nativeint ocaml-doc-4.05/ocaml.html/libref/Scanf.html 0000644 0001750 0001750 00000132016 13131636450 017464 0 ustar mehdi mehdi
module Scanf:sig..end
Scanf provides formatted input functions or scanners.
The formatted input functions can read from any kind of input, including
strings, files, or anything that can return characters. The more general
source of characters is named a formatted input channel (or scanning buffer) and has type Scanf.Scanning.in_channel. The more general
formatted input function reads from any scanning buffer and is named
bscanf.
Generally speaking, the formatted input functions have 3 arguments:
Scanf.bscanf is
bscanf ic fmt f, where:
ic is a source of characters (typically a formatted input channel with type Scanf.Scanning.in_channel),fmt is a format string (the same format strings as those used to print
material with module Printf or Format),f is a function that has as many arguments as the number of values to
read in the input according to fmt.bscanf ic "%d" f reads a decimal
integer n from the source of characters ic and returns f n.
For instance,
stdin as the source of characters (Scanf.Scanning.stdin is
the predefined formatted input channel that reads from standard input),f as let f x = x + 1,bscanf Scanning.stdin "%d" f reads an integer n from the
standard input and returns f n (that is n + 1). Thus, if we
evaluate bscanf stdin "%d" f, and then enter 41 at the
keyboard, the result we get is 42.module Scanning:sig..end
type('a, 'b, 'c, 'd)scanner =('a, Scanning.in_channel, 'b, 'c, 'a -> 'd, 'd) format6 ->
'c
('a, 'b, 'c, 'd) scanner
is the type of a formatted input function that reads from some
formatted input channel according to some format string; more
precisely, if scan is some formatted input function, then scan
ic fmt f applies f to all the arguments specified by format
string fmt, when scan has read those arguments from the
Scanf.Scanning.in_channel formatted input channel ic.
For instance, the Scanf.scanf function below has type
('a, 'b, 'c, 'd) scanner, since it is a formatted input function that
reads from Scanf.Scanning.stdin: scanf fmt f applies f to the arguments
specified by fmt, reading those arguments from !Pervasives.stdin as
expected.
If the format fmt has some %r indications, the corresponding
formatted input functions must be provided before receiver function
f. For instance, if read_elem is an input function for values of type
t, then bscanf ic "%r;" read_elem f reads a value v of type t
followed by a ';' character, and returns f v.
Since 3.10.0
exception Scan_failure of string
Scan_failure.val bscanf : Scanning.in_channel -> ('a, 'b, 'c, 'd) scannerbscanf ic fmt r1 ... rN f reads characters from the
Scanf.Scanning.in_channel formatted input channel ic and converts them to
values according to format string fmt.
As a final step, receiver function f is applied to the values read and
gives the result of the bscanf call.
For instance, if f is the function fun s i -> i + 1, then
Scanf.sscanf "x= 1" "%s = %i" f returns 2.
Arguments r1 to rN are user-defined input functions that read the
argument corresponding to the %r conversions specified in the format
string.
f (see Conversion specifications in format strings),' ' or ASCII code
32) and the line feed character ('\n' or ASCII code 10).
A space does not match a single space character, but any amount of
'whitespace' in the input. More precisely, a space inside the format
string matches any number of tab, space, line feed and carriage
return characters. Similarly, a line feed character in the format string
matches either a single line feed or a carriage return followed by a line
feed.
Matching any amount of whitespace, a space in the format string
also matches no amount of whitespace at all; hence, the call bscanf ib succeeds and returns
"Price = %d $" (fun p -> p)1 when reading an
input with various whitespace in it, such as Price = 1 $,
Price = 1 $, or even Price=1$.
% character, followed by
an optional flag, an optional field width, and followed by one or
two conversion characters.
The conversion characters and their meanings are:
d: reads an optionally signed decimal integer (0-9+).i: reads an optionally signed integer
(usual input conventions for decimal (0-9+), hexadecimal
(0x[0-9a-f]+ and 0X[0-9A-F]+), octal (0o[0-7]+), and binary
(0b[0-1]+) notations are understood).u: reads an unsigned decimal integer.x or X: reads an unsigned hexadecimal integer ([0-9a-fA-F]+).o: reads an unsigned octal integer ([0-7]+).s: reads a string argument that spreads as much as possible, until the
following bounding condition holds: S: reads a delimited string argument (delimiters and special
escaped characters follow the lexical conventions of OCaml).c: reads a single character. To test the current input character
without reading it, specify a null field width, i.e. use
specification %0c. Raise Invalid_argument, if the field width
specification is greater than 1.C: reads a single delimited character (delimiters and special
escaped characters follow the lexical conventions of OCaml).f, e, E, g, G: reads an optionally signed
floating-point number in decimal notation, in the style dddd.ddd
e/E+-dd.h, H: reads an optionally signed floating-point number
in hexadecimal notation.F: reads a floating point number according to the lexical
conventions of OCaml (hence the decimal point is mandatory if the
exponent part is not mentioned).B: reads a boolean argument (true or false).b: reads a boolean argument (for backward compatibility; do not use
in new programs).ld, li, lu, lx, lX, lo: reads an int32 argument to
the format specified by the second letter for regular integers.nd, ni, nu, nx, nX, no: reads a nativeint argument to
the format specified by the second letter for regular integers.Ld, Li, Lu, Lx, LX, Lo: reads an int64 argument to
the format specified by the second letter for regular integers.[ range ]: reads characters that matches one of the characters
mentioned in the range of characters range (or not mentioned in
it, if the range starts with ^). Reads a string that can be
empty, if the next input character does not match the range. The set of
characters from c1 to c2 (inclusively) is denoted by c1-c2.
Hence, %[0-9] returns a string representing a decimal number
or an empty string if no decimal digit is found; similarly,
%[0-9a-f] returns a string of hexadecimal digits.
If a closing bracket appears in a range, it must occur as the
first character of the range (or just after the ^ in case of
range negation); hence []] matches a ] character and
[^]] matches any character that is not ].
Use %% and %@ to include a % or a @ in a range.r: user-defined reader. Takes the next ri formatted input
function and applies it to the scanning buffer ib to read the
next argument. The input function ri must therefore have type
Scanning.in_channel -> 'a and the argument read has type 'a.{ fmt %}: reads a format string argument. The format string
read must have the same type as the format string specification
fmt. For instance, "%{ %i %}" reads any format string that
can read a value of type int; hence, if s is the string
"fmt:\"number is %u\"", then Scanf.sscanf s "fmt: %{%i%}"
succeeds and returns the format string "number is %u".( fmt %): scanning sub-format substitution.
Reads a format string rf in the input, then goes on scanning with
rf instead of scanning with fmt.
The format string rf must have the same type as the format string
specification fmt that it replaces.
For instance, "%( %i %)" reads any format string that can read a value
of type int.
The conversion returns the format string read rf, and then a value
read using rf.
Hence, if s is the string "\"%4d\"1234.00", then
Scanf.sscanf s "%(%i%)" (fun fmt i -> fmt, i) evaluates to
("%4d", 1234).
This behaviour is not mere format substitution, since the conversion
returns the format string read as additional argument. If you need
pure format substitution, use special flag _ to discard the
extraneous argument: conversion %_( fmt %) reads a format string
rf and then behaves the same as format string rf. Hence, if s is
the string "\"%4d\"1234.00", then Scanf.sscanf s "%_(%i%)" is
simply equivalent to Scanf.sscanf "1234.00" "%4d".l: returns the number of lines read so far.n: returns the number of characters read so far.N or L: returns the number of tokens read so far.!: matches the end of input condition.%: matches one % character in the input.@: matches one @ character in the input.,: does nothing.% character that introduces a conversion, there may be
the special flag _: the conversion that follows occurs as usual,
but the resulting value is discarded.
For instance, if f is the function fun i -> i + 1, and s is the
string "x = 1", then Scanf.sscanf s "%_s = %i" f returns 2.
The field width is composed of an optional integer literal
indicating the maximal width of the token to read.
For instance, %6d reads an integer, having at most 6 decimal digits;
%4f reads a float with at most 4 characters; and %8[\000-\255]
returns the next 8 characters (or all the characters still available,
if fewer than 8 characters are available in the input).
Notes:
%s conversion always succeeds, even if there is
nothing to read in the input: in this case, it simply returns "".'_' characters may appear
inside numbers (this is reminiscent to the usual OCaml lexical
conventions). If stricter scanning is desired, use the range
conversion facility instead of the number conversions.scanf facility is not intended for heavy duty lexical
analysis and parsing. If it appears not expressive enough for your
needs, several alternative exists: regular expressions (module
Str), stream parsers, ocamllex-generated lexers,
ocamlyacc-generated parsers.%s
and %[ range ] to delimit the end of the token. A scanning
indication is introduced by a @ character, followed by some
plain character c. It means that the string token should end
just before the next matching c (which is skipped). If no c
character is encountered, the string token spreads as much as
possible. For instance, "%s@\t" reads a string up to the next
tab character or to the end of input. If a @ character appears
anywhere else in the format string, it is treated as a plain character.
Note:
% and @ characters must be escaped
using %% and %@; this rule still holds within range specifications
and scanning indications.
For instance, format "%s@%%" reads a string up to the next %
character, and format "%s@%@" reads a string up to the next @.Scanf format strings, compared to those used for the Printf
module. However, the scanning indications are similar to those used in
the Format module; hence, when producing formatted text to be scanned
by Scanf.bscanf, it is wise to use printing functions from the
Format module (or, if you need to use functions from Printf, banish
or carefully double check the format strings that contain '@'
characters).
Scanf.Scan_failure if the input does not match the format.Failure if a conversion to a number is not possible.End_of_file if the end of input is encountered while some more
characters are needed to read the current conversion specification.Invalid_argument if the format string is invalid.
%s conversion never raises exception
End_of_file: if the end of input is reached the conversion succeeds and
simply returns the characters read so far, or "" if none were ever read.val sscanf : string -> ('a, 'b, 'c, 'd) scannerScanf.bscanf, but reads from the given string.val scanf : ('a, 'b, 'c, 'd) scannerScanf.bscanf, but reads from the predefined formatted input
channel Scanf.Scanning.stdin that is connected to stdin.val kscanf : Scanning.in_channel ->
(Scanning.in_channel -> exn -> 'd) -> ('a, 'b, 'c, 'd) scannerScanf.bscanf, but takes an additional function argument
ef that is called in case of error: if the scanning process or
some conversion fails, the scanning function aborts and calls the
error handling function ef with the formatted input channel and the
exception that aborted the scanning process as arguments.val ksscanf : string ->
(Scanning.in_channel -> exn -> 'd) -> ('a, 'b, 'c, 'd) scanner
val bscanf_format : Scanning.in_channel ->
('a, 'b, 'c, 'd, 'e, 'f) format6 ->
(('a, 'b, 'c, 'd, 'e, 'f) format6 -> 'g) -> 'gbscanf_format ic fmt f reads a format string token from the formatted
input channel ic, according to the given format string fmt, and
applies f to the resulting format string value.
Raise Scanf.Scan_failure if the format string value read does not have the
same type as fmt.val sscanf_format : string ->
('a, 'b, 'c, 'd, 'e, 'f) format6 ->
(('a, 'b, 'c, 'd, 'e, 'f) format6 -> 'g) -> 'g
val format_from_string : string ->
('a, 'b, 'c, 'd, 'e, 'f) format6 ->
('a, 'b, 'c, 'd, 'e, 'f) format6format_from_string s fmt converts a string argument to a format string,
according to the given format string fmt.
Raise Scanf.Scan_failure if s, considered as a format string, does not
have the same type as fmt.val unescaped : string -> stringunescaped s return a copy of s with escape sequences (according to
the lexical conventions of OCaml) replaced by their corresponding special
characters.
More precisely, Scanf.unescaped has the following property:
for all string s, Scanf.unescaped (String.escaped s) = s.
Always return a copy of the argument, even if there is no escape sequence
in the argument.
Raise Scanf.Scan_failure if s is not properly escaped (i.e. s has invalid
escape sequences or special characters that are not properly escaped).
For instance, String.unescaped "\"" will fail.
Since 4.00.0
val fscanf : in_channel -> ('a, 'b, 'c, 'd) scannerScanf.fscanf is error prone and deprecated since 4.03.0.
This function violates the following invariant of the Scanf module:
To preserve scanning semantics, all scanning functions defined in Scanf
must read from a user defined Scanf.Scanning.in_channel formatted input
channel.
If you need to read from a in_channel input channel
ic, simply define a Scanf.Scanning.in_channel formatted input channel as in
let ib = Scanning.from_channel ic,
then use Scanf.bscanf ib as usual.
val kfscanf : in_channel ->
(Scanning.in_channel -> exn -> 'd) -> ('a, 'b, 'c, 'd) scannerScanf.kfscanf is error prone and deprecated since 4.03.0.sig
module Int :
sig
type t = int
module T :
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
val to_string : t -> string
val of_list : elt list -> t
val map : (elt -> elt) -> t -> t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map : 'a t -> f:(key -> 'a -> 'b option) -> 'b t
val of_list : (key * 'a) list -> 'a t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) -> 'a t -> 'a t -> 'a t
val union_right : 'a t -> 'a t -> 'a t
val union_left : 'a t -> 'a t -> 'a t
val union_merge : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val rename : key t -> key -> key
val map_keys : (key -> key) -> 'a t -> 'a t
val keys : 'a t -> Set.t
val data : 'a t -> 'a list
val of_set : (key -> 'a) -> Set.t -> 'a t
val transpose_keys_and_data : key t -> key t
val transpose_keys_and_data_set : key t -> Set.t t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a t -> (T.t * 'a) list
val of_list : (T.t * 'a) list -> 'a t
val to_map : 'a t -> 'a Map.t
val of_map : 'a Map.t -> 'a t
val memoize : 'a t -> (key -> 'a) -> key -> 'a
val map : 'a t -> ('a -> 'b) -> 'b t
end
val zero_to_n : int -> Set.t
end
module Float :
sig
type t = float
module T :
sig
type t = t
val equal : t -> t -> bool
val hash : t -> int
val compare : t -> t -> int
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
end
val equal : T.t -> T.t -> bool
val hash : T.t -> int
val compare : T.t -> T.t -> int
val output : out_channel -> T.t -> unit
val print : Format.formatter -> T.t -> unit
module Set :
sig
type elt = T.t
type t = Set.Make(T).t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit
val to_string : t -> string
val of_list : elt list -> t
val map : (elt -> elt) -> t -> t
end
module Map :
sig
type key = T.t
type 'a t = 'a Map.Make(T).t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
val filter_map : 'a t -> f:(key -> 'a -> 'b option) -> 'b t
val of_list : (key * 'a) list -> 'a t
val disjoint_union :
?eq:('a -> 'a -> bool) ->
?print:(Format.formatter -> 'a -> unit) -> 'a t -> 'a t -> 'a t
val union_right : 'a t -> 'a t -> 'a t
val union_left : 'a t -> 'a t -> 'a t
val union_merge : ('a -> 'a -> 'a) -> 'a t -> 'a t -> 'a t
val rename : key t -> key -> key
val map_keys : (key -> key) -> 'a t -> 'a t
val keys : 'a t -> Set.t
val data : 'a t -> 'a list
val of_set : (key -> 'a) -> Set.t -> 'a t
val transpose_keys_and_data : key t -> key t
val transpose_keys_and_data_set : key t -> Set.t t
val print :
(Format.formatter -> 'a -> unit) ->
Format.formatter -> 'a t -> unit
end
module Tbl :
sig
type key = T.t
type 'a t = 'a Hashtbl.Make(T).t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val to_list : 'a t -> (T.t * 'a) list
val of_list : (T.t * 'a) list -> 'a t
val to_map : 'a t -> 'a Map.t
val of_map : 'a Map.t -> 'a t
val memoize : 'a t -> (key -> 'a) -> key -> 'a
val map : 'a t -> ('a -> 'b) -> 'b t
end
end
end ocaml-doc-4.05/ocaml.html/libref/Misc.Color.html 0000644 0001750 0001750 00000031540 13131636446 020407 0 ustar mehdi mehdi
module Color:sig..end
type
| |
Black |
| |
Red |
| |
Green |
| |
Yellow |
| |
Blue |
| |
Magenta |
| |
Cyan |
| |
White |
type
| |
FG of |
| |
BG of |
| |
Bold |
| |
Reset |
val ansi_of_style_l : style list -> string
type
|
error : |
|
warning : |
|
loc : |
val default_styles : styles
val get_styles : unit -> styles
val set_styles : styles -> unit
type
| |
Auto |
| |
Always |
| |
Never |
val setup : setting option -> unit
val set_color_tag_handling : Format.formatter -> unit ocaml-doc-4.05/ocaml.html/libref/type_Strongly_connected_components.S.html 0000644 0001750 0001750 00000020114 13131636451 026000 0 ustar mehdi mehdi
sig
module Id : Identifiable.S
type directed_graph = Id.Set.t Id.Map.t
type component = Has_loop of Id.t list | No_loop of Id.t
val connected_components_sorted_from_roots_to_leaf :
Strongly_connected_components.S.directed_graph ->
Strongly_connected_components.S.component array
val component_graph :
Strongly_connected_components.S.directed_graph ->
(Strongly_connected_components.S.component * int list) array
end ocaml-doc-4.05/ocaml.html/libref/type_Spacetime.Snapshot.html 0000644 0001750 0001750 00000015271 13131636450 023206 0 ustar mehdi mehdi
sig val take : ?time:float -> Spacetime.Series.t -> unit end ocaml-doc-4.05/ocaml.html/libref/Ast_iterator.html 0000644 0001750 0001750 00000054536 13131636441 021104 0 ustar mehdi mehdi
module Ast_iterator:sig..end
Ast_iterator.iterator allows to implement AST inspection using open recursion. A
typical mapper would be based on Ast_iterator.default_iterator, a trivial iterator,
and will fall back on it for handling the syntax it does not modify.type iterator record implements one "method" per syntactic category,
using an open recursion style: each method takes as its first
argument the iterator to be applied to children in the syntax
tree.val default_iterator : iteratormodule Misc:sig..end
protect_refs l f temporarily sets r to v for each R (r, v) in l
while executing f. The previous contents of the references is restored
even if f raises an exception.val fatal_error : string -> 'a
val fatal_errorf : ('a, Format.formatter, unit, 'b) format4 -> 'a
exception Fatal_error
val try_finally : (unit -> 'a) -> (unit -> unit) -> 'a
val map_end : ('a -> 'b) -> 'a list -> 'b list -> 'b list
val map_left_right : ('a -> 'b) -> 'a list -> 'b list
val for_all2 : ('a -> 'b -> bool) -> 'a list -> 'b list -> bool
val replicate_list : 'a -> int -> 'a list
val list_remove : 'a -> 'a list -> 'a list
val split_last : 'a list -> 'a list * 'a
val may : ('a -> unit) -> 'a option -> unit
val may_map : ('a -> 'b) -> 'a option -> 'b option
type
| |
R : |
val protect_refs : ref_and_value list -> (unit -> 'a) -> 'aprotect_refs l f temporarily sets r to v for each R (r, v) in l
while executing f. The previous contents of the references is restored
even if f raises an exception.module Stdlib:sig..end
val find_in_path : string list -> string -> string
val find_in_path_rel : string list -> string -> string
val find_in_path_uncap : string list -> string -> string
val remove_file : string -> unit
val expand_directory : string -> string -> string
val create_hashtable : int -> ('a * 'b) list -> ('a, 'b) Hashtbl.t
val copy_file : in_channel -> out_channel -> unit
val copy_file_chunk : in_channel -> out_channel -> int -> unit
val string_of_file : in_channel -> string
val log2 : int -> int
val align : int -> int -> int
val no_overflow_add : int -> int -> bool
val no_overflow_sub : int -> int -> bool
val no_overflow_mul : int -> int -> bool
val no_overflow_lsl : int -> int -> bool
module Int_literal_converter:sig..end
val chop_extensions : string -> string
val search_substring : string -> string -> int -> int
val replace_substring : before:string -> after:string -> string -> string
val rev_split_words : string -> string list
val get_ref : 'a list ref -> 'a list
val fst3 : 'a * 'b * 'c -> 'a
val snd3 : 'a * 'b * 'c -> 'b
val thd3 : 'a * 'b * 'c -> 'c
val fst4 : 'a * 'b * 'c * 'd -> 'a
val snd4 : 'a * 'b * 'c * 'd -> 'b
val thd4 : 'a * 'b * 'c * 'd -> 'c
val for4 : 'a * 'b * 'c * 'd -> 'd
module LongString:sig..end
val edit_distance : string -> string -> int -> int optionedit_distance a b cutoff computes the edit distance between
strings a and b. To help efficiency, it uses a cutoff: if the
distance d is smaller than cutoff, it returns Some d, else
None.
The distance algorithm currently used is Damerau-Levenshtein: it
computes the number of insertion, deletion, substitution of
letters, or swapping of adjacent letters to go from one word to the
other. The particular algorithm may change in the future.
val spellcheck : string list -> string -> string listspellcheck env name takes a list of names env that exist in
the current environment and an erroneous name, and returns a
list of suggestions taken from env, that are close enough to
name that it may be a typo for one of them.val did_you_mean : Format.formatter -> (unit -> string list) -> unitdid_you_mean ppf get_choices hints that the user may have meant
one of the option returned by calling get_choices. It does nothing
if the returned list is empty.
The unit -> ... thunking is meant to delay any potentially-slow
computation (typically computing edit-distance with many things
from the current environment) to when the hint message is to be
printed. You should print an understandable error message before
calling did_you_mean, so that users get a clear notification of
the failure even if producing the hint is slow.
val cut_at : string -> char -> string * stringString.cut_at s c returns a pair containing the sub-string before
the first occurrence of c in s, and the sub-string after the
first occurrence of c in s.
let (before, after) = String.cut_at s c in
before ^ String.make 1 c ^ after is the identity if s contains c.
Raise Not_found if the character does not appear in the string
Since 4.01
module StringSet:Set.Swith type elt = string
module StringMap:Map.Swith type key = string
module Color:sig..end
val normalise_eol : string -> stringnormalise_eol s returns a fresh copy of s with any '\r' characters
removed. Intended for pre-processing text which will subsequently be printed
on a channel which performs EOL transformations (i.e. Windows)val delete_eol_spaces : string -> stringdelete_eol_spaces s returns a fresh copy of s with any end of
line spaces removed. Intended to normalize the output of the
toplevel for tests.type
|
sourcefile : |
exception HookExnWrapper of {
|
error : |
|
hook_name : |
|
hook_info : |
HookExnWrapper constructor by the hook machinery.val raise_direct_hook_exn : exn -> 'araise_unwrapped_hook_exn to raise an exception that will
not be wrapped into a Misc.HookExnWrapper.module type HookSig =sig..end
module MakeHooks:ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Pat.html 0000644 0001750 0001750 00000041236 13131636441 022307 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern_desc -> Parsetree.pattern
val attr : Parsetree.pattern -> Parsetree.attribute -> Parsetree.pattern
val any :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> unit -> Parsetree.pattern
val var :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.str -> Parsetree.pattern
val alias :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Ast_helper.str -> Parsetree.pattern
val constant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.constant -> Parsetree.pattern
val interval :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.constant -> Parsetree.constant -> Parsetree.pattern
val tuple :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern list -> Parsetree.pattern
val construct :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.pattern option -> Parsetree.pattern
val variant :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.label -> Parsetree.pattern option -> Parsetree.pattern
val record :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.lid * Parsetree.pattern) list ->
Asttypes.closed_flag -> Parsetree.pattern
val array :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern list -> Parsetree.pattern
val or_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Parsetree.pattern -> Parsetree.pattern
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.pattern -> Parsetree.core_type -> Parsetree.pattern
val type_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.pattern
val lazy_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern -> Parsetree.pattern
val unpack :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.str -> Parsetree.pattern
val open_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.pattern -> Parsetree.pattern
val exception_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.pattern -> Parsetree.pattern
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.pattern
end ocaml-doc-4.05/ocaml.html/libref/type_Obj.html 0000644 0001750 0001750 00000044235 13131636447 020220 0 ustar mehdi mehdi
sig
type t
external repr : 'a -> Obj.t = "%identity"
external obj : Obj.t -> 'a = "%identity"
external magic : 'a -> 'b = "%identity"
val is_block : Obj.t -> bool
external is_int : Obj.t -> bool = "%obj_is_int"
external tag : Obj.t -> int = "caml_obj_tag"
external size : Obj.t -> int = "%obj_size"
external reachable_words : Obj.t -> int = "caml_obj_reachable_words"
external field : Obj.t -> int -> Obj.t = "%obj_field"
external set_field : Obj.t -> int -> Obj.t -> unit = "%obj_set_field"
external set_tag : Obj.t -> int -> unit = "caml_obj_set_tag"
val double_field : Obj.t -> int -> float
val set_double_field : Obj.t -> int -> float -> unit
external new_block : int -> int -> Obj.t = "caml_obj_block"
external dup : Obj.t -> Obj.t = "caml_obj_dup"
external truncate : Obj.t -> int -> unit = "caml_obj_truncate"
external add_offset : Obj.t -> Int32.t -> Obj.t = "caml_obj_add_offset"
val first_non_constant_constructor_tag : int
val last_non_constant_constructor_tag : int
val lazy_tag : int
val closure_tag : int
val object_tag : int
val infix_tag : int
val forward_tag : int
val no_scan_tag : int
val abstract_tag : int
val string_tag : int
val double_tag : int
val double_array_tag : int
val custom_tag : int
val final_tag : int
val int_tag : int
val out_of_heap_tag : int
val unaligned_tag : int
val extension_constructor : 'a -> extension_constructor
val extension_name : extension_constructor -> string
val extension_id : extension_constructor -> int
val marshal : Obj.t -> bytes
val unmarshal : bytes -> int -> Obj.t * int
module Ephemeron :
sig
type obj_t = Obj.t
type t
val create : int -> Obj.Ephemeron.t
val length : Obj.Ephemeron.t -> int
val get_key : Obj.Ephemeron.t -> int -> Obj.Ephemeron.obj_t option
val get_key_copy : Obj.Ephemeron.t -> int -> Obj.Ephemeron.obj_t option
val set_key : Obj.Ephemeron.t -> int -> Obj.Ephemeron.obj_t -> unit
val unset_key : Obj.Ephemeron.t -> int -> unit
val check_key : Obj.Ephemeron.t -> int -> bool
val blit_key :
Obj.Ephemeron.t -> int -> Obj.Ephemeron.t -> int -> int -> unit
val get_data : Obj.Ephemeron.t -> Obj.Ephemeron.obj_t option
val get_data_copy : Obj.Ephemeron.t -> Obj.Ephemeron.obj_t option
val set_data : Obj.Ephemeron.t -> Obj.Ephemeron.obj_t -> unit
val unset_data : Obj.Ephemeron.t -> unit
val check_data : Obj.Ephemeron.t -> bool
val blit_data : Obj.Ephemeron.t -> Obj.Ephemeron.t -> unit
end
end ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.K2.html 0000644 0001750 0001750 00000066502 13131636443 021700 0 ustar mehdi mehdi
sig
type ('k1, 'k2, 'd) t
val create : unit -> ('k1, 'k2, 'd) Ephemeron.K2.t
val get_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k1 option
val get_key1_copy : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k1 option
val set_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k1 -> unit
val unset_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
val check_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> bool
val get_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k2 option
val get_key2_copy : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k2 option
val set_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k2 -> unit
val unset_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
val check_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> bool
val blit_key1 :
('k1, 'a, 'b) Ephemeron.K2.t -> ('k1, 'c, 'd) Ephemeron.K2.t -> unit
val blit_key2 :
('a, 'k2, 'b) Ephemeron.K2.t -> ('c, 'k2, 'd) Ephemeron.K2.t -> unit
val blit_key12 :
('k1, 'k2, 'a) Ephemeron.K2.t -> ('k1, 'k2, 'b) Ephemeron.K2.t -> unit
val get_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'd option
val get_data_copy : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'd option
val set_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'd -> unit
val unset_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
val check_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> bool
val blit_data :
('k1, 'k2, 'd) Ephemeron.K2.t -> ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
module Make :
functor (H1 : Hashtbl.HashedType) (H2 : Hashtbl.HashedType) ->
sig
type key = H1.t * H2.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module MakeSeeded :
functor
(H1 : Hashtbl.SeededHashedType) (H2 : Hashtbl.SeededHashedType) ->
sig
type key = H1.t * H2.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end ocaml-doc-4.05/ocaml.html/libref/type_Queue.html 0000644 0001750 0001750 00000024677 13131636450 020574 0 ustar mehdi mehdi
sig
type 'a t
exception Empty
val create : unit -> 'a Queue.t
val add : 'a -> 'a Queue.t -> unit
val push : 'a -> 'a Queue.t -> unit
val take : 'a Queue.t -> 'a
val pop : 'a Queue.t -> 'a
val peek : 'a Queue.t -> 'a
val top : 'a Queue.t -> 'a
val clear : 'a Queue.t -> unit
val copy : 'a Queue.t -> 'a Queue.t
val is_empty : 'a Queue.t -> bool
val length : 'a Queue.t -> int
val iter : ('a -> unit) -> 'a Queue.t -> unit
val fold : ('b -> 'a -> 'b) -> 'b -> 'a Queue.t -> 'b
val transfer : 'a Queue.t -> 'a Queue.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Scanf.html 0000644 0001750 0001750 00000044111 13131636450 020523 0 ustar mehdi mehdi
sig
module Scanning :
sig
type in_channel
type scanbuf = Scanf.Scanning.in_channel
val stdin : Scanf.Scanning.in_channel
type file_name = string
val open_in : Scanf.Scanning.file_name -> Scanf.Scanning.in_channel
val open_in_bin : Scanf.Scanning.file_name -> Scanf.Scanning.in_channel
val close_in : Scanf.Scanning.in_channel -> unit
val from_file : Scanf.Scanning.file_name -> Scanf.Scanning.in_channel
val from_file_bin : string -> Scanf.Scanning.in_channel
val from_string : string -> Scanf.Scanning.in_channel
val from_function : (unit -> char) -> Scanf.Scanning.in_channel
val from_channel : Pervasives.in_channel -> Scanf.Scanning.in_channel
val end_of_input : Scanf.Scanning.in_channel -> bool
val beginning_of_input : Scanf.Scanning.in_channel -> bool
val name_of_input : Scanf.Scanning.in_channel -> string
val stdib : Scanf.Scanning.in_channel
end
type ('a, 'b, 'c, 'd) scanner =
('a, Scanf.Scanning.in_channel, 'b, 'c, 'a -> 'd, 'd)
Pervasives.format6 -> 'c
exception Scan_failure of string
val bscanf : Scanf.Scanning.in_channel -> ('a, 'b, 'c, 'd) Scanf.scanner
val sscanf : string -> ('a, 'b, 'c, 'd) Scanf.scanner
val scanf : ('a, 'b, 'c, 'd) Scanf.scanner
val kscanf :
Scanf.Scanning.in_channel ->
(Scanf.Scanning.in_channel -> exn -> 'd) ->
('a, 'b, 'c, 'd) Scanf.scanner
val ksscanf :
string ->
(Scanf.Scanning.in_channel -> exn -> 'd) ->
('a, 'b, 'c, 'd) Scanf.scanner
val bscanf_format :
Scanf.Scanning.in_channel ->
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 ->
(('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 -> 'g) -> 'g
val sscanf_format :
string ->
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 ->
(('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 -> 'g) -> 'g
val format_from_string :
string ->
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 ->
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6
val unescaped : string -> string
val fscanf : Pervasives.in_channel -> ('a, 'b, 'c, 'd) Scanf.scanner
val kfscanf :
Pervasives.in_channel ->
(Scanf.Scanning.in_channel -> exn -> 'd) ->
('a, 'b, 'c, 'd) Scanf.scanner
end ocaml-doc-4.05/ocaml.html/libref/type_Map.OrderedType.html 0000644 0001750 0001750 00000015455 13131636445 022450 0 ustar mehdi mehdi
sig type t val compare : Map.OrderedType.t -> Map.OrderedType.t -> int end ocaml-doc-4.05/ocaml.html/libref/index_classes.html 0000644 0001750 0001750 00000014734 13131636452 021266 0 ustar mehdi mehdi
module MakeSeeded:
Hashtbl.MakeSeeded.| Parameters: |
|
include Hashtbl.SeededS
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingsmodule Bigarray:sig..end
This module implements multi-dimensional arrays of integers and floating-point numbers, thereafter referred to as 'big arrays'. The implementation allows efficient sharing of large numerical arrays between OCaml code and C or Fortran numerical libraries.
Concerning the naming conventions, users of this module are encouraged
to do open Bigarray in their source, then refer to array types and
operations via short dot notation, e.g. Array1.t or Array2.sub.
Big arrays support all the OCaml ad-hoc polymorphic operations:
=, <>, <=, etc, as well as compare);Hash);Marshal module, as well as output_value
and input_value).Bigarray.float32_elt),Bigarray.float64_elt),Bigarray.complex32_elt),Bigarray.complex64_elt),Bigarray.int8_signed_elt or Bigarray.int8_unsigned_elt),Bigarray.int16_signed_elt or Bigarray.int16_unsigned_elt),Bigarray.int_elt),Bigarray.int32_elt),Bigarray.int64_elt),Bigarray.nativeint_elt).*_elt types defined below (defined with a single constructor instead
of abstract types for technical injectivity reasons).type
| |
Float32_elt |
type
| |
Float64_elt |
type
| |
Int8_signed_elt |
type
| |
Int8_unsigned_elt |
type
| |
Int16_signed_elt |
type
| |
Int16_unsigned_elt |
type
| |
Int32_elt |
type
| |
Int64_elt |
type
| |
Int_elt |
type
| |
Nativeint_elt |
type
| |
Complex32_elt |
type
| |
Complex64_elt |
type ('a, 'b) kind =
| |
Float32 : |
| |
Float64 : |
| |
Int8_signed : |
| |
Int8_unsigned : |
| |
Int16_signed : |
| |
Int16_unsigned : |
| |
Int32 : |
| |
Int64 : |
| |
Int : |
| |
Nativeint : |
| |
Complex32 : |
| |
Complex64 : |
| |
Char : |
float32_elt contains
32-bit single precision floats, but reading or writing one of
its elements from OCaml uses the OCaml type float, which is
64-bit double precision floats.
The GADT type ('a, 'b) kind captures this association
of an OCaml type 'a for values read or written in the big array,
and of an element kind 'b which represents the actual contents
of the big array. Its constructors list all possible associations
of OCaml types with element kinds, and are re-exported below for
backward-compatibility reasons.
Using a generalized algebraic datatype (GADT) here allows to write well-typed polymorphic functions whose return type depend on the argument type, such as:
let zero : type a b. (a, b) kind -> a = function
| Float32 -> 0.0 | Complex32 -> Complex.zero
| Float64 -> 0.0 | Complex64 -> Complex.zero
| Int8_signed -> 0 | Int8_unsigned -> 0
| Int16_signed -> 0 | Int16_unsigned -> 0
| Int32 -> 0l | Int64 -> 0L
| Int -> 0 | Nativeint -> 0n
| Char -> '\000'
val float32 : (float, float32_elt) kindBigarray.char.val float64 : (float, float64_elt) kindBigarray.char.val complex32 : (Complex.t, complex32_elt) kindBigarray.char.val complex64 : (Complex.t, complex64_elt) kindBigarray.char.val int8_signed : (int, int8_signed_elt) kindBigarray.char.val int8_unsigned : (int, int8_unsigned_elt) kindBigarray.char.val int16_signed : (int, int16_signed_elt) kindBigarray.char.val int16_unsigned : (int, int16_unsigned_elt) kindBigarray.char.val int : (int, int_elt) kindBigarray.char.val int32 : (int32, int32_elt) kindBigarray.char.val int64 : (int64, int64_elt) kindBigarray.char.val nativeint : (nativeint, nativeint_elt) kindBigarray.char.val char : (char, int8_unsigned_elt) kindfloat32_elt and float64_elt are
accessed using the OCaml type float. Big arrays of complex kinds
complex32_elt, complex64_elt are accessed with the OCaml type
Complex.t. Big arrays of
integer kinds are accessed using the smallest OCaml integer
type large enough to represent the array elements:
int for 8- and 16-bit integer bigarrays, as well as OCaml-integer
bigarrays; int32 for 32-bit integer bigarrays; int64
for 64-bit integer bigarrays; and nativeint for
platform-native integer bigarrays. Finally, big arrays of
kind int8_unsigned_elt can also be accessed as arrays of
characters instead of arrays of small integers, by using
the kind value char instead of int8_unsigned.val kind_size_in_bytes : ('a, 'b) kind -> intkind_size_in_bytes k is the number of bytes used to store
an element of type k.type
| |
C_layout_typ |
type
| |
Fortran_layout_typ |
In the C-style layout, array indices start at 0, and
multi-dimensional arrays are laid out in row-major format.
That is, for a two-dimensional array, all elements of
row 0 are contiguous in memory, followed by all elements of
row 1, etc. In other terms, the array elements at (x,y)
and (x, y+1) are adjacent in memory.
In the Fortran-style layout, array indices start at 1, and
multi-dimensional arrays are laid out in column-major format.
That is, for a two-dimensional array, all elements of
column 0 are contiguous in memory, followed by all elements of
column 1, etc. In other terms, the array elements at (x,y)
and (x+1, y) are adjacent in memory.
Each layout style is identified at the type level by the
phantom types Bigarray.c_layout and Bigarray.fortran_layout
respectively.
The GADT type 'a layout represents one of the two supported
memory layouts: C-style or Fortran-style. Its constructors are
re-exported as values below for backward-compatibility reasons.
type 'a layout =
| |
C_layout : |
| |
Fortran_layout : |
val c_layout : c_layout layout
val fortran_layout : fortran_layout layoutmodule Genarray:sig..end
module Array0:sig..end
module Array1:sig..end
module Array2:sig..end
module Array3:sig..end
val genarray_of_array0 : ('a, 'b, 'c) Array0.t -> ('a, 'b, 'c) Genarray.tval genarray_of_array1 : ('a, 'b, 'c) Array1.t -> ('a, 'b, 'c) Genarray.tval genarray_of_array2 : ('a, 'b, 'c) Array2.t -> ('a, 'b, 'c) Genarray.tval genarray_of_array3 : ('a, 'b, 'c) Array3.t -> ('a, 'b, 'c) Genarray.tval array0_of_genarray : ('a, 'b, 'c) Genarray.t -> ('a, 'b, 'c) Array0.tInvalid_argument if the generic big array
does not have exactly zero dimension.val array1_of_genarray : ('a, 'b, 'c) Genarray.t -> ('a, 'b, 'c) Array1.tInvalid_argument if the generic big array
does not have exactly one dimension.val array2_of_genarray : ('a, 'b, 'c) Genarray.t -> ('a, 'b, 'c) Array2.tInvalid_argument if the generic big array
does not have exactly two dimensions.val array3_of_genarray : ('a, 'b, 'c) Genarray.t -> ('a, 'b, 'c) Array3.tInvalid_argument if the generic big array
does not have exactly three dimensions.val reshape : ('a, 'b, 'c) Genarray.t ->
int array -> ('a, 'b, 'c) Genarray.treshape b [|d1;...;dN|] converts the big array b to a
N-dimensional array of dimensions d1...dN. The returned
array and the original array b share their data
and have the same layout. For instance, assuming that b
is a one-dimensional array of dimension 12, reshape b [|3;4|]
returns a two-dimensional array b' of dimensions 3 and 4.
If b has C layout, the element (x,y) of b' corresponds
to the element x * 3 + y of b. If b has Fortran layout,
the element (x,y) of b' corresponds to the element
x + (y - 1) * 4 of b.
The returned big array must have exactly the same number of
elements as the original big array b. That is, the product
of the dimensions of b must be equal to i1 * ... * iN.
Otherwise, Invalid_argument is raised.val reshape_0 : ('a, 'b, 'c) Genarray.t -> ('a, 'b, 'c) Array0.t
val reshape_1 : ('a, 'b, 'c) Genarray.t -> int -> ('a, 'b, 'c) Array1.tBigarray.reshape for reshaping to
one-dimensional arrays.val reshape_2 : ('a, 'b, 'c) Genarray.t ->
int -> int -> ('a, 'b, 'c) Array2.tBigarray.reshape for reshaping to
two-dimensional arrays.val reshape_3 : ('a, 'b, 'c) Genarray.t ->
int -> int -> int -> ('a, 'b, 'c) Array3.tBigarray.reshape for reshaping to
three-dimensional arrays.module Arg_helper:sig..end
,...
(as used for example for the specification of inlining parameters
varying by simplification round).module Make:ocaml-doc-4.05/ocaml.html/libref/Timings.html 0000644 0001750 0001750 00000044430 13131636451 020047 0 ustar mehdi mehdi
module Timings:sig..end
typefile =string
type
| |
File of |
| |
Pack of |
| |
Startup |
| |
Toplevel |
type
| |
All |
| |
Parsing of |
| |
Parser of |
| |
Dash_pp of |
| |
Dash_ppx of |
| |
Typing of |
| |
Transl of |
| |
Generate of |
| |
Assemble of |
| |
Clambda of |
| |
Cmm of |
| |
Compile_phrases of |
| |
Selection of |
| |
Comballoc of |
| |
CSE of |
| |
Liveness of |
| |
Deadcode of |
| |
Spill of |
| |
Split of |
| |
Regalloc of |
| |
Linearize of |
| |
Scheduling of |
| |
Emit of |
| |
Flambda_pass of |
val reset : unit -> unitval get : compiler_pass -> float optionval time_call : compiler_pass -> (unit -> 'a) -> 'atime_call pass f calls f and records its runtime.val time : compiler_pass -> ('a -> 'b) -> 'a -> 'btime pass f arg records the runtime of f argval accumulate_time : compiler_pass -> ('a -> 'b) -> 'a -> 'bval print : Format.formatter -> unitmodule Ephemeron:sig..end
typeobj_t =Obj.t
Obj.ttype
Ephemeronval create : int -> tcreate n returns an ephemeron with n keys.
All the keys and the data are initially emptyval length : t -> intval get_key : t -> int -> obj_t optionEphemeron.K1.get_keyval get_key_copy : t -> int -> obj_t optionEphemeron.K1.get_key_copyval set_key : t -> int -> obj_t -> unitEphemeron.K1.set_keyval unset_key : t -> int -> unitEphemeron.K1.unset_keyval check_key : t -> int -> boolEphemeron.K1.check_keyval blit_key : t -> int -> t -> int -> int -> unitEphemeron.K1.blit_keyval get_data : t -> obj_t optionEphemeron.K1.get_dataval get_data_copy : t -> obj_t optionEphemeron.K1.get_data_copyval set_data : t -> obj_t -> unitEphemeron.K1.set_dataval unset_data : t -> unitEphemeron.K1.unset_dataval check_data : t -> boolEphemeron.K1.check_dataval blit_data : t -> t -> unitEphemeron.K1.blit_datamodule Weak:sig..end
type 'a t
A weak pointer is said to be full if it points to a value, empty if the value was erased by the GC.
Notes:
output_value
nor the functions of the Marshal module.val create : int -> 'a tWeak.create n returns a new weak array of length n.
All the pointers are initially empty. Raise Invalid_argument
if n is negative or greater than Sys.max_array_length-1.val length : 'a t -> intWeak.length ar returns the length (number of elements) of
ar.val set : 'a t -> int -> 'a option -> unitWeak.set ar n (Some el) sets the nth cell of ar to be a
(full) pointer to el; Weak.set ar n None sets the nth
cell of ar to empty.
Raise Invalid_argument "Weak.set" if n is not in the range
0 to Weak.length a - 1.val get : 'a t -> int -> 'a optionWeak.get ar n returns None if the nth cell of ar is
empty, Some x (where x is the value) if it is full.
Raise Invalid_argument "Weak.get" if n is not in the range
0 to Weak.length a - 1.val get_copy : 'a t -> int -> 'a optionWeak.get_copy ar n returns None if the nth cell of ar is
empty, Some x (where x is a (shallow) copy of the value) if
it is full.
In addition to pitfalls with mutable values, the interesting
difference with get is that get_copy does not prevent
the incremental GC from erasing the value in its current cycle
(get may delay the erasure to the next GC cycle).
Raise Invalid_argument "Weak.get" if n is not in the range
0 to Weak.length a - 1.
If the element is a custom block it is not copied.
val check : 'a t -> int -> boolWeak.check ar n returns true if the nth cell of ar is
full, false if it is empty. Note that even if Weak.check ar n
returns true, a subsequent Weak.get ar n can return None.val fill : 'a t -> int -> int -> 'a option -> unitWeak.fill ar ofs len el sets to el all pointers of ar from
ofs to ofs + len - 1. Raise Invalid_argument "Weak.fill"
if ofs and len do not designate a valid subarray of a.val blit : 'a t -> int -> 'a t -> int -> int -> unitWeak.blit ar1 off1 ar2 off2 len copies len weak pointers
from ar1 (starting at off1) to ar2 (starting at off2).
It works correctly even if ar1 and ar2 are the same.
Raise Invalid_argument "Weak.blit" if off1 and len do
not designate a valid subarray of ar1, or if off2 and len
do not designate a valid subarray of ar2.Hashtbl.HashedType
module; the equal relation and hash function are taken from that
module. We will say that v is an instance of x if equal x v
is true.
The equal relation must be able to work on a shallow copy of
the values and give the same result as with the values themselves.
module type S =sig..end
Weak.Make.
module Make:
sig
type ratio
val null_denominator : Ratio.ratio -> bool
val numerator_ratio : Ratio.ratio -> Big_int.big_int
val denominator_ratio : Ratio.ratio -> Big_int.big_int
val sign_ratio : Ratio.ratio -> int
val normalize_ratio : Ratio.ratio -> Ratio.ratio
val cautious_normalize_ratio : Ratio.ratio -> Ratio.ratio
val cautious_normalize_ratio_when_printing : Ratio.ratio -> Ratio.ratio
val create_ratio : Big_int.big_int -> Big_int.big_int -> Ratio.ratio
val create_normalized_ratio :
Big_int.big_int -> Big_int.big_int -> Ratio.ratio
val is_normalized_ratio : Ratio.ratio -> bool
val report_sign_ratio : Ratio.ratio -> Big_int.big_int -> Big_int.big_int
val abs_ratio : Ratio.ratio -> Ratio.ratio
val is_integer_ratio : Ratio.ratio -> bool
val add_ratio : Ratio.ratio -> Ratio.ratio -> Ratio.ratio
val minus_ratio : Ratio.ratio -> Ratio.ratio
val add_int_ratio : int -> Ratio.ratio -> Ratio.ratio
val add_big_int_ratio : Big_int.big_int -> Ratio.ratio -> Ratio.ratio
val sub_ratio : Ratio.ratio -> Ratio.ratio -> Ratio.ratio
val mult_ratio : Ratio.ratio -> Ratio.ratio -> Ratio.ratio
val mult_int_ratio : int -> Ratio.ratio -> Ratio.ratio
val mult_big_int_ratio : Big_int.big_int -> Ratio.ratio -> Ratio.ratio
val square_ratio : Ratio.ratio -> Ratio.ratio
val inverse_ratio : Ratio.ratio -> Ratio.ratio
val div_ratio : Ratio.ratio -> Ratio.ratio -> Ratio.ratio
val integer_ratio : Ratio.ratio -> Big_int.big_int
val floor_ratio : Ratio.ratio -> Big_int.big_int
val round_ratio : Ratio.ratio -> Big_int.big_int
val ceiling_ratio : Ratio.ratio -> Big_int.big_int
val eq_ratio : Ratio.ratio -> Ratio.ratio -> bool
val compare_ratio : Ratio.ratio -> Ratio.ratio -> int
val lt_ratio : Ratio.ratio -> Ratio.ratio -> bool
val le_ratio : Ratio.ratio -> Ratio.ratio -> bool
val gt_ratio : Ratio.ratio -> Ratio.ratio -> bool
val ge_ratio : Ratio.ratio -> Ratio.ratio -> bool
val max_ratio : Ratio.ratio -> Ratio.ratio -> Ratio.ratio
val min_ratio : Ratio.ratio -> Ratio.ratio -> Ratio.ratio
val eq_big_int_ratio : Big_int.big_int -> Ratio.ratio -> bool
val compare_big_int_ratio : Big_int.big_int -> Ratio.ratio -> int
val lt_big_int_ratio : Big_int.big_int -> Ratio.ratio -> bool
val le_big_int_ratio : Big_int.big_int -> Ratio.ratio -> bool
val gt_big_int_ratio : Big_int.big_int -> Ratio.ratio -> bool
val ge_big_int_ratio : Big_int.big_int -> Ratio.ratio -> bool
val int_of_ratio : Ratio.ratio -> int
val ratio_of_int : int -> Ratio.ratio
val ratio_of_nat : Nat.nat -> Ratio.ratio
val nat_of_ratio : Ratio.ratio -> Nat.nat
val ratio_of_big_int : Big_int.big_int -> Ratio.ratio
val big_int_of_ratio : Ratio.ratio -> Big_int.big_int
val div_int_ratio : int -> Ratio.ratio -> Ratio.ratio
val div_ratio_int : Ratio.ratio -> int -> Ratio.ratio
val div_big_int_ratio : Big_int.big_int -> Ratio.ratio -> Ratio.ratio
val div_ratio_big_int : Ratio.ratio -> Big_int.big_int -> Ratio.ratio
val approx_ratio_fix : int -> Ratio.ratio -> string
val approx_ratio_exp : int -> Ratio.ratio -> string
val float_of_rational_string : Ratio.ratio -> string
val string_of_ratio : Ratio.ratio -> string
val ratio_of_string : string -> Ratio.ratio
val float_of_ratio : Ratio.ratio -> float
val power_ratio_positive_int : Ratio.ratio -> int -> Ratio.ratio
val power_ratio_positive_big_int :
Ratio.ratio -> Big_int.big_int -> Ratio.ratio
end ocaml-doc-4.05/ocaml.html/libref/type_Buffer.html 0000644 0001750 0001750 00000026066 13131636442 020714 0 ustar mehdi mehdi
sig
type t
val create : int -> Buffer.t
val contents : Buffer.t -> string
val to_bytes : Buffer.t -> bytes
val sub : Buffer.t -> int -> int -> string
val blit : Buffer.t -> int -> bytes -> int -> int -> unit
val nth : Buffer.t -> int -> char
val length : Buffer.t -> int
val clear : Buffer.t -> unit
val reset : Buffer.t -> unit
val add_char : Buffer.t -> char -> unit
val add_string : Buffer.t -> string -> unit
val add_bytes : Buffer.t -> bytes -> unit
val add_substring : Buffer.t -> string -> int -> int -> unit
val add_subbytes : Buffer.t -> bytes -> int -> int -> unit
val add_substitute : Buffer.t -> (string -> string) -> string -> unit
val add_buffer : Buffer.t -> Buffer.t -> unit
val add_channel : Buffer.t -> Pervasives.in_channel -> int -> unit
val output_buffer : Pervasives.out_channel -> Buffer.t -> unit
val truncate : Buffer.t -> int -> unit
end ocaml-doc-4.05/ocaml.html/libref/Digest.html 0000644 0001750 0001750 00000031550 13131636443 017654 0 ustar mehdi mehdi
module Digest:sig..end
This module provides functions to compute 128-bit 'digests' of
arbitrary-length strings or files. The digests are of cryptographic
quality: it is very hard, given a digest, to forge a string having
that digest. The algorithm used is MD5. This module should not be
used for secure and sensitive cryptographic applications. For these
kind of applications more recent and stronger cryptographic
primitives should be used instead.
typet =string
val compare : t -> t -> intcompare and the implementation
shared with String.compare. Along with the type t, this
function compare allows the module Digest to be passed as
argument to the functors Set.Make and Map.Make.val equal : t -> t -> boolval string : string -> tval bytes : bytes -> tval substring : string -> int -> int -> tDigest.substring s ofs len returns the digest of the substring
of s starting at index ofs and containing len characters.val subbytes : bytes -> int -> int -> tDigest.subbytes s ofs len returns the digest of the subsequence
of s starting at index ofs and containing len bytes.val channel : in_channel -> int -> tlen is nonnegative, Digest.channel ic len reads len
characters from channel ic and returns their digest, or raises
End_of_file if end-of-file is reached before len characters
are read. If len is negative, Digest.channel ic len reads
all characters from ic until end-of-file is reached and return
their digest.val file : string -> tval output : out_channel -> t -> unitval input : in_channel -> tval to_hex : t -> stringInvalid_argument if the argument is not exactly 16 bytes.val from_hex : string -> tInvalid_argument if the argument is not exactly 32 hexadecimal
characters.sig
type key
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/type_StdLabels.html 0000644 0001750 0001750 00000016017 13131636450 021352 0 ustar mehdi mehdi
sig
module Array = ArrayLabels
module Bytes = BytesLabels
module List = ListLabels
module String = StringLabels
end ocaml-doc-4.05/ocaml.html/libref/Condition.html 0000644 0001750 0001750 00000023520 13131636443 020361 0 ustar mehdi mehdi
module Condition:sig..end
Condition variables are used when one thread wants to wait until another
thread has finished doing something: the former thread 'waits' on the
condition variable, the latter thread 'signals' the condition when it
is done. Condition variables should always be protected by a mutex.
The typical use is (if D is a shared data structure, m its mutex,
and c is a condition variable):
Mutex.lock m;
while (* some predicate P over D is not satisfied *) do
Condition.wait c m
done;
(* Modify D *)
if (* the predicate P over D is now satisfied *) then Condition.signal c;
Mutex.unlock m
type
val create : unit -> tval wait : t -> Mutex.t -> unitwait c m atomically unlocks the mutex m and suspends the
calling process on the condition variable c. The process will
restart after the condition variable c has been signalled.
The mutex m is locked again before wait returns.val signal : t -> unitsignal c restarts one of the processes waiting on the
condition variable c.val broadcast : t -> unitbroadcast c restarts all processes waiting on the
condition variable c.module MakeHooks:
| Parameters: |
|
type
val add_hook : string -> (Misc.hook_info -> t -> t) -> unit
val apply_hooks : Misc.hook_info -> t -> t ocaml-doc-4.05/ocaml.html/libref/type_Clflags.Float_arg_helper.html 0000644 0001750 0001750 00000017676 13131636443 024322 0 ustar mehdi mehdi
sig
type parsed
val parse :
string ->
string -> Clflags.Float_arg_helper.parsed Pervasives.ref -> unit
type parse_result = Ok | Parse_failed of exn
val parse_no_error :
string ->
Clflags.Float_arg_helper.parsed Pervasives.ref ->
Clflags.Float_arg_helper.parse_result
val get : key:int -> Clflags.Float_arg_helper.parsed -> float
end ocaml-doc-4.05/ocaml.html/libref/type_Misc.LongString.html 0000644 0001750 0001750 00000022301 13131636446 022453 0 ustar mehdi mehdi
sig
type t = bytes array
val create : int -> Misc.LongString.t
val length : Misc.LongString.t -> int
val get : Misc.LongString.t -> int -> char
val set : Misc.LongString.t -> int -> char -> unit
val blit :
Misc.LongString.t -> int -> Misc.LongString.t -> int -> int -> unit
val output :
Pervasives.out_channel -> Misc.LongString.t -> int -> int -> unit
val unsafe_blit_to_bytes :
Misc.LongString.t -> int -> bytes -> int -> int -> unit
val input_bytes : Pervasives.in_channel -> int -> Misc.LongString.t
end ocaml-doc-4.05/ocaml.html/libref/type_CamlinternalOO.html 0000644 0001750 0001750 00000056347 13131636443 022360 0 ustar mehdi mehdi
sig
type tag
type label
type table
type meth
type t
type obj
type closure
val public_method_label : string -> CamlinternalOO.tag
val new_method : CamlinternalOO.table -> CamlinternalOO.label
val new_variable : CamlinternalOO.table -> string -> int
val new_methods_variables :
CamlinternalOO.table ->
string array -> string array -> CamlinternalOO.label array
val get_variable : CamlinternalOO.table -> string -> int
val get_variables : CamlinternalOO.table -> string array -> int array
val get_method_label :
CamlinternalOO.table -> string -> CamlinternalOO.label
val get_method_labels :
CamlinternalOO.table -> string array -> CamlinternalOO.label array
val get_method :
CamlinternalOO.table -> CamlinternalOO.label -> CamlinternalOO.meth
val set_method :
CamlinternalOO.table ->
CamlinternalOO.label -> CamlinternalOO.meth -> unit
val set_methods :
CamlinternalOO.table -> CamlinternalOO.label array -> unit
val narrow :
CamlinternalOO.table ->
string array -> string array -> string array -> unit
val widen : CamlinternalOO.table -> unit
val add_initializer :
CamlinternalOO.table -> (CamlinternalOO.obj -> unit) -> unit
val dummy_table : CamlinternalOO.table
val create_table : string array -> CamlinternalOO.table
val init_class : CamlinternalOO.table -> unit
val inherits :
CamlinternalOO.table ->
string array ->
string array ->
string array ->
CamlinternalOO.t *
(CamlinternalOO.table -> CamlinternalOO.obj -> Obj.t) *
CamlinternalOO.t * CamlinternalOO.obj -> bool -> Obj.t array
val make_class :
string array ->
(CamlinternalOO.table -> Obj.t -> CamlinternalOO.t) ->
CamlinternalOO.t * (CamlinternalOO.table -> Obj.t -> CamlinternalOO.t) *
(Obj.t -> CamlinternalOO.t) * Obj.t
type init_table
val make_class_store :
string array ->
(CamlinternalOO.table -> CamlinternalOO.t) ->
CamlinternalOO.init_table -> unit
val dummy_class :
string * int * int ->
CamlinternalOO.t * (CamlinternalOO.table -> Obj.t -> CamlinternalOO.t) *
(Obj.t -> CamlinternalOO.t) * Obj.t
val copy : (< .. > as 'a) -> 'a
val create_object : CamlinternalOO.table -> CamlinternalOO.obj
val create_object_opt :
CamlinternalOO.obj -> CamlinternalOO.table -> CamlinternalOO.obj
val run_initializers : CamlinternalOO.obj -> CamlinternalOO.table -> unit
val run_initializers_opt :
CamlinternalOO.obj ->
CamlinternalOO.obj -> CamlinternalOO.table -> CamlinternalOO.obj
val create_object_and_run_initializers :
CamlinternalOO.obj -> CamlinternalOO.table -> CamlinternalOO.obj
external send :
CamlinternalOO.obj -> CamlinternalOO.tag -> CamlinternalOO.t = "%send"
external sendcache :
CamlinternalOO.obj ->
CamlinternalOO.tag -> CamlinternalOO.t -> int -> CamlinternalOO.t
= "%sendcache"
external sendself :
CamlinternalOO.obj -> CamlinternalOO.label -> CamlinternalOO.t
= "%sendself"
external get_public_method :
CamlinternalOO.obj -> CamlinternalOO.tag -> CamlinternalOO.closure
= "caml_get_public_method" [@@noalloc]
type tables
val lookup_tables :
CamlinternalOO.tables ->
CamlinternalOO.closure array -> CamlinternalOO.tables
type impl =
GetConst
| GetVar
| GetEnv
| GetMeth
| SetVar
| AppConst
| AppVar
| AppEnv
| AppMeth
| AppConstConst
| AppConstVar
| AppConstEnv
| AppConstMeth
| AppVarConst
| AppEnvConst
| AppMethConst
| MethAppConst
| MethAppVar
| MethAppEnv
| MethAppMeth
| SendConst
| SendVar
| SendEnv
| SendMeth
| Closure of CamlinternalOO.closure
type params = {
mutable compact_table : bool;
mutable copy_parent : bool;
mutable clean_when_copying : bool;
mutable retry_count : int;
mutable bucket_small_size : int;
}
val params : CamlinternalOO.params
type stats = { classes : int; methods : int; inst_vars : int; }
val stats : unit -> CamlinternalOO.stats
end ocaml-doc-4.05/ocaml.html/libref/Ephemeron.GenHashTable.html 0000644 0001750 0001750 00000026507 13131636443 022651 0 ustar mehdi mehdi
module GenHashTable:sig..end
type
| |
ETrue |
|||
| |
EFalse |
|||
| |
EDead |
(* |
the container is dead
| *) |
module MakeSeeded:functor (H:sigtypetkeys
type'acontainercontains keys and the associated data
val hash :int -> t -> intsame asHashtbl.SeededHashedType
val equal :'a container ->
t -> Ephemeron.GenHashTable.equalequality predicate used to compare a key with the one in a container. Can returnEDeadif the keys in the container are dead
val create :t ->
'a -> 'a containercreate key datacreates a container from some initials keys and one data
val get_key :'a container ->
t optionget_key contreturns the keys if they are all alive
val get_data :'a container -> 'a optionget_data contreturns the data if it is alive
val set_key_data :'a container ->
t -> 'a -> unitset_key_data contmodifies the key and data
val check_key :'a container -> boolcheck_key contchecks if all the keys contained in the data are alive
end) ->Ephemeron.SeededSwith type key = H.t
sig
type t
val create : path:string -> Spacetime.Series.t
val save_event :
?time:float -> Spacetime.Series.t -> event_name:string -> unit
val save_and_close : ?time:float -> Spacetime.Series.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Parsing.html 0000644 0001750 0001750 00000025144 13131636450 021101 0 ustar mehdi mehdi
sig
val symbol_start : unit -> int
val symbol_end : unit -> int
val rhs_start : int -> int
val rhs_end : int -> int
val symbol_start_pos : unit -> Lexing.position
val symbol_end_pos : unit -> Lexing.position
val rhs_start_pos : int -> Lexing.position
val rhs_end_pos : int -> Lexing.position
val clear_parser : unit -> unit
exception Parse_error
val set_trace : bool -> bool
type parser_env
type parse_tables = {
actions : (Parsing.parser_env -> Obj.t) array;
transl_const : int array;
transl_block : int array;
lhs : string;
len : string;
defred : string;
dgoto : string;
sindex : string;
rindex : string;
gindex : string;
tablesize : int;
table : string;
check : string;
error_function : string -> unit;
names_const : string;
names_block : string;
}
exception YYexit of Obj.t
val yyparse :
Parsing.parse_tables ->
int -> (Lexing.lexbuf -> 'a) -> Lexing.lexbuf -> 'b
val peek_val : Parsing.parser_env -> int -> 'a
val is_current_lookahead : 'a -> bool
val parse_error : string -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_Unix.html 0000644 0001750 0001750 00000225033 13131636451 020421 0 ustar mehdi mehdi
sig
type error =
E2BIG
| EACCES
| EAGAIN
| EBADF
| EBUSY
| ECHILD
| EDEADLK
| EDOM
| EEXIST
| EFAULT
| EFBIG
| EINTR
| EINVAL
| EIO
| EISDIR
| EMFILE
| EMLINK
| ENAMETOOLONG
| ENFILE
| ENODEV
| ENOENT
| ENOEXEC
| ENOLCK
| ENOMEM
| ENOSPC
| ENOSYS
| ENOTDIR
| ENOTEMPTY
| ENOTTY
| ENXIO
| EPERM
| EPIPE
| ERANGE
| EROFS
| ESPIPE
| ESRCH
| EXDEV
| EWOULDBLOCK
| EINPROGRESS
| EALREADY
| ENOTSOCK
| EDESTADDRREQ
| EMSGSIZE
| EPROTOTYPE
| ENOPROTOOPT
| EPROTONOSUPPORT
| ESOCKTNOSUPPORT
| EOPNOTSUPP
| EPFNOSUPPORT
| EAFNOSUPPORT
| EADDRINUSE
| EADDRNOTAVAIL
| ENETDOWN
| ENETUNREACH
| ENETRESET
| ECONNABORTED
| ECONNRESET
| ENOBUFS
| EISCONN
| ENOTCONN
| ESHUTDOWN
| ETOOMANYREFS
| ETIMEDOUT
| ECONNREFUSED
| EHOSTDOWN
| EHOSTUNREACH
| ELOOP
| EOVERFLOW
| EUNKNOWNERR of int
exception Unix_error of Unix.error * string * string
val error_message : Unix.error -> string
val handle_unix_error : ('a -> 'b) -> 'a -> 'b
val environment : unit -> string array
val getenv : string -> string
val putenv : string -> string -> unit
type process_status = WEXITED of int | WSIGNALED of int | WSTOPPED of int
type wait_flag = WNOHANG | WUNTRACED
val execv : string -> string array -> 'a
val execve : string -> string array -> string array -> 'a
val execvp : string -> string array -> 'a
val execvpe : string -> string array -> string array -> 'a
val fork : unit -> int
val wait : unit -> int * Unix.process_status
val waitpid : Unix.wait_flag list -> int -> int * Unix.process_status
val system : string -> Unix.process_status
val getpid : unit -> int
val getppid : unit -> int
val nice : int -> int
type file_descr
val stdin : Unix.file_descr
val stdout : Unix.file_descr
val stderr : Unix.file_descr
type open_flag =
O_RDONLY
| O_WRONLY
| O_RDWR
| O_NONBLOCK
| O_APPEND
| O_CREAT
| O_TRUNC
| O_EXCL
| O_NOCTTY
| O_DSYNC
| O_SYNC
| O_RSYNC
| O_SHARE_DELETE
| O_CLOEXEC
| O_KEEPEXEC
type file_perm = int
val openfile :
string -> Unix.open_flag list -> Unix.file_perm -> Unix.file_descr
val close : Unix.file_descr -> unit
val read : Unix.file_descr -> bytes -> int -> int -> int
val write : Unix.file_descr -> bytes -> int -> int -> int
val single_write : Unix.file_descr -> bytes -> int -> int -> int
val write_substring : Unix.file_descr -> string -> int -> int -> int
val single_write_substring : Unix.file_descr -> string -> int -> int -> int
val in_channel_of_descr : Unix.file_descr -> Pervasives.in_channel
val out_channel_of_descr : Unix.file_descr -> Pervasives.out_channel
val descr_of_in_channel : Pervasives.in_channel -> Unix.file_descr
val descr_of_out_channel : Pervasives.out_channel -> Unix.file_descr
type seek_command = SEEK_SET | SEEK_CUR | SEEK_END
val lseek : Unix.file_descr -> int -> Unix.seek_command -> int
val truncate : string -> int -> unit
val ftruncate : Unix.file_descr -> int -> unit
type file_kind = S_REG | S_DIR | S_CHR | S_BLK | S_LNK | S_FIFO | S_SOCK
type stats = {
st_dev : int;
st_ino : int;
st_kind : Unix.file_kind;
st_perm : Unix.file_perm;
st_nlink : int;
st_uid : int;
st_gid : int;
st_rdev : int;
st_size : int;
st_atime : float;
st_mtime : float;
st_ctime : float;
}
val stat : string -> Unix.stats
val lstat : string -> Unix.stats
val fstat : Unix.file_descr -> Unix.stats
val isatty : Unix.file_descr -> bool
module LargeFile :
sig
val lseek : Unix.file_descr -> int64 -> Unix.seek_command -> int64
val truncate : string -> int64 -> unit
val ftruncate : Unix.file_descr -> int64 -> unit
type stats = {
st_dev : int;
st_ino : int;
st_kind : Unix.file_kind;
st_perm : Unix.file_perm;
st_nlink : int;
st_uid : int;
st_gid : int;
st_rdev : int;
st_size : int64;
st_atime : float;
st_mtime : float;
st_ctime : float;
}
val stat : string -> Unix.LargeFile.stats
val lstat : string -> Unix.LargeFile.stats
val fstat : Unix.file_descr -> Unix.LargeFile.stats
end
val unlink : string -> unit
val rename : string -> string -> unit
val link : string -> string -> unit
type access_permission = R_OK | W_OK | X_OK | F_OK
val chmod : string -> Unix.file_perm -> unit
val fchmod : Unix.file_descr -> Unix.file_perm -> unit
val chown : string -> int -> int -> unit
val fchown : Unix.file_descr -> int -> int -> unit
val umask : int -> int
val access : string -> Unix.access_permission list -> unit
val dup : ?cloexec:bool -> Unix.file_descr -> Unix.file_descr
val dup2 : ?cloexec:bool -> Unix.file_descr -> Unix.file_descr -> unit
val set_nonblock : Unix.file_descr -> unit
val clear_nonblock : Unix.file_descr -> unit
val set_close_on_exec : Unix.file_descr -> unit
val clear_close_on_exec : Unix.file_descr -> unit
val mkdir : string -> Unix.file_perm -> unit
val rmdir : string -> unit
val chdir : string -> unit
val getcwd : unit -> string
val chroot : string -> unit
type dir_handle
val opendir : string -> Unix.dir_handle
val readdir : Unix.dir_handle -> string
val rewinddir : Unix.dir_handle -> unit
val closedir : Unix.dir_handle -> unit
val pipe : ?cloexec:bool -> unit -> Unix.file_descr * Unix.file_descr
val mkfifo : string -> Unix.file_perm -> unit
val create_process :
string ->
string array ->
Unix.file_descr -> Unix.file_descr -> Unix.file_descr -> int
val create_process_env :
string ->
string array ->
string array ->
Unix.file_descr -> Unix.file_descr -> Unix.file_descr -> int
val open_process_in : string -> Pervasives.in_channel
val open_process_out : string -> Pervasives.out_channel
val open_process : string -> Pervasives.in_channel * Pervasives.out_channel
val open_process_full :
string ->
string array ->
Pervasives.in_channel * Pervasives.out_channel * Pervasives.in_channel
val close_process_in : Pervasives.in_channel -> Unix.process_status
val close_process_out : Pervasives.out_channel -> Unix.process_status
val close_process :
Pervasives.in_channel * Pervasives.out_channel -> Unix.process_status
val close_process_full :
Pervasives.in_channel * Pervasives.out_channel * Pervasives.in_channel ->
Unix.process_status
val symlink : ?to_dir:bool -> string -> string -> unit
val has_symlink : unit -> bool
val readlink : string -> string
val select :
Unix.file_descr list ->
Unix.file_descr list ->
Unix.file_descr list ->
float ->
Unix.file_descr list * Unix.file_descr list * Unix.file_descr list
type lock_command =
F_ULOCK
| F_LOCK
| F_TLOCK
| F_TEST
| F_RLOCK
| F_TRLOCK
val lockf : Unix.file_descr -> Unix.lock_command -> int -> unit
val kill : int -> int -> unit
type sigprocmask_command = SIG_SETMASK | SIG_BLOCK | SIG_UNBLOCK
val sigprocmask : Unix.sigprocmask_command -> int list -> int list
val sigpending : unit -> int list
val sigsuspend : int list -> unit
val pause : unit -> unit
type process_times = {
tms_utime : float;
tms_stime : float;
tms_cutime : float;
tms_cstime : float;
}
type tm = {
tm_sec : int;
tm_min : int;
tm_hour : int;
tm_mday : int;
tm_mon : int;
tm_year : int;
tm_wday : int;
tm_yday : int;
tm_isdst : bool;
}
val time : unit -> float
val gettimeofday : unit -> float
val gmtime : float -> Unix.tm
val localtime : float -> Unix.tm
val mktime : Unix.tm -> float * Unix.tm
val alarm : int -> int
val sleep : int -> unit
val sleepf : float -> unit
val times : unit -> Unix.process_times
val utimes : string -> float -> float -> unit
type interval_timer = ITIMER_REAL | ITIMER_VIRTUAL | ITIMER_PROF
type interval_timer_status = { it_interval : float; it_value : float; }
val getitimer : Unix.interval_timer -> Unix.interval_timer_status
val setitimer :
Unix.interval_timer ->
Unix.interval_timer_status -> Unix.interval_timer_status
val getuid : unit -> int
val geteuid : unit -> int
val setuid : int -> unit
val getgid : unit -> int
val getegid : unit -> int
val setgid : int -> unit
val getgroups : unit -> int array
val setgroups : int array -> unit
val initgroups : string -> int -> unit
type passwd_entry = {
pw_name : string;
pw_passwd : string;
pw_uid : int;
pw_gid : int;
pw_gecos : string;
pw_dir : string;
pw_shell : string;
}
type group_entry = {
gr_name : string;
gr_passwd : string;
gr_gid : int;
gr_mem : string array;
}
val getlogin : unit -> string
val getpwnam : string -> Unix.passwd_entry
val getgrnam : string -> Unix.group_entry
val getpwuid : int -> Unix.passwd_entry
val getgrgid : int -> Unix.group_entry
type inet_addr
val inet_addr_of_string : string -> Unix.inet_addr
val string_of_inet_addr : Unix.inet_addr -> string
val inet_addr_any : Unix.inet_addr
val inet_addr_loopback : Unix.inet_addr
val inet6_addr_any : Unix.inet_addr
val inet6_addr_loopback : Unix.inet_addr
type socket_domain = PF_UNIX | PF_INET | PF_INET6
type socket_type = SOCK_STREAM | SOCK_DGRAM | SOCK_RAW | SOCK_SEQPACKET
type sockaddr = ADDR_UNIX of string | ADDR_INET of Unix.inet_addr * int
val socket :
?cloexec:bool ->
Unix.socket_domain -> Unix.socket_type -> int -> Unix.file_descr
val domain_of_sockaddr : Unix.sockaddr -> Unix.socket_domain
val socketpair :
?cloexec:bool ->
Unix.socket_domain ->
Unix.socket_type -> int -> Unix.file_descr * Unix.file_descr
val accept :
?cloexec:bool -> Unix.file_descr -> Unix.file_descr * Unix.sockaddr
val bind : Unix.file_descr -> Unix.sockaddr -> unit
val connect : Unix.file_descr -> Unix.sockaddr -> unit
val listen : Unix.file_descr -> int -> unit
type shutdown_command = SHUTDOWN_RECEIVE | SHUTDOWN_SEND | SHUTDOWN_ALL
val shutdown : Unix.file_descr -> Unix.shutdown_command -> unit
val getsockname : Unix.file_descr -> Unix.sockaddr
val getpeername : Unix.file_descr -> Unix.sockaddr
type msg_flag = MSG_OOB | MSG_DONTROUTE | MSG_PEEK
val recv :
Unix.file_descr -> bytes -> int -> int -> Unix.msg_flag list -> int
val recvfrom :
Unix.file_descr ->
bytes -> int -> int -> Unix.msg_flag list -> int * Unix.sockaddr
val send :
Unix.file_descr -> bytes -> int -> int -> Unix.msg_flag list -> int
val send_substring :
Unix.file_descr -> string -> int -> int -> Unix.msg_flag list -> int
val sendto :
Unix.file_descr ->
bytes -> int -> int -> Unix.msg_flag list -> Unix.sockaddr -> int
val sendto_substring :
Unix.file_descr ->
string -> int -> int -> Unix.msg_flag list -> Unix.sockaddr -> int
type socket_bool_option =
SO_DEBUG
| SO_BROADCAST
| SO_REUSEADDR
| SO_KEEPALIVE
| SO_DONTROUTE
| SO_OOBINLINE
| SO_ACCEPTCONN
| TCP_NODELAY
| IPV6_ONLY
type socket_int_option =
SO_SNDBUF
| SO_RCVBUF
| SO_ERROR
| SO_TYPE
| SO_RCVLOWAT
| SO_SNDLOWAT
type socket_optint_option = SO_LINGER
type socket_float_option = SO_RCVTIMEO | SO_SNDTIMEO
val getsockopt : Unix.file_descr -> Unix.socket_bool_option -> bool
val setsockopt : Unix.file_descr -> Unix.socket_bool_option -> bool -> unit
val getsockopt_int : Unix.file_descr -> Unix.socket_int_option -> int
val setsockopt_int :
Unix.file_descr -> Unix.socket_int_option -> int -> unit
val getsockopt_optint :
Unix.file_descr -> Unix.socket_optint_option -> int option
val setsockopt_optint :
Unix.file_descr -> Unix.socket_optint_option -> int option -> unit
val getsockopt_float : Unix.file_descr -> Unix.socket_float_option -> float
val setsockopt_float :
Unix.file_descr -> Unix.socket_float_option -> float -> unit
val getsockopt_error : Unix.file_descr -> Unix.error option
val open_connection :
Unix.sockaddr -> Pervasives.in_channel * Pervasives.out_channel
val shutdown_connection : Pervasives.in_channel -> unit
val establish_server :
(Pervasives.in_channel -> Pervasives.out_channel -> unit) ->
Unix.sockaddr -> unit
type host_entry = {
h_name : string;
h_aliases : string array;
h_addrtype : Unix.socket_domain;
h_addr_list : Unix.inet_addr array;
}
type protocol_entry = {
p_name : string;
p_aliases : string array;
p_proto : int;
}
type service_entry = {
s_name : string;
s_aliases : string array;
s_port : int;
s_proto : string;
}
val gethostname : unit -> string
val gethostbyname : string -> Unix.host_entry
val gethostbyaddr : Unix.inet_addr -> Unix.host_entry
val getprotobyname : string -> Unix.protocol_entry
val getprotobynumber : int -> Unix.protocol_entry
val getservbyname : string -> string -> Unix.service_entry
val getservbyport : int -> string -> Unix.service_entry
type addr_info = {
ai_family : Unix.socket_domain;
ai_socktype : Unix.socket_type;
ai_protocol : int;
ai_addr : Unix.sockaddr;
ai_canonname : string;
}
type getaddrinfo_option =
AI_FAMILY of Unix.socket_domain
| AI_SOCKTYPE of Unix.socket_type
| AI_PROTOCOL of int
| AI_NUMERICHOST
| AI_CANONNAME
| AI_PASSIVE
val getaddrinfo :
string -> string -> Unix.getaddrinfo_option list -> Unix.addr_info list
type name_info = { ni_hostname : string; ni_service : string; }
type getnameinfo_option =
NI_NOFQDN
| NI_NUMERICHOST
| NI_NAMEREQD
| NI_NUMERICSERV
| NI_DGRAM
val getnameinfo :
Unix.sockaddr -> Unix.getnameinfo_option list -> Unix.name_info
type terminal_io = {
mutable c_ignbrk : bool;
mutable c_brkint : bool;
mutable c_ignpar : bool;
mutable c_parmrk : bool;
mutable c_inpck : bool;
mutable c_istrip : bool;
mutable c_inlcr : bool;
mutable c_igncr : bool;
mutable c_icrnl : bool;
mutable c_ixon : bool;
mutable c_ixoff : bool;
mutable c_opost : bool;
mutable c_obaud : int;
mutable c_ibaud : int;
mutable c_csize : int;
mutable c_cstopb : int;
mutable c_cread : bool;
mutable c_parenb : bool;
mutable c_parodd : bool;
mutable c_hupcl : bool;
mutable c_clocal : bool;
mutable c_isig : bool;
mutable c_icanon : bool;
mutable c_noflsh : bool;
mutable c_echo : bool;
mutable c_echoe : bool;
mutable c_echok : bool;
mutable c_echonl : bool;
mutable c_vintr : char;
mutable c_vquit : char;
mutable c_verase : char;
mutable c_vkill : char;
mutable c_veof : char;
mutable c_veol : char;
mutable c_vmin : int;
mutable c_vtime : int;
mutable c_vstart : char;
mutable c_vstop : char;
}
val tcgetattr : Unix.file_descr -> Unix.terminal_io
type setattr_when = TCSANOW | TCSADRAIN | TCSAFLUSH
val tcsetattr :
Unix.file_descr -> Unix.setattr_when -> Unix.terminal_io -> unit
val tcsendbreak : Unix.file_descr -> int -> unit
val tcdrain : Unix.file_descr -> unit
type flush_queue = TCIFLUSH | TCOFLUSH | TCIOFLUSH
val tcflush : Unix.file_descr -> Unix.flush_queue -> unit
type flow_action = TCOOFF | TCOON | TCIOFF | TCION
val tcflow : Unix.file_descr -> Unix.flow_action -> unit
val setsid : unit -> int
end ocaml-doc-4.05/ocaml.html/libref/type_Parser.html 0000644 0001750 0001750 00000056110 13131636447 020735 0 ustar mehdi mehdi
sig
type token =
AMPERAMPER
| AMPERSAND
| AND
| AS
| ASSERT
| BACKQUOTE
| BANG
| BAR
| BARBAR
| BARRBRACKET
| BEGIN
| CHAR of char
| CLASS
| COLON
| COLONCOLON
| COLONEQUAL
| COLONGREATER
| COMMA
| CONSTRAINT
| DO
| DONE
| DOT
| DOTDOT
| DOWNTO
| ELSE
| END
| EOF
| EQUAL
| EXCEPTION
| EXTERNAL
| FALSE
| FLOAT of (string * char option)
| FOR
| FUN
| FUNCTION
| FUNCTOR
| GREATER
| GREATERRBRACE
| GREATERRBRACKET
| IF
| IN
| INCLUDE
| INFIXOP0 of string
| INFIXOP1 of string
| INFIXOP2 of string
| INFIXOP3 of string
| INFIXOP4 of string
| INHERIT
| INITIALIZER
| INT of (string * char option)
| LABEL of string
| LAZY
| LBRACE
| LBRACELESS
| LBRACKET
| LBRACKETBAR
| LBRACKETLESS
| LBRACKETGREATER
| LBRACKETPERCENT
| LBRACKETPERCENTPERCENT
| LESS
| LESSMINUS
| LET
| LIDENT of string
| LPAREN
| LBRACKETAT
| LBRACKETATAT
| LBRACKETATATAT
| MATCH
| METHOD
| MINUS
| MINUSDOT
| MINUSGREATER
| MODULE
| MUTABLE
| NEW
| NONREC
| OBJECT
| OF
| OPEN
| OPTLABEL of string
| OR
| PERCENT
| PLUS
| PLUSDOT
| PLUSEQ
| PREFIXOP of string
| PRIVATE
| QUESTION
| QUOTE
| RBRACE
| RBRACKET
| REC
| RPAREN
| SEMI
| SEMISEMI
| HASH
| HASHOP of string
| SIG
| STAR
| STRING of (string * string option)
| STRUCT
| THEN
| TILDE
| TO
| TRUE
| TRY
| TYPE
| UIDENT of string
| UNDERSCORE
| VAL
| VIRTUAL
| WHEN
| WHILE
| WITH
| COMMENT of (string * Location.t)
| DOCSTRING of Docstrings.docstring
| EOL
val implementation :
(Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parsetree.structure
val interface :
(Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parsetree.signature
val toplevel_phrase :
(Lexing.lexbuf -> Parser.token) ->
Lexing.lexbuf -> Parsetree.toplevel_phrase
val use_file :
(Lexing.lexbuf -> Parser.token) ->
Lexing.lexbuf -> Parsetree.toplevel_phrase list
val parse_core_type :
(Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parsetree.core_type
val parse_expression :
(Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parsetree.expression
val parse_pattern :
(Lexing.lexbuf -> Parser.token) -> Lexing.lexbuf -> Parsetree.pattern
end ocaml-doc-4.05/ocaml.html/libref/Set.OrderedType.html 0000644 0001750 0001750 00000020377 13131636450 021420 0 ustar mehdi mehdi
module type OrderedType =sig..end
Set.Make.type
val compare : t -> t -> intf such that
f e1 e2 is zero if the elements e1 and e2 are equal,
f e1 e2 is strictly negative if e1 is smaller than e2,
and f e1 e2 is strictly positive if e1 is greater than e2.
Example: a suitable ordering function is the generic structural
comparison function compare.module Slot:sig..end
typet =Printexc.backtrace_slot
val is_raise : t -> boolis_raise slot is true when slot refers to a raising
point in the code, and false when it comes from a simple
function call.val is_inline : t -> boolis_inline slot is true when slot refers to a call
that got inlined by the compiler, and false when it comes from
any other context.val location : t -> Printexc.location optionlocation slot returns the location information of the slot,
if available, and None otherwise.
Some possible reasons for failing to return a location are as follow:
-g)val format : int -> t -> string optionformat pos slot returns the string representation of slot as
raw_backtrace_to_string would format it, assuming it is the
pos-th element of the backtrace: the 0-th element is
pretty-printed differently than the others.
Whole-backtrace printing functions also skip some uninformative
slots; in that case, format pos slot returns None.
Since 4.02
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_type_desc -> Parsetree.class_type
val attr :
Parsetree.class_type -> Parsetree.attribute -> Parsetree.class_type
val constr :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.class_type
val signature :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_signature -> Parsetree.class_type
val arrow :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.core_type -> Parsetree.class_type -> Parsetree.class_type
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_type
end ocaml-doc-4.05/ocaml.html/libref/type_StdLabels.List.html 0000644 0001750 0001750 00000014701 13131636450 022262 0 ustar mehdi mehdi
(module ListLabels) ocaml-doc-4.05/ocaml.html/libref/type_Digest.html 0000644 0001750 0001750 00000022317 13131636443 020716 0 ustar mehdi mehdi
sig
type t = string
val compare : Digest.t -> Digest.t -> int
val equal : Digest.t -> Digest.t -> bool
val string : string -> Digest.t
val bytes : bytes -> Digest.t
val substring : string -> int -> int -> Digest.t
val subbytes : bytes -> int -> int -> Digest.t
external channel : Pervasives.in_channel -> int -> Digest.t
= "caml_md5_chan"
val file : string -> Digest.t
val output : Pervasives.out_channel -> Digest.t -> unit
val input : Pervasives.in_channel -> Digest.t
val to_hex : Digest.t -> string
val from_hex : string -> Digest.t
end ocaml-doc-4.05/ocaml.html/libref/type_Docstrings.html 0000644 0001750 0001750 00000036270 13131636443 021621 0 ustar mehdi mehdi
sig
val init : unit -> unit
val warn_bad_docstrings : unit -> unit
type docstring
val docstring : string -> Location.t -> Docstrings.docstring
val register : Docstrings.docstring -> unit
val docstring_body : Docstrings.docstring -> string
val docstring_loc : Docstrings.docstring -> Location.t
val set_pre_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_post_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_floating_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_pre_extra_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
val set_post_extra_docstrings :
Lexing.position -> Docstrings.docstring list -> unit
type docs = {
docs_pre : Docstrings.docstring option;
docs_post : Docstrings.docstring option;
}
val empty_docs : Docstrings.docs
val docs_attr : Docstrings.docstring -> Parsetree.attribute
val add_docs_attrs :
Docstrings.docs -> Parsetree.attributes -> Parsetree.attributes
val symbol_docs : unit -> Docstrings.docs
val symbol_docs_lazy : unit -> Docstrings.docs Lazy.t
val rhs_docs : int -> int -> Docstrings.docs
val rhs_docs_lazy : int -> int -> Docstrings.docs Lazy.t
val mark_symbol_docs : unit -> unit
val mark_rhs_docs : int -> int -> unit
type info = Docstrings.docstring option
val empty_info : Docstrings.info
val info_attr : Docstrings.docstring -> Parsetree.attribute
val add_info_attrs :
Docstrings.info -> Parsetree.attributes -> Parsetree.attributes
val symbol_info : unit -> Docstrings.info
val rhs_info : int -> Docstrings.info
type text = Docstrings.docstring list
val empty_text : Docstrings.text
val empty_text_lazy : Docstrings.text Lazy.t
val text_attr : Docstrings.docstring -> Parsetree.attribute
val add_text_attrs :
Docstrings.text -> Parsetree.attributes -> Parsetree.attributes
val symbol_text : unit -> Docstrings.text
val symbol_text_lazy : unit -> Docstrings.text Lazy.t
val rhs_text : int -> Docstrings.text
val rhs_text_lazy : int -> Docstrings.text Lazy.t
val symbol_pre_extra_text : unit -> Docstrings.text
val symbol_post_extra_text : unit -> Docstrings.text
val rhs_pre_extra_text : int -> Docstrings.text
val rhs_post_extra_text : int -> Docstrings.text
end ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.html 0000644 0001750 0001750 00000264556 13131636444 021437 0 ustar mehdi mehdi
sig
module type S =
sig
type key
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module type SeededS =
sig
type key
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module K1 :
sig
type ('k, 'd) t
val create : unit -> ('k, 'd) Ephemeron.K1.t
val get_key : ('k, 'd) Ephemeron.K1.t -> 'k option
val get_key_copy : ('k, 'd) Ephemeron.K1.t -> 'k option
val set_key : ('k, 'd) Ephemeron.K1.t -> 'k -> unit
val unset_key : ('k, 'd) Ephemeron.K1.t -> unit
val check_key : ('k, 'd) Ephemeron.K1.t -> bool
val blit_key :
('k, 'a) Ephemeron.K1.t -> ('k, 'b) Ephemeron.K1.t -> unit
val get_data : ('k, 'd) Ephemeron.K1.t -> 'd option
val get_data_copy : ('k, 'd) Ephemeron.K1.t -> 'd option
val set_data : ('k, 'd) Ephemeron.K1.t -> 'd -> unit
val unset_data : ('k, 'd) Ephemeron.K1.t -> unit
val check_data : ('k, 'd) Ephemeron.K1.t -> bool
val blit_data :
('a, 'd) Ephemeron.K1.t -> ('b, 'd) Ephemeron.K1.t -> unit
module Make :
functor (H : Hashtbl.HashedType) ->
sig
type key = H.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module MakeSeeded :
functor (H : Hashtbl.SeededHashedType) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end
module K2 :
sig
type ('k1, 'k2, 'd) t
val create : unit -> ('k1, 'k2, 'd) Ephemeron.K2.t
val get_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k1 option
val get_key1_copy : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k1 option
val set_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k1 -> unit
val unset_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
val check_key1 : ('k1, 'k2, 'd) Ephemeron.K2.t -> bool
val get_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k2 option
val get_key2_copy : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k2 option
val set_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'k2 -> unit
val unset_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
val check_key2 : ('k1, 'k2, 'd) Ephemeron.K2.t -> bool
val blit_key1 :
('k1, 'a, 'b) Ephemeron.K2.t -> ('k1, 'c, 'd) Ephemeron.K2.t -> unit
val blit_key2 :
('a, 'k2, 'b) Ephemeron.K2.t -> ('c, 'k2, 'd) Ephemeron.K2.t -> unit
val blit_key12 :
('k1, 'k2, 'a) Ephemeron.K2.t ->
('k1, 'k2, 'b) Ephemeron.K2.t -> unit
val get_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'd option
val get_data_copy : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'd option
val set_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> 'd -> unit
val unset_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> unit
val check_data : ('k1, 'k2, 'd) Ephemeron.K2.t -> bool
val blit_data :
('k1, 'k2, 'd) Ephemeron.K2.t ->
('k1, 'k2, 'd) Ephemeron.K2.t -> unit
module Make :
functor (H1 : Hashtbl.HashedType) (H2 : Hashtbl.HashedType) ->
sig
type key = H1.t * H2.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module MakeSeeded :
functor
(H1 : Hashtbl.SeededHashedType) (H2 : Hashtbl.SeededHashedType) ->
sig
type key = H1.t * H2.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end
module Kn :
sig
type ('k, 'd) t
val create : int -> ('k, 'd) Ephemeron.Kn.t
val get_key : ('k, 'd) Ephemeron.Kn.t -> int -> 'k option
val get_key_copy : ('k, 'd) Ephemeron.Kn.t -> int -> 'k option
val set_key : ('k, 'd) Ephemeron.Kn.t -> int -> 'k -> unit
val unset_key : ('k, 'd) Ephemeron.Kn.t -> int -> unit
val check_key : ('k, 'd) Ephemeron.Kn.t -> int -> bool
val blit_key :
('k, 'a) Ephemeron.Kn.t ->
int -> ('k, 'b) Ephemeron.Kn.t -> int -> int -> unit
val get_data : ('k, 'd) Ephemeron.Kn.t -> 'd option
val get_data_copy : ('k, 'd) Ephemeron.Kn.t -> 'd option
val set_data : ('k, 'd) Ephemeron.Kn.t -> 'd -> unit
val unset_data : ('k, 'd) Ephemeron.Kn.t -> unit
val check_data : ('k, 'd) Ephemeron.Kn.t -> bool
val blit_data :
('k, 'd) Ephemeron.Kn.t -> ('k, 'd) Ephemeron.Kn.t -> unit
module Make :
functor (H : Hashtbl.HashedType) ->
sig
type key = H.t array
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
module MakeSeeded :
functor (H : Hashtbl.SeededHashedType) ->
sig
type key = H.t array
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end
module GenHashTable :
sig
type equal = ETrue | EFalse | EDead
module MakeSeeded :
functor
(H : sig
type t
type 'a container
val hash : int -> Ephemeron.GenHashTable.MakeSeeded.t -> int
val equal :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t ->
Ephemeron.GenHashTable.equal
val create :
Ephemeron.GenHashTable.MakeSeeded.t ->
'a -> 'a Ephemeron.GenHashTable.MakeSeeded.container
val get_key :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t option
val get_data :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
'a option
val set_key_data :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t -> 'a -> unit
val check_key :
'a Ephemeron.GenHashTable.MakeSeeded.container -> bool
end) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end
end ocaml-doc-4.05/ocaml.html/libref/UnixLabels.LargeFile.html 0000644 0001750 0001750 00000036240 13131636451 022334 0 ustar mehdi mehdi
module LargeFile:sig..end
UnixLabels.lseek (for positioning a file descriptor),
UnixLabels.truncate and UnixLabels.ftruncate
(for changing the size of a file),
and UnixLabels.stat, UnixLabels.lstat and UnixLabels.fstat
(for obtaining information on files). These alternate functions represent
positions and sizes by 64-bit integers (type int64) instead of
regular integers (type int), thus allowing operating on files
whose sizes are greater than max_int.val lseek : UnixLabels.file_descr -> int64 -> mode:UnixLabels.seek_command -> int64
val truncate : string -> len:int64 -> unit
val ftruncate : UnixLabels.file_descr -> len:int64 -> unit
typestats =Unix.LargeFile.stats= {
|
st_dev : |
(* |
Device number
| *) |
|
st_ino : |
(* |
Inode number
| *) |
|
st_kind : |
(* |
Kind of the file
| *) |
|
st_perm : |
(* |
Access rights
| *) |
|
st_nlink : |
(* |
Number of links
| *) |
|
st_uid : |
(* |
User id of the owner
| *) |
|
st_gid : |
(* |
Group ID of the file's group
| *) |
|
st_rdev : |
(* |
Device minor number
| *) |
|
st_size : |
(* |
Size in bytes
| *) |
|
st_atime : |
(* |
Last access time
| *) |
|
st_mtime : |
(* |
Last modification time
| *) |
|
st_ctime : |
(* |
Last status change time
| *) |
val stat : string -> stats
val lstat : string -> stats
val fstat : UnixLabels.file_descr -> stats ocaml-doc-4.05/ocaml.html/libref/Identifiable.Pair.html 0000644 0001750 0001750 00000021564 13131636444 021713 0 ustar mehdi mehdi
module Pair:
| Parameters: |
|
type
include Hashtbl.HashedType
include Map.OrderedType
val output : out_channel -> t -> unit
val print : Format.formatter -> t -> unit ocaml-doc-4.05/ocaml.html/libref/Clflags.Float_arg_helper.html 0000644 0001750 0001750 00000021216 13131636443 023242 0 ustar mehdi mehdi
module Float_arg_helper:sig..end
type
val parse : string -> string -> parsed ref -> unit
type
| |
Ok |
| |
Parse_failed of |
val parse_no_error : string ->
parsed ref ->
parse_result
val get : key:int -> parsed -> float ocaml-doc-4.05/ocaml.html/libref/type_UnixLabels.html 0000644 0001750 0001750 00000240336 13131636452 021550 0 ustar mehdi mehdi
sig
type error =
Unix.error =
E2BIG
| EACCES
| EAGAIN
| EBADF
| EBUSY
| ECHILD
| EDEADLK
| EDOM
| EEXIST
| EFAULT
| EFBIG
| EINTR
| EINVAL
| EIO
| EISDIR
| EMFILE
| EMLINK
| ENAMETOOLONG
| ENFILE
| ENODEV
| ENOENT
| ENOEXEC
| ENOLCK
| ENOMEM
| ENOSPC
| ENOSYS
| ENOTDIR
| ENOTEMPTY
| ENOTTY
| ENXIO
| EPERM
| EPIPE
| ERANGE
| EROFS
| ESPIPE
| ESRCH
| EXDEV
| EWOULDBLOCK
| EINPROGRESS
| EALREADY
| ENOTSOCK
| EDESTADDRREQ
| EMSGSIZE
| EPROTOTYPE
| ENOPROTOOPT
| EPROTONOSUPPORT
| ESOCKTNOSUPPORT
| EOPNOTSUPP
| EPFNOSUPPORT
| EAFNOSUPPORT
| EADDRINUSE
| EADDRNOTAVAIL
| ENETDOWN
| ENETUNREACH
| ENETRESET
| ECONNABORTED
| ECONNRESET
| ENOBUFS
| EISCONN
| ENOTCONN
| ESHUTDOWN
| ETOOMANYREFS
| ETIMEDOUT
| ECONNREFUSED
| EHOSTDOWN
| EHOSTUNREACH
| ELOOP
| EOVERFLOW
| EUNKNOWNERR of int
exception Unix_error of UnixLabels.error * string * string
val error_message : UnixLabels.error -> string
val handle_unix_error : ('a -> 'b) -> 'a -> 'b
val environment : unit -> string array
val getenv : string -> string
val putenv : string -> string -> unit
type process_status =
Unix.process_status =
WEXITED of int
| WSIGNALED of int
| WSTOPPED of int
type wait_flag = Unix.wait_flag = WNOHANG | WUNTRACED
val execv : prog:string -> args:string array -> 'a
val execve : prog:string -> args:string array -> env:string array -> 'a
val execvp : prog:string -> args:string array -> 'a
val execvpe : prog:string -> args:string array -> env:string array -> 'a
val fork : unit -> int
val wait : unit -> int * UnixLabels.process_status
val waitpid :
mode:UnixLabels.wait_flag list -> int -> int * UnixLabels.process_status
val system : string -> UnixLabels.process_status
val getpid : unit -> int
val getppid : unit -> int
val nice : int -> int
type file_descr = Unix.file_descr
val stdin : UnixLabels.file_descr
val stdout : UnixLabels.file_descr
val stderr : UnixLabels.file_descr
type open_flag =
Unix.open_flag =
O_RDONLY
| O_WRONLY
| O_RDWR
| O_NONBLOCK
| O_APPEND
| O_CREAT
| O_TRUNC
| O_EXCL
| O_NOCTTY
| O_DSYNC
| O_SYNC
| O_RSYNC
| O_SHARE_DELETE
| O_CLOEXEC
| O_KEEPEXEC
type file_perm = int
val openfile :
string ->
mode:UnixLabels.open_flag list ->
perm:UnixLabels.file_perm -> UnixLabels.file_descr
val close : UnixLabels.file_descr -> unit
val read : UnixLabels.file_descr -> buf:bytes -> pos:int -> len:int -> int
val write : UnixLabels.file_descr -> buf:bytes -> pos:int -> len:int -> int
val single_write :
UnixLabels.file_descr -> buf:bytes -> pos:int -> len:int -> int
val write_substring :
UnixLabels.file_descr -> buf:string -> pos:int -> len:int -> int
val single_write_substring :
UnixLabels.file_descr -> buf:string -> pos:int -> len:int -> int
val in_channel_of_descr : UnixLabels.file_descr -> Pervasives.in_channel
val out_channel_of_descr : UnixLabels.file_descr -> Pervasives.out_channel
val descr_of_in_channel : Pervasives.in_channel -> UnixLabels.file_descr
val descr_of_out_channel : Pervasives.out_channel -> UnixLabels.file_descr
type seek_command = Unix.seek_command = SEEK_SET | SEEK_CUR | SEEK_END
val lseek :
UnixLabels.file_descr -> int -> mode:UnixLabels.seek_command -> int
val truncate : string -> len:int -> unit
val ftruncate : UnixLabels.file_descr -> len:int -> unit
type file_kind =
Unix.file_kind =
S_REG
| S_DIR
| S_CHR
| S_BLK
| S_LNK
| S_FIFO
| S_SOCK
type stats =
Unix.stats = {
st_dev : int;
st_ino : int;
st_kind : UnixLabels.file_kind;
st_perm : UnixLabels.file_perm;
st_nlink : int;
st_uid : int;
st_gid : int;
st_rdev : int;
st_size : int;
st_atime : float;
st_mtime : float;
st_ctime : float;
}
val stat : string -> UnixLabels.stats
val lstat : string -> UnixLabels.stats
val fstat : UnixLabels.file_descr -> UnixLabels.stats
val isatty : UnixLabels.file_descr -> bool
module LargeFile :
sig
val lseek :
UnixLabels.file_descr ->
int64 -> mode:UnixLabels.seek_command -> int64
val truncate : string -> len:int64 -> unit
val ftruncate : UnixLabels.file_descr -> len:int64 -> unit
type stats =
Unix.LargeFile.stats = {
st_dev : int;
st_ino : int;
st_kind : UnixLabels.file_kind;
st_perm : UnixLabels.file_perm;
st_nlink : int;
st_uid : int;
st_gid : int;
st_rdev : int;
st_size : int64;
st_atime : float;
st_mtime : float;
st_ctime : float;
}
val stat : string -> UnixLabels.LargeFile.stats
val lstat : string -> UnixLabels.LargeFile.stats
val fstat : UnixLabels.file_descr -> UnixLabels.LargeFile.stats
end
val unlink : string -> unit
val rename : src:string -> dst:string -> unit
val link : src:string -> dst:string -> unit
type access_permission = Unix.access_permission = R_OK | W_OK | X_OK | F_OK
val chmod : string -> perm:UnixLabels.file_perm -> unit
val fchmod : UnixLabels.file_descr -> perm:UnixLabels.file_perm -> unit
val chown : string -> uid:int -> gid:int -> unit
val fchown : UnixLabels.file_descr -> uid:int -> gid:int -> unit
val umask : int -> int
val access : string -> perm:UnixLabels.access_permission list -> unit
val dup : ?cloexec:bool -> UnixLabels.file_descr -> UnixLabels.file_descr
val dup2 :
?cloexec:bool ->
src:UnixLabels.file_descr -> dst:UnixLabels.file_descr -> unit
val set_nonblock : UnixLabels.file_descr -> unit
val clear_nonblock : UnixLabels.file_descr -> unit
val set_close_on_exec : UnixLabels.file_descr -> unit
val clear_close_on_exec : UnixLabels.file_descr -> unit
val mkdir : string -> perm:UnixLabels.file_perm -> unit
val rmdir : string -> unit
val chdir : string -> unit
val getcwd : unit -> string
val chroot : string -> unit
type dir_handle = Unix.dir_handle
val opendir : string -> UnixLabels.dir_handle
val readdir : UnixLabels.dir_handle -> string
val rewinddir : UnixLabels.dir_handle -> unit
val closedir : UnixLabels.dir_handle -> unit
val pipe :
?cloexec:bool -> unit -> UnixLabels.file_descr * UnixLabels.file_descr
val mkfifo : string -> perm:UnixLabels.file_perm -> unit
val create_process :
prog:string ->
args:string array ->
stdin:UnixLabels.file_descr ->
stdout:UnixLabels.file_descr -> stderr:UnixLabels.file_descr -> int
val create_process_env :
prog:string ->
args:string array ->
env:string array ->
stdin:UnixLabels.file_descr ->
stdout:UnixLabels.file_descr -> stderr:UnixLabels.file_descr -> int
val open_process_in : string -> Pervasives.in_channel
val open_process_out : string -> Pervasives.out_channel
val open_process : string -> Pervasives.in_channel * Pervasives.out_channel
val open_process_full :
string ->
env:string array ->
Pervasives.in_channel * Pervasives.out_channel * Pervasives.in_channel
val close_process_in : Pervasives.in_channel -> UnixLabels.process_status
val close_process_out : Pervasives.out_channel -> UnixLabels.process_status
val close_process :
Pervasives.in_channel * Pervasives.out_channel ->
UnixLabels.process_status
val close_process_full :
Pervasives.in_channel * Pervasives.out_channel * Pervasives.in_channel ->
UnixLabels.process_status
val symlink : ?to_dir:bool -> src:string -> dst:string -> unit
val has_symlink : unit -> bool
val readlink : string -> string
val select :
read:UnixLabels.file_descr list ->
write:UnixLabels.file_descr list ->
except:UnixLabels.file_descr list ->
timeout:float ->
UnixLabels.file_descr list * UnixLabels.file_descr list *
UnixLabels.file_descr list
type lock_command =
Unix.lock_command =
F_ULOCK
| F_LOCK
| F_TLOCK
| F_TEST
| F_RLOCK
| F_TRLOCK
val lockf :
UnixLabels.file_descr -> mode:UnixLabels.lock_command -> len:int -> unit
val kill : pid:int -> signal:int -> unit
type sigprocmask_command =
Unix.sigprocmask_command =
SIG_SETMASK
| SIG_BLOCK
| SIG_UNBLOCK
val sigprocmask :
mode:UnixLabels.sigprocmask_command -> int list -> int list
val sigpending : unit -> int list
val sigsuspend : int list -> unit
val pause : unit -> unit
type process_times =
Unix.process_times = {
tms_utime : float;
tms_stime : float;
tms_cutime : float;
tms_cstime : float;
}
type tm =
Unix.tm = {
tm_sec : int;
tm_min : int;
tm_hour : int;
tm_mday : int;
tm_mon : int;
tm_year : int;
tm_wday : int;
tm_yday : int;
tm_isdst : bool;
}
val time : unit -> float
val gettimeofday : unit -> float
val gmtime : float -> UnixLabels.tm
val localtime : float -> UnixLabels.tm
val mktime : UnixLabels.tm -> float * UnixLabels.tm
val alarm : int -> int
val sleep : int -> unit
val times : unit -> UnixLabels.process_times
val utimes : string -> access:float -> modif:float -> unit
type interval_timer =
Unix.interval_timer =
ITIMER_REAL
| ITIMER_VIRTUAL
| ITIMER_PROF
type interval_timer_status =
Unix.interval_timer_status = {
it_interval : float;
it_value : float;
}
val getitimer :
UnixLabels.interval_timer -> UnixLabels.interval_timer_status
val setitimer :
UnixLabels.interval_timer ->
UnixLabels.interval_timer_status -> UnixLabels.interval_timer_status
val getuid : unit -> int
val geteuid : unit -> int
val setuid : int -> unit
val getgid : unit -> int
val getegid : unit -> int
val setgid : int -> unit
val getgroups : unit -> int array
val setgroups : int array -> unit
val initgroups : string -> int -> unit
type passwd_entry =
Unix.passwd_entry = {
pw_name : string;
pw_passwd : string;
pw_uid : int;
pw_gid : int;
pw_gecos : string;
pw_dir : string;
pw_shell : string;
}
type group_entry =
Unix.group_entry = {
gr_name : string;
gr_passwd : string;
gr_gid : int;
gr_mem : string array;
}
val getlogin : unit -> string
val getpwnam : string -> UnixLabels.passwd_entry
val getgrnam : string -> UnixLabels.group_entry
val getpwuid : int -> UnixLabels.passwd_entry
val getgrgid : int -> UnixLabels.group_entry
type inet_addr = Unix.inet_addr
val inet_addr_of_string : string -> UnixLabels.inet_addr
val string_of_inet_addr : UnixLabels.inet_addr -> string
val inet_addr_any : UnixLabels.inet_addr
val inet_addr_loopback : UnixLabels.inet_addr
val inet6_addr_any : UnixLabels.inet_addr
val inet6_addr_loopback : UnixLabels.inet_addr
type socket_domain = Unix.socket_domain = PF_UNIX | PF_INET | PF_INET6
type socket_type =
Unix.socket_type =
SOCK_STREAM
| SOCK_DGRAM
| SOCK_RAW
| SOCK_SEQPACKET
type sockaddr =
Unix.sockaddr =
ADDR_UNIX of string
| ADDR_INET of UnixLabels.inet_addr * int
val socket :
?cloexec:bool ->
domain:UnixLabels.socket_domain ->
kind:UnixLabels.socket_type -> protocol:int -> UnixLabels.file_descr
val domain_of_sockaddr : UnixLabels.sockaddr -> UnixLabels.socket_domain
val socketpair :
?cloexec:bool ->
domain:UnixLabels.socket_domain ->
kind:UnixLabels.socket_type ->
protocol:int -> UnixLabels.file_descr * UnixLabels.file_descr
val accept :
?cloexec:bool ->
UnixLabels.file_descr -> UnixLabels.file_descr * UnixLabels.sockaddr
val bind : UnixLabels.file_descr -> addr:UnixLabels.sockaddr -> unit
val connect : UnixLabels.file_descr -> addr:UnixLabels.sockaddr -> unit
val listen : UnixLabels.file_descr -> max:int -> unit
type shutdown_command =
Unix.shutdown_command =
SHUTDOWN_RECEIVE
| SHUTDOWN_SEND
| SHUTDOWN_ALL
val shutdown :
UnixLabels.file_descr -> mode:UnixLabels.shutdown_command -> unit
val getsockname : UnixLabels.file_descr -> UnixLabels.sockaddr
val getpeername : UnixLabels.file_descr -> UnixLabels.sockaddr
type msg_flag = Unix.msg_flag = MSG_OOB | MSG_DONTROUTE | MSG_PEEK
val recv :
UnixLabels.file_descr ->
buf:bytes -> pos:int -> len:int -> mode:UnixLabels.msg_flag list -> int
val recvfrom :
UnixLabels.file_descr ->
buf:bytes ->
pos:int ->
len:int -> mode:UnixLabels.msg_flag list -> int * UnixLabels.sockaddr
val send :
UnixLabels.file_descr ->
buf:bytes -> pos:int -> len:int -> mode:UnixLabels.msg_flag list -> int
val send_substring :
UnixLabels.file_descr ->
buf:string -> pos:int -> len:int -> mode:UnixLabels.msg_flag list -> int
val sendto :
UnixLabels.file_descr ->
buf:bytes ->
pos:int ->
len:int ->
mode:UnixLabels.msg_flag list -> addr:UnixLabels.sockaddr -> int
val sendto_substring :
UnixLabels.file_descr ->
buf:string ->
pos:int ->
len:int -> mode:UnixLabels.msg_flag list -> UnixLabels.sockaddr -> int
type socket_bool_option =
SO_DEBUG
| SO_BROADCAST
| SO_REUSEADDR
| SO_KEEPALIVE
| SO_DONTROUTE
| SO_OOBINLINE
| SO_ACCEPTCONN
| TCP_NODELAY
| IPV6_ONLY
type socket_int_option =
SO_SNDBUF
| SO_RCVBUF
| SO_ERROR
| SO_TYPE
| SO_RCVLOWAT
| SO_SNDLOWAT
type socket_optint_option = SO_LINGER
type socket_float_option = SO_RCVTIMEO | SO_SNDTIMEO
val getsockopt :
UnixLabels.file_descr -> UnixLabels.socket_bool_option -> bool
val setsockopt :
UnixLabels.file_descr -> UnixLabels.socket_bool_option -> bool -> unit
val getsockopt_int :
UnixLabels.file_descr -> UnixLabels.socket_int_option -> int
val setsockopt_int :
UnixLabels.file_descr -> UnixLabels.socket_int_option -> int -> unit
val getsockopt_optint :
UnixLabels.file_descr -> UnixLabels.socket_optint_option -> int option
val setsockopt_optint :
UnixLabels.file_descr ->
UnixLabels.socket_optint_option -> int option -> unit
val getsockopt_float :
UnixLabels.file_descr -> UnixLabels.socket_float_option -> float
val setsockopt_float :
UnixLabels.file_descr -> UnixLabels.socket_float_option -> float -> unit
val getsockopt_error : UnixLabels.file_descr -> UnixLabels.error option
val open_connection :
UnixLabels.sockaddr -> Pervasives.in_channel * Pervasives.out_channel
val shutdown_connection : Pervasives.in_channel -> unit
val establish_server :
(Pervasives.in_channel -> Pervasives.out_channel -> unit) ->
addr:UnixLabels.sockaddr -> unit
type host_entry =
Unix.host_entry = {
h_name : string;
h_aliases : string array;
h_addrtype : UnixLabels.socket_domain;
h_addr_list : UnixLabels.inet_addr array;
}
type protocol_entry =
Unix.protocol_entry = {
p_name : string;
p_aliases : string array;
p_proto : int;
}
type service_entry =
Unix.service_entry = {
s_name : string;
s_aliases : string array;
s_port : int;
s_proto : string;
}
val gethostname : unit -> string
val gethostbyname : string -> UnixLabels.host_entry
val gethostbyaddr : UnixLabels.inet_addr -> UnixLabels.host_entry
val getprotobyname : string -> UnixLabels.protocol_entry
val getprotobynumber : int -> UnixLabels.protocol_entry
val getservbyname : string -> protocol:string -> UnixLabels.service_entry
val getservbyport : int -> protocol:string -> UnixLabels.service_entry
type addr_info = {
ai_family : UnixLabels.socket_domain;
ai_socktype : UnixLabels.socket_type;
ai_protocol : int;
ai_addr : UnixLabels.sockaddr;
ai_canonname : string;
}
type getaddrinfo_option =
AI_FAMILY of UnixLabels.socket_domain
| AI_SOCKTYPE of UnixLabels.socket_type
| AI_PROTOCOL of int
| AI_NUMERICHOST
| AI_CANONNAME
| AI_PASSIVE
val getaddrinfo :
string ->
string -> UnixLabels.getaddrinfo_option list -> UnixLabels.addr_info list
type name_info = { ni_hostname : string; ni_service : string; }
type getnameinfo_option =
NI_NOFQDN
| NI_NUMERICHOST
| NI_NAMEREQD
| NI_NUMERICSERV
| NI_DGRAM
val getnameinfo :
UnixLabels.sockaddr ->
UnixLabels.getnameinfo_option list -> UnixLabels.name_info
type terminal_io =
Unix.terminal_io = {
mutable c_ignbrk : bool;
mutable c_brkint : bool;
mutable c_ignpar : bool;
mutable c_parmrk : bool;
mutable c_inpck : bool;
mutable c_istrip : bool;
mutable c_inlcr : bool;
mutable c_igncr : bool;
mutable c_icrnl : bool;
mutable c_ixon : bool;
mutable c_ixoff : bool;
mutable c_opost : bool;
mutable c_obaud : int;
mutable c_ibaud : int;
mutable c_csize : int;
mutable c_cstopb : int;
mutable c_cread : bool;
mutable c_parenb : bool;
mutable c_parodd : bool;
mutable c_hupcl : bool;
mutable c_clocal : bool;
mutable c_isig : bool;
mutable c_icanon : bool;
mutable c_noflsh : bool;
mutable c_echo : bool;
mutable c_echoe : bool;
mutable c_echok : bool;
mutable c_echonl : bool;
mutable c_vintr : char;
mutable c_vquit : char;
mutable c_verase : char;
mutable c_vkill : char;
mutable c_veof : char;
mutable c_veol : char;
mutable c_vmin : int;
mutable c_vtime : int;
mutable c_vstart : char;
mutable c_vstop : char;
}
val tcgetattr : UnixLabels.file_descr -> UnixLabels.terminal_io
type setattr_when = Unix.setattr_when = TCSANOW | TCSADRAIN | TCSAFLUSH
val tcsetattr :
UnixLabels.file_descr ->
mode:UnixLabels.setattr_when -> UnixLabels.terminal_io -> unit
val tcsendbreak : UnixLabels.file_descr -> duration:int -> unit
val tcdrain : UnixLabels.file_descr -> unit
type flush_queue = Unix.flush_queue = TCIFLUSH | TCOFLUSH | TCIOFLUSH
val tcflush : UnixLabels.file_descr -> mode:UnixLabels.flush_queue -> unit
type flow_action = Unix.flow_action = TCOOFF | TCOON | TCIOFF | TCION
val tcflow : UnixLabels.file_descr -> mode:UnixLabels.flow_action -> unit
val setsid : unit -> int
end ocaml-doc-4.05/ocaml.html/libref/type_Pervasives.html 0000644 0001750 0001750 00000153074 13131636450 021631 0 ustar mehdi mehdi
sig
external raise : exn -> 'a = "%raise"
external raise_notrace : exn -> 'a = "%raise_notrace"
val invalid_arg : string -> 'a
val failwith : string -> 'a
exception Exit
external ( = ) : 'a -> 'a -> bool = "%equal"
external ( <> ) : 'a -> 'a -> bool = "%notequal"
external ( < ) : 'a -> 'a -> bool = "%lessthan"
external ( > ) : 'a -> 'a -> bool = "%greaterthan"
external ( <= ) : 'a -> 'a -> bool = "%lessequal"
external ( >= ) : 'a -> 'a -> bool = "%greaterequal"
external compare : 'a -> 'a -> int = "%compare"
val min : 'a -> 'a -> 'a
val max : 'a -> 'a -> 'a
external ( == ) : 'a -> 'a -> bool = "%eq"
external ( != ) : 'a -> 'a -> bool = "%noteq"
external not : bool -> bool = "%boolnot"
external ( && ) : bool -> bool -> bool = "%sequand"
external ( & ) : bool -> bool -> bool = "%sequand"
external ( || ) : bool -> bool -> bool = "%sequor"
external ( or ) : bool -> bool -> bool = "%sequor"
external __LOC__ : string = "%loc_LOC"
external __FILE__ : string = "%loc_FILE"
external __LINE__ : int = "%loc_LINE"
external __MODULE__ : string = "%loc_MODULE"
external __POS__ : string * int * int * int = "%loc_POS"
external __LOC_OF__ : 'a -> string * 'a = "%loc_LOC"
external __LINE_OF__ : 'a -> int * 'a = "%loc_LINE"
external __POS_OF__ : 'a -> (string * int * int * int) * 'a = "%loc_POS"
external ( |> ) : 'a -> ('a -> 'b) -> 'b = "%revapply"
external ( @@ ) : ('a -> 'b) -> 'a -> 'b = "%apply"
external ( ~- ) : int -> int = "%negint"
external ( ~+ ) : int -> int = "%identity"
external succ : int -> int = "%succint"
external pred : int -> int = "%predint"
external ( + ) : int -> int -> int = "%addint"
external ( - ) : int -> int -> int = "%subint"
external ( * ) : int -> int -> int = "%mulint"
external ( / ) : int -> int -> int = "%divint"
external ( mod ) : int -> int -> int = "%modint"
val abs : int -> int
val max_int : int
val min_int : int
external ( land ) : int -> int -> int = "%andint"
external ( lor ) : int -> int -> int = "%orint"
external ( lxor ) : int -> int -> int = "%xorint"
val lnot : int -> int
external ( lsl ) : int -> int -> int = "%lslint"
external ( lsr ) : int -> int -> int = "%lsrint"
external ( asr ) : int -> int -> int = "%asrint"
external ( ~-. ) : float -> float = "%negfloat"
external ( ~+. ) : float -> float = "%identity"
external ( +. ) : float -> float -> float = "%addfloat"
external ( -. ) : float -> float -> float = "%subfloat"
external ( *. ) : float -> float -> float = "%mulfloat"
external ( /. ) : float -> float -> float = "%divfloat"
external ( ** ) : float -> float -> float = "caml_power_float" "pow"
[@@unboxed] [@@noalloc]
external sqrt : float -> float = "caml_sqrt_float" "sqrt" [@@unboxed]
[@@noalloc]
external exp : float -> float = "caml_exp_float" "exp" [@@unboxed]
[@@noalloc]
external log : float -> float = "caml_log_float" "log" [@@unboxed]
[@@noalloc]
external log10 : float -> float = "caml_log10_float" "log10" [@@unboxed]
[@@noalloc]
external expm1 : float -> float = "caml_expm1_float" "caml_expm1"
[@@unboxed] [@@noalloc]
external log1p : float -> float = "caml_log1p_float" "caml_log1p"
[@@unboxed] [@@noalloc]
external cos : float -> float = "caml_cos_float" "cos" [@@unboxed]
[@@noalloc]
external sin : float -> float = "caml_sin_float" "sin" [@@unboxed]
[@@noalloc]
external tan : float -> float = "caml_tan_float" "tan" [@@unboxed]
[@@noalloc]
external acos : float -> float = "caml_acos_float" "acos" [@@unboxed]
[@@noalloc]
external asin : float -> float = "caml_asin_float" "asin" [@@unboxed]
[@@noalloc]
external atan : float -> float = "caml_atan_float" "atan" [@@unboxed]
[@@noalloc]
external atan2 : float -> float -> float = "caml_atan2_float" "atan2"
[@@unboxed] [@@noalloc]
external hypot : float -> float -> float = "caml_hypot_float" "caml_hypot"
[@@unboxed] [@@noalloc]
external cosh : float -> float = "caml_cosh_float" "cosh" [@@unboxed]
[@@noalloc]
external sinh : float -> float = "caml_sinh_float" "sinh" [@@unboxed]
[@@noalloc]
external tanh : float -> float = "caml_tanh_float" "tanh" [@@unboxed]
[@@noalloc]
external ceil : float -> float = "caml_ceil_float" "ceil" [@@unboxed]
[@@noalloc]
external floor : float -> float = "caml_floor_float" "floor" [@@unboxed]
[@@noalloc]
external abs_float : float -> float = "%absfloat"
external copysign : float -> float -> float = "caml_copysign_float"
"caml_copysign" [@@unboxed] [@@noalloc]
external mod_float : float -> float -> float = "caml_fmod_float" "fmod"
[@@unboxed] [@@noalloc]
external frexp : float -> float * int = "caml_frexp_float"
external ldexp :
(float [@unboxed]) -> (int [@untagged]) -> (float [@unboxed])
= "caml_ldexp_float" "caml_ldexp_float_unboxed" [@@noalloc]
external modf : float -> float * float = "caml_modf_float"
external float : int -> float = "%floatofint"
external float_of_int : int -> float = "%floatofint"
external truncate : float -> int = "%intoffloat"
external int_of_float : float -> int = "%intoffloat"
val infinity : float
val neg_infinity : float
val nan : float
val max_float : float
val min_float : float
val epsilon_float : float
type fpclass = FP_normal | FP_subnormal | FP_zero | FP_infinite | FP_nan
external classify_float : (float [@unboxed]) -> Pervasives.fpclass
= "caml_classify_float" "caml_classify_float_unboxed" [@@noalloc]
val ( ^ ) : string -> string -> string
external int_of_char : char -> int = "%identity"
val char_of_int : int -> char
external ignore : 'a -> unit = "%ignore"
val string_of_bool : bool -> string
val bool_of_string : string -> bool
val bool_of_string_opt : string -> bool option
val string_of_int : int -> string
external int_of_string : string -> int = "caml_int_of_string"
val int_of_string_opt : string -> int option
val string_of_float : float -> string
external float_of_string : string -> float = "caml_float_of_string"
val float_of_string_opt : string -> float option
external fst : 'a * 'b -> 'a = "%field0"
external snd : 'a * 'b -> 'b = "%field1"
val ( @ ) : 'a list -> 'a list -> 'a list
type in_channel
type out_channel
val stdin : Pervasives.in_channel
val stdout : Pervasives.out_channel
val stderr : Pervasives.out_channel
val print_char : char -> unit
val print_string : string -> unit
val print_bytes : bytes -> unit
val print_int : int -> unit
val print_float : float -> unit
val print_endline : string -> unit
val print_newline : unit -> unit
val prerr_char : char -> unit
val prerr_string : string -> unit
val prerr_bytes : bytes -> unit
val prerr_int : int -> unit
val prerr_float : float -> unit
val prerr_endline : string -> unit
val prerr_newline : unit -> unit
val read_line : unit -> string
val read_int : unit -> int
val read_int_opt : unit -> int option
val read_float : unit -> float
val read_float_opt : unit -> float option
type open_flag =
Open_rdonly
| Open_wronly
| Open_append
| Open_creat
| Open_trunc
| Open_excl
| Open_binary
| Open_text
| Open_nonblock
val open_out : string -> Pervasives.out_channel
val open_out_bin : string -> Pervasives.out_channel
val open_out_gen :
Pervasives.open_flag list -> int -> string -> Pervasives.out_channel
val flush : Pervasives.out_channel -> unit
val flush_all : unit -> unit
val output_char : Pervasives.out_channel -> char -> unit
val output_string : Pervasives.out_channel -> string -> unit
val output_bytes : Pervasives.out_channel -> bytes -> unit
val output : Pervasives.out_channel -> bytes -> int -> int -> unit
val output_substring :
Pervasives.out_channel -> string -> int -> int -> unit
val output_byte : Pervasives.out_channel -> int -> unit
val output_binary_int : Pervasives.out_channel -> int -> unit
val output_value : Pervasives.out_channel -> 'a -> unit
val seek_out : Pervasives.out_channel -> int -> unit
val pos_out : Pervasives.out_channel -> int
val out_channel_length : Pervasives.out_channel -> int
val close_out : Pervasives.out_channel -> unit
val close_out_noerr : Pervasives.out_channel -> unit
val set_binary_mode_out : Pervasives.out_channel -> bool -> unit
val open_in : string -> Pervasives.in_channel
val open_in_bin : string -> Pervasives.in_channel
val open_in_gen :
Pervasives.open_flag list -> int -> string -> Pervasives.in_channel
val input_char : Pervasives.in_channel -> char
val input_line : Pervasives.in_channel -> string
val input : Pervasives.in_channel -> bytes -> int -> int -> int
val really_input : Pervasives.in_channel -> bytes -> int -> int -> unit
val really_input_string : Pervasives.in_channel -> int -> string
val input_byte : Pervasives.in_channel -> int
val input_binary_int : Pervasives.in_channel -> int
val input_value : Pervasives.in_channel -> 'a
val seek_in : Pervasives.in_channel -> int -> unit
val pos_in : Pervasives.in_channel -> int
val in_channel_length : Pervasives.in_channel -> int
val close_in : Pervasives.in_channel -> unit
val close_in_noerr : Pervasives.in_channel -> unit
val set_binary_mode_in : Pervasives.in_channel -> bool -> unit
module LargeFile :
sig
val seek_out : Pervasives.out_channel -> int64 -> unit
val pos_out : Pervasives.out_channel -> int64
val out_channel_length : Pervasives.out_channel -> int64
val seek_in : Pervasives.in_channel -> int64 -> unit
val pos_in : Pervasives.in_channel -> int64
val in_channel_length : Pervasives.in_channel -> int64
end
type 'a ref = { mutable contents : 'a; }
external ref : 'a -> 'a Pervasives.ref = "%makemutable"
external ( ! ) : 'a Pervasives.ref -> 'a = "%field0"
external ( := ) : 'a Pervasives.ref -> 'a -> unit = "%setfield0"
external incr : int Pervasives.ref -> unit = "%incr"
external decr : int Pervasives.ref -> unit = "%decr"
type ('a, 'b) result = Ok of 'a | Error of 'b
type ('a, 'b, 'c, 'd, 'e, 'f) format6 =
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6
type ('a, 'b, 'c, 'd) format4 = ('a, 'b, 'c, 'c, 'c, 'd) Pervasives.format6
type ('a, 'b, 'c) format = ('a, 'b, 'c, 'c) Pervasives.format4
val string_of_format :
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 -> string
external format_of_string :
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 ->
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 = "%identity"
val ( ^^ ) :
('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6 ->
('f, 'b, 'c, 'e, 'g, 'h) Pervasives.format6 ->
('a, 'b, 'c, 'd, 'g, 'h) Pervasives.format6
val exit : int -> 'a
val at_exit : (unit -> unit) -> unit
val valid_float_lexem : string -> string
val unsafe_really_input :
Pervasives.in_channel -> bytes -> int -> int -> unit
val do_at_exit : unit -> unit
end ocaml-doc-4.05/ocaml.html/libref/MoreLabels.Set.S.html 0000644 0001750 0001750 00000036301 13131636446 021417 0 ustar mehdi mehdi
module type S =sig..end
type
type
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : f:(elt -> unit) -> t -> unit
val map : f:(elt -> elt) ->
t -> t
val fold : f:(elt -> 'a -> 'a) -> t -> init:'a -> 'a
val for_all : f:(elt -> bool) -> t -> bool
val exists : f:(elt -> bool) -> t -> bool
val filter : f:(elt -> bool) -> t -> t
val partition : f:(elt -> bool) ->
t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt ->
t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : f:(elt -> bool) ->
t -> elt
val find_first_opt : f:(elt -> bool) ->
t -> elt option
val find_last : f:(elt -> bool) ->
t -> elt
val find_last_opt : f:(elt -> bool) ->
t -> elt option
val of_list : elt list -> t ocaml-doc-4.05/ocaml.html/libref/Ephemeron.K2.Make.html 0000644 0001750 0001750 00000023045 13131636443 021506 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
mem h k is true, a subsequent
find h k may raise Not_found because the garbage collector
can run between the two.
Moreover, the table shouldn't be modified during a call to iter.
Use filter_map_inplace in this case.
include Hashtbl.S
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingssig
type constant =
Pconst_integer of string * char option
| Pconst_char of char
| Pconst_string of string * string option
| Pconst_float of string * char option
type attribute = string Asttypes.loc * Parsetree.payload
and extension = string Asttypes.loc * Parsetree.payload
and attributes = Parsetree.attribute list
and payload =
PStr of Parsetree.structure
| PSig of Parsetree.signature
| PTyp of Parsetree.core_type
| PPat of Parsetree.pattern * Parsetree.expression option
and core_type = {
ptyp_desc : Parsetree.core_type_desc;
ptyp_loc : Location.t;
ptyp_attributes : Parsetree.attributes;
}
and core_type_desc =
Ptyp_any
| Ptyp_var of string
| Ptyp_arrow of Asttypes.arg_label * Parsetree.core_type *
Parsetree.core_type
| Ptyp_tuple of Parsetree.core_type list
| Ptyp_constr of Longident.t Asttypes.loc * Parsetree.core_type list
| Ptyp_object of
(string Asttypes.loc * Parsetree.attributes * Parsetree.core_type)
list * Asttypes.closed_flag
| Ptyp_class of Longident.t Asttypes.loc * Parsetree.core_type list
| Ptyp_alias of Parsetree.core_type * string
| Ptyp_variant of Parsetree.row_field list * Asttypes.closed_flag *
Asttypes.label list option
| Ptyp_poly of string Asttypes.loc list * Parsetree.core_type
| Ptyp_package of Parsetree.package_type
| Ptyp_extension of Parsetree.extension
and package_type =
Longident.t Asttypes.loc *
(Longident.t Asttypes.loc * Parsetree.core_type) list
and row_field =
Rtag of Asttypes.label * Parsetree.attributes * bool *
Parsetree.core_type list
| Rinherit of Parsetree.core_type
and pattern = {
ppat_desc : Parsetree.pattern_desc;
ppat_loc : Location.t;
ppat_attributes : Parsetree.attributes;
}
and pattern_desc =
Ppat_any
| Ppat_var of string Asttypes.loc
| Ppat_alias of Parsetree.pattern * string Asttypes.loc
| Ppat_constant of Parsetree.constant
| Ppat_interval of Parsetree.constant * Parsetree.constant
| Ppat_tuple of Parsetree.pattern list
| Ppat_construct of Longident.t Asttypes.loc * Parsetree.pattern option
| Ppat_variant of Asttypes.label * Parsetree.pattern option
| Ppat_record of (Longident.t Asttypes.loc * Parsetree.pattern) list *
Asttypes.closed_flag
| Ppat_array of Parsetree.pattern list
| Ppat_or of Parsetree.pattern * Parsetree.pattern
| Ppat_constraint of Parsetree.pattern * Parsetree.core_type
| Ppat_type of Longident.t Asttypes.loc
| Ppat_lazy of Parsetree.pattern
| Ppat_unpack of string Asttypes.loc
| Ppat_exception of Parsetree.pattern
| Ppat_extension of Parsetree.extension
| Ppat_open of Longident.t Asttypes.loc * Parsetree.pattern
and expression = {
pexp_desc : Parsetree.expression_desc;
pexp_loc : Location.t;
pexp_attributes : Parsetree.attributes;
}
and expression_desc =
Pexp_ident of Longident.t Asttypes.loc
| Pexp_constant of Parsetree.constant
| Pexp_let of Asttypes.rec_flag * Parsetree.value_binding list *
Parsetree.expression
| Pexp_function of Parsetree.case list
| Pexp_fun of Asttypes.arg_label * Parsetree.expression option *
Parsetree.pattern * Parsetree.expression
| Pexp_apply of Parsetree.expression *
(Asttypes.arg_label * Parsetree.expression) list
| Pexp_match of Parsetree.expression * Parsetree.case list
| Pexp_try of Parsetree.expression * Parsetree.case list
| Pexp_tuple of Parsetree.expression list
| Pexp_construct of Longident.t Asttypes.loc *
Parsetree.expression option
| Pexp_variant of Asttypes.label * Parsetree.expression option
| Pexp_record of (Longident.t Asttypes.loc * Parsetree.expression) list *
Parsetree.expression option
| Pexp_field of Parsetree.expression * Longident.t Asttypes.loc
| Pexp_setfield of Parsetree.expression * Longident.t Asttypes.loc *
Parsetree.expression
| Pexp_array of Parsetree.expression list
| Pexp_ifthenelse of Parsetree.expression * Parsetree.expression *
Parsetree.expression option
| Pexp_sequence of Parsetree.expression * Parsetree.expression
| Pexp_while of Parsetree.expression * Parsetree.expression
| Pexp_for of Parsetree.pattern * Parsetree.expression *
Parsetree.expression * Asttypes.direction_flag * Parsetree.expression
| Pexp_constraint of Parsetree.expression * Parsetree.core_type
| Pexp_coerce of Parsetree.expression * Parsetree.core_type option *
Parsetree.core_type
| Pexp_send of Parsetree.expression * string Asttypes.loc
| Pexp_new of Longident.t Asttypes.loc
| Pexp_setinstvar of string Asttypes.loc * Parsetree.expression
| Pexp_override of (string Asttypes.loc * Parsetree.expression) list
| Pexp_letmodule of string Asttypes.loc * Parsetree.module_expr *
Parsetree.expression
| Pexp_letexception of Parsetree.extension_constructor *
Parsetree.expression
| Pexp_assert of Parsetree.expression
| Pexp_lazy of Parsetree.expression
| Pexp_poly of Parsetree.expression * Parsetree.core_type option
| Pexp_object of Parsetree.class_structure
| Pexp_newtype of string Asttypes.loc * Parsetree.expression
| Pexp_pack of Parsetree.module_expr
| Pexp_open of Asttypes.override_flag * Longident.t Asttypes.loc *
Parsetree.expression
| Pexp_extension of Parsetree.extension
| Pexp_unreachable
and case = {
pc_lhs : Parsetree.pattern;
pc_guard : Parsetree.expression option;
pc_rhs : Parsetree.expression;
}
and value_description = {
pval_name : string Asttypes.loc;
pval_type : Parsetree.core_type;
pval_prim : string list;
pval_attributes : Parsetree.attributes;
pval_loc : Location.t;
}
and type_declaration = {
ptype_name : string Asttypes.loc;
ptype_params : (Parsetree.core_type * Asttypes.variance) list;
ptype_cstrs :
(Parsetree.core_type * Parsetree.core_type * Location.t) list;
ptype_kind : Parsetree.type_kind;
ptype_private : Asttypes.private_flag;
ptype_manifest : Parsetree.core_type option;
ptype_attributes : Parsetree.attributes;
ptype_loc : Location.t;
}
and type_kind =
Ptype_abstract
| Ptype_variant of Parsetree.constructor_declaration list
| Ptype_record of Parsetree.label_declaration list
| Ptype_open
and label_declaration = {
pld_name : string Asttypes.loc;
pld_mutable : Asttypes.mutable_flag;
pld_type : Parsetree.core_type;
pld_loc : Location.t;
pld_attributes : Parsetree.attributes;
}
and constructor_declaration = {
pcd_name : string Asttypes.loc;
pcd_args : Parsetree.constructor_arguments;
pcd_res : Parsetree.core_type option;
pcd_loc : Location.t;
pcd_attributes : Parsetree.attributes;
}
and constructor_arguments =
Pcstr_tuple of Parsetree.core_type list
| Pcstr_record of Parsetree.label_declaration list
and type_extension = {
ptyext_path : Longident.t Asttypes.loc;
ptyext_params : (Parsetree.core_type * Asttypes.variance) list;
ptyext_constructors : Parsetree.extension_constructor list;
ptyext_private : Asttypes.private_flag;
ptyext_attributes : Parsetree.attributes;
}
and extension_constructor = {
pext_name : string Asttypes.loc;
pext_kind : Parsetree.extension_constructor_kind;
pext_loc : Location.t;
pext_attributes : Parsetree.attributes;
}
and extension_constructor_kind =
Pext_decl of Parsetree.constructor_arguments *
Parsetree.core_type option
| Pext_rebind of Longident.t Asttypes.loc
and class_type = {
pcty_desc : Parsetree.class_type_desc;
pcty_loc : Location.t;
pcty_attributes : Parsetree.attributes;
}
and class_type_desc =
Pcty_constr of Longident.t Asttypes.loc * Parsetree.core_type list
| Pcty_signature of Parsetree.class_signature
| Pcty_arrow of Asttypes.arg_label * Parsetree.core_type *
Parsetree.class_type
| Pcty_extension of Parsetree.extension
and class_signature = {
pcsig_self : Parsetree.core_type;
pcsig_fields : Parsetree.class_type_field list;
}
and class_type_field = {
pctf_desc : Parsetree.class_type_field_desc;
pctf_loc : Location.t;
pctf_attributes : Parsetree.attributes;
}
and class_type_field_desc =
Pctf_inherit of Parsetree.class_type
| Pctf_val of
(string Asttypes.loc * Asttypes.mutable_flag *
Asttypes.virtual_flag * Parsetree.core_type)
| Pctf_method of
(string Asttypes.loc * Asttypes.private_flag *
Asttypes.virtual_flag * Parsetree.core_type)
| Pctf_constraint of (Parsetree.core_type * Parsetree.core_type)
| Pctf_attribute of Parsetree.attribute
| Pctf_extension of Parsetree.extension
and 'a class_infos = {
pci_virt : Asttypes.virtual_flag;
pci_params : (Parsetree.core_type * Asttypes.variance) list;
pci_name : string Asttypes.loc;
pci_expr : 'a;
pci_loc : Location.t;
pci_attributes : Parsetree.attributes;
}
and class_description = Parsetree.class_type Parsetree.class_infos
and class_type_declaration = Parsetree.class_type Parsetree.class_infos
and class_expr = {
pcl_desc : Parsetree.class_expr_desc;
pcl_loc : Location.t;
pcl_attributes : Parsetree.attributes;
}
and class_expr_desc =
Pcl_constr of Longident.t Asttypes.loc * Parsetree.core_type list
| Pcl_structure of Parsetree.class_structure
| Pcl_fun of Asttypes.arg_label * Parsetree.expression option *
Parsetree.pattern * Parsetree.class_expr
| Pcl_apply of Parsetree.class_expr *
(Asttypes.arg_label * Parsetree.expression) list
| Pcl_let of Asttypes.rec_flag * Parsetree.value_binding list *
Parsetree.class_expr
| Pcl_constraint of Parsetree.class_expr * Parsetree.class_type
| Pcl_extension of Parsetree.extension
and class_structure = {
pcstr_self : Parsetree.pattern;
pcstr_fields : Parsetree.class_field list;
}
and class_field = {
pcf_desc : Parsetree.class_field_desc;
pcf_loc : Location.t;
pcf_attributes : Parsetree.attributes;
}
and class_field_desc =
Pcf_inherit of Asttypes.override_flag * Parsetree.class_expr *
string Asttypes.loc option
| Pcf_val of
(string Asttypes.loc * Asttypes.mutable_flag *
Parsetree.class_field_kind)
| Pcf_method of
(string Asttypes.loc * Asttypes.private_flag *
Parsetree.class_field_kind)
| Pcf_constraint of (Parsetree.core_type * Parsetree.core_type)
| Pcf_initializer of Parsetree.expression
| Pcf_attribute of Parsetree.attribute
| Pcf_extension of Parsetree.extension
and class_field_kind =
Cfk_virtual of Parsetree.core_type
| Cfk_concrete of Asttypes.override_flag * Parsetree.expression
and class_declaration = Parsetree.class_expr Parsetree.class_infos
and module_type = {
pmty_desc : Parsetree.module_type_desc;
pmty_loc : Location.t;
pmty_attributes : Parsetree.attributes;
}
and module_type_desc =
Pmty_ident of Longident.t Asttypes.loc
| Pmty_signature of Parsetree.signature
| Pmty_functor of string Asttypes.loc * Parsetree.module_type option *
Parsetree.module_type
| Pmty_with of Parsetree.module_type * Parsetree.with_constraint list
| Pmty_typeof of Parsetree.module_expr
| Pmty_extension of Parsetree.extension
| Pmty_alias of Longident.t Asttypes.loc
and signature = Parsetree.signature_item list
and signature_item = {
psig_desc : Parsetree.signature_item_desc;
psig_loc : Location.t;
}
and signature_item_desc =
Psig_value of Parsetree.value_description
| Psig_type of Asttypes.rec_flag * Parsetree.type_declaration list
| Psig_typext of Parsetree.type_extension
| Psig_exception of Parsetree.extension_constructor
| Psig_module of Parsetree.module_declaration
| Psig_recmodule of Parsetree.module_declaration list
| Psig_modtype of Parsetree.module_type_declaration
| Psig_open of Parsetree.open_description
| Psig_include of Parsetree.include_description
| Psig_class of Parsetree.class_description list
| Psig_class_type of Parsetree.class_type_declaration list
| Psig_attribute of Parsetree.attribute
| Psig_extension of Parsetree.extension * Parsetree.attributes
and module_declaration = {
pmd_name : string Asttypes.loc;
pmd_type : Parsetree.module_type;
pmd_attributes : Parsetree.attributes;
pmd_loc : Location.t;
}
and module_type_declaration = {
pmtd_name : string Asttypes.loc;
pmtd_type : Parsetree.module_type option;
pmtd_attributes : Parsetree.attributes;
pmtd_loc : Location.t;
}
and open_description = {
popen_lid : Longident.t Asttypes.loc;
popen_override : Asttypes.override_flag;
popen_loc : Location.t;
popen_attributes : Parsetree.attributes;
}
and 'a include_infos = {
pincl_mod : 'a;
pincl_loc : Location.t;
pincl_attributes : Parsetree.attributes;
}
and include_description = Parsetree.module_type Parsetree.include_infos
and include_declaration = Parsetree.module_expr Parsetree.include_infos
and with_constraint =
Pwith_type of Longident.t Asttypes.loc * Parsetree.type_declaration
| Pwith_module of Longident.t Asttypes.loc * Longident.t Asttypes.loc
| Pwith_typesubst of Parsetree.type_declaration
| Pwith_modsubst of string Asttypes.loc * Longident.t Asttypes.loc
and module_expr = {
pmod_desc : Parsetree.module_expr_desc;
pmod_loc : Location.t;
pmod_attributes : Parsetree.attributes;
}
and module_expr_desc =
Pmod_ident of Longident.t Asttypes.loc
| Pmod_structure of Parsetree.structure
| Pmod_functor of string Asttypes.loc * Parsetree.module_type option *
Parsetree.module_expr
| Pmod_apply of Parsetree.module_expr * Parsetree.module_expr
| Pmod_constraint of Parsetree.module_expr * Parsetree.module_type
| Pmod_unpack of Parsetree.expression
| Pmod_extension of Parsetree.extension
and structure = Parsetree.structure_item list
and structure_item = {
pstr_desc : Parsetree.structure_item_desc;
pstr_loc : Location.t;
}
and structure_item_desc =
Pstr_eval of Parsetree.expression * Parsetree.attributes
| Pstr_value of Asttypes.rec_flag * Parsetree.value_binding list
| Pstr_primitive of Parsetree.value_description
| Pstr_type of Asttypes.rec_flag * Parsetree.type_declaration list
| Pstr_typext of Parsetree.type_extension
| Pstr_exception of Parsetree.extension_constructor
| Pstr_module of Parsetree.module_binding
| Pstr_recmodule of Parsetree.module_binding list
| Pstr_modtype of Parsetree.module_type_declaration
| Pstr_open of Parsetree.open_description
| Pstr_class of Parsetree.class_declaration list
| Pstr_class_type of Parsetree.class_type_declaration list
| Pstr_include of Parsetree.include_declaration
| Pstr_attribute of Parsetree.attribute
| Pstr_extension of Parsetree.extension * Parsetree.attributes
and value_binding = {
pvb_pat : Parsetree.pattern;
pvb_expr : Parsetree.expression;
pvb_attributes : Parsetree.attributes;
pvb_loc : Location.t;
}
and module_binding = {
pmb_name : string Asttypes.loc;
pmb_expr : Parsetree.module_expr;
pmb_attributes : Parsetree.attributes;
pmb_loc : Location.t;
}
type toplevel_phrase =
Ptop_def of Parsetree.structure
| Ptop_dir of string * Parsetree.directive_argument
and directive_argument =
Pdir_none
| Pdir_string of string
| Pdir_int of string * char option
| Pdir_ident of Longident.t
| Pdir_bool of bool
end ocaml-doc-4.05/ocaml.html/libref/type_Oo.html 0000644 0001750 0001750 00000016352 13131636447 020062 0 ustar mehdi mehdi
sig
val copy : (< .. > as 'a) -> 'a
external id : < .. > -> int = "%field1"
val new_method : string -> CamlinternalOO.tag
val public_method_label : string -> CamlinternalOO.tag
end ocaml-doc-4.05/ocaml.html/libref/type_Parse.html 0000644 0001750 0001750 00000017754 13131636447 020566 0 ustar mehdi mehdi
sig
val implementation : Lexing.lexbuf -> Parsetree.structure
val interface : Lexing.lexbuf -> Parsetree.signature
val toplevel_phrase : Lexing.lexbuf -> Parsetree.toplevel_phrase
val use_file : Lexing.lexbuf -> Parsetree.toplevel_phrase list
val core_type : Lexing.lexbuf -> Parsetree.core_type
val expression : Lexing.lexbuf -> Parsetree.expression
val pattern : Lexing.lexbuf -> Parsetree.pattern
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Set.OrderedType.html 0000644 0001750 0001750 00000014710 13131636446 024504 0 ustar mehdi mehdi
Set.OrderedType ocaml-doc-4.05/ocaml.html/libref/Printexc.html 0000644 0001750 0001750 00000063307 13131636450 020234 0 ustar mehdi mehdi
module Printexc:sig..end
val to_string : exn -> stringPrintexc.to_string e returns a string representation of
the exception e.val print : ('a -> 'b) -> 'a -> 'bPrintexc.print fn x applies fn to x and returns the result.
If the evaluation of fn x raises any exception, the
name of the exception is printed on standard error output,
and the exception is raised again.
The typical use is to catch and report exceptions that
escape a function application.val catch : ('a -> 'b) -> 'a -> 'bPrintexc.catch fn x is similar to Printexc.print, but
aborts the program with exit code 2 after printing the
uncaught exception. This function is deprecated: the runtime
system is now able to print uncaught exceptions as precisely
as Printexc.catch does. Moreover, calling Printexc.catch
makes it harder to track the location of the exception
using the debugger or the stack backtrace facility.
So, do not use Printexc.catch in new code.val print_backtrace : out_channel -> unitPrintexc.print_backtrace oc prints an exception backtrace
on the output channel oc. The backtrace lists the program
locations where the most-recently raised exception was raised
and where it was propagated through function calls.
If the call is not inside an exception handler, the returned
backtrace is unspecified. If the call is after some
exception-catching code (before in the handler, or in a when-guard
during the matching of the exception handler), the backtrace may
correspond to a later exception than the handled one.
Since 3.11.0
val get_backtrace : unit -> stringPrintexc.get_backtrace () returns a string containing the
same exception backtrace that Printexc.print_backtrace would
print. Same restriction usage than Printexc.print_backtrace.val record_backtrace : bool -> unitPrintexc.record_backtrace b turns recording of exception backtraces
on (if b = true) or off (if b = false). Initially, backtraces
are not recorded, unless the b flag is given to the program
through the OCAMLRUNPARAM variable.val backtrace_status : unit -> boolPrintexc.backtrace_status() returns true if exception
backtraces are currently recorded, false if not.val register_printer : (exn -> string option) -> unitPrintexc.register_printer fn registers fn as an exception
printer. The printer should return None or raise an exception
if it does not know how to convert the passed exception, and Some
s with s the resulting string if it can convert the passed
exception. Exceptions raised by the printer are ignored.
When converting an exception into a string, the printers will be invoked
in the reverse order of their registrations, until a printer returns
a Some s value (if no such printer exists, the runtime will use a
generic printer).
When using this mechanism, one should be aware that an exception backtrace
is attached to the thread that saw it raised, rather than to the exception
itself. Practically, it means that the code related to fn should not use
the backtrace if it has itself raised an exception before.
Since 3.11.2
type
raw_backtrace stores a backtrace in
a low-level format, instead of directly exposing them as string as
the get_backtrace() function does.
This allows delaying the formatting of backtraces to when they are actually printed, which may be useful if you record more backtraces than you print.
Raw backtraces cannot be marshalled. If you need marshalling, you
should use the array returned by the backtrace_slots function of
the next section.
Since 4.01.0
val get_raw_backtrace : unit -> raw_backtracePrintexc.get_raw_backtrace () returns the same exception
backtrace that Printexc.print_backtrace would print, but in
a raw format. Same restriction usage than Printexc.print_backtrace.val print_raw_backtrace : out_channel -> raw_backtrace -> unitPrintexc.print_backtrace uses.val raw_backtrace_to_string : raw_backtrace -> stringPrintexc.get_backtrace uses.val raise_with_backtrace : exn -> raw_backtrace -> 'aval get_callstack : int -> raw_backtracePrintexc.get_callstack n returns a description of the top of the
call stack on the current program point (for the current thread),
with at most n entries. (Note: this function is not related to
exceptions at all, despite being part of the Printexc module.)val set_uncaught_exception_handler : (exn -> raw_backtrace -> unit) -> unitPrintexc.set_uncaught_exception_handler fn registers fn as the handler
for uncaught exceptions. The default handler prints the exception and
backtrace on standard error output.
Note that when fn is called all the functions registered with
at_exit have already been called. Because of this you must
make sure any output channel fn writes on is flushed.
Also note that exceptions raised by user code in the interactive toplevel are not passed to this function as they are caught by the toplevel itself.
If fn raises an exception, both the exceptions passed to fn and raised
by fn will be printed with their respective backtrace.
Since 4.02.0
These functions are used to traverse the slots of a raw backtrace
and extract information from them in a programmer-friendly format.
type
backtrace_slot represents a single slot of
a backtrace.val backtrace_slots : raw_backtrace -> backtrace_slot array optionNone if none of them
contain useful information.
In the return array, the slot at index 0 corresponds to the most
recent function call, raise, or primitive get_backtrace call in
the trace.
Some possible reasons for returning None are as follow:
-g)ocamlc -g)type
|
filename : |
|
line_number : |
|
start_char : |
|
end_char : |
start_char
and end_char are positions relative to the beginning of the
line.module Slot:sig..end
type
Elements of this type can still be compared and hashed: when two
elements are equal, then they represent the same source location
(the converse is not necessarily true in presence of inlining,
for example).
Since 4.02.0
val raw_backtrace_length : raw_backtrace -> intraw_backtrace_length bckt returns the number of slots in the
backtrace bckt.val get_raw_backtrace_slot : raw_backtrace -> int -> raw_backtrace_slotget_raw_backtrace_slot bckt pos returns the slot in position pos in the
backtrace bckt.val convert_raw_backtrace_slot : raw_backtrace_slot -> backtrace_slotbacktrace_slot from a low-level
raw_backtrace_slot.val get_raw_backtrace_next_slot : raw_backtrace_slot -> raw_backtrace_slot optionget_raw_backtrace_next_slot slot returns the next slot inlined, if any.
Sample code to iterate over all frames (inlined and non-inlined):
(* Iterate over inlined frames *)
let rec iter_raw_backtrace_slot f slot =
f slot;
match get_raw_backtrace_next_slot slot with
| None -> ()
| Some slot' -> iter_raw_backtrace_slot f slot'
(* Iterate over stack frames *)
let iter_raw_backtrace f bt =
for i = 0 to raw_backtrace_length bt - 1 do
iter_raw_backtrace_slot f (get_raw_backtrace_slot bt i)
done
val exn_slot_id : exn -> intPrintexc.exn_slot_id returns an integer which uniquely identifies
the constructor used to create the exception value exn
(in the current runtime).val exn_slot_name : exn -> stringPrintexc.exn_slot_name exn returns the internal name of the constructor
used to create the exception value exn.sig
type num = Int of int | Big_int of Big_int.big_int | Ratio of Ratio.ratio
val ( +/ ) : Num.num -> Num.num -> Num.num
val add_num : Num.num -> Num.num -> Num.num
val minus_num : Num.num -> Num.num
val ( -/ ) : Num.num -> Num.num -> Num.num
val sub_num : Num.num -> Num.num -> Num.num
val ( */ ) : Num.num -> Num.num -> Num.num
val mult_num : Num.num -> Num.num -> Num.num
val square_num : Num.num -> Num.num
val ( // ) : Num.num -> Num.num -> Num.num
val div_num : Num.num -> Num.num -> Num.num
val quo_num : Num.num -> Num.num -> Num.num
val mod_num : Num.num -> Num.num -> Num.num
val ( **/ ) : Num.num -> Num.num -> Num.num
val power_num : Num.num -> Num.num -> Num.num
val abs_num : Num.num -> Num.num
val succ_num : Num.num -> Num.num
val pred_num : Num.num -> Num.num
val incr_num : Num.num Pervasives.ref -> unit
val decr_num : Num.num Pervasives.ref -> unit
val is_integer_num : Num.num -> bool
val integer_num : Num.num -> Num.num
val floor_num : Num.num -> Num.num
val round_num : Num.num -> Num.num
val ceiling_num : Num.num -> Num.num
val sign_num : Num.num -> int
val ( =/ ) : Num.num -> Num.num -> bool
val ( </ ) : Num.num -> Num.num -> bool
val ( >/ ) : Num.num -> Num.num -> bool
val ( <=/ ) : Num.num -> Num.num -> bool
val ( >=/ ) : Num.num -> Num.num -> bool
val ( <>/ ) : Num.num -> Num.num -> bool
val eq_num : Num.num -> Num.num -> bool
val lt_num : Num.num -> Num.num -> bool
val le_num : Num.num -> Num.num -> bool
val gt_num : Num.num -> Num.num -> bool
val ge_num : Num.num -> Num.num -> bool
val compare_num : Num.num -> Num.num -> int
val max_num : Num.num -> Num.num -> Num.num
val min_num : Num.num -> Num.num -> Num.num
val string_of_num : Num.num -> string
val approx_num_fix : int -> Num.num -> string
val approx_num_exp : int -> Num.num -> string
val num_of_string : string -> Num.num
val num_of_string_opt : string -> Num.num option
val int_of_num : Num.num -> int
val int_of_num_opt : Num.num -> int option
val num_of_int : int -> Num.num
val nat_of_num : Num.num -> Nat.nat
val nat_of_num_opt : Num.num -> Nat.nat option
val num_of_nat : Nat.nat -> Num.num
val num_of_big_int : Big_int.big_int -> Num.num
val big_int_of_num : Num.num -> Big_int.big_int
val big_int_of_num_opt : Num.num -> Big_int.big_int option
val ratio_of_num : Num.num -> Ratio.ratio
val num_of_ratio : Ratio.ratio -> Num.num
val float_of_num : Num.num -> float
end ocaml-doc-4.05/ocaml.html/libref/Bigarray.Array3.html 0000644 0001750 0001750 00000051474 13131636442 021343 0 ustar mehdi mehdi
module Array3:sig..end
Array3 structure provides operations
similar to those of Bigarray.Genarray, but specialized to the case
of three-dimensional arrays.type ('a, 'b, 'c) t
'a, representation kind 'b, and memory layout 'c.val create : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> int -> int -> ('a, 'b, 'c) tArray3.create kind layout dim1 dim2 dim3 returns a new bigarray of
three dimension, whose size is dim1 in the first dimension,
dim2 in the second dimension, and dim3 in the third.
kind and layout determine the array element kind and
the array layout as described for Bigarray.Genarray.create.val dim1 : ('a, 'b, 'c) t -> intval dim2 : ('a, 'b, 'c) t -> intval dim3 : ('a, 'b, 'c) t -> intval kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kindval layout : ('a, 'b, 'c) t -> 'c Bigarray.layoutval size_in_bytes : ('a, 'b, 'c) t -> intsize_in_bytes a is the number of elements in a
multiplied by a's Bigarray.kind_size_in_bytes.val get : ('a, 'b, 'c) t -> int -> int -> int -> 'aArray3.get a x y z, also written a.{x,y,z},
returns the element of a at coordinates (x, y, z).
x, y and z must be within the bounds of a,
as described for Bigarray.Genarray.get;
otherwise, Invalid_argument is raised.val set : ('a, 'b, 'c) t -> int -> int -> int -> 'a -> unitArray3.set a x y v, or alternatively a.{x,y,z} <- v,
stores the value v at coordinates (x, y, z) in a.
x, y and z must be within the bounds of a,
as described for Bigarray.Genarray.set;
otherwise, Invalid_argument is raised.val sub_left : ('a, 'b, Bigarray.c_layout) t ->
int -> int -> ('a, 'b, Bigarray.c_layout) tBigarray.Genarray.sub_left for more details. Array3.sub_left
applies only to arrays with C layout.val sub_right : ('a, 'b, Bigarray.fortran_layout) t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) tBigarray.Genarray.sub_right for more details. Array3.sub_right
applies only to arrays with Fortran layout.val slice_left_1 : ('a, 'b, Bigarray.c_layout) t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.tBigarray.Genarray.slice_left for more details.
Array3.slice_left_1 applies only to arrays with C layout.val slice_right_1 : ('a, 'b, Bigarray.fortran_layout) t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.tBigarray.Genarray.slice_right for more details.
Array3.slice_right_1 applies only to arrays with Fortran
layout.val slice_left_2 : ('a, 'b, Bigarray.c_layout) t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array2.tBigarray.Genarray.slice_left for more details.
Array3.slice_left_2 applies only to arrays with C layout.val slice_right_2 : ('a, 'b, Bigarray.fortran_layout) t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.tBigarray.Genarray.slice_right for more details.
Array3.slice_right_2 applies only to arrays with Fortran
layout.val blit : ('a, 'b, 'c) t -> ('a, 'b, 'c) t -> unitBigarray.Genarray.blit for more details.val fill : ('a, 'b, 'c) t -> 'a -> unitBigarray.Genarray.fill for more details.val of_array : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array array array -> ('a, 'b, 'c) tval map_file : Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int -> int -> int -> ('a, 'b, 'c) tBigarray.Genarray.map_file for more details.val unsafe_get : ('a, 'b, 'c) t -> int -> int -> int -> 'aBigarray.Array3.get, but bounds checking is not always
performed.val unsafe_set : ('a, 'b, 'c) t -> int -> int -> int -> 'a -> unitBigarray.Array3.set, but bounds checking is not always
performed.module type HashedType = Hashtbl.HashedTypetype
val equal : t -> t -> boolval hash : t -> intequal, then they have identical hash values
as computed by hash.
Examples: suitable (equal, hash) pairs for arbitrary key
types include(=), Hashtbl.hash) for comparing objects by structure
(provided objects do not contain floats)(fun x y -> compare x y = 0), Hashtbl.hash)
for comparing objects by structure
and handling nan correctly(==), Hashtbl.hash) for comparing objects by physical
equality (e.g. for mutable or cyclic objects).sig
val lseek :
UnixLabels.file_descr -> int64 -> mode:UnixLabels.seek_command -> int64
val truncate : string -> len:int64 -> unit
val ftruncate : UnixLabels.file_descr -> len:int64 -> unit
type stats =
Unix.LargeFile.stats = {
st_dev : int;
st_ino : int;
st_kind : UnixLabels.file_kind;
st_perm : UnixLabels.file_perm;
st_nlink : int;
st_uid : int;
st_gid : int;
st_rdev : int;
st_size : int64;
st_atime : float;
st_mtime : float;
st_ctime : float;
}
val stat : string -> UnixLabels.LargeFile.stats
val lstat : string -> UnixLabels.LargeFile.stats
val fstat : UnixLabels.file_descr -> UnixLabels.LargeFile.stats
end ocaml-doc-4.05/ocaml.html/libref/type_Strongly_connected_components.S.Id.html 0000644 0001750 0001750 00000014717 13131636451 026347 0 ustar mehdi mehdi
Identifiable.S ocaml-doc-4.05/ocaml.html/libref/Int32.html 0000644 0001750 0001750 00000045474 13131636445 017350 0 ustar mehdi mehdi
module Int32:sig..end
This module provides operations on the type int32
of signed 32-bit integers. Unlike the built-in int type,
the type int32 is guaranteed to be exactly 32-bit wide on all
platforms. All arithmetic operations over int32 are taken
modulo 232.
Performance notice: values of type int32 occupy more memory
space than values of type int, and arithmetic operations on
int32 are generally slower than those on int. Use int32
only when the application requires exact 32-bit arithmetic.
val zero : int32val one : int32val minus_one : int32val neg : int32 -> int32val add : int32 -> int32 -> int32val sub : int32 -> int32 -> int32val mul : int32 -> int32 -> int32val div : int32 -> int32 -> int32Division_by_zero if the second
argument is zero. This division rounds the real quotient of
its arguments towards zero, as specified for (/).val rem : int32 -> int32 -> int32y is not zero, the result
of Int32.rem x y satisfies the following property:
x = Int32.add (Int32.mul (Int32.div x y) y) (Int32.rem x y).
If y = 0, Int32.rem x y raises Division_by_zero.val succ : int32 -> int32Int32.succ x is Int32.add x Int32.one.val pred : int32 -> int32Int32.pred x is Int32.sub x Int32.one.val abs : int32 -> int32val max_int : int32val min_int : int32val logand : int32 -> int32 -> int32val logor : int32 -> int32 -> int32val logxor : int32 -> int32 -> int32val lognot : int32 -> int32val shift_left : int32 -> int -> int32Int32.shift_left x y shifts x to the left by y bits.
The result is unspecified if y < 0 or y >= 32.val shift_right : int32 -> int -> int32Int32.shift_right x y shifts x to the right by y bits.
This is an arithmetic shift: the sign bit of x is replicated
and inserted in the vacated bits.
The result is unspecified if y < 0 or y >= 32.val shift_right_logical : int32 -> int -> int32Int32.shift_right_logical x y shifts x to the right by y bits.
This is a logical shift: zeroes are inserted in the vacated bits
regardless of the sign of x.
The result is unspecified if y < 0 or y >= 32.val of_int : int -> int32int) to a 32-bit integer
(type int32).val to_int : int32 -> intint32) to an
integer (type int). On 32-bit platforms, the 32-bit integer
is taken modulo 231, i.e. the high-order bit is lost
during the conversion. On 64-bit platforms, the conversion
is exact.val of_float : float -> int32Int32.min_int, Int32.max_int].val to_float : int32 -> floatval of_string : string -> int320x, 0o or 0b
respectively.
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 int32.val of_string_opt : string -> int32 optionof_string, but return None instead of raising.val to_string : int32 -> stringval bits_of_float : float -> int32val float_of_bits : int32 -> floatint32.typet =int32
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module Int32 to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolmodule Callback:sig..end
This module allows OCaml values to be registered with the C runtime
under a symbolic name, so that C code can later call back registered
OCaml functions, or raise registered OCaml exceptions.
val register : string -> 'a -> unitCallback.register n v registers the value v under
the name n. C code can later retrieve a handle to v
by calling caml_named_value(n).val register_exception : string -> exn -> unitCallback.register_exception n exn registers the
exception contained in the exception value exn
under the name n. C code can later retrieve a handle to
the exception by calling caml_named_value(n). The exception
value thus obtained is suitable for passing as first argument
to raise_constant or raise_with_arg.sig
type 'a t = 'a lazy_t
exception Undefined
external force : 'a Lazy.t -> 'a = "%lazy_force"
val force_val : 'a Lazy.t -> 'a
val from_fun : (unit -> 'a) -> 'a Lazy.t
val from_val : 'a -> 'a Lazy.t
val is_val : 'a Lazy.t -> bool
val lazy_from_fun : (unit -> 'a) -> 'a Lazy.t
val lazy_from_val : 'a -> 'a Lazy.t
val lazy_is_val : 'a Lazy.t -> bool
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_mapper.html 0000644 0001750 0001750 00000061702 13131636441 021571 0 ustar mehdi mehdi
sig
type mapper = {
attribute :
Ast_mapper.mapper -> Parsetree.attribute -> Parsetree.attribute;
attributes :
Ast_mapper.mapper ->
Parsetree.attribute list -> Parsetree.attribute list;
case : Ast_mapper.mapper -> Parsetree.case -> Parsetree.case;
cases : Ast_mapper.mapper -> Parsetree.case list -> Parsetree.case list;
class_declaration :
Ast_mapper.mapper ->
Parsetree.class_declaration -> Parsetree.class_declaration;
class_description :
Ast_mapper.mapper ->
Parsetree.class_description -> Parsetree.class_description;
class_expr :
Ast_mapper.mapper -> Parsetree.class_expr -> Parsetree.class_expr;
class_field :
Ast_mapper.mapper -> Parsetree.class_field -> Parsetree.class_field;
class_signature :
Ast_mapper.mapper ->
Parsetree.class_signature -> Parsetree.class_signature;
class_structure :
Ast_mapper.mapper ->
Parsetree.class_structure -> Parsetree.class_structure;
class_type :
Ast_mapper.mapper -> Parsetree.class_type -> Parsetree.class_type;
class_type_declaration :
Ast_mapper.mapper ->
Parsetree.class_type_declaration -> Parsetree.class_type_declaration;
class_type_field :
Ast_mapper.mapper ->
Parsetree.class_type_field -> Parsetree.class_type_field;
constructor_declaration :
Ast_mapper.mapper ->
Parsetree.constructor_declaration -> Parsetree.constructor_declaration;
expr : Ast_mapper.mapper -> Parsetree.expression -> Parsetree.expression;
extension :
Ast_mapper.mapper -> Parsetree.extension -> Parsetree.extension;
extension_constructor :
Ast_mapper.mapper ->
Parsetree.extension_constructor -> Parsetree.extension_constructor;
include_declaration :
Ast_mapper.mapper ->
Parsetree.include_declaration -> Parsetree.include_declaration;
include_description :
Ast_mapper.mapper ->
Parsetree.include_description -> Parsetree.include_description;
label_declaration :
Ast_mapper.mapper ->
Parsetree.label_declaration -> Parsetree.label_declaration;
location : Ast_mapper.mapper -> Location.t -> Location.t;
module_binding :
Ast_mapper.mapper ->
Parsetree.module_binding -> Parsetree.module_binding;
module_declaration :
Ast_mapper.mapper ->
Parsetree.module_declaration -> Parsetree.module_declaration;
module_expr :
Ast_mapper.mapper -> Parsetree.module_expr -> Parsetree.module_expr;
module_type :
Ast_mapper.mapper -> Parsetree.module_type -> Parsetree.module_type;
module_type_declaration :
Ast_mapper.mapper ->
Parsetree.module_type_declaration -> Parsetree.module_type_declaration;
open_description :
Ast_mapper.mapper ->
Parsetree.open_description -> Parsetree.open_description;
pat : Ast_mapper.mapper -> Parsetree.pattern -> Parsetree.pattern;
payload : Ast_mapper.mapper -> Parsetree.payload -> Parsetree.payload;
signature :
Ast_mapper.mapper -> Parsetree.signature -> Parsetree.signature;
signature_item :
Ast_mapper.mapper ->
Parsetree.signature_item -> Parsetree.signature_item;
structure :
Ast_mapper.mapper -> Parsetree.structure -> Parsetree.structure;
structure_item :
Ast_mapper.mapper ->
Parsetree.structure_item -> Parsetree.structure_item;
typ : Ast_mapper.mapper -> Parsetree.core_type -> Parsetree.core_type;
type_declaration :
Ast_mapper.mapper ->
Parsetree.type_declaration -> Parsetree.type_declaration;
type_extension :
Ast_mapper.mapper ->
Parsetree.type_extension -> Parsetree.type_extension;
type_kind :
Ast_mapper.mapper -> Parsetree.type_kind -> Parsetree.type_kind;
value_binding :
Ast_mapper.mapper -> Parsetree.value_binding -> Parsetree.value_binding;
value_description :
Ast_mapper.mapper ->
Parsetree.value_description -> Parsetree.value_description;
with_constraint :
Ast_mapper.mapper ->
Parsetree.with_constraint -> Parsetree.with_constraint;
}
val default_mapper : Ast_mapper.mapper
val tool_name : unit -> string
val apply : source:string -> target:string -> Ast_mapper.mapper -> unit
val run_main : (string list -> Ast_mapper.mapper) -> unit
val register_function :
(string -> (string list -> Ast_mapper.mapper) -> unit) Pervasives.ref
val register : string -> (string list -> Ast_mapper.mapper) -> unit
val map_opt : ('a -> 'b) -> 'a option -> 'b option
val extension_of_error : Location.error -> Parsetree.extension
val attribute_of_warning : Location.t -> string -> Parsetree.attribute
val add_ppx_context_str :
tool_name:string -> Parsetree.structure -> Parsetree.structure
val add_ppx_context_sig :
tool_name:string -> Parsetree.signature -> Parsetree.signature
val drop_ppx_context_str :
restore:bool -> Parsetree.structure -> Parsetree.structure
val drop_ppx_context_sig :
restore:bool -> Parsetree.signature -> Parsetree.signature
val set_cookie : string -> Parsetree.expression -> unit
val get_cookie : string -> Parsetree.expression option
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Cf.html 0000644 0001750 0001750 00000027353 13131636441 021056 0 ustar mehdi mehdi
module Cf:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs -> Parsetree.class_field_desc -> Parsetree.class_field
val attr : Parsetree.class_field -> Parsetree.attribute -> Parsetree.class_field
val inherit_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.override_flag ->
Parsetree.class_expr -> Ast_helper.str option -> Parsetree.class_field
val val_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.mutable_flag -> Parsetree.class_field_kind -> Parsetree.class_field
val method_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Asttypes.private_flag -> Parsetree.class_field_kind -> Parsetree.class_field
val constraint_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.class_field
val initializer_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.class_field
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_field
val attribute : ?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.class_field
val text : Docstrings.text -> Parsetree.class_field list
val virtual_ : Parsetree.core_type -> Parsetree.class_field_kind
val concrete : Asttypes.override_flag -> Parsetree.expression -> Parsetree.class_field_kind ocaml-doc-4.05/ocaml.html/libref/Clflags.Int_arg_helper.html 0000644 0001750 0001750 00000021011 13131636443 022720 0 ustar mehdi mehdi
module Int_arg_helper:sig..end
type
val parse : string -> string -> parsed ref -> unit
type
| |
Ok |
| |
Parse_failed of |
val parse_no_error : string ->
parsed ref ->
parse_result
val get : key:int -> parsed -> int ocaml-doc-4.05/ocaml.html/libref/type_Set.S.html 0000644 0001750 0001750 00000045764 13131636450 020444 0 ustar mehdi mehdi
sig
type elt
type t
val empty : Set.S.t
val is_empty : Set.S.t -> bool
val mem : Set.S.elt -> Set.S.t -> bool
val add : Set.S.elt -> Set.S.t -> Set.S.t
val singleton : Set.S.elt -> Set.S.t
val remove : Set.S.elt -> Set.S.t -> Set.S.t
val union : Set.S.t -> Set.S.t -> Set.S.t
val inter : Set.S.t -> Set.S.t -> Set.S.t
val diff : Set.S.t -> Set.S.t -> Set.S.t
val compare : Set.S.t -> Set.S.t -> int
val equal : Set.S.t -> Set.S.t -> bool
val subset : Set.S.t -> Set.S.t -> bool
val iter : (Set.S.elt -> unit) -> Set.S.t -> unit
val map : (Set.S.elt -> Set.S.elt) -> Set.S.t -> Set.S.t
val fold : (Set.S.elt -> 'a -> 'a) -> Set.S.t -> 'a -> 'a
val for_all : (Set.S.elt -> bool) -> Set.S.t -> bool
val exists : (Set.S.elt -> bool) -> Set.S.t -> bool
val filter : (Set.S.elt -> bool) -> Set.S.t -> Set.S.t
val partition : (Set.S.elt -> bool) -> Set.S.t -> Set.S.t * Set.S.t
val cardinal : Set.S.t -> int
val elements : Set.S.t -> Set.S.elt list
val min_elt : Set.S.t -> Set.S.elt
val min_elt_opt : Set.S.t -> Set.S.elt option
val max_elt : Set.S.t -> Set.S.elt
val max_elt_opt : Set.S.t -> Set.S.elt option
val choose : Set.S.t -> Set.S.elt
val choose_opt : Set.S.t -> Set.S.elt option
val split : Set.S.elt -> Set.S.t -> Set.S.t * bool * Set.S.t
val find : Set.S.elt -> Set.S.t -> Set.S.elt
val find_opt : Set.S.elt -> Set.S.t -> Set.S.elt option
val find_first : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt
val find_first_opt : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt option
val find_last : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt
val find_last_opt : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt option
val of_list : Set.S.elt list -> Set.S.t
end ocaml-doc-4.05/ocaml.html/libref/Docstrings.html 0000644 0001750 0001750 00000047237 13131636443 020565 0 ustar mehdi mehdi
module Docstrings:sig..end
val init : unit -> unitval warn_bad_docstrings : unit -> unittype
val docstring : string -> Location.t -> docstringval register : docstring -> unitval docstring_body : docstring -> stringval docstring_loc : docstring -> Location.t
These functions are used by the lexer to associate docstrings to
the locations of tokens.
val set_pre_docstrings : Lexing.position -> docstring list -> unitval set_post_docstrings : Lexing.position -> docstring list -> unitval set_floating_docstrings : Lexing.position -> docstring list -> unitval set_pre_extra_docstrings : Lexing.position -> docstring list -> unitval set_post_extra_docstrings : Lexing.position -> docstring list -> unit
The Docstrings.docs type represents documentation attached to an item.
type
|
docs_pre : |
|
docs_post : |
val empty_docs : docs
val docs_attr : docstring -> Parsetree.attribute
val add_docs_attrs : docs -> Parsetree.attributes -> Parsetree.attributesval symbol_docs : unit -> docsval symbol_docs_lazy : unit -> docs Lazy.t
val rhs_docs : int -> int -> docsval rhs_docs_lazy : int -> int -> docs Lazy.t
val mark_symbol_docs : unit -> unitval mark_rhs_docs : int -> int -> unit
The Docstrings.info type represents documentation attached to a field or
constructor.
typeinfo =docstring option
val empty_info : info
val info_attr : docstring -> Parsetree.attribute
val add_info_attrs : info -> Parsetree.attributes -> Parsetree.attributesval symbol_info : unit -> infoval rhs_info : int -> info
The Docstrings.text type represents documentation which is not attached to
anything.
typetext =docstring list
val empty_text : text
val empty_text_lazy : text Lazy.t
val text_attr : docstring -> Parsetree.attribute
val add_text_attrs : text -> Parsetree.attributes -> Parsetree.attributesval symbol_text : unit -> textval symbol_text_lazy : unit -> text Lazy.t
val rhs_text : int -> textval rhs_text_lazy : int -> text Lazy.t
There may be additional text attached to the delimiters of a block
(e.g. struct and end). This is fetched by the following
functions, which are applied to the contents of the block rather
than the delimiters.
val symbol_pre_extra_text : unit -> textval symbol_post_extra_text : unit -> textval rhs_pre_extra_text : int -> textval rhs_post_extra_text : int -> textmodule StringSet:Set.Swith type elt = string
type
type
val empty : tval is_empty : t -> boolval mem : elt -> t -> boolmem x s tests whether x belongs to the set s.val add : elt -> t -> tadd x s returns a set containing all elements of s,
plus x. If x was already in s, s is returned unchanged
(the result of the function is then physically equal to s).val singleton : elt -> tsingleton x returns the one-element set containing only x.val remove : elt -> t -> tremove x s returns a set containing all elements of s,
except x. If x was not in s, s is returned unchanged
(the result of the function is then physically equal to s).val union : t -> t -> tval inter : t -> t -> tval diff : t -> t -> tval compare : t -> t -> intval equal : t -> t -> boolequal s1 s2 tests whether the sets s1 and s2 are
equal, that is, contain equal elements.val subset : t -> t -> boolsubset s1 s2 tests whether the set s1 is a subset of
the set s2.val iter : (elt -> unit) -> t -> unititer f s applies f in turn to all elements of s.
The elements of s are presented to f in increasing order
with respect to the ordering over the type of the elements.val map : (elt -> elt) -> t -> tmap f s is the set whose elements are f a0,f a1... f
aN, where a0,a1...aN are the elements of s.
The elements are passed to f in increasing order
with respect to the ordering over the type of the elements.
If no element of s is changed by f, s is returned
unchanged. (If each output of f is physically equal to its
input, the returned set is physically equal to s.)
Since 4.04.0
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'afold f s a computes (f xN ... (f x2 (f x1 a))...),
where x1 ... xN are the elements of s, in increasing order.val for_all : (elt -> bool) -> t -> boolfor_all p s checks if all elements of the set
satisfy the predicate p.val exists : (elt -> bool) -> t -> boolexists p s checks if at least one element of
the set satisfies the predicate p.val filter : (elt -> bool) -> t -> tfilter p s returns the set of all elements in s
that satisfy predicate p. If p satisfies every element in s,
s is returned unchanged (the result of the function is then
physically equal to s).val partition : (elt -> bool) -> t -> t * tpartition p s returns a pair of sets (s1, s2), where
s1 is the set of all the elements of s that satisfy the
predicate p, and s2 is the set of all the elements of
s that do not satisfy p.val cardinal : t -> intval elements : t -> elt listOrd.compare, where Ord is the argument
given to Set.Make.val min_elt : t -> eltOrd.compare ordering), or raise
Not_found if the set is empty.val min_elt_opt : t -> elt optionOrd.compare ordering), or None
if the set is empty.val max_elt : t -> eltSet.S.min_elt, but returns the largest element of the
given set.val max_elt_opt : t -> elt option
val choose : t -> eltNot_found if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val choose_opt : t -> elt optionNone if
the set is empty. Which element is chosen is unspecified,
but equal elements will be chosen for equal sets.val split : elt -> t -> t * bool * tsplit x s returns a triple (l, present, r), where
l is the set of elements of s that are
strictly less than x;
r is the set of elements of s that are
strictly greater than x;
present is false if s contains no element equal to x,
or true if s contains an element equal to x.val find : elt -> t -> eltfind x s returns the element of s equal to x (according
to Ord.compare), or raise Not_found if no such element
exists.val find_opt : elt -> t -> elt optionfind_opt x s returns the element of s equal to x (according
to Ord.compare), or None if no such element
exists.val find_first : (elt -> bool) -> t -> eltfind_first f s, where f is a monotonically increasing function,
returns the lowest element e of s such that f e,
or raises Not_found if no such element exists.
For example, find_first (fun e -> Ord.compare e x >= 0) s will return
the first element e of s where Ord.compare e x >= 0 (intuitively:
e >= x), or raise Not_found if x is greater than any element of
s.
Since 4.05
val find_first_opt : (elt -> bool) -> t -> elt optionfind_first_opt f s, where f is a monotonically increasing function,
returns an option containing the lowest element e of s such that
f e, or None if no such element exists.val find_last : (elt -> bool) -> t -> eltfind_last f s, where f is a monotonically decreasing function,
returns the highest element e of s such that f e,
or raises Not_found if no such element exists.val find_last_opt : (elt -> bool) -> t -> elt optionfind_last_opt f s, where f is a monotonically decreasing function,
returns an option containing the highest element e of s such that
f e, or None if no such element exists.val of_list : elt list -> tof_list l creates a set from a list of elements.
This is usually more efficient than folding add over the list,
except perhaps for lists with many duplicated elements.module String:sig..end
A string is an immutable data structure that contains a fixed-length sequence of (single-byte) characters. Each character can be accessed in constant time through its index.
Given a string s of length l, we can access each of the l
characters of s via its index in the sequence. Indexes start at
0, and we will call an index valid in s if it falls within the
range [0...l-1] (inclusive). A position is the point between two
characters or at the beginning or end of the string. We call a
position valid in s if it falls within the range [0...l]
(inclusive). Note that the character at index n is between
positions n and n+1.
Two parameters start and len are said to designate a valid
substring of s if len >= 0 and start and start+len are
valid positions in s.
OCaml strings used to be modifiable in place, for instance via the
String.set and String.blit functions described below. This
usage is deprecated and only possible when the compiler is put in
"unsafe-string" mode by giving the -unsafe-string command-line
option (which is currently the default for reasons of backward
compatibility). This is done by making the types string and
bytes (see module Bytes) interchangeable so that functions
expecting byte sequences can also accept strings as arguments and
modify them.
All new code should avoid this feature and be compiled with the
-safe-string command-line option to enforce the separation between
the types string and bytes.
val length : string -> intval get : string -> int -> charString.get s n returns the character at index n in string s.
You can also write s.[n] instead of String.get s n.
Raise Invalid_argument if n not a valid index in s.
val set : bytes -> int -> char -> unitBytes.set. String.set s n c modifies byte sequence s in place,
replacing the byte at index n with c.
You can also write s.[n] <- c instead of String.set s n c.
Raise Invalid_argument if n is not a valid index in s.
val create : int -> bytesBytes.create. String.create n returns a fresh byte sequence of length n.
The sequence is uninitialized and contains arbitrary bytes.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val make : int -> char -> stringString.make n c returns a fresh string of length n,
filled with the character c.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val init : int -> (int -> char) -> stringString.init n f returns a string of length n, with character
i initialized to the result of f i (called in increasing
index order).
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
Since 4.02.0
val copy : string -> stringval sub : string -> int -> int -> stringString.sub s start len returns a fresh string of length len,
containing the substring of s that starts at position start and
has length len.
Raise Invalid_argument if start and len do not
designate a valid substring of s.
val fill : bytes -> int -> int -> char -> unitBytes.fill. String.fill s start len c modifies byte sequence s in place,
replacing len bytes with c, starting at start.
Raise Invalid_argument if start and len do not
designate a valid range of s.
val blit : string -> int -> bytes -> int -> int -> unitBytes.blit_string.val concat : string -> string list -> stringString.concat sep sl concatenates the list of strings sl,
inserting the separator string sep between each.
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
val iter : (char -> unit) -> string -> unitString.iter f s applies function f in turn to all
the characters of s. It is equivalent to
f s.[0]; f s.[1]; ...; f s.[String.length s - 1]; ().val iteri : (int -> char -> unit) -> string -> unitString.iter, but the
function is applied to the index of the element as first argument
(counting from 0), and the character itself as second argument.val map : (char -> char) -> string -> stringString.map f s applies function f in turn to all the
characters of s (in increasing index order) and stores the
results in a new string that is returned.val mapi : (int -> char -> char) -> string -> stringString.mapi f s calls f with each character of s and its
index (in increasing index order) and stores the results in a new
string that is returned.val trim : string -> string' ',
'\012', '\n', '\r', and '\t'. If there is neither leading nor
trailing whitespace character in the argument, return the original
string itself, not a copy.val escaped : string -> stringIf there is no special character in the argument that needs escaping, return the original string itself, not a copy.
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
The function Scanf.unescaped is a left inverse of escaped,
i.e. Scanf.unescaped (escaped s) = s for any string s (unless
escape s fails).
val index : string -> char -> intString.index s c returns the index of the first
occurrence of character c in string s.
Raise Not_found if c does not occur in s.
val index_opt : string -> char -> int optionString.index_opt s c returns the index of the first
occurrence of character c in string s, or
None if c does not occur in s.val rindex : string -> char -> intString.rindex s c returns the index of the last
occurrence of character c in string s.
Raise Not_found if c does not occur in s.
val rindex_opt : string -> char -> int optionString.rindex_opt s c returns the index of the last occurrence
of character c in string s, or None if c does not occur in
s.val index_from : string -> int -> char -> intString.index_from s i c returns the index of the
first occurrence of character c in string s after position i.
String.index s c is equivalent to String.index_from s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Raise Not_found if c does not occur in s after position i.
val index_from_opt : string -> int -> char -> int optionString.index_from_opt s i c returns the index of the
first occurrence of character c in string s after position i
or None if c does not occur in s after position i.
String.index_opt s c is equivalent to String.index_from_opt s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Since 4.05
val rindex_from : string -> int -> char -> intString.rindex_from s i c returns the index of the
last occurrence of character c in string s before position i+1.
String.rindex s c is equivalent to
String.rindex_from s (String.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Raise Not_found if c does not occur in s before position i+1.
val rindex_from_opt : string -> int -> char -> int optionString.rindex_from_opt s i c returns the index of the
last occurrence of character c in string s before position i+1
or None if c does not occur in s before position i+1.
String.rindex_opt s c is equivalent to
String.rindex_from_opt s (String.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Since 4.05
val contains : string -> char -> boolString.contains s c tests if character c
appears in the string s.val contains_from : string -> int -> char -> boolString.contains_from s start c tests if character c
appears in s after position start.
String.contains s c is equivalent to
String.contains_from s 0 c.
Raise Invalid_argument if start is not a valid position in s.
val rcontains_from : string -> int -> char -> boolString.rcontains_from s stop c tests if character c
appears in s before position stop+1.
Raise Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.
val uppercase : string -> stringval lowercase : string -> stringval capitalize : string -> stringval uncapitalize : string -> stringval uppercase_ascii : string -> stringval lowercase_ascii : string -> stringval capitalize_ascii : string -> stringval uncapitalize_ascii : string -> stringtypet =string
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module String to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolval split_on_char : char -> string -> string listString.split_on_char sep s returns the list of all (possibly empty)
substrings of s that are delimited by the sep character.
The function's output is specified by the following invariants:
sep as a separator returns a
string equal to the input (String.concat (String.make 1 sep)
(String.split_on_char sep s) = s).sep character.sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?typ:Parsetree.module_type ->
Ast_helper.str -> Parsetree.module_type_declaration
end ocaml-doc-4.05/ocaml.html/libref/type_Bigarray.Array1.html 0000644 0001750 0001750 00000036522 13131636442 022377 0 ustar mehdi mehdi
sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> ('a, 'b, 'c) Bigarray.Array1.t
external dim : ('a, 'b, 'c) Bigarray.Array1.t -> int = "%caml_ba_dim_1"
external kind : ('a, 'b, 'c) Bigarray.Array1.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array1.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array1.t -> int
external get : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a
= "%caml_ba_ref_1"
external set : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a -> unit
= "%caml_ba_set_1"
external sub :
('a, 'b, 'c) Bigarray.Array1.t ->
int -> int -> ('a, 'b, 'c) Bigarray.Array1.t = "caml_ba_sub"
val slice :
('a, 'b, 'c) Bigarray.Array1.t -> int -> ('a, 'b, 'c) Bigarray.Array0.t
external blit :
('a, 'b, 'c) Bigarray.Array1.t -> ('a, 'b, 'c) Bigarray.Array1.t -> unit
= "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array1.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array -> ('a, 'b, 'c) Bigarray.Array1.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> bool -> int -> ('a, 'b, 'c) Bigarray.Array1.t
external unsafe_get : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a
= "%caml_ba_unsafe_ref_1"
external unsafe_set : ('a, 'b, 'c) Bigarray.Array1.t -> int -> 'a -> unit
= "%caml_ba_unsafe_set_1"
end ocaml-doc-4.05/ocaml.html/libref/type_CamlinternalFormatBasics.html 0000644 0001750 0001750 00000432033 13131636443 024406 0 ustar mehdi mehdi
sig
type padty = Left | Right | Zeros
type int_conv =
Int_d
| Int_pd
| Int_sd
| Int_i
| Int_pi
| Int_si
| Int_x
| Int_Cx
| Int_X
| Int_CX
| Int_o
| Int_Co
| Int_u
type float_conv =
Float_f
| Float_pf
| Float_sf
| Float_e
| Float_pe
| Float_se
| Float_E
| Float_pE
| Float_sE
| Float_g
| Float_pg
| Float_sg
| Float_G
| Float_pG
| Float_sG
| Float_F
| Float_h
| Float_ph
| Float_sh
| Float_H
| Float_pH
| Float_sH
type char_set = string
type counter = Line_counter | Char_counter | Token_counter
type ('a, 'b) padding =
No_padding : ('a, 'a) CamlinternalFormatBasics.padding
| Lit_padding : CamlinternalFormatBasics.padty *
int -> ('a, 'a) CamlinternalFormatBasics.padding
| Arg_padding :
CamlinternalFormatBasics.padty -> (int -> 'a, 'a)
CamlinternalFormatBasics.padding
type pad_option = int option
type ('a, 'b) precision =
No_precision : ('a, 'a) CamlinternalFormatBasics.precision
| Lit_precision : int -> ('a, 'a) CamlinternalFormatBasics.precision
| Arg_precision : (int -> 'a, 'a) CamlinternalFormatBasics.precision
type prec_option = int option
type ('a, 'b, 'c) custom_arity =
Custom_zero : ('a, string, 'a) CamlinternalFormatBasics.custom_arity
| Custom_succ :
('a, 'b, 'c) CamlinternalFormatBasics.custom_arity -> ('a, 'x -> 'b,
'x -> 'c)
CamlinternalFormatBasics.custom_arity
type block_type =
Pp_hbox
| Pp_vbox
| Pp_hvbox
| Pp_hovbox
| Pp_box
| Pp_fits
type formatting_lit =
Close_box
| Close_tag
| Break of string * int * int
| FFlush
| Force_newline
| Flush_newline
| Magic_size of string * int
| Escaped_at
| Escaped_percent
| Scan_indic of char
type ('a, 'b, 'c, 'd, 'e, 'f) formatting_gen =
Open_tag :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6 ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.formatting_gen
| Open_box :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6 ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.formatting_gen
and ('a, 'b, 'c, 'd, 'e, 'f) fmtty =
('a, 'b, 'c, 'd, 'e, 'f, 'a, 'b, 'c, 'd, 'e, 'f)
CamlinternalFormatBasics.fmtty_rel
and ('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2) fmtty_rel =
Char_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (char -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, char -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| String_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (string -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, string -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Int_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (int -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, int -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Int32_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (int32 -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, int32 -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Nativeint_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (nativeint -> 'a1, 'b1, 'c1,
'd1, 'e1, 'f1,
nativeint -> 'a2, 'b2, 'c2,
'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Int64_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (int64 -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, int64 -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Float_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (float -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, float -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Bool_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (bool -> 'a1, 'b1, 'c1, 'd1,
'e1, 'f1, bool -> 'a2, 'b2,
'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Format_arg_ty :
('g, 'h, 'i, 'j, 'k, 'l) CamlinternalFormatBasics.fmtty *
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (('g, 'h, 'i, 'j, 'k, 'l)
CamlinternalFormatBasics.format6 ->
'a1, 'b1, 'c1, 'd1, 'e1, 'f1,
('g, 'h, 'i, 'j, 'k, 'l)
CamlinternalFormatBasics.format6 ->
'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Format_subst_ty :
('g, 'h, 'i, 'j, 'k, 'l, 'g1, 'b1, 'c1, 'j1, 'd1, 'a1)
CamlinternalFormatBasics.fmtty_rel *
('g, 'h, 'i, 'j, 'k, 'l, 'g2, 'b2, 'c2, 'j2, 'd2, 'a2)
CamlinternalFormatBasics.fmtty_rel *
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (('g, 'h, 'i, 'j, 'k, 'l)
CamlinternalFormatBasics.format6 ->
'g1, 'b1, 'c1, 'j1, 'e1, 'f1,
('g, 'h, 'i, 'j, 'k, 'l)
CamlinternalFormatBasics.format6 ->
'g2, 'b2, 'c2, 'j2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Alpha_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (('b1 -> 'x -> 'c1) ->
'x -> 'a1, 'b1, 'c1, 'd1, 'e1,
'f1,
('b2 -> 'x -> 'c2) ->
'x -> 'a2, 'b2, 'c2, 'd2, 'e2,
'f2)
CamlinternalFormatBasics.fmtty_rel
| Theta_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> (('b1 -> 'c1) -> 'a1, 'b1, 'c1,
'd1, 'e1, 'f1,
('b2 -> 'c2) -> 'a2, 'b2, 'c2,
'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Any_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> ('x -> 'a1, 'b1, 'c1, 'd1, 'e1,
'f1, 'x -> 'a2, 'b2, 'c2, 'd2,
'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Reader_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> ('x -> 'a1, 'b1, 'c1,
('b1 -> 'x) -> 'd1, 'e1, 'f1,
'x -> 'a2, 'b2, 'c2,
('b2 -> 'x) -> 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| Ignored_reader_ty :
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel -> ('a1, 'b1, 'c1,
('b1 -> 'x) -> 'd1, 'e1, 'f1,
'a2, 'b2, 'c2,
('b2 -> 'x) -> 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
| End_of_fmtty :
('f1, 'b1, 'c1, 'd1, 'd1, 'f1, 'f2, 'b2, 'c2, 'd2, 'd2, 'f2)
CamlinternalFormatBasics.fmtty_rel
and ('a, 'b, 'c, 'd, 'e, 'f) fmt =
Char :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (char -> 'a,
'b, 'c, 'd,
'e, 'f)
CamlinternalFormatBasics.fmt
| Caml_char :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (char -> 'a,
'b, 'c, 'd,
'e, 'f)
CamlinternalFormatBasics.fmt
| String : ('x, string -> 'a) CamlinternalFormatBasics.padding *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Caml_string : ('x, string -> 'a) CamlinternalFormatBasics.padding *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Int : CamlinternalFormatBasics.int_conv *
('x, 'y) CamlinternalFormatBasics.padding *
('y, int -> 'a) CamlinternalFormatBasics.precision *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Int32 : CamlinternalFormatBasics.int_conv *
('x, 'y) CamlinternalFormatBasics.padding *
('y, int32 -> 'a) CamlinternalFormatBasics.precision *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Nativeint : CamlinternalFormatBasics.int_conv *
('x, 'y) CamlinternalFormatBasics.padding *
('y, nativeint -> 'a) CamlinternalFormatBasics.precision *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Int64 : CamlinternalFormatBasics.int_conv *
('x, 'y) CamlinternalFormatBasics.padding *
('y, int64 -> 'a) CamlinternalFormatBasics.precision *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Float : CamlinternalFormatBasics.float_conv *
('x, 'y) CamlinternalFormatBasics.padding *
('y, float -> 'a) CamlinternalFormatBasics.precision *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Bool :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (bool -> 'a,
'b, 'c, 'd,
'e, 'f)
CamlinternalFormatBasics.fmt
| Flush :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| String_literal : string *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Char_literal : char *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Format_arg : CamlinternalFormatBasics.pad_option *
('g, 'h, 'i, 'j, 'k, 'l) CamlinternalFormatBasics.fmtty *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (('g, 'h,
'i, 'j,
'k, 'l)
CamlinternalFormatBasics.format6 ->
'a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Format_subst : CamlinternalFormatBasics.pad_option *
('g, 'h, 'i, 'j, 'k, 'l, 'g2, 'b, 'c, 'j2, 'd, 'a)
CamlinternalFormatBasics.fmtty_rel *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (('g, 'h,
'i, 'j,
'k, 'l)
CamlinternalFormatBasics.format6 ->
'g2, 'b,
'c, 'j2,
'e, 'f)
CamlinternalFormatBasics.fmt
| Alpha :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (('b ->
'x -> 'c) ->
'x -> 'a,
'b, 'c, 'd,
'e, 'f)
CamlinternalFormatBasics.fmt
| Theta :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (('b -> 'c) ->
'a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Formatting_lit : CamlinternalFormatBasics.formatting_lit *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Formatting_gen :
('a1, 'b, 'c, 'd1, 'e1, 'f1) CamlinternalFormatBasics.formatting_gen *
('f1, 'b, 'c, 'e1, 'e2, 'f2) CamlinternalFormatBasics.fmt ->
('a1, 'b, 'c, 'd1, 'e2, 'f2) CamlinternalFormatBasics.fmt
| Reader :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('x -> 'a,
'b, 'c,
('b -> 'x) ->
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Scan_char_set : CamlinternalFormatBasics.pad_option *
CamlinternalFormatBasics.char_set *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (string ->
'a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Scan_get_counter : CamlinternalFormatBasics.counter *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (int -> 'a,
'b, 'c, 'd,
'e, 'f)
CamlinternalFormatBasics.fmt
| Scan_next_char :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> (char -> 'a,
'b, 'c, 'd,
'e, 'f)
CamlinternalFormatBasics.fmt
| Ignored_param :
('a, 'b, 'c, 'd, 'y, 'x) CamlinternalFormatBasics.ignored *
('x, 'b, 'c, 'y, 'e, 'f) CamlinternalFormatBasics.fmt -> ('a, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| Custom : ('a, 'x, 'y) CamlinternalFormatBasics.custom_arity *
(unit -> 'x) *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> ('y, 'b, 'c,
'd, 'e, 'f)
CamlinternalFormatBasics.fmt
| End_of_format : ('f, 'b, 'c, 'e, 'e, 'f) CamlinternalFormatBasics.fmt
and ('a, 'b, 'c, 'd, 'e, 'f) ignored =
Ignored_char :
('a, 'b, 'c, 'd, 'd, 'a) CamlinternalFormatBasics.ignored
| Ignored_caml_char :
('a, 'b, 'c, 'd, 'd, 'a) CamlinternalFormatBasics.ignored
| Ignored_string :
CamlinternalFormatBasics.pad_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_caml_string :
CamlinternalFormatBasics.pad_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_int : CamlinternalFormatBasics.int_conv *
CamlinternalFormatBasics.pad_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_int32 : CamlinternalFormatBasics.int_conv *
CamlinternalFormatBasics.pad_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_nativeint : CamlinternalFormatBasics.int_conv *
CamlinternalFormatBasics.pad_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_int64 : CamlinternalFormatBasics.int_conv *
CamlinternalFormatBasics.pad_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_float : CamlinternalFormatBasics.pad_option *
CamlinternalFormatBasics.prec_option -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_bool :
('a, 'b, 'c, 'd, 'd, 'a) CamlinternalFormatBasics.ignored
| Ignored_format_arg : CamlinternalFormatBasics.pad_option *
('g, 'h, 'i, 'j, 'k, 'l) CamlinternalFormatBasics.fmtty -> ('a, 'b,
'c, 'd,
'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_format_subst : CamlinternalFormatBasics.pad_option *
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty -> ('a, 'b,
'c, 'd,
'e, 'f)
CamlinternalFormatBasics.ignored
| Ignored_reader :
('a, 'b, 'c, ('b -> 'x) -> 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_scan_char_set : CamlinternalFormatBasics.pad_option *
CamlinternalFormatBasics.char_set -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_scan_get_counter :
CamlinternalFormatBasics.counter -> ('a, 'b, 'c, 'd, 'd, 'a)
CamlinternalFormatBasics.ignored
| Ignored_scan_next_char :
('a, 'b, 'c, 'd, 'd, 'a) CamlinternalFormatBasics.ignored
and ('a, 'b, 'c, 'd, 'e, 'f) format6 =
Format of ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt *
string
val concat_fmtty :
('g1, 'b1, 'c1, 'j1, 'd1, 'a1, 'g2, 'b2, 'c2, 'j2, 'd2, 'a2)
CamlinternalFormatBasics.fmtty_rel ->
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('g1, 'b1, 'c1, 'j1, 'e1, 'f1, 'g2, 'b2, 'c2, 'j2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel
val erase_rel :
('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'i, 'j, 'k, 'l)
CamlinternalFormatBasics.fmtty_rel ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty
val concat_fmt :
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt ->
('f, 'b, 'c, 'e, 'g, 'h) CamlinternalFormatBasics.fmt ->
('a, 'b, 'c, 'd, 'g, 'h) CamlinternalFormatBasics.fmt
end ocaml-doc-4.05/ocaml.html/libref/type_Longident.html 0000644 0001750 0001750 00000017116 13131636445 021425 0 ustar mehdi mehdi
sig
type t =
Lident of string
| Ldot of Longident.t * string
| Lapply of Longident.t * Longident.t
val flatten : Longident.t -> string list
val last : Longident.t -> string
val parse : string -> Longident.t
end ocaml-doc-4.05/ocaml.html/libref/type_Misc.Stdlib.List.html 0000644 0001750 0001750 00000026027 13131636445 022530 0 ustar mehdi mehdi
sig
type 'a t = 'a list
val compare :
('a -> 'a -> int) ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t -> int
val equal :
('a -> 'a -> bool) ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t -> bool
val filter_map :
('a -> 'b option) -> 'a Misc.Stdlib.List.t -> 'b Misc.Stdlib.List.t
val some_if_all_elements_are_some :
'a option Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t option
val map2_prefix :
('a -> 'b -> 'c) ->
'a Misc.Stdlib.List.t ->
'b Misc.Stdlib.List.t -> 'c Misc.Stdlib.List.t * 'b Misc.Stdlib.List.t
val split_at :
int ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t * 'a Misc.Stdlib.List.t
end ocaml-doc-4.05/ocaml.html/libref/Bytes.html 0000644 0001750 0001750 00000122553 13131636442 017526 0 ustar mehdi mehdi
module Bytes:sig..end
A byte sequence is a mutable data structure that contains a fixed-length sequence of bytes. Each byte can be indexed in constant time for reading or writing.
Given a byte sequence s of length l, we can access each of the
l bytes of s via its index in the sequence. Indexes start at
0, and we will call an index valid in s if it falls within the
range [0...l-1] (inclusive). A position is the point between two
bytes or at the beginning or end of the sequence. We call a
position valid in s if it falls within the range [0...l]
(inclusive). Note that the byte at index n is between positions
n and n+1.
Two parameters start and len are said to designate a valid
range of s if len >= 0 and start and start+len are valid
positions in s.
Byte sequences can be modified in place, for instance via the set
and blit functions described below. See also strings (module
String), which are almost the same data structure, but cannot be
modified in place.
Bytes are represented by the OCaml type char.
Since 4.02.0
val length : bytes -> intval get : bytes -> int -> charget s n returns the byte at index n in argument s.
Raise Invalid_argument if n is not a valid index in s.
val set : bytes -> int -> char -> unitset s n c modifies s in place, replacing the byte at index n
with c.
Raise Invalid_argument if n is not a valid index in s.
val create : int -> bytescreate n returns a new byte sequence of length n. The
sequence is uninitialized and contains arbitrary bytes.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val make : int -> char -> bytesmake n c returns a new byte sequence of length n, filled with
the byte c.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val init : int -> (int -> char) -> bytesBytes.init n f returns a fresh byte sequence of length n, with
character i initialized to the result of f i (in increasing
index order).
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val empty : bytesval copy : bytes -> bytesval of_string : string -> bytesval to_string : bytes -> stringval sub : bytes -> int -> int -> bytessub s start len returns a new byte sequence of length len,
containing the subsequence of s that starts at position start
and has length len.
Raise Invalid_argument if start and len do not designate a
valid range of s.
val sub_string : bytes -> int -> int -> stringsub but return a string instead of a byte sequence.val extend : bytes -> int -> int -> bytesextend s left right returns a new byte sequence that contains
the bytes of s, with left uninitialized bytes prepended and
right uninitialized bytes appended to it. If left or right
is negative, then bytes are removed (instead of appended) from
the corresponding side of s.
Raise Invalid_argument if the result length is negative or
longer than Sys.max_string_length bytes.
val fill : bytes -> int -> int -> char -> unitfill s start len c modifies s in place, replacing len
characters with c, starting at start.
Raise Invalid_argument if start and len do not designate a
valid range of s.
val blit : bytes -> int -> bytes -> int -> int -> unitblit src srcoff dst dstoff len copies len bytes from sequence
src, starting at index srcoff, to sequence dst, starting at
index dstoff. It works correctly even if src and dst are the
same byte sequence, and the source and destination intervals
overlap.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
val blit_string : string -> int -> bytes -> int -> int -> unitblit src srcoff dst dstoff len copies len bytes from string
src, starting at index srcoff, to byte sequence dst,
starting at index dstoff.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
val concat : bytes -> bytes list -> bytesconcat sep sl concatenates the list of byte sequences sl,
inserting the separator byte sequence sep between each, and
returns the result as a new byte sequence.
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
val cat : bytes -> bytes -> bytescat s1 s2 concatenates s1 and s2 and returns the result
as new byte sequence.
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
val iter : (char -> unit) -> bytes -> unititer f s applies function f in turn to all the bytes of s.
It is equivalent to f (get s 0); f (get s 1); ...; f (get s
(length s - 1)); ().val iteri : (int -> char -> unit) -> bytes -> unitBytes.iter, but the function is applied to the index of
the byte as first argument and the byte itself as second
argument.val map : (char -> char) -> bytes -> bytesmap f s applies function f in turn to all the bytes of s
(in increasing index order) and stores the resulting bytes in
a new sequence that is returned as the result.val mapi : (int -> char -> char) -> bytes -> bytesmapi f s calls f with each character of s and its
index (in increasing index order) and stores the resulting bytes
in a new sequence that is returned as the result.val trim : bytes -> bytes' ', '\012', '\n', '\r', and '\t'.val escaped : bytes -> bytes
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
val index : bytes -> char -> intindex s c returns the index of the first occurrence of byte c
in s.
Raise Not_found if c does not occur in s.
val index_opt : bytes -> char -> int optionindex_opt s c returns the index of the first occurrence of byte c
in s or None if c does not occur in s.val rindex : bytes -> char -> intrindex s c returns the index of the last occurrence of byte c
in s.
Raise Not_found if c does not occur in s.
val rindex_opt : bytes -> char -> int optionrindex_opt s c returns the index of the last occurrence of byte c
in s or None if c does not occur in s.val index_from : bytes -> int -> char -> intindex_from s i c returns the index of the first occurrence of
byte c in s after position i. Bytes.index s c is
equivalent to Bytes.index_from s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Raise Not_found if c does not occur in s after position i.
val index_from_opt : bytes -> int -> char -> int optionindex_from _opts i c returns the index of the first occurrence of
byte c in s after position i or None if c does not occur in s after position i.
Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Since 4.05
val rindex_from : bytes -> int -> char -> intrindex_from s i c returns the index of the last occurrence of
byte c in s before position i+1. rindex s c is equivalent
to rindex_from s (Bytes.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Raise Not_found if c does not occur in s before position i+1.
val rindex_from_opt : bytes -> int -> char -> int optionrindex_from_opt s i c returns the index of the last occurrence
of byte c in s before position i+1 or None if c does not
occur in s before position i+1. rindex_opt s c is equivalent to
rindex_from s (Bytes.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Since 4.05
val contains : bytes -> char -> boolcontains s c tests if byte c appears in s.val contains_from : bytes -> int -> char -> boolcontains_from s start c tests if byte c appears in s after
position start. contains s c is equivalent to contains_from
s 0 c.
Raise Invalid_argument if start is not a valid position in s.
val rcontains_from : bytes -> int -> char -> boolrcontains_from s stop c tests if byte c appears in s before
position stop+1.
Raise Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.
val uppercase : bytes -> bytesval lowercase : bytes -> bytesval capitalize : bytes -> bytesval uncapitalize : bytes -> bytesval uppercase_ascii : bytes -> bytesval lowercase_ascii : bytes -> bytesval capitalize_ascii : bytes -> bytesval uncapitalize_ascii : bytes -> bytestypet =bytes
val compare : t -> t -> intcompare. Along with the type t,
this function compare allows the module Bytes to be passed as
argument to the functors Set.Make and Map.Make.val equal : t -> t -> bool
This section describes unsafe, low-level conversion functions
between bytes and string. They do not copy the internal data;
used improperly, they can break the immutability invariant on
strings provided by the -safe-string option. They are available for
expert library authors, but for most purposes you should use the
always-correct Bytes.to_string and Bytes.of_string instead.
val unsafe_to_string : bytes -> string
To reason about the use of unsafe_to_string, it is convenient to
consider an "ownership" discipline. A piece of code that
manipulates some data "owns" it; there are several disjoint ownership
modes, including:
unsafe_to_string s can only be used when the caller owns the byte
sequence s -- either uniquely or as shared immutable data. The
caller gives up ownership of s, and gains ownership of the
returned string.
There are two valid use-cases that respect this ownership discipline:
1. Creating a string by initializing and mutating a byte sequence that is never changed after initialization is performed.
let string_init len f : string =
let s = Bytes.create len in
for i = 0 to len - 1 do Bytes.set s i (f i) done;
Bytes.unsafe_to_string s
This function is safe because the byte sequence s will never be
accessed or mutated after unsafe_to_string is called. The
string_init code gives up ownership of s, and returns the
ownership of the resulting string to its caller.
Note that it would be unsafe if s was passed as an additional
parameter to the function f as it could escape this way and be
mutated in the future -- string_init would give up ownership of
s to pass it to f, and could not call unsafe_to_string
safely.
We have provided the String.init, String.map and
String.mapi functions to cover most cases of building
new strings. You should prefer those over to_string or
unsafe_to_string whenever applicable.
2. Temporarily giving ownership of a byte sequence to a function that expects a uniquely owned string and returns ownership back, so that we can mutate the sequence again after the call ended.
let bytes_length (s : bytes) =
String.length (Bytes.unsafe_to_string s)
In this use-case, we do not promise that s will never be mutated
after the call to bytes_length s. The String.length function
temporarily borrows unique ownership of the byte sequence
(and sees it as a string), but returns this ownership back to
the caller, which may assume that s is still a valid byte
sequence after the call. Note that this is only correct because we
know that String.length does not capture its argument -- it could
escape by a side-channel such as a memoization combinator.
The caller may not mutate s while the string is borrowed (it has
temporarily given up ownership). This affects concurrent programs,
but also higher-order functions: if String.length returned
a closure to be called later, s should not be mutated until this
closure is fully applied and returns ownership.
val unsafe_of_string : string -> bytes
The same ownership discipline that makes unsafe_to_string
correct applies to unsafe_of_string: you may use it if you were
the owner of the string value, and you will own the return
bytes in the same mode.
In practice, unique ownership of string values is extremely difficult to reason about correctly. You should always assume strings are shared, never uniquely owned.
For example, string literals are implicitly shared by the compiler, so you never uniquely own them.
let incorrect = Bytes.unsafe_of_string "hello"
let s = Bytes.of_string "hello"
The first declaration is incorrect, because the string literal
"hello" could be shared by the compiler with other parts of the
program, and mutating incorrect is a bug. You must always use
the second version, which performs a copy and is thus correct.
Assuming unique ownership of strings that are not string
literals, but are (partly) built from string literals, is also
incorrect. For example, mutating unsafe_of_string ("foo" ^ s)
could mutate the shared string "foo" -- assuming a rope-like
representation of strings. More generally, functions operating on
strings will assume shared ownership, they do not preserve unique
ownership. It is thus incorrect to assume unique ownership of the
result of unsafe_of_string.
The only case we have reasonable confidence is safe is if the
produced bytes is shared -- used as an immutable byte
sequence. This is possibly useful for incremental migration of
low-level programs that manipulate immutable sequences of bytes
(for example Marshal.from_bytes) and previously used the
string type for this purpose.
sig
type 'a t
exception Failure
exception Error of string
val from : (int -> 'a option) -> 'a Stream.t
val of_list : 'a list -> 'a Stream.t
val of_string : string -> char Stream.t
val of_bytes : bytes -> char Stream.t
val of_channel : Pervasives.in_channel -> char Stream.t
val iter : ('a -> unit) -> 'a Stream.t -> unit
val next : 'a Stream.t -> 'a
val empty : 'a Stream.t -> unit
val peek : 'a Stream.t -> 'a option
val junk : 'a Stream.t -> unit
val count : 'a Stream.t -> int
val npeek : int -> 'a Stream.t -> 'a list
val iapp : 'a Stream.t -> 'a Stream.t -> 'a Stream.t
val icons : 'a -> 'a Stream.t -> 'a Stream.t
val ising : 'a -> 'a Stream.t
val lapp : (unit -> 'a Stream.t) -> 'a Stream.t -> 'a Stream.t
val lcons : (unit -> 'a) -> 'a Stream.t -> 'a Stream.t
val lsing : (unit -> 'a) -> 'a Stream.t
val sempty : 'a Stream.t
val slazy : (unit -> 'a Stream.t) -> 'a Stream.t
val dump : ('a -> unit) -> 'a Stream.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/Array.html 0000644 0001750 0001750 00000070601 13131636441 017511 0 ustar mehdi mehdi
module Array:sig..end
val length : 'a array -> intval get : 'a array -> int -> 'aArray.get a n returns the element number n of array a.
The first element has number 0.
The last element has number Array.length a - 1.
You can also write a.(n) instead of Array.get a n.
Raise Invalid_argument "index out of bounds"
if n is outside the range 0 to (Array.length a - 1).
val set : 'a array -> int -> 'a -> unitArray.set a n x modifies array a in place, replacing
element number n with x.
You can also write a.(n) <- x instead of Array.set a n x.
Raise Invalid_argument "index out of bounds"
if n is outside the range 0 to Array.length a - 1.
val make : int -> 'a -> 'a arrayArray.make n x returns a fresh array of length n,
initialized with x.
All the elements of this new array are initially
physically equal to x (in the sense of the == predicate).
Consequently, if x is mutable, it is shared among all elements
of the array, and modifying x through one of the array entries
will modify all other entries at the same time.
Raise Invalid_argument if n < 0 or n > Sys.max_array_length.
If the value of x is a floating-point number, then the maximum
size is only Sys.max_array_length / 2.
val create : int -> 'a -> 'a array
val create_float : int -> float arrayArray.create_float n returns a fresh float array of length n,
with uninitialized data.val make_float : int -> float array
val init : int -> (int -> 'a) -> 'a arrayArray.init n f returns a fresh array of length n,
with element number i initialized to the result of f i.
In other terms, Array.init n f tabulates the results of f
applied to the integers 0 to n-1.
Raise Invalid_argument if n < 0 or n > Sys.max_array_length.
If the return type of f is float, then the maximum
size is only Sys.max_array_length / 2.
val make_matrix : int -> int -> 'a -> 'a array arrayArray.make_matrix dimx dimy e returns a two-dimensional array
(an array of arrays) with first dimension dimx and
second dimension dimy. All the elements of this new matrix
are initially physically equal to e.
The element (x,y) of a matrix m is accessed
with the notation m.(x).(y).
Raise Invalid_argument if dimx or dimy is negative or
greater than Sys.max_array_length.
If the value of e is a floating-point number, then the maximum
size is only Sys.max_array_length / 2.
val create_matrix : int -> int -> 'a -> 'a array array
val append : 'a array -> 'a array -> 'a arrayArray.append v1 v2 returns a fresh array containing the
concatenation of the arrays v1 and v2.val concat : 'a array list -> 'a arrayArray.append, but concatenates a list of arrays.val sub : 'a array -> int -> int -> 'a arrayArray.sub a start len returns a fresh array of length len,
containing the elements number start to start + len - 1
of array a.
Raise Invalid_argument "Array.sub" if start and len do not
designate a valid subarray of a; that is, if
start < 0, or len < 0, or start + len > Array.length a.
val copy : 'a array -> 'a arrayArray.copy a returns a copy of a, that is, a fresh array
containing the same elements as a.val fill : 'a array -> int -> int -> 'a -> unitArray.fill a ofs len x modifies the array a in place,
storing x in elements number ofs to ofs + len - 1.
Raise Invalid_argument "Array.fill" if ofs and len do not
designate a valid subarray of a.
val blit : 'a array -> int -> 'a array -> int -> int -> unitArray.blit v1 o1 v2 o2 len copies len elements
from array v1, starting at element number o1, to array v2,
starting at element number o2. It works correctly even if
v1 and v2 are the same array, and the source and
destination chunks overlap.
Raise Invalid_argument "Array.blit" if o1 and len do not
designate a valid subarray of v1, or if o2 and len do not
designate a valid subarray of v2.
val to_list : 'a array -> 'a listArray.to_list a returns the list of all the elements of a.val of_list : 'a list -> 'a arrayArray.of_list l returns a fresh array containing the elements
of l.val iter : ('a -> unit) -> 'a array -> unitArray.iter f a applies function f in turn to all
the elements of a. It is equivalent to
f a.(0); f a.(1); ...; f a.(Array.length a - 1); ().val iteri : (int -> 'a -> unit) -> 'a array -> unitArray.iter, but the
function is applied with the index of the element as first argument,
and the element itself as second argument.val map : ('a -> 'b) -> 'a array -> 'b arrayArray.map f a applies function f to all the elements of a,
and builds an array with the results returned by f:
[| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |].val mapi : (int -> 'a -> 'b) -> 'a array -> 'b arrayArray.map, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.val fold_left : ('a -> 'b -> 'a) -> 'a -> 'b array -> 'aArray.fold_left f x a computes
f (... (f (f x a.(0)) a.(1)) ...) a.(n-1),
where n is the length of the array a.val fold_right : ('b -> 'a -> 'a) -> 'b array -> 'a -> 'aArray.fold_right f a x computes
f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...)),
where n is the length of the array a.val iter2 : ('a -> 'b -> unit) -> 'a array -> 'b array -> unitArray.iter2 f a b applies function f to all the elements of a
and b.
Raise Invalid_argument if the arrays are not the same size.val map2 : ('a -> 'b -> 'c) -> 'a array -> 'b array -> 'c arrayArray.map2 f a b applies function f to all the elements of a
and b, and builds an array with the results returned by f:
[| f a.(0) b.(0); ...; f a.(Array.length a - 1) b.(Array.length b - 1)|].
Raise Invalid_argument if the arrays are not the same size.val for_all : ('a -> bool) -> 'a array -> boolArray.for_all p [|a1; ...; an|] checks if all elements of the array
satisfy the predicate p. That is, it returns
(p a1) && (p a2) && ... && (p an).val exists : ('a -> bool) -> 'a array -> boolArray.exists p [|a1; ...; an|] checks if at least one element of
the array satisfies the predicate p. That is, it returns
(p a1) || (p a2) || ... || (p an).val mem : 'a -> 'a array -> boolmem a l is true if and only if a is equal
to an element of l.val memq : 'a -> 'a array -> boolArray.mem, but uses physical equality instead of structural
equality to compare array elements.val sort : ('a -> 'a -> int) -> 'a array -> unitcompare is
a suitable comparison function, provided there are no floating-point
NaN values in the data. After calling Array.sort, the
array is sorted in place in increasing order.
Array.sort is guaranteed to run in constant heap space
and (at most) logarithmic stack space.
The current implementation uses Heap Sort. It runs in constant stack space.
Specification of the comparison function:
Let a be the array and cmp the comparison function. The following
must be true for all x, y, z in a :
cmp x y > 0 if and only if cmp y x < 0cmp x y >= 0 and cmp y z >= 0 then cmp x z >= 0Array.sort returns, a contains the same elements as before,
reordered in such a way that for all i and j valid indices of a :cmp a.(i) a.(j) >= 0 if and only if i >= jval stable_sort : ('a -> 'a -> int) -> 'a array -> unitArray.sort, but the sorting algorithm is stable (i.e.
elements that compare equal are kept in their original order) and
not guaranteed to run in constant heap space.
The current implementation uses Merge Sort. It uses n/2
words of heap space, where n is the length of the array.
It is usually faster than the current implementation of Array.sort.
val fast_sort : ('a -> 'a -> int) -> 'a array -> unit
ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Csig.html 0000644 0001750 0001750 00000015474 13131636441 022455 0 ustar mehdi mehdi
sig
val mk :
Parsetree.core_type ->
Parsetree.class_type_field list -> Parsetree.class_signature
end ocaml-doc-4.05/ocaml.html/libref/type_Attr_helper.html 0000644 0001750 0001750 00000017554 13131636441 021755 0 ustar mehdi mehdi
sig
type error = Multiple_attributes of string | No_payload_expected of string
val get_no_payload_attribute :
string list -> Parsetree.attributes -> string Asttypes.loc option
val has_no_payload_attribute : string list -> Parsetree.attributes -> bool
exception Error of Location.t * Attr_helper.error
val report_error : Format.formatter -> Attr_helper.error -> unit
end ocaml-doc-4.05/ocaml.html/libref/Bigarray.Genarray.html 0000644 0001750 0001750 00000076013 13131636442 021746 0 ustar mehdi mehdi
module Genarray:sig..end
type ('a, 'b, 'c) t
Genarray.t is the type of big arrays with variable
numbers of dimensions. Any number of dimensions between 0 and 16
is supported.
The three type parameters to Genarray.t identify the array element
kind and layout, as follows:
'a, is the OCaml type for accessing array
elements (float, int, int32, int64, nativeint);'b, is the actual kind of array elements
(float32_elt, float64_elt, int8_signed_elt, int8_unsigned_elt,
etc);'c, identifies the array layout
(c_layout or fortran_layout).(float, float32_elt, fortran_layout) Genarray.t
is the type of generic big arrays containing 32-bit floats
in Fortran layout; reads and writes in this array use the
OCaml type float.val create : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int array -> ('a, 'b, 'c) tGenarray.create kind layout dimensions returns a new big array
whose element kind is determined by the parameter kind (one of
float32, float64, int8_signed, etc) and whose layout is
determined by the parameter layout (one of c_layout or
fortran_layout). The dimensions parameter is an array of
integers that indicate the size of the big array in each dimension.
The length of dimensions determines the number of dimensions
of the bigarray.
For instance, Genarray.create int32 c_layout [|4;6;8|]
returns a fresh big array of 32-bit integers, in C layout,
having three dimensions, the three dimensions being 4, 6 and 8
respectively.
Big arrays returned by Genarray.create are not initialized:
the initial values of array elements is unspecified.
Genarray.create raises Invalid_argument if the number of dimensions
is not in the range 0 to 16 inclusive, or if one of the dimensions
is negative.
val num_dims : ('a, 'b, 'c) t -> intval dims : ('a, 'b, 'c) t -> int arrayGenarray.dims a returns all dimensions of the big array a,
as an array of integers of length Genarray.num_dims a.val nth_dim : ('a, 'b, 'c) t -> int -> intGenarray.nth_dim a n returns the n-th dimension of the
big array a. The first dimension corresponds to n = 0;
the second dimension corresponds to n = 1; the last dimension,
to n = Genarray.num_dims a - 1.
Raise Invalid_argument if n is less than 0 or greater or equal than
Genarray.num_dims a.val kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kindval layout : ('a, 'b, 'c) t -> 'c Bigarray.layoutval change_layout : ('a, 'b, 'c) t ->
'd Bigarray.layout -> ('a, 'b, 'd) tGenarray.change_layout a layout returns a bigarray with the
specified layout, sharing the data with a (and hence having
the same dimensions as a). No copying of elements is involved: the
new array and the original array share the same storage space.
The dimensions are reversed, such that get v [| a; b |] in
C layout becomes get v [| b+1; a+1 |] in Fortran layout.val size_in_bytes : ('a, 'b, 'c) t -> intsize_in_bytes a is the number of elements in a multiplied
by a's Bigarray.kind_size_in_bytes.val get : ('a, 'b, 'c) t -> int array -> 'aGenarray.get a [|i1; ...; iN|] returns the element of a
whose coordinates are i1 in the first dimension, i2 in
the second dimension, ..., iN in the N-th dimension.
If a has C layout, the coordinates must be greater or equal than 0
and strictly less than the corresponding dimensions of a.
If a has Fortran layout, the coordinates must be greater or equal
than 1 and less or equal than the corresponding dimensions of a.
Raise Invalid_argument if the array a does not have exactly N
dimensions, or if the coordinates are outside the array bounds.
If N > 3, alternate syntax is provided: you can write
a.{i1, i2, ..., iN} instead of Genarray.get a [|i1; ...; iN|].
(The syntax a.{...} with one, two or three coordinates is
reserved for accessing one-, two- and three-dimensional arrays
as described below.)
val set : ('a, 'b, 'c) t -> int array -> 'a -> unitGenarray.set a [|i1; ...; iN|] v stores the value v in the
element of a whose coordinates are i1 in the first dimension,
i2 in the second dimension, ..., iN in the N-th dimension.
The array a must have exactly N dimensions, and all coordinates
must lie inside the array bounds, as described for Genarray.get;
otherwise, Invalid_argument is raised.
If N > 3, alternate syntax is provided: you can write
a.{i1, i2, ..., iN} <- v instead of
Genarray.set a [|i1; ...; iN|] v.
(The syntax a.{...} <- v with one, two or three coordinates is
reserved for updating one-, two- and three-dimensional arrays
as described below.)
val sub_left : ('a, 'b, Bigarray.c_layout) t ->
int -> int -> ('a, 'b, Bigarray.c_layout) tGenarray.sub_left a ofs len
returns a big array with the same number of dimensions as a,
and the same dimensions as a, except the first dimension,
which corresponds to the interval [ofs ... ofs + len - 1]
of the first dimension of a. No copying of elements is
involved: the sub-array and the original array share the same
storage space. In other terms, the element at coordinates
[|i1; ...; iN|] of the sub-array is identical to the
element at coordinates [|i1+ofs; ...; iN|] of the original
array a.
Genarray.sub_left applies only to big arrays in C layout.
Raise Invalid_argument if ofs and len do not designate
a valid sub-array of a, that is, if ofs < 0, or len < 0,
or ofs + len > Genarray.nth_dim a 0.
val sub_right : ('a, 'b, Bigarray.fortran_layout) t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) tGenarray.sub_right a ofs len
returns a big array with the same number of dimensions as a,
and the same dimensions as a, except the last dimension,
which corresponds to the interval [ofs ... ofs + len - 1]
of the last dimension of a. No copying of elements is
involved: the sub-array and the original array share the same
storage space. In other terms, the element at coordinates
[|i1; ...; iN|] of the sub-array is identical to the
element at coordinates [|i1; ...; iN+ofs|] of the original
array a.
Genarray.sub_right applies only to big arrays in Fortran layout.
Raise Invalid_argument if ofs and len do not designate
a valid sub-array of a, that is, if ofs < 1, or len < 0,
or ofs + len > Genarray.nth_dim a (Genarray.num_dims a - 1).
val slice_left : ('a, 'b, Bigarray.c_layout) t ->
int array -> ('a, 'b, Bigarray.c_layout) tGenarray.slice_left a [|i1; ... ; iM|] returns the 'slice'
of a obtained by setting the first M coordinates to
i1, ..., iM. If a has N dimensions, the slice has
dimension N - M, and the element at coordinates
[|j1; ...; j(N-M)|] in the slice is identical to the element
at coordinates [|i1; ...; iM; j1; ...; j(N-M)|] in the original
array a. No copying of elements is involved: the slice and
the original array share the same storage space.
Genarray.slice_left applies only to big arrays in C layout.
Raise Invalid_argument if M >= N, or if [|i1; ... ; iM|]
is outside the bounds of a.
val slice_right : ('a, 'b, Bigarray.fortran_layout) t ->
int array -> ('a, 'b, Bigarray.fortran_layout) tGenarray.slice_right a [|i1; ... ; iM|] returns the 'slice'
of a obtained by setting the last M coordinates to
i1, ..., iM. If a has N dimensions, the slice has
dimension N - M, and the element at coordinates
[|j1; ...; j(N-M)|] in the slice is identical to the element
at coordinates [|j1; ...; j(N-M); i1; ...; iM|] in the original
array a. No copying of elements is involved: the slice and
the original array share the same storage space.
Genarray.slice_right applies only to big arrays in Fortran layout.
Raise Invalid_argument if M >= N, or if [|i1; ... ; iM|]
is outside the bounds of a.
val blit : ('a, 'b, 'c) t -> ('a, 'b, 'c) t -> unitGenarray.blit src dst copies all elements of src into
dst. Both arrays src and dst must have the same number of
dimensions and equal dimensions. Copying a sub-array of src
to a sub-array of dst can be achieved by applying Genarray.blit
to sub-array or slices of src and dst.val fill : ('a, 'b, 'c) t -> 'a -> unitGenarray.fill a v stores the value v in all elements of
the big array a. Setting only some elements of a to v
can be achieved by applying Genarray.fill to a sub-array
or a slice of a.val map_file : Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> bool -> int array -> ('a, 'b, 'c) tGenarray.map_file fd kind layout shared dims
returns a big array of kind kind, layout layout,
and dimensions as specified in dims. The data contained in
this big array are the contents of the file referred to by
the file descriptor fd (as opened previously with
Unix.openfile, for example). The optional pos parameter
is the byte offset in the file of the data being mapped;
it defaults to 0 (map from the beginning of the file).
If shared is true, all modifications performed on the array
are reflected in the file. This requires that fd be opened
with write permissions. If shared is false, modifications
performed on the array are done in memory only, using
copy-on-write of the modified pages; the underlying file is not
affected.
Genarray.map_file is much more efficient than reading
the whole file in a big array, modifying that big array,
and writing it afterwards.
To adjust automatically the dimensions of the big array to
the actual size of the file, the major dimension (that is,
the first dimension for an array with C layout, and the last
dimension for an array with Fortran layout) can be given as
-1. Genarray.map_file then determines the major dimension
from the size of the file. The file must contain an integral
number of sub-arrays as determined by the non-major dimensions,
otherwise Failure is raised.
If all dimensions of the big array are given, the file size is
matched against the size of the big array. If the file is larger
than the big array, only the initial portion of the file is
mapped to the big array. If the file is smaller than the big
array, the file is automatically grown to the size of the big array.
This requires write permissions on fd.
Array accesses are bounds-checked, but the bounds are determined by
the initial call to map_file. Therefore, you should make sure no
other process modifies the mapped file while you're accessing it,
or a SIGBUS signal may be raised. This happens, for instance, if the
file is shrunk.
This function raises Sys_error in the case of any errors from the
underlying system calls. Invalid_argument or Failure may be
raised in cases where argument validation fails.
module Str:sig..end
val mk : ?loc:Ast_helper.loc ->
Parsetree.structure_item_desc -> Parsetree.structure_item
val eval : ?loc:Ast_helper.loc ->
?attrs:Parsetree.attributes ->
Parsetree.expression -> Parsetree.structure_item
val value : ?loc:Ast_helper.loc ->
Asttypes.rec_flag -> Parsetree.value_binding list -> Parsetree.structure_item
val primitive : ?loc:Ast_helper.loc ->
Parsetree.value_description -> Parsetree.structure_item
val type_ : ?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.type_declaration list -> Parsetree.structure_item
val type_extension : ?loc:Ast_helper.loc -> Parsetree.type_extension -> Parsetree.structure_item
val exception_ : ?loc:Ast_helper.loc ->
Parsetree.extension_constructor -> Parsetree.structure_item
val module_ : ?loc:Ast_helper.loc -> Parsetree.module_binding -> Parsetree.structure_item
val rec_module : ?loc:Ast_helper.loc ->
Parsetree.module_binding list -> Parsetree.structure_item
val modtype : ?loc:Ast_helper.loc ->
Parsetree.module_type_declaration -> Parsetree.structure_item
val open_ : ?loc:Ast_helper.loc -> Parsetree.open_description -> Parsetree.structure_item
val class_ : ?loc:Ast_helper.loc ->
Parsetree.class_declaration list -> Parsetree.structure_item
val class_type : ?loc:Ast_helper.loc ->
Parsetree.class_type_declaration list -> Parsetree.structure_item
val include_ : ?loc:Ast_helper.loc ->
Parsetree.include_declaration -> Parsetree.structure_item
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.structure_item
val attribute : ?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.structure_item
val text : Docstrings.text -> Parsetree.structure_item list ocaml-doc-4.05/ocaml.html/libref/Identifiable.S.Tbl.html 0000644 0001750 0001750 00000020422 13131636451 021730 0 ustar mehdi mehdi
module Tbl:sig..end
include Hashtbl.S
val to_list : 'a Identifiable.S.t -> (Identifiable.S.T.t * 'a) list
val of_list : (Identifiable.S.T.t * 'a) list -> 'a Identifiable.S.t
val to_map : 'a Identifiable.S.t -> 'a Identifiable.S.Map.t
val of_map : 'a Identifiable.S.Map.t -> 'a Identifiable.S.t
val memoize : 'a Identifiable.S.t -> (key -> 'a) -> key -> 'a
val map : 'a Identifiable.S.t -> ('a -> 'b) -> 'b Identifiable.S.t ocaml-doc-4.05/ocaml.html/libref/index_module_types.html 0000644 0001750 0001750 00000027530 13131636452 022340 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Ast_helper.str -> Parsetree.module_type -> Parsetree.module_declaration
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Mb.html 0000644 0001750 0001750 00000016412 13131636441 022117 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
Ast_helper.str -> Parsetree.module_expr -> Parsetree.module_binding
end ocaml-doc-4.05/ocaml.html/libref/type_BytesLabels.html 0000644 0001750 0001750 00000043063 13131636442 021710 0 ustar mehdi mehdi
sig
external length : bytes -> int = "%bytes_length"
external get : bytes -> int -> char = "%bytes_safe_get"
external set : bytes -> int -> char -> unit = "%bytes_safe_set"
external create : int -> bytes = "caml_create_bytes"
val make : int -> char -> bytes
val init : int -> f:(int -> char) -> bytes
val empty : bytes
val copy : bytes -> bytes
val of_string : string -> bytes
val to_string : bytes -> string
val sub : bytes -> pos:int -> len:int -> bytes
val sub_string : bytes -> int -> int -> string
val extend : bytes -> left:int -> right:int -> bytes
val fill : bytes -> pos:int -> len:int -> char -> unit
val blit :
src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
val blit_string :
src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
val concat : sep:bytes -> bytes list -> bytes
val cat : bytes -> bytes -> bytes
val iter : f:(char -> unit) -> bytes -> unit
val iteri : f:(int -> char -> unit) -> bytes -> unit
val map : f:(char -> char) -> bytes -> bytes
val mapi : f:(int -> char -> char) -> bytes -> bytes
val trim : bytes -> bytes
val escaped : bytes -> bytes
val index : bytes -> char -> int
val index_opt : bytes -> char -> int option
val rindex : bytes -> char -> int
val rindex_opt : bytes -> char -> int option
val index_from : bytes -> int -> char -> int
val index_from_opt : bytes -> int -> char -> int option
val rindex_from : bytes -> int -> char -> int
val rindex_from_opt : bytes -> int -> char -> int option
val contains : bytes -> char -> bool
val contains_from : bytes -> int -> char -> bool
val rcontains_from : bytes -> int -> char -> bool
val uppercase : bytes -> bytes
val lowercase : bytes -> bytes
val capitalize : bytes -> bytes
val uncapitalize : bytes -> bytes
val uppercase_ascii : bytes -> bytes
val lowercase_ascii : bytes -> bytes
val capitalize_ascii : bytes -> bytes
val uncapitalize_ascii : bytes -> bytes
type t = bytes
val compare : BytesLabels.t -> BytesLabels.t -> int
val equal : BytesLabels.t -> BytesLabels.t -> bool
external unsafe_get : bytes -> int -> char = "%bytes_unsafe_get"
external unsafe_set : bytes -> int -> char -> unit = "%bytes_unsafe_set"
external unsafe_blit :
src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unit
= "caml_blit_bytes" [@@noalloc]
external unsafe_fill : bytes -> pos:int -> len:int -> char -> unit
= "caml_fill_bytes" [@@noalloc]
val unsafe_to_string : bytes -> string
val unsafe_of_string : string -> bytes
end ocaml-doc-4.05/ocaml.html/libref/Ephemeron.GenHashTable.MakeSeeded.html 0000644 0001750 0001750 00000027505 13131636443 024636 0 ustar mehdi mehdi
module MakeSeeded:functor (H:sigtypetkeys
type'acontainercontains keys and the associated data
val hash :int -> t -> intsame asHashtbl.SeededHashedType
val equal :'a container ->
t -> Ephemeron.GenHashTable.equalequality predicate used to compare a key with the one in a container. Can returnEDeadif the keys in the container are dead
val create :t ->
'a -> 'a containercreate key datacreates a container from some initials keys and one data
val get_key :'a container ->
t optionget_key contreturns the keys if they are all alive
val get_data :'a container -> 'a optionget_data contreturns the data if it is alive
val set_key_data :'a container ->
t -> 'a -> unitset_key_data contmodifies the key and data
val check_key :'a container -> boolcheck_key contchecks if all the keys contained in the data are alive
end) ->Ephemeron.SeededSwith type key = H.t
| Parameters: |
|
include Hashtbl.SeededS
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingsmodule Oo:sig..end
val copy : (< .. > as 'a) -> 'aOo.copy o returns a copy of object o, that is a fresh
object with the same methods and instance variables as o.val id : < .. > -> intsig
type 'a t = 'a option
val equal :
('a -> 'a -> bool) ->
'a Misc.Stdlib.Option.t -> 'a Misc.Stdlib.Option.t -> bool
val iter : ('a -> unit) -> 'a Misc.Stdlib.Option.t -> unit
val map : ('a -> 'b) -> 'a Misc.Stdlib.Option.t -> 'b Misc.Stdlib.Option.t
val fold : ('a -> 'b -> 'b) -> 'a Misc.Stdlib.Option.t -> 'b -> 'b
val value_default :
('a -> 'b) -> default:'b -> 'a Misc.Stdlib.Option.t -> 'b
end ocaml-doc-4.05/ocaml.html/libref/type_Str.html 0000644 0001750 0001750 00000033051 13131636450 020242 0 ustar mehdi mehdi
sig
type regexp
val regexp : string -> Str.regexp
val regexp_case_fold : string -> Str.regexp
val quote : string -> string
val regexp_string : string -> Str.regexp
val regexp_string_case_fold : string -> Str.regexp
val string_match : Str.regexp -> string -> int -> bool
val search_forward : Str.regexp -> string -> int -> int
val search_backward : Str.regexp -> string -> int -> int
val string_partial_match : Str.regexp -> string -> int -> bool
val matched_string : string -> string
val match_beginning : unit -> int
val match_end : unit -> int
val matched_group : int -> string -> string
val group_beginning : int -> int
val group_end : int -> int
val global_replace : Str.regexp -> string -> string -> string
val replace_first : Str.regexp -> string -> string -> string
val global_substitute :
Str.regexp -> (string -> string) -> string -> string
val substitute_first : Str.regexp -> (string -> string) -> string -> string
val replace_matched : string -> string -> string
val split : Str.regexp -> string -> string list
val bounded_split : Str.regexp -> string -> int -> string list
val split_delim : Str.regexp -> string -> string list
val bounded_split_delim : Str.regexp -> string -> int -> string list
type split_result = Text of string | Delim of string
val full_split : Str.regexp -> string -> Str.split_result list
val bounded_full_split :
Str.regexp -> string -> int -> Str.split_result list
val string_before : string -> int -> string
val string_after : string -> int -> string
val first_chars : string -> int -> string
val last_chars : string -> int -> string
end ocaml-doc-4.05/ocaml.html/libref/ListLabels.html 0000644 0001750 0001750 00000101244 13131636445 020473 0 ustar mehdi mehdi
module ListLabels:sig..end
Some functions are flagged as not tail-recursive. A tail-recursive function uses constant stack space, while a non-tail-recursive function uses stack space proportional to the length of its list argument, which can be a problem with very long lists. When the function takes several list arguments, an approximate formula giving stack usage (in some unspecified constant unit) is shown in parentheses.
The above considerations can usually be ignored if your lists are not
longer than about 10000 elements.
val length : 'a list -> intval hd : 'a list -> 'aFailure "hd" if the list is empty.val compare_lengths : 'a list -> 'b list -> intcompare_lengths l1 l2 is
equivalent to compare (length l1) (length l2), except that
the computation stops after itering on the shortest list.val compare_length_with : 'a list -> len:int -> intcompare_length_with l n is
equivalent to compare (length l) n, except that
the computation stops after at most n iterations on the list.val cons : 'a -> 'a list -> 'a listcons x xs is x :: xsval tl : 'a list -> 'a listFailure "tl" if the list is empty.val nth : 'a list -> int -> 'an-th element of the given list.
The first element (head of the list) is at position 0.
Raise Failure "nth" if the list is too short.
Raise Invalid_argument "List.nth" if n is negative.val nth_opt : 'a list -> int -> 'a optionn-th element of the given list.
The first element (head of the list) is at position 0.
Return None if the list is too short.
Raise Invalid_argument "List.nth" if n is negative.val rev : 'a list -> 'a listval append : 'a list -> 'a list -> 'a list@.
Not tail-recursive (length of the first argument). The @
operator is not tail-recursive either.val rev_append : 'a list -> 'a list -> 'a listList.rev_append l1 l2 reverses l1 and concatenates it to l2.
This is equivalent to List.rev l1 @ l2, but rev_append is
tail-recursive and more efficient.val concat : 'a list list -> 'a listval flatten : 'a list list -> 'a listconcat. Not tail-recursive
(length of the argument + length of the longest sub-list).val iter : f:('a -> unit) -> 'a list -> unitList.iter f [a1; ...; an] applies function f in turn to
a1; ...; an. It is equivalent to
begin f a1; f a2; ...; f an; () end.val iteri : f:(int -> 'a -> unit) -> 'a list -> unitList.iter, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.val map : f:('a -> 'b) -> 'a list -> 'b listList.map f [a1; ...; an] applies function f to a1, ..., an,
and builds the list [f a1; ...; f an]
with the results returned by f. Not tail-recursive.val mapi : f:(int -> 'a -> 'b) -> 'a list -> 'b listList.map, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.val rev_map : f:('a -> 'b) -> 'a list -> 'b listList.rev_map f l gives the same result as
List.rev (List.map f l), but is tail-recursive and
more efficient.val fold_left : f:('a -> 'b -> 'a) -> init:'a -> 'b list -> 'aList.fold_left f a [b1; ...; bn] is
f (... (f (f a b1) b2) ...) bn.val fold_right : f:('a -> 'b -> 'b) -> 'a list -> init:'b -> 'bList.fold_right f [a1; ...; an] b is
f a1 (f a2 (... (f an b) ...)). Not tail-recursive.val iter2 : f:('a -> 'b -> unit) -> 'a list -> 'b list -> unitList.iter2 f [a1; ...; an] [b1; ...; bn] calls in turn
f a1 b1; ...; f an bn.
Raise Invalid_argument if the two lists are determined
to have different lengths.val map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c listList.map2 f [a1; ...; an] [b1; ...; bn] is
[f a1 b1; ...; f an bn].
Raise Invalid_argument if the two lists are determined
to have different lengths. Not tail-recursive.val rev_map2 : f:('a -> 'b -> 'c) -> 'a list -> 'b list -> 'c listList.rev_map2 f l1 l2 gives the same result as
List.rev (List.map2 f l1 l2), but is tail-recursive and
more efficient.val fold_left2 : f:('a -> 'b -> 'c -> 'a) -> init:'a -> 'b list -> 'c list -> 'aList.fold_left2 f a [b1; ...; bn] [c1; ...; cn] is
f (... (f (f a b1 c1) b2 c2) ...) bn cn.
Raise Invalid_argument if the two lists are determined
to have different lengths.val fold_right2 : f:('a -> 'b -> 'c -> 'c) -> 'a list -> 'b list -> init:'c -> 'cList.fold_right2 f [a1; ...; an] [b1; ...; bn] c is
f a1 b1 (f a2 b2 (... (f an bn c) ...)).
Raise Invalid_argument if the two lists are determined
to have different lengths. Not tail-recursive.val for_all : f:('a -> bool) -> 'a list -> boolfor_all p [a1; ...; an] checks if all elements of the list
satisfy the predicate p. That is, it returns
(p a1) && (p a2) && ... && (p an).val exists : f:('a -> bool) -> 'a list -> boolexists p [a1; ...; an] checks if at least one element of
the list satisfies the predicate p. That is, it returns
(p a1) || (p a2) || ... || (p an).val for_all2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> boolList.for_all, but for a two-argument predicate.
Raise Invalid_argument if the two lists are determined
to have different lengths.val exists2 : f:('a -> 'b -> bool) -> 'a list -> 'b list -> boolList.exists, but for a two-argument predicate.
Raise Invalid_argument if the two lists are determined
to have different lengths.val mem : 'a -> set:'a list -> boolmem a l is true if and only if a is equal
to an element of l.val memq : 'a -> set:'a list -> boolList.mem, but uses physical equality instead of structural
equality to compare list elements.val find : f:('a -> bool) -> 'a list -> 'afind p l returns the first element of the list l
that satisfies the predicate p.
Raise Not_found if there is no value that satisfies p in the
list l.val find_opt : f:('a -> bool) -> 'a list -> 'a optionfind p l returns the first element of the list l
that satisfies the predicate p.
Returns None if there is no value that satisfies p in the
list l.val filter : f:('a -> bool) -> 'a list -> 'a listfilter p l returns all the elements of the list l
that satisfy the predicate p. The order of the elements
in the input list is preserved.val find_all : f:('a -> bool) -> 'a list -> 'a list
val partition : f:('a -> bool) -> 'a list -> 'a list * 'a listpartition p l returns a pair of lists (l1, l2), where
l1 is the list of all the elements of l that
satisfy the predicate p, and l2 is the list of all the
elements of l that do not satisfy p.
The order of the elements in the input list is preserved.val assoc : 'a -> ('a * 'b) list -> 'bassoc a l returns the value associated with key a in the list of
pairs l. That is,
assoc a [ ...; (a,b); ...] = b
if (a,b) is the leftmost binding of a in list l.
Raise Not_found if there is no value associated with a in the
list l.val assoc_opt : 'a -> ('a * 'b) list -> 'b optionassoc_opt a l returns the value associated with key a in the list of
pairs l. That is,
assoc a [ ...; (a,b); ...] = b
if (a,b) is the leftmost binding of a in list l.
Returns None if there is no value associated with a in the
list l.val assq : 'a -> ('a * 'b) list -> 'bList.assoc, but uses physical equality instead of
structural equality to compare keys.val assq_opt : 'a -> ('a * 'b) list -> 'b optionList.assoc_opt, but uses physical equality instead of
structural equality to compare keys.val mem_assoc : 'a -> map:('a * 'b) list -> boolList.assoc, but simply return true if a binding exists,
and false if no bindings exist for the given key.val mem_assq : 'a -> map:('a * 'b) list -> boolList.mem_assoc, but uses physical equality instead of
structural equality to compare keys.val remove_assoc : 'a -> ('a * 'b) list -> ('a * 'b) listremove_assoc a l returns the list of
pairs l without the first pair with key a, if any.
Not tail-recursive.val remove_assq : 'a -> ('a * 'b) list -> ('a * 'b) listList.remove_assoc, but uses physical equality instead
of structural equality to compare keys. Not tail-recursive.val split : ('a * 'b) list -> 'a list * 'b listsplit [(a1,b1); ...; (an,bn)] is ([a1; ...; an], [b1; ...; bn]).
Not tail-recursive.val combine : 'a list -> 'b list -> ('a * 'b) listcombine [a1; ...; an] [b1; ...; bn] is
[(a1,b1); ...; (an,bn)].
Raise Invalid_argument if the two lists
have different lengths. Not tail-recursive.val sort : cmp:('a -> 'a -> int) -> 'a list -> 'a listcompare is a suitable comparison function.
The resulting list is sorted in increasing order.
List.sort is guaranteed to run in constant heap space
(in addition to the size of the result list) and logarithmic
stack space.
The current implementation uses Merge Sort. It runs in constant
heap space and logarithmic stack space.
val stable_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a listList.sort, but the sorting algorithm is guaranteed to
be stable (i.e. elements that compare equal are kept in their
original order) .
The current implementation uses Merge Sort. It runs in constant
heap space and logarithmic stack space.
val fast_sort : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val sort_uniq : cmp:('a -> 'a -> int) -> 'a list -> 'a list
val merge : cmp:('a -> 'a -> int) -> 'a list -> 'a list -> 'a listl1 and l2 are sorted according to the
comparison function cmp, merge cmp l1 l2 will return a
sorted list containting all the elements of l1 and l2.
If several elements compare equal, the elements of l1 will be
before the elements of l2.
Not tail-recursive (sum of the lengths of the arguments).module Typ:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.core_type_desc -> Parsetree.core_type
val attr : Parsetree.core_type -> Parsetree.attribute -> Parsetree.core_type
val any : ?loc:Ast_helper.loc -> ?attrs:Ast_helper.attrs -> unit -> Parsetree.core_type
val var : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> string -> Parsetree.core_type
val arrow : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.core_type -> Parsetree.core_type -> Parsetree.core_type
val tuple : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.core_type list -> Parsetree.core_type
val constr : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
val object_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
(Ast_helper.str * Parsetree.attributes * Parsetree.core_type) list ->
Asttypes.closed_flag -> Parsetree.core_type
val class_ : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.core_type
val alias : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.core_type -> string -> Parsetree.core_type
val variant : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.row_field list ->
Asttypes.closed_flag -> Asttypes.label list option -> Parsetree.core_type
val poly : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str list -> Parsetree.core_type -> Parsetree.core_type
val package : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid ->
(Ast_helper.lid * Parsetree.core_type) list -> Parsetree.core_type
val extension : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.core_type
val force_poly : Parsetree.core_type -> Parsetree.core_type
val varify_constructors : Ast_helper.str list -> Parsetree.core_type -> Parsetree.core_typevarify_constructors newtypes te is type expression te, of which
any of nullary type constructor tc is replaced by type variable of
the same name, if tc's name appears in newtypes.
Raise Syntaxerr.Variable_in_scope if any type variable inside te
appears in newtypes.sig
type obj_t = Obj.t
type t
val create : int -> Obj.Ephemeron.t
val length : Obj.Ephemeron.t -> int
val get_key : Obj.Ephemeron.t -> int -> Obj.Ephemeron.obj_t option
val get_key_copy : Obj.Ephemeron.t -> int -> Obj.Ephemeron.obj_t option
val set_key : Obj.Ephemeron.t -> int -> Obj.Ephemeron.obj_t -> unit
val unset_key : Obj.Ephemeron.t -> int -> unit
val check_key : Obj.Ephemeron.t -> int -> bool
val blit_key :
Obj.Ephemeron.t -> int -> Obj.Ephemeron.t -> int -> int -> unit
val get_data : Obj.Ephemeron.t -> Obj.Ephemeron.obj_t option
val get_data_copy : Obj.Ephemeron.t -> Obj.Ephemeron.obj_t option
val set_data : Obj.Ephemeron.t -> Obj.Ephemeron.obj_t -> unit
val unset_data : Obj.Ephemeron.t -> unit
val check_data : Obj.Ephemeron.t -> bool
val blit_data : Obj.Ephemeron.t -> Obj.Ephemeron.t -> unit
end ocaml-doc-4.05/ocaml.html/libref/Unix.LargeFile.html 0000644 0001750 0001750 00000036444 13131636451 021217 0 ustar mehdi mehdi
module LargeFile:sig..end
Unix.lseek (for positioning a file descriptor),
Unix.truncate and Unix.ftruncate (for changing the size of a file),
and Unix.stat, Unix.lstat and Unix.fstat (for obtaining
information on files). These alternate functions represent
positions and sizes by 64-bit integers (type int64) instead of
regular integers (type int), thus allowing operating on files
whose sizes are greater than max_int.val lseek : Unix.file_descr -> int64 -> Unix.seek_command -> int64Unix.lseek.val truncate : string -> int64 -> unitUnix.truncate.val ftruncate : Unix.file_descr -> int64 -> unitUnix.ftruncate.type
|
st_dev : |
(* |
Device number
| *) |
|
st_ino : |
(* |
Inode number
| *) |
|
st_kind : |
(* |
Kind of the file
| *) |
|
st_perm : |
(* |
Access rights
| *) |
|
st_nlink : |
(* |
Number of links
| *) |
|
st_uid : |
(* |
User id of the owner
| *) |
|
st_gid : |
(* |
Group ID of the file's group
| *) |
|
st_rdev : |
(* |
Device minor number
| *) |
|
st_size : |
(* |
Size in bytes
| *) |
|
st_atime : |
(* |
Last access time
| *) |
|
st_mtime : |
(* |
Last modification time
| *) |
|
st_ctime : |
(* |
Last status change time
| *) |
val stat : string -> stats
val lstat : string -> stats
val fstat : Unix.file_descr -> stats ocaml-doc-4.05/ocaml.html/libref/index_attributes.html 0000644 0001750 0001750 00000014756 13131636452 022023 0 ustar mehdi mehdi
module Parser:sig..end
type
| |
AMPERAMPER |
| |
AMPERSAND |
| |
AND |
| |
AS |
| |
ASSERT |
| |
BACKQUOTE |
| |
BANG |
| |
BAR |
| |
BARBAR |
| |
BARRBRACKET |
| |
BEGIN |
| |
CHAR of |
| |
CLASS |
| |
COLON |
| |
COLONCOLON |
| |
COLONEQUAL |
| |
COLONGREATER |
| |
COMMA |
| |
CONSTRAINT |
| |
DO |
| |
DONE |
| |
DOT |
| |
DOTDOT |
| |
DOWNTO |
| |
ELSE |
| |
END |
| |
EOF |
| |
EQUAL |
| |
EXCEPTION |
| |
EXTERNAL |
| |
FALSE |
| |
FLOAT of |
| |
FOR |
| |
FUN |
| |
FUNCTION |
| |
FUNCTOR |
| |
GREATER |
| |
GREATERRBRACE |
| |
GREATERRBRACKET |
| |
IF |
| |
IN |
| |
INCLUDE |
| |
INFIXOP0 of |
| |
INFIXOP1 of |
| |
INFIXOP2 of |
| |
INFIXOP3 of |
| |
INFIXOP4 of |
| |
INHERIT |
| |
INITIALIZER |
| |
INT of |
| |
LABEL of |
| |
LAZY |
| |
LBRACE |
| |
LBRACELESS |
| |
LBRACKET |
| |
LBRACKETBAR |
| |
LBRACKETLESS |
| |
LBRACKETGREATER |
| |
LBRACKETPERCENT |
| |
LBRACKETPERCENTPERCENT |
| |
LESS |
| |
LESSMINUS |
| |
LET |
| |
LIDENT of |
| |
LPAREN |
| |
LBRACKETAT |
| |
LBRACKETATAT |
| |
LBRACKETATATAT |
| |
MATCH |
| |
METHOD |
| |
MINUS |
| |
MINUSDOT |
| |
MINUSGREATER |
| |
MODULE |
| |
MUTABLE |
| |
NEW |
| |
NONREC |
| |
OBJECT |
| |
OF |
| |
OPEN |
| |
OPTLABEL of |
| |
OR |
| |
PERCENT |
| |
PLUS |
| |
PLUSDOT |
| |
PLUSEQ |
| |
PREFIXOP of |
| |
PRIVATE |
| |
QUESTION |
| |
QUOTE |
| |
RBRACE |
| |
RBRACKET |
| |
REC |
| |
RPAREN |
| |
SEMI |
| |
SEMISEMI |
| |
HASH |
| |
HASHOP of |
| |
SIG |
| |
STAR |
| |
STRING of |
| |
STRUCT |
| |
THEN |
| |
TILDE |
| |
TO |
| |
TRUE |
| |
TRY |
| |
TYPE |
| |
UIDENT of |
| |
UNDERSCORE |
| |
VAL |
| |
VIRTUAL |
| |
WHEN |
| |
WHILE |
| |
WITH |
| |
COMMENT of |
| |
DOCSTRING of |
| |
EOL |
val implementation : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> Parsetree.structure
val interface : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> Parsetree.signature
val toplevel_phrase : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> Parsetree.toplevel_phrase
val use_file : (Lexing.lexbuf -> token) ->
Lexing.lexbuf -> Parsetree.toplevel_phrase list
val parse_core_type : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> Parsetree.core_type
val parse_expression : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> Parsetree.expression
val parse_pattern : (Lexing.lexbuf -> token) -> Lexing.lexbuf -> Parsetree.pattern ocaml-doc-4.05/ocaml.html/libref/type_Big_int.html 0000644 0001750 0001750 00000053762 13131636441 021060 0 ustar mehdi mehdi
sig
type big_int
val zero_big_int : Big_int.big_int
val unit_big_int : Big_int.big_int
val minus_big_int : Big_int.big_int -> Big_int.big_int
val abs_big_int : Big_int.big_int -> Big_int.big_int
val add_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val succ_big_int : Big_int.big_int -> Big_int.big_int
val add_int_big_int : int -> Big_int.big_int -> Big_int.big_int
val sub_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val pred_big_int : Big_int.big_int -> Big_int.big_int
val mult_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val mult_int_big_int : int -> Big_int.big_int -> Big_int.big_int
val square_big_int : Big_int.big_int -> Big_int.big_int
val sqrt_big_int : Big_int.big_int -> Big_int.big_int
val quomod_big_int :
Big_int.big_int -> Big_int.big_int -> Big_int.big_int * Big_int.big_int
val div_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val mod_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val gcd_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val power_int_positive_int : int -> int -> Big_int.big_int
val power_big_int_positive_int : Big_int.big_int -> int -> Big_int.big_int
val power_int_positive_big_int : int -> Big_int.big_int -> Big_int.big_int
val power_big_int_positive_big_int :
Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val sign_big_int : Big_int.big_int -> int
val compare_big_int : Big_int.big_int -> Big_int.big_int -> int
val eq_big_int : Big_int.big_int -> Big_int.big_int -> bool
val le_big_int : Big_int.big_int -> Big_int.big_int -> bool
val ge_big_int : Big_int.big_int -> Big_int.big_int -> bool
val lt_big_int : Big_int.big_int -> Big_int.big_int -> bool
val gt_big_int : Big_int.big_int -> Big_int.big_int -> bool
val max_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val min_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val num_digits_big_int : Big_int.big_int -> int
val num_bits_big_int : Big_int.big_int -> int
val string_of_big_int : Big_int.big_int -> string
val big_int_of_string : string -> Big_int.big_int
val big_int_of_string_opt : string -> Big_int.big_int option
val big_int_of_int : int -> Big_int.big_int
val is_int_big_int : Big_int.big_int -> bool
val int_of_big_int : Big_int.big_int -> int
val int_of_big_int_opt : Big_int.big_int -> int option
val big_int_of_int32 : int32 -> Big_int.big_int
val big_int_of_nativeint : nativeint -> Big_int.big_int
val big_int_of_int64 : int64 -> Big_int.big_int
val int32_of_big_int : Big_int.big_int -> int32
val int32_of_big_int_opt : Big_int.big_int -> int32 option
val nativeint_of_big_int : Big_int.big_int -> nativeint
val nativeint_of_big_int_opt : Big_int.big_int -> nativeint option
val int64_of_big_int : Big_int.big_int -> int64
val int64_of_big_int_opt : Big_int.big_int -> int64 option
val float_of_big_int : Big_int.big_int -> float
val and_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val or_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val xor_big_int : Big_int.big_int -> Big_int.big_int -> Big_int.big_int
val shift_left_big_int : Big_int.big_int -> int -> Big_int.big_int
val shift_right_big_int : Big_int.big_int -> int -> Big_int.big_int
val shift_right_towards_zero_big_int :
Big_int.big_int -> int -> Big_int.big_int
val extract_big_int : Big_int.big_int -> int -> int -> Big_int.big_int
val nat_of_big_int : Big_int.big_int -> Nat.nat
val big_int_of_nat : Nat.nat -> Big_int.big_int
val base_power_big_int : int -> int -> Big_int.big_int -> Big_int.big_int
val sys_big_int_of_string : string -> int -> int -> Big_int.big_int
val round_futur_last_digit : bytes -> int -> int -> bool
val approx_big_int : int -> Big_int.big_int -> string
val round_big_int_to_float : Big_int.big_int -> bool -> float
end ocaml-doc-4.05/ocaml.html/libref/type_Builtin_attributes.html 0000644 0001750 0001750 00000023540 13131636442 023351 0 ustar mehdi mehdi
sig
val check_deprecated : Location.t -> Parsetree.attributes -> string -> unit
val deprecated_of_attrs : Parsetree.attributes -> string option
val deprecated_of_sig : Parsetree.signature -> string option
val deprecated_of_str : Parsetree.structure -> string option
val check_deprecated_mutable :
Location.t -> Parsetree.attributes -> string -> unit
val error_of_extension : Parsetree.extension -> Location.error
val warning_enter_scope : unit -> unit
val warning_leave_scope : unit -> unit
val warning_attribute : Parsetree.attributes -> unit
val with_warning_attribute : Parsetree.attributes -> (unit -> 'a) -> 'a
val emit_external_warnings : Ast_iterator.iterator
val warn_on_literal_pattern : Parsetree.attributes -> bool
val explicit_arity : Parsetree.attributes -> bool
val immediate : Parsetree.attributes -> bool
val has_unboxed : Parsetree.attributes -> bool
val has_boxed : Parsetree.attributes -> bool
end ocaml-doc-4.05/ocaml.html/libref/Misc.Stdlib.List.html 0000644 0001750 0001750 00000025267 13131636445 021474 0 ustar mehdi mehdi
module List:sig..end
type'at ='a list
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> intval equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> booltrue iff the given lists have the same length and content
with respect to the given equality function.val filter_map : ('a -> 'b option) -> 'a t -> 'b tfilter_map f l applies f to every element of l, filters
out the None elements and returns the list of the arguments of
the Some elements.val some_if_all_elements_are_some : 'a option t -> 'a t optionSome _ then Some xs
is returned with the xs being the contents of those Somes, with
order preserved. Otherwise return None.val map2_prefix : ('a -> 'b -> 'c) ->
'a t ->
'b t -> 'c t * 'b tlet r1, r2 = map2_prefix f l1 l2
If l1 is of length n and l2 = h2 @ t2 with h2 of length n,
r1 is List.map2 f l1 h1 and r2 is t2.val split_at : int -> 'a t -> 'a t * 'a tsplit_at n l returns the pair before, after where before is
the n first elements of l and after the remaining ones.
If l has less than n elements, raises Invalid_argument.sig
type key
type 'a t
val create : ?random:bool -> int -> 'a Hashtbl.SeededS.t
val clear : 'a Hashtbl.SeededS.t -> unit
val reset : 'a Hashtbl.SeededS.t -> unit
val copy : 'a Hashtbl.SeededS.t -> 'a Hashtbl.SeededS.t
val add : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a -> unit
val remove : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> unit
val find : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a
val find_opt : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a option
val find_all : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a list
val replace : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> 'a -> unit
val mem : 'a Hashtbl.SeededS.t -> Hashtbl.SeededS.key -> bool
val iter :
(Hashtbl.SeededS.key -> 'a -> unit) -> 'a Hashtbl.SeededS.t -> unit
val filter_map_inplace :
(Hashtbl.SeededS.key -> 'a -> 'a option) -> 'a Hashtbl.SeededS.t -> unit
val fold :
(Hashtbl.SeededS.key -> 'a -> 'b -> 'b) ->
'a Hashtbl.SeededS.t -> 'b -> 'b
val length : 'a Hashtbl.SeededS.t -> int
val stats : 'a Hashtbl.SeededS.t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/Numbers.html 0000644 0001750 0001750 00000017152 13131636447 020056 0 ustar mehdi mehdi
module Numbers:sig..end
Identifiable.S.module Int:sig..end
module Float:ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.K2.Make.html 0000644 0001750 0001750 00000027614 13131636443 022555 0 ustar mehdi mehdiIdentifiable.Swith type t = float
functor (H1 : Hashtbl.HashedType) (H2 : Hashtbl.HashedType) ->
sig
type key = H1.t * H2.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end ocaml-doc-4.05/ocaml.html/libref/StdLabels.html 0000644 0001750 0001750 00000020531 13131636450 020305 0 ustar mehdi mehdi
module StdLabels:sig..end
This meta-module provides labelized version of the Array,
Bytes, List and String modules.
They only differ by their labels. Detailed interfaces can be found
in arrayLabels.mli, bytesLabels.mli, listLabels.mli
and stringLabels.mli.
module Array: ArrayLabels
module Bytes: BytesLabels
module List: ListLabels
module String: StringLabels ocaml-doc-4.05/ocaml.html/libref/type_Misc.Color.html 0000644 0001750 0001750 00000023274 13131636446 021455 0 ustar mehdi mehdi
sig
type color = Black | Red | Green | Yellow | Blue | Magenta | Cyan | White
type style = FG of Misc.Color.color | BG of Misc.Color.color | Bold | Reset
val ansi_of_style_l : Misc.Color.style list -> string
type styles = {
error : Misc.Color.style list;
warning : Misc.Color.style list;
loc : Misc.Color.style list;
}
val default_styles : Misc.Color.styles
val get_styles : unit -> Misc.Color.styles
val set_styles : Misc.Color.styles -> unit
type setting = Auto | Always | Never
val setup : Misc.Color.setting option -> unit
val set_color_tag_handling : Format.formatter -> unit
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.html 0000644 0001750 0001750 00000357032 13131636447 021535 0 ustar mehdi mehdi
sig
module Hashtbl :
sig
type ('a, 'b) t = ('a, 'b) Hashtbl.t
val create : ?random:bool -> int -> ('a, 'b) MoreLabels.Hashtbl.t
val clear : ('a, 'b) MoreLabels.Hashtbl.t -> unit
val reset : ('a, 'b) MoreLabels.Hashtbl.t -> unit
val copy :
('a, 'b) MoreLabels.Hashtbl.t -> ('a, 'b) MoreLabels.Hashtbl.t
val add : ('a, 'b) MoreLabels.Hashtbl.t -> key:'a -> data:'b -> unit
val find : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> 'b
val find_opt : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> 'b option
val find_all : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> 'b list
val mem : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> bool
val remove : ('a, 'b) MoreLabels.Hashtbl.t -> 'a -> unit
val replace :
('a, 'b) MoreLabels.Hashtbl.t -> key:'a -> data:'b -> unit
val iter :
f:(key:'a -> data:'b -> unit) ->
('a, 'b) MoreLabels.Hashtbl.t -> unit
val filter_map_inplace :
f:(key:'a -> data:'b -> 'b option) ->
('a, 'b) MoreLabels.Hashtbl.t -> unit
val fold :
f:(key:'a -> data:'b -> 'c -> 'c) ->
('a, 'b) MoreLabels.Hashtbl.t -> init:'c -> 'c
val length : ('a, 'b) MoreLabels.Hashtbl.t -> int
val randomize : unit -> unit
val is_randomized : unit -> bool
type statistics = Hashtbl.statistics
val stats :
('a, 'b) MoreLabels.Hashtbl.t -> MoreLabels.Hashtbl.statistics
module type HashedType = Hashtbl.HashedType
module type SeededHashedType = Hashtbl.SeededHashedType
module type S =
sig
type key
and 'a t
val create : int -> 'a MoreLabels.Hashtbl.S.t
val clear : 'a MoreLabels.Hashtbl.S.t -> unit
val reset : 'a MoreLabels.Hashtbl.S.t -> unit
val copy : 'a MoreLabels.Hashtbl.S.t -> 'a MoreLabels.Hashtbl.S.t
val add :
'a MoreLabels.Hashtbl.S.t ->
key:MoreLabels.Hashtbl.S.key -> data:'a -> unit
val remove :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> unit
val find :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a
val find_opt :
'a MoreLabels.Hashtbl.S.t ->
MoreLabels.Hashtbl.S.key -> 'a option
val find_all :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> 'a list
val replace :
'a MoreLabels.Hashtbl.S.t ->
key:MoreLabels.Hashtbl.S.key -> data:'a -> unit
val mem :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.S.key -> bool
val iter :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> unit) ->
'a MoreLabels.Hashtbl.S.t -> unit
val filter_map_inplace :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> 'a option) ->
'a MoreLabels.Hashtbl.S.t -> unit
val fold :
f:(key:MoreLabels.Hashtbl.S.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Hashtbl.S.t -> init:'b -> 'b
val length : 'a MoreLabels.Hashtbl.S.t -> int
val stats :
'a MoreLabels.Hashtbl.S.t -> MoreLabels.Hashtbl.statistics
end
module type SeededS =
sig
type key
and 'a t
val create : ?random:bool -> int -> 'a MoreLabels.Hashtbl.SeededS.t
val clear : 'a MoreLabels.Hashtbl.SeededS.t -> unit
val reset : 'a MoreLabels.Hashtbl.SeededS.t -> unit
val copy :
'a MoreLabels.Hashtbl.SeededS.t ->
'a MoreLabels.Hashtbl.SeededS.t
val add :
'a MoreLabels.Hashtbl.SeededS.t ->
key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit
val remove :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> unit
val find :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a
val find_opt :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a option
val find_all :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> 'a list
val replace :
'a MoreLabels.Hashtbl.SeededS.t ->
key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit
val mem :
'a MoreLabels.Hashtbl.SeededS.t ->
MoreLabels.Hashtbl.SeededS.key -> bool
val iter :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> unit) ->
'a MoreLabels.Hashtbl.SeededS.t -> unit
val filter_map_inplace :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> 'a option) ->
'a MoreLabels.Hashtbl.SeededS.t -> unit
val fold :
f:(key:MoreLabels.Hashtbl.SeededS.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Hashtbl.SeededS.t -> init:'b -> 'b
val length : 'a MoreLabels.Hashtbl.SeededS.t -> int
val stats :
'a MoreLabels.Hashtbl.SeededS.t -> MoreLabels.Hashtbl.statistics
end
module Make :
functor (H : HashedType) ->
sig
type key = H.t
and 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val filter_map_inplace :
f:(key:key -> data:'a -> 'a option) -> 'a t -> unit
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end
module MakeSeeded :
functor (H : SeededHashedType) ->
sig
type key = H.t
and 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val filter_map_inplace :
f:(key:key -> data:'a -> 'a option) -> 'a t -> unit
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end
val hash : 'a -> int
val seeded_hash : int -> 'a -> int
val hash_param : int -> int -> 'a -> int
val seeded_hash_param : int -> int -> int -> 'a -> int
end
module Map :
sig
module type OrderedType = Map.OrderedType
module type S =
sig
type key
and +'a t
val empty : 'a MoreLabels.Map.S.t
val is_empty : 'a MoreLabels.Map.S.t -> bool
val mem : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> bool
val add :
key:MoreLabels.Map.S.key ->
data:'a -> 'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val singleton : MoreLabels.Map.S.key -> 'a -> 'a MoreLabels.Map.S.t
val remove :
MoreLabels.Map.S.key ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val merge :
f:(MoreLabels.Map.S.key -> 'a option -> 'b option -> 'c option) ->
'a MoreLabels.Map.S.t ->
'b MoreLabels.Map.S.t -> 'c MoreLabels.Map.S.t
val union :
f:(MoreLabels.Map.S.key -> 'a -> 'a -> 'a option) ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val compare :
cmp:('a -> 'a -> int) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> int
val equal :
cmp:('a -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t -> bool
val iter :
f:(key:MoreLabels.Map.S.key -> data:'a -> unit) ->
'a MoreLabels.Map.S.t -> unit
val fold :
f:(key:MoreLabels.Map.S.key -> data:'a -> 'b -> 'b) ->
'a MoreLabels.Map.S.t -> init:'b -> 'b
val for_all :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> bool
val exists :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> bool
val filter :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t -> 'a MoreLabels.Map.S.t
val partition :
f:(MoreLabels.Map.S.key -> 'a -> bool) ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t * 'a MoreLabels.Map.S.t
val cardinal : 'a MoreLabels.Map.S.t -> int
val bindings :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) list
val min_binding :
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val min_binding_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val max_binding :
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val max_binding_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val choose : 'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val choose_opt :
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val split :
MoreLabels.Map.S.key ->
'a MoreLabels.Map.S.t ->
'a MoreLabels.Map.S.t * 'a option * 'a MoreLabels.Map.S.t
val find : MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a
val find_opt :
MoreLabels.Map.S.key -> 'a MoreLabels.Map.S.t -> 'a option
val find_first :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val find_first_opt :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val find_last :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> MoreLabels.Map.S.key * 'a
val find_last_opt :
f:(MoreLabels.Map.S.key -> bool) ->
'a MoreLabels.Map.S.t -> (MoreLabels.Map.S.key * 'a) option
val map :
f:('a -> 'b) -> 'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t
val mapi :
f:(MoreLabels.Map.S.key -> 'a -> 'b) ->
'a MoreLabels.Map.S.t -> 'b MoreLabels.Map.S.t
end
module Make :
functor (Ord : OrderedType) ->
sig
type key = Ord.t
and +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key:key -> data:'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
f:(key -> 'a option -> 'b option -> 'c option) ->
'a t -> 'b t -> 'c t
val union :
f:(key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : cmp:('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : cmp:('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : f:(key:key -> data:'a -> unit) -> 'a t -> unit
val fold :
f:(key:key -> data:'a -> 'b -> 'b) -> 'a t -> init:'b -> 'b
val for_all : f:(key -> 'a -> bool) -> 'a t -> bool
val exists : f:(key -> 'a -> bool) -> 'a t -> bool
val filter : f:(key -> 'a -> bool) -> 'a t -> 'a t
val partition : f:(key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : f:(key -> bool) -> 'a t -> key * 'a
val find_first_opt : f:(key -> bool) -> 'a t -> (key * 'a) option
val find_last : f:(key -> bool) -> 'a t -> key * 'a
val find_last_opt : f:(key -> bool) -> 'a t -> (key * 'a) option
val map : f:('a -> 'b) -> 'a t -> 'b t
val mapi : f:(key -> 'a -> 'b) -> 'a t -> 'b t
end
end
module Set :
sig
module type OrderedType = Set.OrderedType
module type S =
sig
type elt
and t
val empty : MoreLabels.Set.S.t
val is_empty : MoreLabels.Set.S.t -> bool
val mem : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> bool
val add :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val singleton : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t
val remove :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val union :
MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val inter :
MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val diff :
MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val compare : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> int
val equal : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> bool
val subset : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> bool
val iter :
f:(MoreLabels.Set.S.elt -> unit) -> MoreLabels.Set.S.t -> unit
val map :
f:(MoreLabels.Set.S.elt -> MoreLabels.Set.S.elt) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val fold :
f:(MoreLabels.Set.S.elt -> 'a -> 'a) ->
MoreLabels.Set.S.t -> init:'a -> 'a
val for_all :
f:(MoreLabels.Set.S.elt -> bool) -> MoreLabels.Set.S.t -> bool
val exists :
f:(MoreLabels.Set.S.elt -> bool) -> MoreLabels.Set.S.t -> bool
val filter :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val partition :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t * MoreLabels.Set.S.t
val cardinal : MoreLabels.Set.S.t -> int
val elements : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt list
val min_elt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val min_elt_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val max_elt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val max_elt_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val choose : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val choose_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val split :
MoreLabels.Set.S.elt ->
MoreLabels.Set.S.t ->
MoreLabels.Set.S.t * bool * MoreLabels.Set.S.t
val find :
MoreLabels.Set.S.elt ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_opt :
MoreLabels.Set.S.elt ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val find_first :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_first_opt :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val find_last :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_last_opt :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val of_list : MoreLabels.Set.S.elt list -> MoreLabels.Set.S.t
end
module Make :
functor (Ord : OrderedType) ->
sig
type elt = Ord.t
and t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : f:(elt -> unit) -> t -> unit
val map : f:(elt -> elt) -> t -> t
val fold : f:(elt -> 'a -> 'a) -> t -> init:'a -> 'a
val for_all : f:(elt -> bool) -> t -> bool
val exists : f:(elt -> bool) -> t -> bool
val filter : f:(elt -> bool) -> t -> t
val partition : f:(elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : f:(elt -> bool) -> t -> elt
val find_first_opt : f:(elt -> bool) -> t -> elt option
val find_last : f:(elt -> bool) -> t -> elt
val find_last_opt : f:(elt -> bool) -> t -> elt option
val of_list : elt list -> t
end
end
end ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Val.html 0000644 0001750 0001750 00000016354 13131636441 022310 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?prim:string list ->
Ast_helper.str -> Parsetree.core_type -> Parsetree.value_description
end ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Hashtbl.SeededHashedType.html 0000644 0001750 0001750 00000014732 13131636446 026264 0 ustar mehdi mehdi
Hashtbl.SeededHashedType ocaml-doc-4.05/ocaml.html/libref/type_Sort.html 0000644 0001750 0001750 00000017401 13131636450 020422 0 ustar mehdi mehdi
sig
val list : ('a -> 'a -> bool) -> 'a list -> 'a list
val array : ('a -> 'a -> bool) -> 'a array -> unit
val merge : ('a -> 'a -> bool) -> 'a list -> 'a list -> 'a list
end ocaml-doc-4.05/ocaml.html/libref/type_Marshal.html 0000644 0001750 0001750 00000022620 13131636445 021065 0 ustar mehdi mehdi
sig
type extern_flags = No_sharing | Closures | Compat_32
val to_channel :
Pervasives.out_channel -> 'a -> Marshal.extern_flags list -> unit
external to_bytes : 'a -> Marshal.extern_flags list -> bytes
= "caml_output_value_to_string"
external to_string : 'a -> Marshal.extern_flags list -> string
= "caml_output_value_to_string"
val to_buffer :
bytes -> int -> int -> 'a -> Marshal.extern_flags list -> int
val from_channel : Pervasives.in_channel -> 'a
val from_bytes : bytes -> int -> 'a
val from_string : string -> int -> 'a
val header_size : int
val data_size : bytes -> int -> int
val total_size : bytes -> int -> int
end ocaml-doc-4.05/ocaml.html/libref/type_Strongly_connected_components.html 0000644 0001750 0001750 00000024313 13131636451 025604 0 ustar mehdi mehdi
sig
module type S =
sig
module Id : Identifiable.S
type directed_graph = Id.Set.t Id.Map.t
type component = Has_loop of Id.t list | No_loop of Id.t
val connected_components_sorted_from_roots_to_leaf :
Strongly_connected_components.S.directed_graph ->
Strongly_connected_components.S.component array
val component_graph :
Strongly_connected_components.S.directed_graph ->
(Strongly_connected_components.S.component * int list) array
end
module Make :
functor (Id : Identifiable.S) ->
sig
type directed_graph = Id.Set.t Id.Map.t
type component = Has_loop of Id.t list | No_loop of Id.t
val connected_components_sorted_from_roots_to_leaf :
directed_graph -> component array
val component_graph : directed_graph -> (component * int list) array
end
end ocaml-doc-4.05/ocaml.html/libref/type_Ephemeron.GenHashTable.html 0000644 0001750 0001750 00000043140 13131636443 023702 0 ustar mehdi mehdi
sig
type equal = ETrue | EFalse | EDead
module MakeSeeded :
functor
(H : sig
type t
type 'a container
val hash : int -> Ephemeron.GenHashTable.MakeSeeded.t -> int
val equal :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t ->
Ephemeron.GenHashTable.equal
val create :
Ephemeron.GenHashTable.MakeSeeded.t ->
'a -> 'a Ephemeron.GenHashTable.MakeSeeded.container
val get_key :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t option
val get_data :
'a Ephemeron.GenHashTable.MakeSeeded.container -> 'a option
val set_key_data :
'a Ephemeron.GenHashTable.MakeSeeded.container ->
Ephemeron.GenHashTable.MakeSeeded.t -> 'a -> unit
val check_key :
'a Ephemeron.GenHashTable.MakeSeeded.container -> bool
end) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statistics
val clean : 'a t -> unit
val stats_alive : 'a t -> Hashtbl.statistics
end
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Opn.html 0000644 0001750 0001750 00000017216 13131636441 021257 0 ustar mehdi mehdi
module Opn:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?override:Asttypes.override_flag ->
Ast_helper.lid -> Parsetree.open_description ocaml-doc-4.05/ocaml.html/libref/type_Map.Make.html 0000644 0001750 0001750 00000044002 13131636445 021065 0 ustar mehdi mehdi
functor (Ord : OrderedType) ->
sig
type key = Ord.t
type +'a t
val empty : 'a t
val is_empty : 'a t -> bool
val mem : key -> 'a t -> bool
val add : key -> 'a -> 'a t -> 'a t
val singleton : key -> 'a -> 'a t
val remove : key -> 'a t -> 'a t
val merge :
(key -> 'a option -> 'b option -> 'c option) -> 'a t -> 'b t -> 'c t
val union : (key -> 'a -> 'a -> 'a option) -> 'a t -> 'a t -> 'a t
val compare : ('a -> 'a -> int) -> 'a t -> 'a t -> int
val equal : ('a -> 'a -> bool) -> 'a t -> 'a t -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val for_all : (key -> 'a -> bool) -> 'a t -> bool
val exists : (key -> 'a -> bool) -> 'a t -> bool
val filter : (key -> 'a -> bool) -> 'a t -> 'a t
val partition : (key -> 'a -> bool) -> 'a t -> 'a t * 'a t
val cardinal : 'a t -> int
val bindings : 'a t -> (key * 'a) list
val min_binding : 'a t -> key * 'a
val min_binding_opt : 'a t -> (key * 'a) option
val max_binding : 'a t -> key * 'a
val max_binding_opt : 'a t -> (key * 'a) option
val choose : 'a t -> key * 'a
val choose_opt : 'a t -> (key * 'a) option
val split : key -> 'a t -> 'a t * 'a option * 'a t
val find : key -> 'a t -> 'a
val find_opt : key -> 'a t -> 'a option
val find_first : (key -> bool) -> 'a t -> key * 'a
val find_first_opt : (key -> bool) -> 'a t -> (key * 'a) option
val find_last : (key -> bool) -> 'a t -> key * 'a
val find_last_opt : (key -> bool) -> 'a t -> (key * 'a) option
val map : ('a -> 'b) -> 'a t -> 'b t
val mapi : (key -> 'a -> 'b) -> 'a t -> 'b t
end ocaml-doc-4.05/ocaml.html/libref/Identifiable.S.Set.html 0000644 0001750 0001750 00000020332 13131636451 021742 0 ustar mehdi mehdi
module Set:sig..end
include Set.S
val output : out_channel -> Identifiable.S.t -> unit
val print : Format.formatter -> Identifiable.S.t -> unit
val to_string : Identifiable.S.t -> string
val of_list : elt list -> Identifiable.S.t
val map : (elt -> elt) -> Identifiable.S.t -> Identifiable.S.t ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Const.html 0000644 0001750 0001750 00000020713 13131636441 021605 0 ustar mehdi mehdi
module Const:sig..end
val char : char -> Parsetree.constant
val string : ?quotation_delimiter:string -> string -> Parsetree.constant
val integer : ?suffix:char -> string -> Parsetree.constant
val int : ?suffix:char -> int -> Parsetree.constant
val int32 : ?suffix:char -> int32 -> Parsetree.constant
val int64 : ?suffix:char -> int64 -> Parsetree.constant
val nativeint : ?suffix:char -> nativeint -> Parsetree.constant
val float : ?suffix:char -> string -> Parsetree.constant ocaml-doc-4.05/ocaml.html/libref/Ephemeron.Kn.MakeSeeded.html 0000644 0001750 0001750 00000021333 13131636443 022712 0 ustar mehdi mehdi
module MakeSeeded:
Hashtbl.MakeSeeded.| Parameters: |
|
include Hashtbl.SeededS
val clean : 'a t -> unitval stats_alive : 'a t -> Hashtbl.statisticsHashtbl.SeededS.stats but only count the alive bindingssig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr_desc -> Parsetree.class_expr
val attr :
Parsetree.class_expr -> Parsetree.attribute -> Parsetree.class_expr
val constr :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.lid -> Parsetree.core_type list -> Parsetree.class_expr
val structure :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_structure -> Parsetree.class_expr
val fun_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.arg_label ->
Parsetree.expression option ->
Parsetree.pattern -> Parsetree.class_expr -> Parsetree.class_expr
val apply :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr ->
(Asttypes.arg_label * Parsetree.expression) list -> Parsetree.class_expr
val let_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Asttypes.rec_flag ->
Parsetree.value_binding list ->
Parsetree.class_expr -> Parsetree.class_expr
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.class_expr -> Parsetree.class_type -> Parsetree.class_expr
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.class_expr
end ocaml-doc-4.05/ocaml.html/libref/Stack.html 0000644 0001750 0001750 00000026302 13131636450 017477 0 ustar mehdi mehdi
module Stack:sig..end
This module implements stacks (LIFOs), with in-place modification.
type 'a t
'a.exception Empty
val create : unit -> 'a tval push : 'a -> 'a t -> unitpush x s adds the element x at the top of stack s.val pop : 'a t -> 'apop s removes and returns the topmost element in stack s,
or raises Stack.Empty if the stack is empty.val top : 'a t -> 'a
val clear : 'a t -> unitval copy : 'a t -> 'a tval is_empty : 'a t -> booltrue if the given stack is empty, false otherwise.val length : 'a t -> intval iter : ('a -> unit) -> 'a t -> unititer f s applies f in turn to all elements of s,
from the element at the top of the stack to the element at the
bottom of the stack. The stack itself is unchanged.val fold : ('b -> 'a -> 'b) -> 'b -> 'a t -> 'bfold f accu s is (f (... (f (f accu x1) x2) ...) xn)
where x1 is the top of the stack, x2 the second element,
and xn the bottom element. The stack is unchanged.module type OrderedType = Map.OrderedTypetype
val compare : t -> t -> intf such that
f e1 e2 is zero if the keys e1 and e2 are equal,
f e1 e2 is strictly negative if e1 is smaller than e2,
and f e1 e2 is strictly positive if e1 is greater than e2.
Example: a suitable ordering function is the generic structural
comparison function compare.module Terminfo:sig..end
type
| |
Uninitialised |
| |
Bad_term |
| |
Good_term of |
val setup : out_channel -> status
val backup : int -> unit
val standout : bool -> unit
val resume : int -> unit ocaml-doc-4.05/ocaml.html/libref/type_Misc.MakeHooks.html 0000644 0001750 0001750 00000016477 13131636446 022267 0 ustar mehdi mehdi
functor (M : sig type t end) ->
sig
type t = M.t
val add_hook : string -> (hook_info -> t -> t) -> unit
val apply_hooks : hook_info -> t -> t
end ocaml-doc-4.05/ocaml.html/libref/MoreLabels.Hashtbl.SeededHashedType.html 0000644 0001750 0001750 00000020517 13131636446 025221 0 ustar mehdi mehdi
module type SeededHashedType = Hashtbl.SeededHashedTypetype
val equal : t -> t -> boolval hash : int -> t -> intequal x y is true,
then hash seed x = hash seed y for any value of seed.
A suitable choice for hash is the function Hashtbl.seeded_hash
below.module Printf:sig..end
val fprintf : out_channel ->
('a, out_channel, unit) format -> 'afprintf outchan format arg1 ... argN formats the arguments
arg1 to argN according to the format string format, and
outputs the resulting string on the channel outchan.
The format string is a character string which contains two types of objects: plain characters, which are simply copied to the output channel, and conversion specifications, each of which causes conversion and printing of arguments.
Conversion specifications have the following form:
% [flags] [width] [.precision] type
In short, a conversion specification consists in the % character,
followed by optional modifiers and a type which is made of one or
two characters.
The types and their meanings are:
d, i: convert an integer argument to signed decimal.u, n, l, L, or N: convert an integer argument to
unsigned decimal. Warning: n, l, L, and N are
used for scanf, and should not be used for printf.x: convert an integer argument to unsigned hexadecimal,
using lowercase letters.X: convert an integer argument to unsigned hexadecimal,
using uppercase letters.o: convert an integer argument to unsigned octal.s: insert a string argument.S: convert a string argument to OCaml syntax (double quotes, escapes).c: insert a character argument.C: convert a character argument to OCaml syntax
(single quotes, escapes).f: convert a floating-point argument to decimal notation,
in the style dddd.ddd.F: convert a floating-point argument to OCaml syntax (dddd.
or dddd.ddd or d.ddd e+-dd).e or E: convert a floating-point argument to decimal notation,
in the style d.ddd e+-dd (mantissa and exponent).g or G: convert a floating-point argument to decimal notation,
in style f or e, E (whichever is more compact).h or H: convert a floating-point argument to hexadecimal notation,
in the style 0xh.hhhh e+-dd (hexadecimal mantissa, exponent in
decimal and denotes a power of 2).B: convert a boolean argument to the string true or falseb: convert a boolean argument (deprecated; do not use in new
programs).ld, li, lu, lx, lX, lo: convert an int32 argument to
the format specified by the second letter (decimal, hexadecimal, etc).nd, ni, nu, nx, nX, no: convert a nativeint argument to
the format specified by the second letter.Ld, Li, Lu, Lx, LX, Lo: convert an int64 argument to
the format specified by the second letter.a: user-defined printer. Take two arguments and apply the
first one to outchan (the current output channel) and to the
second argument. The first argument must therefore have type
out_channel -> 'b -> unit and the second 'b.
The output produced by the function is inserted in the output of
fprintf at the current point.t: same as %a, but take only one argument (with type
out_channel -> unit) and apply it to outchan.{ fmt %}: convert a format string argument to its type digest.
The argument must have the same type as the internal format string
fmt.( fmt %): format string substitution. Take a format string
argument and substitute it to the internal format string fmt
to print following arguments. The argument must have the same
type as the internal format string fmt.!: take no argument and flush the output.%: take no argument and output one % character.@: take no argument and output one @ character.,: take no argument and output nothing: a no-op delimiter for
conversion specifications.flags are:-: left-justify the output (default is right justification).0: for numerical conversions, pad with zeroes instead of spaces.+: for signed numerical conversions, prefix number with a +
sign if positive.#: request an alternate formatting style for the hexadecimal
and octal integer types (x, X, o, lx, lX, lo, Lx,
LX, Lo).width is an integer indicating the minimal
width of the result. For instance, %6d prints an integer,
prefixing it with spaces to fill at least 6 characters.
The optional precision is a dot . followed by an integer
indicating how many digits follow the decimal point in the %f,
%e, and %E conversions. For instance, %.4f prints a float with
4 fractional digits.
The integer in a width or precision can also be specified as
*, in which case an extra integer argument is taken to specify
the corresponding width or precision. This integer argument
precedes immediately the argument to print.
For instance, %.*f prints a float with as many fractional
digits as the value of the argument given before the float.
val printf : ('a, out_channel, unit) format -> 'a
val eprintf : ('a, out_channel, unit) format -> 'a
val sprintf : ('a, unit, string) format -> 'aPrintf.fprintf, but instead of printing on an output channel,
return a string containing the result of formatting the arguments.val bprintf : Buffer.t -> ('a, Buffer.t, unit) format -> 'aPrintf.fprintf, but instead of printing on an output channel,
append the formatted arguments to the given extensible buffer
(see module Buffer).val ifprintf : 'b -> ('a, 'b, 'c, unit) format4 -> 'aPrintf.fprintf, but does not print anything.
Useful to ignore some material when conditionally printing.val kfprintf : (out_channel -> 'd) ->
out_channel ->
('a, out_channel, unit, 'd) format4 -> 'afprintf, but instead of returning immediately,
passes the out channel to its first argument at the end of printing.val ikfprintf : ('b -> 'd) -> 'b -> ('a, 'b, 'c, 'd) format4 -> 'akfprintf above, but does not print anything.
Useful to ignore some material when conditionally printing.val ksprintf : (string -> 'd) -> ('a, unit, string, 'd) format4 -> 'asprintf above, but instead of returning the string,
passes it to the first argument.val kbprintf : (Buffer.t -> 'd) ->
Buffer.t -> ('a, Buffer.t, unit, 'd) format4 -> 'abprintf, but instead of returning immediately,
passes the buffer to its first argument at the end of printing.val kprintf : (string -> 'b) -> ('a, unit, string, 'b) format4 -> 'aksprintf.module Depend:sig..end
module StringSet:Set.Swith type elt = string
module StringMap:Map.Swith type key = string
type
| |
Node of |
typebound_map =map_tree StringMap.t
val make_leaf : string -> map_tree
val make_node : bound_map -> map_tree
val weaken_map : StringSet.t -> map_tree -> map_tree
val free_structure_names : StringSet.t ref
val open_module : bound_map -> Longident.t -> bound_map
val add_use_file : bound_map -> Parsetree.toplevel_phrase list -> unit
val add_signature : bound_map -> Parsetree.signature -> unit
val add_implementation : bound_map -> Parsetree.structure -> unit
val add_implementation_binding : bound_map -> Parsetree.structure -> bound_map
val add_signature_binding : bound_map -> Parsetree.signature -> bound_map ocaml-doc-4.05/ocaml.html/libref/type_Timings.html 0000644 0001750 0001750 00000033250 13131636451 021106 0 ustar mehdi mehdi
sig
type file = string
type source_provenance =
File of Timings.file
| Pack of string
| Startup
| Toplevel
type compiler_pass =
All
| Parsing of Timings.file
| Parser of Timings.file
| Dash_pp of Timings.file
| Dash_ppx of Timings.file
| Typing of Timings.file
| Transl of Timings.file
| Generate of Timings.file
| Assemble of Timings.source_provenance
| Clambda of Timings.source_provenance
| Cmm of Timings.source_provenance
| Compile_phrases of Timings.source_provenance
| Selection of Timings.source_provenance
| Comballoc of Timings.source_provenance
| CSE of Timings.source_provenance
| Liveness of Timings.source_provenance
| Deadcode of Timings.source_provenance
| Spill of Timings.source_provenance
| Split of Timings.source_provenance
| Regalloc of Timings.source_provenance
| Linearize of Timings.source_provenance
| Scheduling of Timings.source_provenance
| Emit of Timings.source_provenance
| Flambda_pass of string * Timings.source_provenance
val reset : unit -> unit
val get : Timings.compiler_pass -> float option
val time_call : Timings.compiler_pass -> (unit -> 'a) -> 'a
val time : Timings.compiler_pass -> ('a -> 'b) -> 'a -> 'b
val accumulate_time : Timings.compiler_pass -> ('a -> 'b) -> 'a -> 'b
val print : Format.formatter -> unit
end ocaml-doc-4.05/ocaml.html/libref/Parse.html 0000644 0001750 0001750 00000021213 13131636447 017506 0 ustar mehdi mehdi
module Parse:sig..end
val implementation : Lexing.lexbuf -> Parsetree.structure
val interface : Lexing.lexbuf -> Parsetree.signature
val toplevel_phrase : Lexing.lexbuf -> Parsetree.toplevel_phrase
val use_file : Lexing.lexbuf -> Parsetree.toplevel_phrase list
val core_type : Lexing.lexbuf -> Parsetree.core_type
val expression : Lexing.lexbuf -> Parsetree.expression
val pattern : Lexing.lexbuf -> Parsetree.pattern ocaml-doc-4.05/ocaml.html/libref/Ephemeron.K2.html 0000644 0001750 0001750 00000041531 13131636443 020632 0 ustar mehdi mehdi
module K2:sig..end
type ('k1, 'k2, 'd) t
val create : unit -> ('k1, 'k2, 'd) tEphemeron.K1.createval get_key1 : ('k1, 'k2, 'd) t -> 'k1 optionEphemeron.K1.get_keyval get_key1_copy : ('k1, 'k2, 'd) t -> 'k1 optionEphemeron.K1.get_key_copyval set_key1 : ('k1, 'k2, 'd) t -> 'k1 -> unitEphemeron.K1.set_keyval unset_key1 : ('k1, 'k2, 'd) t -> unitEphemeron.K1.unset_keyval check_key1 : ('k1, 'k2, 'd) t -> boolEphemeron.K1.check_keyval get_key2 : ('k1, 'k2, 'd) t -> 'k2 optionEphemeron.K1.get_keyval get_key2_copy : ('k1, 'k2, 'd) t -> 'k2 optionEphemeron.K1.get_key_copyval set_key2 : ('k1, 'k2, 'd) t -> 'k2 -> unitEphemeron.K1.set_keyval unset_key2 : ('k1, 'k2, 'd) t -> unitEphemeron.K1.unset_keyval check_key2 : ('k1, 'k2, 'd) t -> boolEphemeron.K1.check_keyval blit_key1 : ('k1, 'a, 'b) t -> ('k1, 'c, 'd) t -> unitEphemeron.K1.blit_keyval blit_key2 : ('a, 'k2, 'b) t -> ('c, 'k2, 'd) t -> unitEphemeron.K1.blit_keyval blit_key12 : ('k1, 'k2, 'a) t -> ('k1, 'k2, 'b) t -> unitEphemeron.K1.blit_keyval get_data : ('k1, 'k2, 'd) t -> 'd optionEphemeron.K1.get_dataval get_data_copy : ('k1, 'k2, 'd) t -> 'd optionEphemeron.K1.get_data_copyval set_data : ('k1, 'k2, 'd) t -> 'd -> unitEphemeron.K1.set_dataval unset_data : ('k1, 'k2, 'd) t -> unitEphemeron.K1.unset_dataval check_data : ('k1, 'k2, 'd) t -> boolEphemeron.K1.check_dataval blit_data : ('k1, 'k2, 'd) t -> ('k1, 'k2, 'd) t -> unitEphemeron.K1.blit_datamodule Make:
module MakeSeeded:
functor (H : HashedType) ->
sig
type key = H.t
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end ocaml-doc-4.05/ocaml.html/libref/type_Consistbl.html 0000644 0001750 0001750 00000022100 13131636443 021425 0 ustar mehdi mehdi
sig
type t
val create : unit -> Consistbl.t
val clear : Consistbl.t -> unit
val check : Consistbl.t -> string -> Digest.t -> string -> unit
val check_noadd : Consistbl.t -> string -> Digest.t -> string -> unit
val set : Consistbl.t -> string -> Digest.t -> string -> unit
val source : Consistbl.t -> string -> string
val extract : string list -> Consistbl.t -> (string * Digest.t option) list
val filter : (string -> bool) -> Consistbl.t -> unit
exception Inconsistency of string * string * string
exception Not_available of string
end ocaml-doc-4.05/ocaml.html/libref/Syntaxerr.html 0000644 0001750 0001750 00000026405 13131636451 020436 0 ustar mehdi mehdi
module Syntaxerr:sig..end
type
| |
Unclosed of |
| |
Expecting of |
| |
Not_expecting of |
| |
Applicative_path of |
| |
Variable_in_scope of |
| |
Other of |
| |
Ill_formed_ast of |
| |
Invalid_package_type of |
exception Error of error
exception Escape_error
val report_error : Format.formatter -> error -> unit
val location_of_error : error -> Location.t
val ill_formed_ast : Location.t -> string -> 'a ocaml-doc-4.05/ocaml.html/libref/type_StdLabels.Bytes.html 0000644 0001750 0001750 00000014703 13131636450 022437 0 ustar mehdi mehdi
(module BytesLabels) ocaml-doc-4.05/ocaml.html/libref/type_MoreLabels.Set.html 0000644 0001750 0001750 00000103435 13131636446 022262 0 ustar mehdi mehdi
sig
module type OrderedType = Set.OrderedType
module type S =
sig
type elt
and t
val empty : MoreLabels.Set.S.t
val is_empty : MoreLabels.Set.S.t -> bool
val mem : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> bool
val add :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val singleton : MoreLabels.Set.S.elt -> MoreLabels.Set.S.t
val remove :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val union :
MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val inter :
MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val diff :
MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val compare : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> int
val equal : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> bool
val subset : MoreLabels.Set.S.t -> MoreLabels.Set.S.t -> bool
val iter :
f:(MoreLabels.Set.S.elt -> unit) -> MoreLabels.Set.S.t -> unit
val map :
f:(MoreLabels.Set.S.elt -> MoreLabels.Set.S.elt) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val fold :
f:(MoreLabels.Set.S.elt -> 'a -> 'a) ->
MoreLabels.Set.S.t -> init:'a -> 'a
val for_all :
f:(MoreLabels.Set.S.elt -> bool) -> MoreLabels.Set.S.t -> bool
val exists :
f:(MoreLabels.Set.S.elt -> bool) -> MoreLabels.Set.S.t -> bool
val filter :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t
val partition :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t * MoreLabels.Set.S.t
val cardinal : MoreLabels.Set.S.t -> int
val elements : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt list
val min_elt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val min_elt_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val max_elt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val max_elt_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val choose : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val choose_opt : MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val split :
MoreLabels.Set.S.elt ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.t * bool * MoreLabels.Set.S.t
val find :
MoreLabels.Set.S.elt -> MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_opt :
MoreLabels.Set.S.elt ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val find_first :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_first_opt :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val find_last :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt
val find_last_opt :
f:(MoreLabels.Set.S.elt -> bool) ->
MoreLabels.Set.S.t -> MoreLabels.Set.S.elt option
val of_list : MoreLabels.Set.S.elt list -> MoreLabels.Set.S.t
end
module Make :
functor (Ord : OrderedType) ->
sig
type elt = Ord.t
and t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : f:(elt -> unit) -> t -> unit
val map : f:(elt -> elt) -> t -> t
val fold : f:(elt -> 'a -> 'a) -> t -> init:'a -> 'a
val for_all : f:(elt -> bool) -> t -> bool
val exists : f:(elt -> bool) -> t -> bool
val filter : f:(elt -> bool) -> t -> t
val partition : f:(elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : f:(elt -> bool) -> t -> elt
val find_first_opt : f:(elt -> bool) -> t -> elt option
val find_last : f:(elt -> bool) -> t -> elt
val find_last_opt : f:(elt -> bool) -> t -> elt option
val of_list : elt list -> t
end
end ocaml-doc-4.05/ocaml.html/libref/type_Targetint.html 0000644 0001750 0001750 00000034324 13131636451 021440 0 ustar mehdi mehdi
sig
type t
val zero : Targetint.t
val one : Targetint.t
val minus_one : Targetint.t
val neg : Targetint.t -> Targetint.t
val add : Targetint.t -> Targetint.t -> Targetint.t
val sub : Targetint.t -> Targetint.t -> Targetint.t
val mul : Targetint.t -> Targetint.t -> Targetint.t
val div : Targetint.t -> Targetint.t -> Targetint.t
val rem : Targetint.t -> Targetint.t -> Targetint.t
val succ : Targetint.t -> Targetint.t
val pred : Targetint.t -> Targetint.t
val abs : Targetint.t -> Targetint.t
val size : int
val max_int : Targetint.t
val min_int : Targetint.t
val logand : Targetint.t -> Targetint.t -> Targetint.t
val logor : Targetint.t -> Targetint.t -> Targetint.t
val logxor : Targetint.t -> Targetint.t -> Targetint.t
val lognot : Targetint.t -> Targetint.t
val shift_left : Targetint.t -> int -> Targetint.t
val shift_right : Targetint.t -> int -> Targetint.t
val shift_right_logical : Targetint.t -> int -> Targetint.t
val of_int : int -> Targetint.t
val of_int_exn : int -> Targetint.t
val to_int : Targetint.t -> int
val of_float : float -> Targetint.t
val to_float : Targetint.t -> float
val of_int32 : int32 -> Targetint.t
val to_int32 : Targetint.t -> int32
val of_int64 : int64 -> Targetint.t
val to_int64 : Targetint.t -> int64
val of_string : string -> Targetint.t
val to_string : Targetint.t -> string
val compare : Targetint.t -> Targetint.t -> int
val equal : Targetint.t -> Targetint.t -> bool
type repr = Int32 of int32 | Int64 of int64
val repr : Targetint.t -> Targetint.repr
end ocaml-doc-4.05/ocaml.html/libref/index_class_types.html 0000644 0001750 0001750 00000014744 13131636452 022163 0 ustar mehdi mehdi
module Spacetime:sig..end
To use the functions in this module you must:
exit, with whatever exit code, rather than being
abnormally terminated by a signal) so that the snapshot file is
correctly completed.
When using the automatic snapshot mode the profiling output is written to a file called "spacetime-<pid>" where <pid> is the process ID of the program. (If the program forks and continues executing then multiple files may be produced with different pid numbers.) The profiling output is by default written to the current working directory when the program starts. This may be customised by setting the OCAML_SPACETIME_SNAPSHOT_DIR environment variable to the name of the desired directory.
If using automatic snapshots the presence of the
save_event_for_automatic_snapshots function, below, should be noted.
The functions in this module are thread safe.
For functions to decode the information recorded by the profiler,
see the Spacetime offline library in otherlibs/.
val enabled : boolenabled is true if the compiler is configured with spacetime and false
otherwisemodule Series:sig..end
module Snapshot:sig..end
val save_event_for_automatic_snapshots : event_name:string -> unitSpacetime.Series.save_event, but writes to the automatic snapshot file.
This function is a no-op if OCAML_SPACETIME_INTERVAL was not set.sig type t val compare : Set.OrderedType.t -> Set.OrderedType.t -> int end ocaml-doc-4.05/ocaml.html/libref/CamlinternalFormat.html 0000644 0001750 0001750 00000053752 13131636442 022226 0 ustar mehdi mehdi
module CamlinternalFormat:sig..end
val is_in_char_set : CamlinternalFormatBasics.char_set -> char -> bool
val rev_char_set : CamlinternalFormatBasics.char_set -> CamlinternalFormatBasics.char_set
typemutable_char_set =bytes
val create_char_set : unit -> mutable_char_set
val add_in_char_set : mutable_char_set -> char -> unit
val freeze_char_set : mutable_char_set -> CamlinternalFormatBasics.char_set
type ('a, 'b, 'c, 'd, 'e, 'f) param_format_ebb =
| |
Param_format_EBB : |
val param_format_of_ignored_format : ('a, 'b, 'c, 'd, 'y, 'x) CamlinternalFormatBasics.ignored ->
('x, 'b, 'c, 'y, 'e, 'f) CamlinternalFormatBasics.fmt ->
('a, 'b, 'c, 'd, 'e, 'f) param_format_ebb
type ('b, 'c) acc_formatting_gen =
| |
Acc_open_tag of |
| |
Acc_open_box of |
type ('b, 'c) acc =
| |
Acc_formatting_lit of |
| |
Acc_formatting_gen of |
| |
Acc_string_literal of |
| |
Acc_char_literal of |
| |
Acc_data_string of |
| |
Acc_data_char of |
| |
Acc_delay of |
| |
Acc_flush of |
| |
Acc_invalid_arg of |
| |
End_of_acc |
type ('a, 'b) heter_list =
| |
Cons : |
| |
Nil : |
type ('b, 'c, 'e, 'f) fmt_ebb =
| |
Fmt_EBB : |
val make_printf : ('b -> ('b, 'c) acc -> 'd) ->
'b ->
('b, 'c) acc ->
('a, 'b, 'c, 'c, 'c, 'd) CamlinternalFormatBasics.fmt -> 'a
val make_iprintf : ('b -> 'f) ->
'b -> ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> 'a
val output_acc : out_channel ->
(out_channel, unit) acc -> unit
val bufput_acc : Buffer.t -> (Buffer.t, unit) acc -> unit
val strput_acc : Buffer.t -> (unit, string) acc -> unit
val type_format : ('x, 'b, 'c, 't, 'u, 'v) CamlinternalFormatBasics.fmt ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt
val fmt_ebb_of_string : ?legacy_behavior:bool ->
string -> ('b, 'c, 'e, 'f) fmt_ebb
val format_of_string_fmtty : string ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6
val format_of_string_format : string ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6 ->
('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.format6
val char_of_iconv : CamlinternalFormatBasics.int_conv -> char
val string_of_formatting_lit : CamlinternalFormatBasics.formatting_lit -> string
val string_of_formatting_gen : ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.formatting_gen -> string
val string_of_fmtty : ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmtty -> string
val string_of_fmt : ('a, 'b, 'c, 'd, 'e, 'f) CamlinternalFormatBasics.fmt -> string
val open_box_of_string : string -> int * CamlinternalFormatBasics.block_type
val symm : ('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('a2, 'b2, 'c2, 'd2, 'e2, 'f2, 'a1, 'b1, 'c1, 'd1, 'e1, 'f1)
CamlinternalFormatBasics.fmtty_rel
val trans : ('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('a2, 'b2, 'c2, 'd2, 'e2, 'f2, 'a3, 'b3, 'c3, 'd3, 'e3, 'f3)
CamlinternalFormatBasics.fmtty_rel ->
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a3, 'b3, 'c3, 'd3, 'e3, 'f3)
CamlinternalFormatBasics.fmtty_rel
val recast : ('a1, 'b1, 'c1, 'd1, 'e1, 'f1) CamlinternalFormatBasics.fmt ->
('a1, 'b1, 'c1, 'd1, 'e1, 'f1, 'a2, 'b2, 'c2, 'd2, 'e2, 'f2)
CamlinternalFormatBasics.fmtty_rel ->
('a2, 'b2, 'c2, 'd2, 'e2, 'f2) CamlinternalFormatBasics.fmt ocaml-doc-4.05/ocaml.html/libref/type_Ast_helper.Mod.html 0000644 0001750 0001750 00000026162 13131636441 022303 0 ustar mehdi mehdi
sig
val mk :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr_desc -> Parsetree.module_expr
val attr :
Parsetree.module_expr -> Parsetree.attribute -> Parsetree.module_expr
val ident :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Ast_helper.lid -> Parsetree.module_expr
val structure :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.structure -> Parsetree.module_expr
val functor_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Ast_helper.str ->
Parsetree.module_type option ->
Parsetree.module_expr -> Parsetree.module_expr
val apply :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr -> Parsetree.module_expr -> Parsetree.module_expr
val constraint_ :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.module_expr -> Parsetree.module_type -> Parsetree.module_expr
val unpack :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.expression -> Parsetree.module_expr
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs -> Parsetree.extension -> Parsetree.module_expr
end ocaml-doc-4.05/ocaml.html/libref/Ephemeron.Kn.html 0000644 0001750 0001750 00000032737 13131636443 020736 0 ustar mehdi mehdi
module Kn:sig..end
type ('k, 'd) t
val create : int -> ('k, 'd) tEphemeron.K1.createval get_key : ('k, 'd) t -> int -> 'k optionEphemeron.K1.get_keyval get_key_copy : ('k, 'd) t -> int -> 'k optionEphemeron.K1.get_key_copyval set_key : ('k, 'd) t -> int -> 'k -> unitEphemeron.K1.set_keyval unset_key : ('k, 'd) t -> int -> unitEphemeron.K1.unset_keyval check_key : ('k, 'd) t -> int -> boolEphemeron.K1.check_keyval blit_key : ('k, 'a) t ->
int -> ('k, 'b) t -> int -> int -> unitEphemeron.K1.blit_keyval get_data : ('k, 'd) t -> 'd optionEphemeron.K1.get_dataval get_data_copy : ('k, 'd) t -> 'd optionEphemeron.K1.get_data_copyval set_data : ('k, 'd) t -> 'd -> unitEphemeron.K1.set_dataval unset_data : ('k, 'd) t -> unitEphemeron.K1.unset_dataval check_data : ('k, 'd) t -> boolEphemeron.K1.check_dataval blit_data : ('k, 'd) t -> ('k, 'd) t -> unitEphemeron.K1.blit_datamodule Make:
module MakeSeeded:
| ( * ) [Pervasives] |
Integer multiplication.
|
| ( ** ) [Pervasives] |
Exponentiation.
|
| ( **/ ) [Num] |
Same as
Num.power_num.
|
| ( *. ) [Pervasives] |
Floating-point multiplication
|
| ( */ ) [Num] |
Same as
Num.mult_num.
|
| (!) [Pervasives] | !r returns the current contents of reference r.
|
| (!=) [Pervasives] |
Negation of
(==).
|
| (&&) [Pervasives] |
The boolean 'and'.
|
| (&) [Pervasives] | |
| (+) [Pervasives] |
Integer addition.
|
| (+.) [Pervasives] |
Floating-point addition
|
| (+/) [Num] |
Same as
Num.add_num.
|
| (-) [Pervasives] |
Integer subtraction.
|
| (-.) [Pervasives] |
Floating-point subtraction
|
| (-/) [Num] |
Same as
Num.sub_num.
|
| (/) [Pervasives] |
Integer division.
|
| (/.) [Pervasives] |
Floating-point division.
|
| (//) [Num] |
Same as
Num.div_num.
|
| (:=) [Pervasives] | r := a stores the value of a in reference r.
|
| (<) [Pervasives] |
See
(>=).
|
| (</) [Num] | |
| (<=) [Pervasives] |
See
(>=).
|
| (<=/) [Num] | |
| (<>) [Pervasives] |
Negation of
(=).
|
| (<>/) [Num] | |
| (=) [Pervasives] | e1 = e2 tests for structural equality of e1 and e2.
|
| (=/) [Num] | |
| (==) [Pervasives] | e1 == e2 tests for physical equality of e1 and e2.
|
| (>) [Pervasives] |
See
(>=).
|
| (>/) [Num] | |
| (>=) [Pervasives] |
Structural ordering functions.
|
| (>=/) [Num] | |
| (@) [Pervasives] |
List concatenation.
|
| (@@) [Pervasives] |
Application operator:
g @@ f @@ x is exactly equivalent to
g (f (x)).
|
| (^) [Pervasives] |
String concatenation.
|
| (^^) [Pervasives] | f1 ^^ f2 catenates format strings f1 and f2.
|
| (asr) [Pervasives] | n asr m shifts n to the right by m bits.
|
| (land) [Pervasives] |
Bitwise logical and.
|
| (lor) [Pervasives] |
Bitwise logical or.
|
| (lsl) [Pervasives] | n lsl m shifts n to the left by m bits.
|
| (lsr) [Pervasives] | n lsr m shifts n to the right by m bits.
|
| (lxor) [Pervasives] |
Bitwise logical exclusive or.
|
| (mod) [Pervasives] |
Integer remainder.
|
| (or) [Pervasives] | |
| (|>) [Pervasives] |
Reverse-application operator:
x |> f |> g is exactly equivalent
to g (f (x)).
|
| (||) [Pervasives] |
The boolean 'or'.
|
| (~+) [Pervasives] |
Unary addition.
|
| (~+.) [Pervasives] |
Unary addition.
|
| (~-) [Pervasives] |
Unary negation.
|
| (~-.) [Pervasives] |
Unary negation.
|
| __FILE__ [Pervasives] | __FILE__ returns the name of the file currently being
parsed by the compiler.
|
| __LINE_OF__ [Pervasives] | __LINE__ 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.
|
| __LINE__ [Pervasives] | __LINE__ returns the line number at which this expression
appears in the file currently being parsed by the compiler.
|
| __LOC_OF__ [Pervasives] | __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".
|
| __LOC__ [Pervasives] | __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".
|
| __MODULE__ [Pervasives] | __MODULE__ returns the module name of the file being
parsed by the compiler.
|
| __POS_OF__ [Pervasives] | __POS_OF__ expr returns a pair (loc,expr), 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.
|
| __POS__ [Pervasives] | __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.
|
A | |
| abs [Targetint] |
Return the absolute value of its argument.
|
| abs [Pervasives] |
Return the absolute value of the argument.
|
| abs [Nativeint] |
Return the absolute value of its argument.
|
| abs [Int64] |
Return the absolute value of its argument.
|
| abs [Int32] |
Return the absolute value of its argument.
|
| abs_big_int [Big_int] |
Absolute value.
|
| abs_float [Pervasives] | abs_float f returns the absolute value of f.
|
| abs_num [Num] |
Absolute value.
|
| absname [Location] | |
| absolute_path [Location] | |
| abstract_tag [Obj] | |
| accept [UnixLabels] |
Accept connections on the given socket.
|
| accept [Unix] |
Accept connections on the given socket.
|
| accept [ThreadUnix] | |
| access [UnixLabels] |
Check that the process has the given permissions over the named
file.
|
| access [Unix] |
Check that the process has the given permissions over the named file.
|
| accumulate_time [Timings] |
Like time for passes that can run multiple times
|
| acos [Pervasives] |
Arc cosine.
|
| adapt_filename [Dynlink] |
In bytecode, the identity function.
|
| add [Weak.S] | add t x adds x to t.
|
| add [Tbl] | |
| add [Targetint] |
Addition.
|
| add [Queue] | add x q adds the element x at the end of the queue q.
|
| add [Nativeint] |
Addition.
|
| add [MoreLabels.Set.S] | |
| add [MoreLabels.Map.S] | |
| add [MoreLabels.Hashtbl.SeededS] | |
| add [MoreLabels.Hashtbl.S] | |
| add [MoreLabels.Hashtbl] | |
| add [Int64] |
Addition.
|
| add [Int32] |
Addition.
|
| add [Hashtbl.SeededS] | |
| add [Hashtbl.S] | |
| add [Hashtbl] | Hashtbl.add tbl x y adds a binding of x to y in table tbl.
|
| add [Map.S] | add x y m returns a map containing the same bindings as
m, plus a binding of x to y.
|
| add [Set.S] | add x s returns a set containing all elements of s,
plus x.
|
| add [Complex] |
Addition
|
| add_arguments [Clflags] | |
| add_available_units [Dynlink] |
Same as
Dynlink.add_interfaces, but instead of searching .cmi files
to find the unit interfaces, uses the interface digests given
for each unit.
|
| add_base_override [Arg_helper.Make] | |
| add_big_int [Big_int] |
Addition.
|
| add_buffer [Buffer] | add_buffer b1 b2 appends the current contents of buffer b2
at the end of buffer b1.
|
| add_bytes [Buffer] | add_bytes b s appends the byte sequence s at the end of buffer b.
|
| add_channel [Buffer] | add_channel b ic n reads at most n characters from the
input channel ic and stores them at the end of buffer b.
|
| add_char [Buffer] | add_char b c appends the character c at the end of buffer b.
|
| add_docs_attrs [Docstrings] |
Convert item documentation to attributes and add them to an
attribute list
|
| add_hook [Misc.HookSig] | |
| add_implementation [Depend] | |
| add_implementation_binding [Depend] | |
| add_in_char_set [CamlinternalFormat] | |
| add_info_attrs [Docstrings] |
Convert field info to attributes and add them to an
attribute list
|
| add_initializer [CamlinternalOO] | |
| add_int_big_int [Big_int] |
Addition of a small integer to a big integer.
|
| add_interfaces [Dynlink] | add_interfaces units path grants dynamically-linked object
files access to the compilation units named in list units.
|
| add_num [Num] |
Addition
|
| add_offset [Obj] | |
| add_ppx_context_sig [Ast_mapper] |
Same as
add_ppx_context_str, but for signatures.
|
| add_ppx_context_str [Ast_mapper] |
Extract information from the current environment and encode it
into an attribute which is prepended to the list of structure
items in order to pass the information to an external
processor.
|
| add_signature [Depend] | |
| add_signature_binding [Depend] | |
| add_string [Buffer] | add_string b s appends the string s at the end of buffer b.
|
| add_subbytes [Buffer] | add_subbytes b s ofs len takes len characters from offset
ofs in byte sequence s and appends them at the end of buffer b.
|
| add_substitute [Buffer] | add_substitute b f s appends the string pattern s at the end
of buffer b with substitution.
|
| add_substring [Buffer] | add_substring b s ofs len takes len characters from offset
ofs in string s and appends them at the end of buffer b.
|
| add_text_attrs [Docstrings] |
Convert text to attributes and add them to an attribute list
|
| add_use_file [Depend] | |
| add_user_override [Arg_helper.Make] | |
| afl_inst_ratio [Clflags] | |
| afl_instrument [Config] | |
| afl_instrument [Clflags] | |
| alarm [UnixLabels] |
Schedule a
SIGALRM signal after the given number of seconds.
|
| alarm [Unix] |
Schedule a
SIGALRM signal after the given number of seconds.
|
| alias [Ast_helper.Mty] | |
| alias [Ast_helper.Pat] | |
| alias [Ast_helper.Typ] | |
| align [Misc] | |
| align [Arg] |
Align the documentation strings by inserting spaces at the first
space, according to the length of the keyword.
|
| all_ccopts [Clflags] | |
| all_passes [Clflags] | |
| all_ppx [Clflags] | |
| allocated_bytes [Gc] |
Return the total number of bytes allocated since the program was
started.
|
| allow_only [Dynlink] | allow_only units restricts the compilation units that
dynamically-linked units can reference: it forbids all references
to units other than those named in the list units.
|
| allow_unsafe_modules [Dynlink] |
Govern whether unsafe object files are allowed to be
dynamically linked.
|
| always [Event] | always v returns an event that is always ready for
synchronization.
|
| and_big_int [Big_int] |
Bitwise logical 'and'.
|
| annotations [Clflags] | |
| ansi_of_style_l [Misc.Color] | |
| any [Ast_helper.Pat] | |
| any [Ast_helper.Typ] | |
| append [ListLabels] |
Catenate two lists.
|
| append [List] |
Concatenate two lists.
|
| append [ArrayLabels] | Array.append v1 v2 returns a fresh array containing the
concatenation of the arrays v1 and v2.
|
| append [Array] | Array.append v1 v2 returns a fresh array containing the
concatenation of the arrays v1 and v2.
|
| applicative_functors [Clflags] | |
| apply [Ast_mapper] |
Apply a mapper (parametrized by the unit name) to a dumped
parsetree found in the
source file and put the result in the
target file.
|
| apply [Ast_helper.Cl] | |
| apply [Ast_helper.Mod] | |
| apply [Ast_helper.Exp] | |
| apply_hooks [Misc.HookSig] | |
| approx_num_exp [Num] |
Approximate a number by a decimal.
|
| approx_num_fix [Num] |
See
Num.approx_num_exp.
|
| ar [Config] | |
| architecture [Config] | |
| arg [Complex] |
Argument.
|
| arg_spec [Clflags] | |
| argv [Sys] |
The command line arguments given to the process.
|
| arith_status [Arith_status] |
Print the current status of the arithmetic flags.
|
| array [Sort] |
Sort an array in increasing order according to an
ordering predicate.
|
| array [Ast_helper.Exp] | |
| array [Ast_helper.Pat] | |
| array0_of_genarray [Bigarray] |
Return the zero-dimensional big array corresponding to the given
generic big array.
|
| array1_of_genarray [Bigarray] |
Return the one-dimensional big array corresponding to the given
generic big array.
|
| array2_of_genarray [Bigarray] |
Return the two-dimensional big array corresponding to the given
generic big array.
|
| array3_of_genarray [Bigarray] |
Return the three-dimensional big array corresponding to the given
generic big array.
|
| arrow [Ast_helper.Cty] | |
| arrow [Ast_helper.Typ] | |
| asin [Pervasives] |
Arc sine.
|
| asm [Config] | |
| asm_cfi_supported [Config] | |
| asprintf [Format] |
Same as
printf above, but instead of printing on a formatter,
returns a string containing the result of formatting the arguments.
|
| assert_ [Ast_helper.Exp] | |
| assoc [ListLabels] | assoc a l returns the value associated with key a in the list of
pairs l.
|
| assoc [List] | assoc a l returns the value associated with key a in the list of
pairs l.
|
| assoc_opt [ListLabels] | assoc_opt a l returns the value associated with key a in the list of
pairs l.
|
| assoc_opt [List] | assoc_opt a l returns the value associated with key a in the list of
pairs l.
|
| assq [ListLabels] |
Same as
List.assoc, but uses physical equality instead of
structural equality to compare keys.
|
| assq [List] |
Same as
List.assoc, but uses physical equality instead of structural
equality to compare keys.
|
| assq_opt [ListLabels] |
Same as
List.assoc_opt, but uses physical equality instead of
structural equality to compare keys.
|
| assq_opt [List] |
Same as
List.assoc_opt, but uses physical equality instead of structural
equality to compare keys.
|
| ast_impl_magic_number [Config] | |
| ast_intf_magic_number [Config] | |
| at_exit [Pervasives] |
Register the given function to be called at program
termination time.
|
| atan [Pervasives] |
Arc tangent.
|
| atan2 [Pervasives] | atan2 y x returns the arc tangent of y /. x.
|
| attr [Ast_helper.Cf] | |
| attr [Ast_helper.Cl] | |
| attr [Ast_helper.Ctf] | |
| attr [Ast_helper.Cty] | |
| attr [Ast_helper.Mod] | |
| attr [Ast_helper.Mty] | |
| attr [Ast_helper.Exp] | |
| attr [Ast_helper.Pat] | |
| attr [Ast_helper.Typ] | |
| attribute [Ast_helper.Cf] | |
| attribute [Ast_helper.Ctf] | |
| attribute [Ast_helper.Str] | |
| attribute [Ast_helper.Sig] | |
| attribute_of_warning [Ast_mapper] |
Encode a warning message into an 'ocaml.ppwarning' attribute which can be
inserted in a generated Parsetree.
|
| auto_synchronize [Graphics] |
By default, drawing takes place both on the window displayed
on screen, and in a memory area (the 'backing store').
|
B | |
| backend_type [Sys] |
Backend type currently executing the OCaml program.
|
| background [Graphics] |
See
Graphics.foreground.
|
| backtrace_slots [Printexc] |
Returns the slots of a raw backtrace, or
None if none of them
contain useful information.
|
| backtrace_status [Printexc] | Printexc.backtrace_status() returns true if exception
backtraces are currently recorded, false if not.
|
| backup [Warnings] | |
| backup [Terminfo] | |
| basename [Filename] |
Split a file name into directory name / base file name.
|
| beginning_of_input [Scanf.Scanning] | Scanning.beginning_of_input ic tests the beginning of input condition
of the given Scanf.Scanning.in_channel formatted input channel.
|
| big_endian [Sys] |
Whether the machine currently executing the Caml program is big-endian.
|
| big_int_of_int [Big_int] |
Convert a small integer to a big integer.
|
| big_int_of_int32 [Big_int] |
Convert a 32-bit integer to a big integer.
|
| big_int_of_int64 [Big_int] |
Convert a 64-bit integer to a big integer.
|
| big_int_of_nativeint [Big_int] |
Convert a native integer to a big integer.
|
| big_int_of_num [Num] | |
| big_int_of_num_opt [Num] | |
| big_int_of_string [Big_int] |
Convert a string to a big integer, in decimal.
|
| big_int_of_string_opt [Big_int] |
Convert a string to a big integer, in decimal.
|
| binary_annotations [Clflags] | |
| bind [UnixLabels] |
Bind a socket to an address.
|
| bind [Unix] |
Bind a socket to an address.
|
| bindings [MoreLabels.Map.S] | |
| bindings [Map.S] |
Return the list of all bindings of the given map.
|
| bits [Random.State] | |
| bits [Random] |
Return 30 random bits in a nonnegative integer.
|
| bits_of_float [Int64] |
Return the internal representation of the given float according
to the IEEE 754 floating-point 'double format' bit layout.
|
| bits_of_float [Int32] |
Return the internal representation of the given float according
to the IEEE 754 floating-point 'single format' bit layout.
|
| black [Graphics] | |
| blit [Weak] | Weak.blit ar1 off1 ar2 off2 len copies len weak pointers
from ar1 (starting at off1) to ar2 (starting at off2).
|
| blit [String] |
Same as
Bytes.blit_string.
|
| blit [StringLabels] | String.blit src srcoff dst dstoff len copies len bytes
from the string src, starting at index srcoff,
to byte sequence dst, starting at character number dstoff.
|
| blit [Misc.LongString] | |
| blit [BytesLabels] | blit src srcoff dst dstoff len copies len bytes from sequence
src, starting at index srcoff, to sequence dst, starting at
index dstoff.
|
| blit [Bytes] | blit src srcoff dst dstoff len copies len bytes from sequence
src, starting at index srcoff, to sequence dst, starting at
index dstoff.
|
| blit [Buffer] | Buffer.blit src srcoff dst dstoff len copies len characters from
the current contents of the buffer src, starting at offset srcoff
to dst, starting at character dstoff.
|
| blit [Bigarray.Array3] |
Copy the first big array to the second big array.
|
| blit [Bigarray.Array2] |
Copy the first big array to the second big array.
|
| blit [Bigarray.Array1] |
Copy the first big array to the second big array.
|
| blit [Bigarray.Array0] |
Copy the first big array to the second big array.
|
| blit [Bigarray.Genarray] |
Copy all elements of a big array in another big array.
|
| blit [ArrayLabels] | Array.blit v1 o1 v2 o2 len copies len elements
from array v1, starting at element number o1, to array v2,
starting at element number o2.
|
| blit [Array] | Array.blit v1 o1 v2 o2 len copies len elements
from array v1, starting at element number o1, to array v2,
starting at element number o2.
|
| blit_data [Obj.Ephemeron] |
Same as
Ephemeron.K1.blit_data
|
| blit_data [Ephemeron.Kn] |
Same as
Ephemeron.K1.blit_data
|
| blit_data [Ephemeron.K2] |
Same as
Ephemeron.K1.blit_data
|
| blit_data [Ephemeron.K1] | Ephemeron.K1.blit_data eph1 eph2 sets the data of eph2 with
the data of eph1.
|
| blit_image [Graphics] | blit_image img x y copies screen pixels into the image img,
modifying img in-place.
|
| blit_key [Obj.Ephemeron] |
Same as
Ephemeron.K1.blit_key
|
| blit_key [Ephemeron.Kn] |
Same as
Ephemeron.K1.blit_key
|
| blit_key [Ephemeron.K1] | Ephemeron.K1.blit_key eph1 eph2 sets the key of eph2 with
the key of eph1.
|
| blit_key1 [Ephemeron.K2] |
Same as
Ephemeron.K1.blit_key
|
| blit_key12 [Ephemeron.K2] |
Same as
Ephemeron.K1.blit_key
|
| blit_key2 [Ephemeron.K2] |
Same as
Ephemeron.K1.blit_key
|
| blit_string [BytesLabels] | blit src srcoff dst dstoff len copies len bytes from string
src, starting at index srcoff, to byte sequence dst,
starting at index dstoff.
|
| blit_string [Bytes] | blit src srcoff dst dstoff len copies len bytes from string
src, starting at index srcoff, to byte sequence dst,
starting at index dstoff.
|
| blue [Graphics] | |
| bool [Random.State] |
These functions are the same as the basic functions, except that they
use (and update) the given PRNG state instead of the default one.
|
| bool [Random] | Random.bool () returns true or false with probability 0.5 each.
|
| bool_of_string [Pervasives] |
Convert the given string to a boolean.
|
| bool_of_string_opt [Pervasives] |
Convert the given string to a boolean.
|
| bounded_full_split [Str] |
Same as
Str.bounded_split_delim, but returns
the delimiters as well as the substrings contained between
delimiters.
|
| bounded_split [Str] | |
| bounded_split_delim [Str] |
Same as
Str.bounded_split, but occurrences of the
delimiter at the beginning and at the end of the string are
recognized and returned as empty strings in the result.
|
| bprintf [Printf] |
Same as
Printf.fprintf, but instead of printing on an output channel,
append the formatted arguments to the given extensible buffer
(see module Buffer).
|
| bprintf [Format] | |
| broadcast [Condition] | broadcast c restarts all processes waiting on the
condition variable c.
|
| bscanf [Scanf] | |
| bscanf_format [Scanf] | bscanf_format ic fmt f reads a format string token from the formatted
input channel ic, according to the given format string fmt, and
applies f to the resulting format string value.
|
| bufput_acc [CamlinternalFormat] | |
| button_down [Graphics] |
Return
true if the mouse button is pressed, false otherwise.
|
| bytecode_compatible_32 [Clflags] | |
| bytecomp_c_compiler [Config] | |
| bytecomp_c_libraries [Config] | |
| bytes [Digest] |
Return the digest of the given byte sequence.
|
C | |
| c_compiler [Clflags] | |
| c_layout [Bigarray] | |
| call_linker [Ccomp] | |
| capitalize [String] |
Return a copy of the argument, with the first character set to uppercase,
using the ISO Latin-1 (8859-1) character set..
|
| capitalize [StringLabels] |
Return a copy of the argument, with the first character set to uppercase,
using the ISO Latin-1 (8859-1) character set..
|
| capitalize [BytesLabels] |
Return a copy of the argument, with the first character set to uppercase,
using the ISO Latin-1 (8859-1) character set..
|
| capitalize [Bytes] |
Return a copy of the argument, with the first character set to uppercase,
using the ISO Latin-1 (8859-1) character set..
|
| capitalize_ascii [String] |
Return a copy of the argument, with the first character set to uppercase,
using the US-ASCII character set.
|
| capitalize_ascii [StringLabels] |
Return a copy of the argument, with the first character set to uppercase,
using the US-ASCII character set.
|
| capitalize_ascii [BytesLabels] |
Return a copy of the argument, with the first character set to uppercase,
using the US-ASCII character set.
|
| capitalize_ascii [Bytes] |
Return a copy of the argument, with the first character set to uppercase,
using the US-ASCII character set.
|
| cardinal [MoreLabels.Set.S] | |
| cardinal [MoreLabels.Map.S] | |
| cardinal [Map.S] |
Return the number of bindings of a map.
|
| cardinal [Set.S] |
Return the number of elements of a set.
|
| case [Ast_helper.Exp] | |
| cat [BytesLabels] | cat s1 s2 concatenates s1 and s2 and returns the result
as new byte sequence.
|
| cat [Bytes] | cat s1 s2 concatenates s1 and s2 and returns the result
as new byte sequence.
|
| catch [Printexc] | Printexc.catch fn x is similar to Printexc.print, but
aborts the program with exit code 2 after printing the
uncaught exception.
|
| catch_break [Sys] | catch_break governs whether interactive interrupt (ctrl-C)
terminates the program or raises the Break exception.
|
| cc_profile [Config] | |
| ccobjs [Clflags] | |
| ccomp_type [Config] | |
| ceil [Pervasives] |
Round above to an integer value.
|
| ceiling_num [Num] | ceiling_num n returns the smallest integer bigger or equal to n.
|
| change_layout [Bigarray.Genarray] | Genarray.change_layout a layout returns a bigarray with the
specified layout, sharing the data with a (and hence having
the same dimensions as a).
|
| channel [Digest] |
If
len is nonnegative, Digest.channel ic len reads len
characters from channel ic and returns their digest, or raises
End_of_file if end-of-file is reached before len characters
are read.
|
| char [Bigarray] |
As shown by the types of the values above,
big arrays of kind
float32_elt and float64_elt are
accessed using the OCaml type float.
|
| char [Ast_helper.Const] | |
| char_of_iconv [CamlinternalFormat] | |
| char_of_int [Pervasives] |
Return the character with the given ASCII code.
|
| chdir [UnixLabels] |
Change the process working directory.
|
| chdir [Unix] |
Change the process working directory.
|
| chdir [Sys] |
Change the current working directory of the process.
|
| check [Weak] | Weak.check ar n returns true if the nth cell of ar is
full, false if it is empty.
|
| check [Consistbl] | |
| check_data [Obj.Ephemeron] |
Same as
Ephemeron.K1.check_data
|
| check_data [Ephemeron.Kn] |
Same as
Ephemeron.K1.check_data
|
| check_data [Ephemeron.K2] |
Same as
Ephemeron.K1.check_data
|
| check_data [Ephemeron.K1] | Ephemeron.K1.check_data eph returns true if the data of the eph
is full, false if it is empty.
|
| check_deprecated [Builtin_attributes] | |
| check_deprecated_mutable [Builtin_attributes] | |
| check_fatal [Warnings] | |
| check_key [Obj.Ephemeron] |
Same as
Ephemeron.K1.check_key
|
| check_key [Ephemeron.Kn] |
Same as
Ephemeron.K1.check_key
|
| check_key [Ephemeron.K1] | Ephemeron.K1.check_key eph returns true if the key of the eph
is full, false if it is empty.
|
| check_key1 [Ephemeron.K2] |
Same as
Ephemeron.K1.check_key
|
| check_key2 [Ephemeron.K2] |
Same as
Ephemeron.K1.check_key
|
| check_noadd [Consistbl] | |
| check_suffix [Filename] | check_suffix name suff returns true if the filename name
ends with the suffix suff.
|
| chmod [UnixLabels] |
Change the permissions of the named file.
|
| chmod [Unix] |
Change the permissions of the named file.
|
| choose [MoreLabels.Set.S] | |
| choose [MoreLabels.Map.S] | |
| choose [Event] | choose evl returns the event that is the alternative of
all the events in the list evl.
|
| choose [Map.S] |
Return one binding of the given map, or raise
Not_found if
the map is empty.
|
| choose [Set.S] |
Return one element of the given set, or raise
Not_found if
the set is empty.
|
| choose_opt [MoreLabels.Set.S] | |
| choose_opt [MoreLabels.Map.S] | |
| choose_opt [Map.S] |
Return one binding of the given map, or
None if
the map is empty.
|
| choose_opt [Set.S] |
Return one element of the given set, or
None if
the set is empty.
|
| chop_extension [Filename] |
Same as
Filename.remove_extension, but raise Invalid_argument
if the given name has an empty extension.
|
| chop_extensions [Misc] | |
| chop_suffix [Filename] | chop_suffix name suff removes the suffix suff from
the filename name.
|
| chown [UnixLabels] |
Change the owner uid and owner gid of the named file.
|
| chown [Unix] |
Change the owner uid and owner gid of the named file.
|
| chr [Char] |
Return the character with the given ASCII code.
|
| chroot [UnixLabels] |
Change the process root directory.
|
| chroot [Unix] |
Change the process root directory.
|
| clambda_checks [Clflags] | |
| class_ [Ast_helper.Str] | |
| class_ [Ast_helper.Sig] | |
| class_ [Ast_helper.Typ] | |
| class_type [Ast_helper.Str] | |
| class_type [Ast_helper.Sig] | |
| classic [Clflags] | |
| classic_arguments [Clflags] | |
| classic_inlining [Clflags] | |
| classify_float [Pervasives] |
Return the class of the given floating-point number:
normal, subnormal, zero, infinite, or not a number.
|
| clean [Ephemeron.SeededS] |
remove all dead bindings.
|
| clean [Ephemeron.S] |
remove all dead bindings.
|
| clear [Weak.S] |
Remove all elements from the table.
|
| clear [Stack] |
Discard all elements from a stack.
|
| clear [Queue] |
Discard all elements from a queue.
|
| clear [MoreLabels.Hashtbl.SeededS] | |
| clear [MoreLabels.Hashtbl.S] | |
| clear [MoreLabels.Hashtbl] | |
| clear [Hashtbl.SeededS] | |
| clear [Hashtbl.S] | |
| clear [Hashtbl] |
Empty a hash table.
|
| clear [Consistbl] | |
| clear [Buffer] |
Empty the buffer.
|
| clear_available_units [Dynlink] |
Empty the list of compilation units accessible to dynamically-linked
programs.
|
| clear_close_on_exec [UnixLabels] |
Clear the ``close-on-exec'' flag on the given descriptor.
|
| clear_close_on_exec [Unix] |
Clear the ``close-on-exec'' flag on the given descriptor.
|
| clear_graph [Graphics] |
Erase the graphics window.
|
| clear_nonblock [UnixLabels] |
Clear the ``non-blocking'' flag on the given descriptor.
|
| clear_nonblock [Unix] |
Clear the ``non-blocking'' flag on the given descriptor.
|
| clear_parser [Parsing] |
Empty the parser stack.
|
| close [UnixLabels] |
Close a file descriptor.
|
| close [Unix] |
Close a file descriptor.
|
| close_box [Format] |
Closes the most recently opened pretty-printing box.
|
| close_graph [Graphics] |
Delete the graphics window or switch the screen back to text mode.
|
| close_in [Scanf.Scanning] |
Closes the
in_channel associated with the given
Scanf.Scanning.in_channel formatted input channel.
|
| close_in [Pervasives] |
Close the given channel.
|
| close_in_noerr [Pervasives] |
Same as
close_in, but ignore all errors.
|
| close_out [Pervasives] |
Close the given channel, flushing all buffered write operations.
|
| close_out_noerr [Pervasives] |
Same as
close_out, but ignore all errors.
|
| close_process [UnixLabels] |
Close channels opened by
UnixLabels.open_process,
wait for the associated command to terminate,
and return its termination status.
|
| close_process [Unix] |
Close channels opened by
Unix.open_process,
wait for the associated command to terminate,
and return its termination status.
|
| close_process_full [UnixLabels] |
Close channels opened by
UnixLabels.open_process_full,
wait for the associated command to terminate,
and return its termination status.
|
| close_process_full [Unix] |
Close channels opened by
Unix.open_process_full,
wait for the associated command to terminate,
and return its termination status.
|
| close_process_in [UnixLabels] |
Close channels opened by
UnixLabels.open_process_in,
wait for the associated command to terminate,
and return its termination status.
|
| close_process_in [Unix] |
Close channels opened by
Unix.open_process_in,
wait for the associated command to terminate,
and return its termination status.
|
| close_process_out [UnixLabels] |
Close channels opened by
UnixLabels.open_process_out,
wait for the associated command to terminate,
and return its termination status.
|
| close_process_out [Unix] |
Close channels opened by
Unix.open_process_out,
wait for the associated command to terminate,
and return its termination status.
|
| close_subwindow [GraphicsX11] |
Close the sub-window having the given identifier.
|
| close_tag [Format] | close_tag () closes the most recently opened tag t.
|
| close_tbox [Format] | |
| closedir [UnixLabels] |
Close a directory descriptor.
|
| closedir [Unix] |
Close a directory descriptor.
|
| closure_tag [Obj] | |
| cma_magic_number [Config] | |
| cmi_magic_number [Config] | |
| cmo_magic_number [Config] | |
| cmt_magic_number [Config] | |
| cmx_magic_number [Config] | |
| cmxa_magic_number [Config] | |
| cmxs_magic_number [Config] | |
| code [Char] |
Return the ASCII code of the argument.
|
| coerce [Ast_helper.Exp] | |
| color [Clflags] | |
| combine [ListLabels] |
Transform a pair of lists into a list of pairs:
combine [a1; ...; an] [b1; ...; bn] is
[(a1,b1); ...; (an,bn)].
|
| combine [List] |
Transform a pair of lists into a list of pairs:
combine [a1; ...; an] [b1; ...; bn] is
[(a1,b1); ...; (an,bn)].
|
| command [Sys] |
Execute the given shell command and return its exit code.
|
| command [Ccomp] | |
| comments [Lexer] | |
| compact [Gc] |
Perform a full major collection and compact the heap.
|
| compare [Uchar] | compare u u' is Pervasives.compare u u'.
|
| compare [Targetint] |
The comparison function for target integers, with the same specification as
compare.
|
| compare [String] |
The comparison function for strings, with the same specification as
compare.
|
| compare [StringLabels] |
The comparison function for strings, with the same specification as
compare.
|
| compare [Pervasives] | compare x y returns 0 if x is equal to y,
a negative integer if x is less than y, and a positive integer
if x is greater than y.
|
| compare [Nativeint] |
The comparison function for native integers, with the same specification as
compare.
|
| compare [Set.OrderedType] |
A total ordering function over the set elements.
|
| compare [MoreLabels.Set.S] | |
| compare [MoreLabels.Map.S] | |
| compare [Misc.Stdlib.List] |
The lexicographic order supported by the provided order.
|
| compare [Map.OrderedType] |
A total ordering function over the keys.
|
| compare [Int64] |
The comparison function for 64-bit integers, with the same specification as
compare.
|
| compare [Int32] |
The comparison function for 32-bit integers, with the same specification as
compare.
|
| compare [Digest] |
The comparison function for 16-character digest, with the same
specification as
compare and the implementation
shared with String.compare.
|
| compare [Map.S] |
Total ordering between maps.
|
| compare [Set.S] |
Total ordering between sets.
|
| compare [Char] |
The comparison function for characters, with the same specification as
compare.
|
| compare [BytesLabels] |
The comparison function for byte sequences, with the same
specification as
compare.
|
| compare [Bytes] |
The comparison function for byte sequences, with the same
specification as
compare.
|
| compare_big_int [Big_int] | compare_big_int a b returns 0 if a and b are equal,
1 if a is greater than b, and -1 if a is smaller
than b.
|
| compare_length_with [ListLabels] |
Compare the length of a list to an integer.
|
| compare_length_with [List] |
Compare the length of a list to an integer.
|
| compare_lengths [ListLabels] |
Compare the lengths of two lists.
|
| compare_lengths [List] |
Compare the lengths of two lists.
|
| compare_num [Num] |
Return
-1, 0 or 1 if the first argument is less than,
equal to, or greater than the second argument.
|
| compile_file [Ccomp] | |
| compile_only [Clflags] | |
| complex32 [Bigarray] |
See
Bigarray.char.
|
| complex64 [Bigarray] |
See
Bigarray.char.
|
| component_graph [Strongly_connected_components.S] | |
| concat [String] | String.concat sep sl concatenates the list of strings sl,
inserting the separator string sep between each.
|
| concat [StringLabels] | String.concat sep sl concatenates the list of strings sl,
inserting the separator string sep between each.
|
| concat [ListLabels] |
Concatenate a list of lists.
|
| concat [List] |
Concatenate a list of lists.
|
| concat [Filename] | concat dir file returns a file name that designates file
file in directory dir.
|
| concat [BytesLabels] | concat sep sl concatenates the list of byte sequences sl,
inserting the separator byte sequence sep between each, and
returns the result as a new byte sequence.
|
| concat [Bytes] | concat sep sl concatenates the list of byte sequences sl,
inserting the separator byte sequence sep between each, and
returns the result as a new byte sequence.
|
| concat [ArrayLabels] |
Same as
Array.append, but concatenates a list of arrays.
|
| concat [Array] |
Same as
Array.append, but concatenates a list of arrays.
|
| concat_fmt [CamlinternalFormatBasics] | |
| concat_fmtty [CamlinternalFormatBasics] | |
| concrete [Ast_helper.Cf] | |
| conj [Complex] |
Conjugate: given the complex
x + i.y, returns x - i.y.
|
| connect [UnixLabels] |
Connect a socket to an address.
|
| connect [Unix] |
Connect a socket to an address.
|
| connect [ThreadUnix] | |
| connected_components_sorted_from_roots_to_leaf [Strongly_connected_components.S] | |
| cons [ListLabels] | cons x xs is x :: xs
|
| cons [List] | cons x xs is x :: xs
|
| constant [Ast_helper.Exp] | |
| constant [Ast_helper.Pat] | |
| constr [Ast_helper.Cl] | |
| constr [Ast_helper.Cty] | |
| constr [Ast_helper.Typ] | |
| constraint_ [Ast_helper.Cf] | |
| constraint_ [Ast_helper.Cl] | |
| constraint_ [Ast_helper.Ctf] | |
| constraint_ [Ast_helper.Mod] | |
| constraint_ [Ast_helper.Exp] | |
| constraint_ [Ast_helper.Pat] | |
| construct [Ast_helper.Exp] | |
| construct [Ast_helper.Pat] | |
| constructor [Ast_helper.Te] | |
| constructor [Ast_helper.Type] | |
| contains [String] | String.contains s c tests if character c
appears in the string s.
|
| contains [StringLabels] | String.contains s c tests if character c
appears in the string s.
|
| contains [BytesLabels] | contains s c tests if byte c appears in s.
|
| contains [Bytes] | contains s c tests if byte c appears in s.
|
| contains_from [String] | String.contains_from s start c tests if character c
appears in s after position start.
|
| contains_from [StringLabels] | String.contains_from s start c tests if character c
appears in s after position start.
|
| contains_from [BytesLabels] | contains_from s start c tests if byte c appears in s after
position start.
|
| contains_from [Bytes] | contains_from s start c tests if byte c appears in s after
position start.
|
| contents [Buffer] |
Return a copy of the current contents of the buffer.
|
| convert_raw_backtrace_slot [Printexc] |
Extracts the user-friendly
backtrace_slot from a low-level
raw_backtrace_slot.
|
| copy [String] |
Return a copy of the given string.
|
| copy [StringLabels] |
Return a copy of the given string.
|
| copy [Stack] |
Return a copy of the given stack.
|
| copy [Random.State] |
Return a copy of the given state.
|
| copy [Queue] |
Return a copy of the given queue.
|
| copy [Oo] | Oo.copy o returns a copy of object o, that is a fresh
object with the same methods and instance variables as o.
|
| copy [MoreLabels.Hashtbl.SeededS] | |
| copy [MoreLabels.Hashtbl.S] | |
| copy [MoreLabels.Hashtbl] | |
| copy [Hashtbl.SeededS] | |
| copy [Hashtbl.S] | |
| copy [Hashtbl] |
Return a copy of the given hashtable.
|
| copy [CamlinternalOO] | |
| copy [BytesLabels] |
Return a new byte sequence that contains the same bytes as the
argument.
|
| copy [Bytes] |
Return a new byte sequence that contains the same bytes as the
argument.
|
| copy [ArrayLabels] | Array.copy a returns a copy of a, that is, a fresh array
containing the same elements as a.
|
| copy [Array] | Array.copy a returns a copy of a, that is, a fresh array
containing the same elements as a.
|
| copy_file [Misc] | |
| copy_file_chunk [Misc] | |
| copysign [Pervasives] | copysign x y returns a float whose absolute value is that of x
and whose sign is that of y.
|
| core_type [Pprintast] | |
| core_type [Parse] | |
| cos [Pervasives] |
Cosine.
|
| cosh [Pervasives] |
Hyperbolic cosine.
|
| count [Weak.S] |
Count the number of elements in the table.
|
| count [Stream] |
Return the current count of the stream elements, i.e.
|
| counters [Gc] |
Return
(minor_words, promoted_words, major_words).
|
| create [Weak.S] | create n creates a new empty weak hash set, of initial
size n.
|
| create [Weak] | Weak.create n returns a new weak array of length n.
|
| create [Thread] | Thread.create funct arg creates a new thread of control,
in which the function application funct arg
is executed concurrently with the other threads of the program.
|
| create [String] | String.create n returns a fresh byte sequence of length n.
|
| create [StringLabels] | String.create n returns a fresh byte sequence of length n.
|
| create [Stack] |
Return a new stack, initially empty.
|
| create [Spacetime.Series] | create ~path creates a series file at path.
|
| create [Queue] |
Return a new queue, initially empty.
|
| create [Obj.Ephemeron] | create n returns an ephemeron with n keys.
|
| create [Mutex] |
Return a new mutex.
|
| create [MoreLabels.Hashtbl.SeededS] | |
| create [MoreLabels.Hashtbl.S] | |
| create [MoreLabels.Hashtbl] | |
| create [Misc.LongString] | |
| create [Hashtbl.SeededS] | |
| create [Hashtbl.S] | |
| create [Hashtbl] | Hashtbl.create n creates a new, empty hash table, with
initial size n.
|
| create [Ephemeron.Kn] |
Same as
Ephemeron.K1.create
|
| create [Ephemeron.K2] |
Same as
Ephemeron.K1.create
|
| create [Ephemeron.K1] | Ephemeron.K1.create () creates an ephemeron with one key.
|
| create [Consistbl] | |
| create [Condition] |
Return a new condition variable.
|
| create [BytesLabels] | create n returns a new byte sequence of length n.
|
| create [Bytes] | create n returns a new byte sequence of length n.
|
| create [Buffer] | create n returns a fresh buffer, initially empty.
|
| create [Bigarray.Array3] | Array3.create kind layout dim1 dim2 dim3 returns a new bigarray of
three dimension, whose size is dim1 in the first dimension,
dim2 in the second dimension, and dim3 in the third.
|
| create [Bigarray.Array2] | Array2.create kind layout dim1 dim2 returns a new bigarray of
two dimension, whose size is dim1 in the first dimension
and dim2 in the second dimension.
|
| create [Bigarray.Array1] | Array1.create kind layout dim returns a new bigarray of
one dimension, whose size is dim.
|
| create [Bigarray.Array0] | Array0.create kind layout returns a new bigarray of zero dimension.
|
| create [Bigarray.Genarray] | Genarray.create kind layout dimensions returns a new big array
whose element kind is determined by the parameter kind (one of
float32, float64, int8_signed, etc) and whose layout is
determined by the parameter layout (one of c_layout or
fortran_layout).
|
| create [ArrayLabels] | |
| create [Array] | |
| create_alarm [Gc] | create_alarm f will arrange for f to be called at the end of each
major GC cycle, starting with the current cycle or the next one.
|
| create_archive [Ccomp] | |
| create_char_set [CamlinternalFormat] | |
| create_float [ArrayLabels] | Array.create_float n returns a fresh float array of length n,
with uninitialized data.
|
| create_float [Array] | Array.create_float n returns a fresh float array of length n,
with uninitialized data.
|
| create_hashtable [Misc] | |
| create_image [Graphics] | create_image w h returns a new image w pixels wide and h
pixels tall, to be used in conjunction with blit_image.
|
| create_matrix [ArrayLabels] | |
| create_matrix [Array] | |
| create_object [CamlinternalOO] | |
| create_object_and_run_initializers [CamlinternalOO] | |
| create_object_opt [CamlinternalOO] | |
| create_process [UnixLabels] | create_process prog args new_stdin new_stdout new_stderr
forks a new process that executes the program
in file prog, with arguments args.
|
| create_process [Unix] | create_process prog args new_stdin new_stdout new_stderr
forks a new process that executes the program
in file prog, with arguments args.
|
| create_process_env [UnixLabels] | create_process_env prog args env new_stdin new_stdout new_stderr
works as UnixLabels.create_process, except that the extra argument
env specifies the environment passed to the program.
|
| create_process_env [Unix] | create_process_env prog args env new_stdin new_stdout new_stderr
works as Unix.create_process, except that the extra argument
env specifies the environment passed to the program.
|
| create_table [CamlinternalOO] | |
| curr [Location] |
Get the location of the current token from the
lexbuf.
|
| current [Arg] |
Position (in
Sys.argv) of the argument being processed.
|
| current_dir_name [Filename] |
The conventional name for the current directory (e.g.
|
| current_point [Graphics] |
Return the position of the current point.
|
| current_x [Graphics] |
Return the abscissa of the current point.
|
| current_y [Graphics] |
Return the ordinate of the current point.
|
| curveto [Graphics] | curveto b c d draws a cubic Bezier curve starting from
the current point to point d, with control points b and
c, and moves the current point to d.
|
| custom_runtime [Clflags] | |
| custom_tag [Obj] | |
| cut_at [Misc] | String.cut_at s c returns a pair containing the sub-string before
the first occurrence of c in s, and the sub-string after the
first occurrence of c in s.
|
| cyan [Graphics] | |
| cygwin [Sys] |
True if
Sys.os_type = "Cygwin".
|
D | |
| data [Identifiable.S.Map] | |
| data_size [Marshal] |
See
Marshal.header_size.
|
| debug [Clflags] | |
| decl [Ast_helper.Te] | |
| decr [Pervasives] |
Decrement the integer contained in the given reference.
|
| decr_num [Num] | decr r is r:=!r-1, where r is a reference to a number.
|
| default [Arg_helper.Make] | |
| default_available_units [Dynlink] |
Reset the set of units that can be referenced from dynamically-linked
code to its default value, that is, all units composing the currently
running program.
|
| default_error_reporter [Location] |
Original error reporter for use in hooks.
|
| default_executable_name [Config] | |
| default_inline_alloc_cost [Clflags] | |
| default_inline_branch_cost [Clflags] | |
| default_inline_branch_factor [Clflags] | |
| default_inline_call_cost [Clflags] | |
| default_inline_indirect_cost [Clflags] | |
| default_inline_lifting_benefit [Clflags] | |
| default_inline_max_depth [Clflags] | |
| default_inline_max_unroll [Clflags] | |
| default_inline_prim_cost [Clflags] | |
| default_inline_threshold [Clflags] | |
| default_inline_toplevel_threshold [Clflags] | |
| default_iterator [Ast_iterator] |
A default iterator, which implements a "do not do anything" mapping.
|
| default_loc [Ast_helper] |
Default value for all optional location arguments.
|
| default_mapper [Ast_mapper] |
A default mapper, which implements a "deep identity" mapping.
|
| default_simplify_rounds [Clflags] | |
| default_styles [Misc.Color] | |
| default_unbox_closures_factor [Clflags] | |
| default_warning_printer [Location] |
Original warning printer for use in hooks.
|
| defaults_w [Warnings] | |
| defaults_warn_error [Warnings] | |
| delay [Thread] | delay d suspends the execution of the calling thread for
d seconds.
|
| delete_alarm [Gc] | delete_alarm a will stop the calls to the function associated
to a.
|
| delete_eol_spaces [Misc] | delete_eol_spaces s returns a fresh copy of s with any end of
line spaces removed.
|
| deprecated_of_attrs [Builtin_attributes] | |
| deprecated_of_sig [Builtin_attributes] | |
| deprecated_of_str [Builtin_attributes] | |
| descr_of_in_channel [UnixLabels] |
Return the descriptor corresponding to an input channel.
|
| descr_of_in_channel [Unix] |
Return the descriptor corresponding to an input channel.
|
| descr_of_out_channel [UnixLabels] |
Return the descriptor corresponding to an output channel.
|
| descr_of_out_channel [Unix] |
Return the descriptor corresponding to an output channel.
|
| did_you_mean [Misc] | did_you_mean ppf get_choices hints that the user may have meant
one of the option returned by calling get_choices.
|
| diff [MoreLabels.Set.S] | |
| diff [Set.S] |
Set difference.
|
| dim [Bigarray.Array1] |
Return the size (dimension) of the given one-dimensional
big array.
|
| dim1 [Bigarray.Array3] |
Return the first dimension of the given three-dimensional big array.
|
| dim1 [Bigarray.Array2] |
Return the first dimension of the given two-dimensional big array.
|
| dim2 [Bigarray.Array3] |
Return the second dimension of the given three-dimensional big array.
|
| dim2 [Bigarray.Array2] |
Return the second dimension of the given two-dimensional big array.
|
| dim3 [Bigarray.Array3] |
Return the third dimension of the given three-dimensional big array.
|
| dims [Bigarray.Genarray] | Genarray.dims a returns all dimensions of the big array a,
as an array of integers of length Genarray.num_dims a.
|
| dir_sep [Filename] |
The directory separator (e.g.
|
| dirname [Filename] |
See
Filename.basename.
|
| disjoint_union [Identifiable.S.Map] | disjoint_union m1 m2 contains all bindings from m1 and
m2.
|
| display_mode [Graphics] |
Set display mode on or off.
|
| div [Targetint] |
Integer division.
|
| div [Nativeint] |
Integer division.
|
| div [Int64] |
Integer division.
|
| div [Int32] |
Integer division.
|
| div [Complex] |
Division
|
| div_big_int [Big_int] |
Euclidean quotient of two big integers.
|
| div_num [Num] |
Division
|
| dlcode [Clflags] | |
| dllibs [Clflags] | |
| dllpaths [Clflags] | |
| docs_attr [Docstrings] | |
| docstring [Docstrings] |
Create a docstring
|
| docstring_body [Docstrings] |
Get the text of a docstring
|
| docstring_loc [Docstrings] |
Get the location of a docstring
|
| domain_of_sockaddr [UnixLabels] |
Return the socket domain adequate for the given socket address.
|
| domain_of_sockaddr [Unix] |
Return the socket domain adequate for the given socket address.
|
| dont_write_files [Clflags] | |
| double_array_tag [Obj] | |
| double_field [Obj] | |
| double_tag [Obj] | |
| draw_arc [Graphics] | draw_arc x y rx ry a1 a2 draws an elliptical arc with center
x,y, horizontal radius rx, vertical radius ry, from angle
a1 to angle a2 (in degrees).
|
| draw_char [Graphics] |
See
Graphics.draw_string.
|
| draw_circle [Graphics] | draw_circle x y r draws a circle with center x,y and
radius r.
|
| draw_ellipse [Graphics] | draw_ellipse x y rx ry draws an ellipse with center
x,y, horizontal radius rx and vertical radius ry.
|
| draw_image [Graphics] |
Draw the given image with lower left corner at the given point.
|
| draw_poly [Graphics] | draw_poly polygon draws the given polygon.
|
| draw_poly_line [Graphics] | draw_poly_line points draws the line that joins the
points given by the array argument.
|
| draw_rect [Graphics] | draw_rect x y w h draws the rectangle with lower left corner
at x,y, width w and height h.
|
| draw_segments [Graphics] | draw_segments segments draws the segments given in the array
argument.
|
| draw_string [Graphics] |
Draw a character or a character string with lower left corner
at current position.
|
| drop_ppx_context_sig [Ast_mapper] |
Same as
drop_ppx_context_str, but for signatures.
|
| drop_ppx_context_str [Ast_mapper] |
Drop the ocaml.ppx.context attribute from a structure.
|
| dummy_class [CamlinternalOO] | |
| dummy_pos [Lexing] |
A value of type
position, guaranteed to be different from any
valid position.
|
| dummy_table [CamlinternalOO] | |
| dump_clambda [Clflags] | |
| dump_cmm [Clflags] | |
| dump_combine [Clflags] | |
| dump_cse [Clflags] | |
| dump_flambda [Clflags] | |
| dump_flambda_let [Clflags] | |
| dump_flambda_verbose [Clflags] | |
| dump_image [Graphics] |
Convert an image to a color matrix.
|
| dump_instr [Clflags] | |
| dump_interf [Clflags] | |
| dump_lambda [Clflags] | |
| dump_linear [Clflags] | |
| dump_live [Clflags] | |
| dump_parsetree [Clflags] | |
| dump_prefer [Clflags] | |
| dump_rawclambda [Clflags] | |
| dump_rawflambda [Clflags] | |
| dump_rawlambda [Clflags] | |
| dump_regalloc [Clflags] | |
| dump_reload [Clflags] | |
| dump_scheduling [Clflags] | |
| dump_selection [Clflags] | |
| dump_source [Clflags] | |
| dump_spill [Clflags] | |
| dump_split [Clflags] | |
| dump_typedtree [Clflags] | |
| dumped_pass [Clflags] | |
| dup [UnixLabels] |
Return a new file descriptor referencing the same file as
the given descriptor.
|
| dup [Unix] |
Return a new file descriptor referencing the same file as
the given descriptor.
|
| dup [Obj] | |
| dup2 [UnixLabels] | dup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already
opened.
|
| dup2 [Unix] | dup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already
opened.
|
E | |
| echo_eof [Location] | |
| edit_distance [Misc] | edit_distance a b cutoff computes the edit distance between
strings a and b.
|
| elements [MoreLabels.Set.S] | |
| elements [Set.S] |
Return the list of all elements of the given set.
|
| emit_external_warnings [Builtin_attributes] | |
| empty [Tbl] | |
| empty [Stream] |
Return
() if the stream is empty, else raise Stream.Failure.
|
| empty [MoreLabels.Set.S] | |
| empty [MoreLabels.Map.S] | |
| empty [Map.S] |
The empty map.
|
| empty [Set.S] |
The empty set.
|
| empty [BytesLabels] |
A byte sequence of size 0.
|
| empty [Bytes] |
A byte sequence of size 0.
|
| empty_docs [Docstrings] | |
| empty_info [Docstrings] | |
| empty_text [Docstrings] | |
| empty_text_lazy [Docstrings] | |
| enable_runtime_warnings [Sys] |
Control whether the OCaml runtime system can emit warnings
on stderr.
|
| enabled [Spacetime] | enabled is true if the compiler is configured with spacetime and false
otherwise
|
| end_of_input [Scanf.Scanning] | Scanning.end_of_input ic tests the end-of-input condition of the given
Scanf.Scanning.in_channel formatted input channel.
|
| environment [UnixLabels] |
Return the process environment, as an array of strings
with the format ``variable=value''.
|
| environment [Unix] |
Return the process environment, as an array of strings
with the format ``variable=value''.
|
| eprintf [Printf] |
Same as
Printf.fprintf, but output on stderr.
|
| eprintf [Format] |
Same as
fprintf above, but output on err_formatter.
|
| epsilon_float [Pervasives] |
The difference between
1.0 and the smallest exactly representable
floating-point number greater than 1.0.
|
| eq_big_int [Big_int] | |
| eq_num [Num] | |
| equal [Uchar] | equal u u' is u = u'.
|
| equal [Targetint] |
The equal function for target ints.
|
| equal [String] |
The equal function for strings.
|
| equal [StringLabels] |
The equal function for strings.
|
| equal [Nativeint] |
The equal function for native ints.
|
| equal [MoreLabels.Set.S] | |
| equal [MoreLabels.Map.S] | |
| equal [Misc.Stdlib.Option] | |
| equal [Misc.Stdlib.List] |
Returns
true iff the given lists have the same length and content
with respect to the given equality function.
|
| equal [Int64] |
The equal function for int64s.
|
| equal [Int32] |
The equal function for int32s.
|
| equal [Hashtbl.SeededHashedType] |
The equality predicate used to compare keys.
|
| equal [Hashtbl.HashedType] |
The equality predicate used to compare keys.
|
| equal [Digest] |
The equal function for 16-character digest.
|
| equal [Map.S] | equal cmp m1 m2 tests whether the maps m1 and m2 are
equal, that is, contain equal keys and associate them with
equal data.
|
| equal [Set.S] | equal s1 s2 tests whether the sets s1 and s2 are
equal, that is, contain equal elements.
|
| equal [Char] |
The equal function for chars.
|
| equal [BytesLabels] |
The equality function for byte sequences.
|
| equal [Bytes] |
The equality function for byte sequences.
|
| erase_rel [CamlinternalFormatBasics] | |
| err_formatter [Format] |
A formatter to use with formatting functions below for
output to standard error.
|
| error [Location] | |
| error_message [UnixLabels] |
Return a string describing the given error code.
|
| error_message [Unix] |
Return a string describing the given error code.
|
| error_message [Dynlink] |
Convert an error description to a printable message.
|
| error_of_exn [Location] | |
| error_of_extension [Builtin_attributes] | |
| error_of_printer [Location] | |
| error_of_printer_file [Location] | |
| error_reporter [Location] |
Hook for intercepting error reports.
|
| error_size [Clflags] | |
| errorf [Location] | |
| escaped [String] |
Return a copy of the argument, with special characters
represented by escape sequences, following the lexical
conventions of OCaml.
|
| escaped [StringLabels] |
Return a copy of the argument, with special characters
represented by escape sequences, following the lexical
conventions of OCaml.
|
| escaped [Char] |
Return a string representing the given character,
with special characters escaped following the lexical conventions
of OCaml.
|
| escaped [BytesLabels] |
Return a copy of the argument, with special characters represented
by escape sequences, following the lexical conventions of OCaml.
|
| escaped [Bytes] |
Return a copy of the argument, with special characters represented
by escape sequences, following the lexical conventions of OCaml.
|
| establish_server [UnixLabels] |
Establish a server on the given address.
|
| establish_server [Unix] |
Establish a server on the given address.
|
| eval [Ast_helper.Str] | |
| exception_ [Ast_helper.Str] | |
| exception_ [Ast_helper.Sig] | |
| exception_ [Ast_helper.Pat] | |
| exec_magic_number [Config] | |
| executable_name [Sys] |
The name of the file containing the executable currently running.
|
| execv [UnixLabels] | execv prog args execute the program in file prog, with
the arguments args, and the current process environment.
|
| execv [Unix] | execv prog args execute the program in file prog, with
the arguments args, and the current process environment.
|
| execv [ThreadUnix] | |
| execve [UnixLabels] |
Same as
UnixLabels.execv, except that the third argument provides the
environment to the program executed.
|
| execve [Unix] |
Same as
Unix.execv, except that the third argument provides the
environment to the program executed.
|
| execve [ThreadUnix] | |
| execvp [UnixLabels] |
Same as
UnixLabels.execv, except that
the program is searched in the path.
|
| execvp [Unix] |
Same as
Unix.execv, except that
the program is searched in the path.
|
| execvp [ThreadUnix] | |
| execvpe [UnixLabels] |
Same as
UnixLabels.execve, except that
the program is searched in the path.
|
| execvpe [Unix] |
Same as
Unix.execve, except that
the program is searched in the path.
|
| exists [MoreLabels.Set.S] | |
| exists [MoreLabels.Map.S] | |
| exists [ListLabels] | exists p [a1; ...; an] checks if at least one element of
the list satisfies the predicate p.
|
| exists [List] | exists p [a1; ...; an] checks if at least one element of
the list satisfies the predicate p.
|
| exists [Map.S] | exists p m checks if at least one binding of the map
satisfies the predicate p.
|
| exists [Set.S] | exists p s checks if at least one element of
the set satisfies the predicate p.
|
| exists [ArrayLabels] | Array.exists p [|a1; ...; an|] checks if at least one element of
the array satisfies the predicate p.
|
| exists [Array] | Array.exists p [|a1; ...; an|] checks if at least one element of
the array satisfies the predicate p.
|
| exists2 [ListLabels] |
Same as
List.exists, but for a two-argument predicate.
|
| exists2 [List] |
Same as
List.exists, but for a two-argument predicate.
|
| exit [Thread] |
Terminate prematurely the currently executing thread.
|
| exit [Pervasives] |
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.
|
| exn_slot_id [Printexc] | Printexc.exn_slot_id returns an integer which uniquely identifies
the constructor used to create the exception value exn
(in the current runtime).
|
| exn_slot_name [Printexc] | Printexc.exn_slot_name exn returns the internal name of the constructor
used to create the exception value exn.
|
| exp [Pervasives] |
Exponential.
|
| exp [Complex] |
Exponentiation.
|
| expand_directory [Misc] | |
| expand_libname [Ccomp] | |
| explicit_arity [Builtin_attributes] | |
| expm1 [Pervasives] | expm1 x computes exp x -. 1.0, giving numerically-accurate results
even if x is close to 0.0.
|
| expression [Printast] | |
| expression [Pprintast] | |
| expression [Parse] | |
| ext_asm [Config] | |
| ext_dll [Config] | |
| ext_lib [Config] | |
| ext_obj [Config] | |
| extend [BytesLabels] | extend s left right returns a new byte sequence that contains
the bytes of s, with left uninitialized bytes prepended and
right uninitialized bytes appended to it.
|
| extend [Bytes] | extend s left right returns a new byte sequence that contains
the bytes of s, with left uninitialized bytes prepended and
right uninitialized bytes appended to it.
|
| extension [Filename] | extension name is the shortest suffix ext of name0 where:
|
| extension [Ast_helper.Cf] | |
| extension [Ast_helper.Cl] | |
| extension [Ast_helper.Ctf] | |
| extension [Ast_helper.Cty] | |
| extension [Ast_helper.Str] | |
| extension [Ast_helper.Sig] | |
| extension [Ast_helper.Mod] | |
| extension [Ast_helper.Mty] | |
| extension [Ast_helper.Exp] | |
| extension [Ast_helper.Pat] | |
| extension [Ast_helper.Typ] | |
| extension_constructor [Obj] | |
| extension_id [Obj] | |
| extension_name [Obj] | |
| extension_of_error [Ast_mapper] |
Encode an error into an 'ocaml.error' extension node which can be
inserted in a generated Parsetree.
|
| extract [Consistbl] | |
| extract_big_int [Big_int] | extract_big_int bi ofs n returns a nonnegative number
corresponding to bits ofs to ofs + n - 1 of the
binary representation of bi.
|
F | |
| failwith [Pervasives] |
Raise exception
Failure with the given string.
|
| fast [Clflags] | |
| fast_sort [ListLabels] |
Same as
List.sort or List.stable_sort, whichever is
faster on typical input.
|
| fast_sort [List] |
Same as
List.sort or List.stable_sort, whichever is faster
on typical input.
|
| fast_sort [ArrayLabels] |
Same as
Array.sort or Array.stable_sort, whichever is
faster on typical input.
|
| fast_sort [Array] |
Same as
Array.sort or Array.stable_sort, whichever is faster
on typical input.
|
| fatal_error [Misc] | |
| fatal_errorf [Misc] | |
| fchmod [UnixLabels] |
Change the permissions of an opened file.
|
| fchmod [Unix] |
Change the permissions of an opened file.
|
| fchown [UnixLabels] |
Change the owner uid and owner gid of an opened file.
|
| fchown [Unix] |
Change the owner uid and owner gid of an opened file.
|
| field [Obj] | |
| field [Ast_helper.Type] | |
| field [Ast_helper.Exp] | |
| file [Digest] |
Return the digest of the file whose name is given.
|
| file_exists [Sys] |
Test if a file with the given name exists.
|
| fill [Weak] | Weak.fill ar ofs len el sets to el all pointers of ar from
ofs to ofs + len - 1.
|
| fill [String] | String.fill s start len c modifies byte sequence s in place,
replacing len bytes with c, starting at start.
|
| fill [StringLabels] | String.fill s start len c modifies byte sequence s in place,
replacing len bytes by c, starting at start.
|
| fill [BytesLabels] | fill s start len c modifies s in place, replacing len
characters with c, starting at start.
|
| fill [Bytes] | fill s start len c modifies s in place, replacing len
characters with c, starting at start.
|
| fill [Bigarray.Array3] |
Fill the given big array with the given value.
|
| fill [Bigarray.Array2] |
Fill the given big array with the given value.
|
| fill [Bigarray.Array1] |
Fill the given big array with the given value.
|
| fill [Bigarray.Array0] |
Fill the given big array with the given value.
|
| fill [Bigarray.Genarray] |
Set all elements of a big array to a given value.
|
| fill [ArrayLabels] | Array.fill a ofs len x modifies the array a in place,
storing x in elements number ofs to ofs + len - 1.
|
| fill [Array] | Array.fill a ofs len x modifies the array a in place,
storing x in elements number ofs to ofs + len - 1.
|
| fill_arc [Graphics] |
Fill an elliptical pie slice with the current color.
|
| fill_circle [Graphics] |
Fill a circle with the current color.
|
| fill_ellipse [Graphics] |
Fill an ellipse with the current color.
|
| fill_poly [Graphics] |
Fill the given polygon with the current color.
|
| fill_rect [Graphics] | fill_rect x y w h fills the rectangle with lower left corner
at x,y, width w and height h, with the current color.
|
| filter [MoreLabels.Set.S] | |
| filter [MoreLabels.Map.S] | |
| filter [ListLabels] | filter p l returns all the elements of the list l
that satisfy the predicate p.
|
| filter [List] | filter p l returns all the elements of the list l
that satisfy the predicate p.
|
| filter [Map.S] | filter p m returns the map with all the bindings in m
that satisfy predicate p.
|
| filter [Set.S] | filter p s returns the set of all elements in s
that satisfy predicate p.
|
| filter [Consistbl] | |
| filter_map [Misc.Stdlib.List] | filter_map f l applies f to every element of l, filters
out the None elements and returns the list of the arguments of
the Some elements.
|
| filter_map [Identifiable.S.Map] | |
| filter_map_inplace [MoreLabels.Hashtbl.SeededS] | |
| filter_map_inplace [MoreLabels.Hashtbl.S] | |
| filter_map_inplace [MoreLabels.Hashtbl] | |
| filter_map_inplace [Hashtbl.SeededS] | |
| filter_map_inplace [Hashtbl.S] | |
| filter_map_inplace [Hashtbl] | Hashtbl.filter_map_inplace f tbl applies f to all bindings in
table tbl and update each binding depending on the result of
f.
|
| final_tag [Obj] | |
| finalise [Gc] | finalise f v registers f as a finalisation function for v.
|
| finalise_last [Gc] |
same as
Gc.finalise except the value is not given as argument.
|
| finalise_release [Gc] |
A finalisation function may call
finalise_release to tell the
GC that it can launch the next finalisation function without waiting
for the current one to return.
|
| find [Weak.S] | find t x returns an instance of x found in t.
|
| find [Tbl] | |
| find [MoreLabels.Set.S] | |
| find [MoreLabels.Map.S] | |
| find [MoreLabels.Hashtbl.SeededS] | |
| find [MoreLabels.Hashtbl.S] | |
| find [MoreLabels.Hashtbl] | |
| find [ListLabels] | find p l returns the first element of the list l
that satisfies the predicate p.
|
| find [List] | find p l returns the first element of the list l
that satisfies the predicate p.
|
| find [Hashtbl.SeededS] | |
| find [Hashtbl.S] | |
| find [Hashtbl] | Hashtbl.find tbl x returns the current binding of x in tbl,
or raises Not_found if no such binding exists.
|
| find [Map.S] | find x m returns the current binding of x in m,
or raises Not_found if no such binding exists.
|
| find [Set.S] | find x s returns the element of s equal to x (according
to Ord.compare), or raise Not_found if no such element
exists.
|
| find_all [Weak.S] | find_all t x returns a list of all the instances of x
found in t.
|
| find_all [MoreLabels.Hashtbl.SeededS] | |
| find_all [MoreLabels.Hashtbl.S] | |
| find_all [MoreLabels.Hashtbl] | |
| find_all [ListLabels] | find_all is another name for List.filter.
|
| find_all [List] | find_all is another name for List.filter.
|
| find_all [Hashtbl.SeededS] | |
| find_all [Hashtbl.S] | |
| find_all [Hashtbl] | Hashtbl.find_all tbl x returns the list of all data
associated with x in tbl.
|
| find_first [MoreLabels.Set.S] | |
| find_first [MoreLabels.Map.S] | |
| find_first [Map.S] | find_first f m, where f is a monotonically increasing function,
returns the binding of m with the lowest key k such that f k,
or raises Not_found if no such key exists.
|
| find_first [Set.S] | find_first f s, where f is a monotonically increasing function,
returns the lowest element e of s such that f e,
or raises Not_found if no such element exists.
|
| find_first_opt [MoreLabels.Set.S] | |
| find_first_opt [MoreLabels.Map.S] | |
| find_first_opt [Map.S] | find_first_opt f m, where f is a monotonically increasing function,
returns an option containing the binding of m with the lowest key k
such that f k, or None if no such key exists.
|
| find_first_opt [Set.S] | find_first_opt f s, where f is a monotonically increasing function,
returns an option containing the lowest element e of s such that
f e, or None if no such element exists.
|
| find_in_path [Misc] | |
| find_in_path_rel [Misc] | |
| find_in_path_uncap [Misc] | |
| find_last [MoreLabels.Set.S] | |
| find_last [MoreLabels.Map.S] | |
| find_last [Map.S] | find_last f m, where f is a monotonically decreasing function,
returns the binding of m with the highest key k such that f k,
or raises Not_found if no such key exists.
|
| find_last [Set.S] | find_last f s, where f is a monotonically decreasing function,
returns the highest element e of s such that f e,
or raises Not_found if no such element exists.
|
| find_last_opt [MoreLabels.Set.S] | |
| find_last_opt [MoreLabels.Map.S] | |
| find_last_opt [Map.S] | find_last_opt f m, where f is a monotonically decreasing function,
returns an option containing the binding of m with the highest key k
such that f k, or None if no such key exists.
|
| find_last_opt [Set.S] | find_last_opt f s, where f is a monotonically decreasing function,
returns an option containing the highest element e of s such that
f e, or None if no such element exists.
|
| find_opt [Weak.S] | find_opt t x returns an instance of x found in t
or None if there is no such element.
|
| find_opt [MoreLabels.Set.S] | |
| find_opt [MoreLabels.Map.S] | |
| find_opt [MoreLabels.Hashtbl.SeededS] | |
| find_opt [MoreLabels.Hashtbl.S] | |
| find_opt [MoreLabels.Hashtbl] | |
| find_opt [ListLabels] | find p l returns the first element of the list l
that satisfies the predicate p.
|
| find_opt [List] | find_opt p l returns the first element of the list l that
satisfies the predicate p, or None if there is no value that
satisfies p in the list l.
|
| find_opt [Hashtbl.SeededS] | |
| find_opt [Hashtbl.S] | |
| find_opt [Hashtbl] | Hashtbl.find_opt tbl x returns the current binding of x in tbl,
or None if no such binding exists.
|
| find_opt [Map.S] | find_opt x m returns Some v if the current binding of x
in m is v, or None if no such binding exists.
|
| find_opt [Set.S] | find_opt x s returns the element of s equal to x (according
to Ord.compare), or None if no such element
exists.
|
| first_chars [Str] | first_chars s n returns the first n characters of s.
|
| first_non_constant_constructor_tag [Obj] | |
| flambda [Config] | |
| flambda_invariant_checks [Clflags] | |
| flatten [Longident] | |
| flatten [ListLabels] |
Same as
concat.
|
| flatten [List] |
An alias for
concat.
|
| flexdll_dirs [Config] | |
| float [Random.State] | |
| float [Random] | Random.float bound returns a random floating-point number
between 0 and bound (inclusive).
|
| float [Pervasives] |
Same as
float_of_int.
|
| float [Ast_helper.Const] | |
| float32 [Bigarray] |
See
Bigarray.char.
|
| float64 [Bigarray] |
See
Bigarray.char.
|
| float_const_prop [Clflags] | |
| float_of_big_int [Big_int] |
Returns a floating-point number approximating the
given big integer.
|
| float_of_bits [Int64] |
Return the floating-point number whose internal representation,
according to the IEEE 754 floating-point 'double format' bit layout,
is the given
int64.
|
| float_of_bits [Int32] |
Return the floating-point number whose internal representation,
according to the IEEE 754 floating-point 'single format' bit layout,
is the given
int32.
|
| float_of_int [Pervasives] |
Convert an integer to floating-point.
|
| float_of_num [Num] | |
| float_of_string [Pervasives] |
Convert the given string to a float.
|
| float_of_string_opt [Pervasives] |
Same as
float_of_string, but returns None instead of raising.
|
| floor [Pervasives] |
Round below to an integer value.
|
| floor_num [Num] | floor_num n returns the largest integer smaller or equal to n.
|
| flush [Pervasives] |
Flush the buffer associated with the given output channel,
performing all pending writes on that channel.
|
| flush_all [Pervasives] |
Flush all open output channels; ignore errors.
|
| flush_input [Lexing] |
Discard the contents of the buffer and reset the current
position to 0.
|
| flush_str_formatter [Format] |
Returns the material printed with
str_formatter, flushes
the formatter and resets the corresponding buffer.
|
| fmt_ebb_of_string [CamlinternalFormat] | |
| fold [Weak.S] | fold f t init computes (f d1 (... (f dN init))) where
d1 ... dN are the elements of t in some unspecified order.
|
| fold [Tbl] | |
| fold [Stack] | fold f accu s is (f (... (f (f accu x1) x2) ...) xn)
where x1 is the top of the stack, x2 the second element,
and xn the bottom element.
|
| fold [Queue] | fold f accu q is equivalent to List.fold_left f accu l,
where l is the list of q's elements.
|
| fold [MoreLabels.Set.S] | |
| fold [MoreLabels.Map.S] | |
| fold [MoreLabels.Hashtbl.SeededS] | |
| fold [MoreLabels.Hashtbl.S] | |
| fold [MoreLabels.Hashtbl] | |
| fold [Misc.Stdlib.Option] | |
| fold [Hashtbl.SeededS] | |
| fold [Hashtbl.S] | |
| fold [Hashtbl] | Hashtbl.fold f tbl init computes
(f kN dN ... (f k1 d1 init)...),
where k1 ... kN are the keys of all bindings in tbl,
and d1 ... dN are the associated values.
|
| fold [Map.S] | fold f m a computes (f kN dN ... (f k1 d1 a)...),
where k1 ... kN are the keys of all bindings in m
(in increasing order), and d1 ... dN are the associated data.
|
| fold [Set.S] | fold f s a computes (f xN ... (f x2 (f x1 a))...),
where x1 ... xN are the elements of s, in increasing order.
|
| fold_left [ListLabels] | List.fold_left f a [b1; ...; bn] is
f (... (f (f a b1) b2) ...) bn.
|
| fold_left [List] | List.fold_left f a [b1; ...; bn] is
f (... (f (f a b1) b2) ...) bn.
|
| fold_left [ArrayLabels] | Array.fold_left f x a computes
f (... (f (f x a.(0)) a.(1)) ...) a.(n-1),
where n is the length of the array a.
|
| fold_left [Array] | Array.fold_left f x a computes
f (... (f (f x a.(0)) a.(1)) ...) a.(n-1),
where n is the length of the array a.
|
| fold_left2 [ListLabels] | List.fold_left2 f a [b1; ...; bn] [c1; ...; cn] is
f (... (f (f a b1 c1) b2 c2) ...) bn cn.
|
| fold_left2 [List] | List.fold_left2 f a [b1; ...; bn] [c1; ...; cn] is
f (... (f (f a b1 c1) b2 c2) ...) bn cn.
|
| fold_right [ListLabels] | List.fold_right f [a1; ...; an] b is
f a1 (f a2 (... (f an b) ...)).
|
| fold_right [List] | List.fold_right f [a1; ...; an] b is
f a1 (f a2 (... (f an b) ...)).
|
| fold_right [ArrayLabels] | Array.fold_right f a x computes
f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...)),
where n is the length of the array a.
|
| fold_right [Array] | Array.fold_right f a x computes
f a.(0) (f a.(1) ( ... (f a.(n-1) x) ...)),
where n is the length of the array a.
|
| fold_right2 [ListLabels] | List.fold_right2 f [a1; ...; an] [b1; ...; bn] c is
f a1 b1 (f a2 b2 (... (f an bn c) ...)).
|
| fold_right2 [List] | List.fold_right2 f [a1; ...; an] [b1; ...; bn] c is
f a1 b1 (f a2 b2 (... (f an bn c) ...)).
|
| for4 [Misc] | |
| for_ [Ast_helper.Exp] | |
| for_all [MoreLabels.Set.S] | |
| for_all [MoreLabels.Map.S] | |
| for_all [ListLabels] | for_all p [a1; ...; an] checks if all elements of the list
satisfy the predicate p.
|
| for_all [List] | for_all p [a1; ...; an] checks if all elements of the list
satisfy the predicate p.
|
| for_all [Map.S] | for_all p m checks if all the bindings of the map
satisfy the predicate p.
|
| for_all [Set.S] | for_all p s checks if all elements of the set
satisfy the predicate p.
|
| for_all [ArrayLabels] | Array.for_all p [|a1; ...; an|] checks if all elements of the array
satisfy the predicate p.
|
| for_all [Array] | Array.for_all p [|a1; ...; an|] checks if all elements of the array
satisfy the predicate p.
|
| for_all2 [Misc] | |
| for_all2 [ListLabels] |
Same as
List.for_all, but for a two-argument predicate.
|
| for_all2 [List] |
Same as
List.for_all, but for a two-argument predicate.
|
| for_package [Clflags] | |
| force [Lazy] | force x forces the suspension x and returns its result.
|
| force [CamlinternalLazy] | |
| force_lazy_block [CamlinternalLazy] | |
| force_newline [Format] |
Forces a new line in the current box.
|
| force_poly [Ast_helper.Typ] | |
| force_slash [Clflags] | |
| force_val [Lazy] | force_val x forces the suspension x and returns its
result.
|
| force_val [CamlinternalLazy] | |
| force_val_lazy_block [CamlinternalLazy] | |
| foreground [Graphics] |
Default background and foreground colors (usually, either black
foreground on a white background or white foreground on a
black background).
|
| fork [UnixLabels] |
Fork a new process.
|
| fork [Unix] |
Fork a new process.
|
| format [Printexc.Slot] | format pos slot returns the string representation of slot as
raw_backtrace_to_string would format it, assuming it is the
pos-th element of the backtrace: the 0-th element is
pretty-printed differently than the others.
|
| format_from_string [Scanf] | format_from_string s fmt converts a string argument to a format string,
according to the given format string fmt.
|
| format_of_string [Pervasives] | format_of_string s returns a format string read from the string
literal s.
|
| format_of_string_fmtty [CamlinternalFormat] | |
| format_of_string_format [CamlinternalFormat] | |
| formatter_for_warnings [Location] | |
| formatter_of_buffer [Format] | formatter_of_buffer b returns a new formatter writing to
buffer b.
|
| formatter_of_out_channel [Format] | formatter_of_out_channel oc returns a new formatter that
writes to the corresponding channel oc.
|
| fortran_layout [Bigarray] | |
| forward_tag [Obj] | |
| fprintf [Printf] | fprintf outchan format arg1 ... argN formats the arguments
arg1 to argN according to the format string format, and
outputs the resulting string on the channel outchan.
|
| fprintf [Format] | |
| free_structure_names [Depend] | |
| freeze_char_set [CamlinternalFormat] | |
| frexp [Pervasives] | frexp f returns the pair of the significant
and the exponent of f.
|
| from [Stream] | Stream.from f returns a stream built from the function f.
|
| from_bytes [Marshal] | Marshal.from_bytes buff ofs unmarshals a structured value
like Marshal.from_channel does, except that the byte
representation is not read from a channel, but taken from
the byte sequence buff, starting at position ofs.
|
| from_channel [Scanf.Scanning] | Scanning.from_channel ic returns a Scanf.Scanning.in_channel formatted
input channel which reads from the regular in_channel input
channel ic argument.
|
| from_channel [Marshal] | Marshal.from_channel chan reads from channel chan the
byte representation of a structured value, as produced by
one of the Marshal.to_* functions, and reconstructs and
returns the corresponding value.
|
| from_channel [Lexing] |
Create a lexer buffer on the given input channel.
|
| from_file [Scanf.Scanning] |
An alias for
Scanf.Scanning.open_in above.
|
| from_file_bin [Scanf.Scanning] |
An alias for
Scanf.Scanning.open_in_bin above.
|
| from_fun [Lazy] | from_fun f is the same as lazy (f ()) but slightly more efficient.
|
| from_function [Scanf.Scanning] | Scanning.from_function f returns a Scanf.Scanning.in_channel formatted
input channel with the given function as its reading method.
|
| from_function [Lexing] |
Create a lexer buffer with the given function as its reading method.
|
| from_hex [Digest] |
Convert a hexadecimal representation back into the corresponding digest.
|
| from_string [Scanf.Scanning] | Scanning.from_string s returns a Scanf.Scanning.in_channel formatted
input channel which reads from the given string.
|
| from_string [Marshal] |
Same as
from_bytes but take a string as argument instead of a
byte sequence.
|
| from_string [Lexing] |
Create a lexer buffer which reads from
the given string.
|
| from_val [Lazy] | from_val v returns an already-forced suspension of v.
|
| fscanf [Scanf] | |
| fst [Pervasives] |
Return the first component of a pair.
|
| fst3 [Misc] | |
| fst4 [Misc] | |
| fstat [UnixLabels.LargeFile] | |
| fstat [UnixLabels] |
Return the information for the file associated with the given
descriptor.
|
| fstat [Unix.LargeFile] | |
| fstat [Unix] |
Return the information for the file associated with the given
descriptor.
|
| ftruncate [UnixLabels.LargeFile] | |
| ftruncate [UnixLabels] |
Truncates the file corresponding to the given descriptor
to the given size.
|
| ftruncate [Unix.LargeFile] |
See
Unix.ftruncate.
|
| ftruncate [Unix] |
Truncates the file corresponding to the given descriptor
to the given size.
|
| full_init [Random] |
Same as
Random.init but takes more data as seed.
|
| full_major [Gc] |
Do a minor collection, finish the current major collection cycle,
and perform a complete new cycle.
|
| full_split [Str] |
Same as
Str.split_delim, but returns
the delimiters as well as the substrings contained between
delimiters.
|
| fun_ [Ast_helper.Cl] | |
| fun_ [Ast_helper.Exp] | |
| function_ [Ast_helper.Exp] | |
| functor_ [Ast_helper.Mod] | |
| functor_ [Ast_helper.Mty] | |
G | |
| gcd_big_int [Big_int] |
Greatest common divisor of two big integers.
|
| ge_big_int [Big_int] | |
| ge_num [Num] | |
| genarray_of_array0 [Bigarray] |
Return the generic big array corresponding to the given zero-dimensional
big array.
|
| genarray_of_array1 [Bigarray] |
Return the generic big array corresponding to the given one-dimensional
big array.
|
| genarray_of_array2 [Bigarray] |
Return the generic big array corresponding to the given two-dimensional
big array.
|
| genarray_of_array3 [Bigarray] |
Return the generic big array corresponding to the given three-dimensional
big array.
|
| get [Weak] | Weak.get ar n returns None if the nth cell of ar is
empty, Some x (where x is the value) if it is full.
|
| get [Timings] |
returns the runtime in seconds of a completed pass
|
| get [String] | String.get s n returns the character at index n in string s.
|
| get [StringLabels] | String.get s n returns the character at index n in string s.
|
| get [Misc.LongString] | |
| get [Gc] |
Return the current values of the GC parameters in a
control record.
|
| get [Clflags.Float_arg_helper] | |
| get [Clflags.Int_arg_helper] | |
| get [BytesLabels] | get s n returns the byte at index n in argument s.
|
| get [Bytes] | get s n returns the byte at index n in argument s.
|
| get [Bigarray.Array3] | Array3.get a x y z, also written a.{x,y,z},
returns the element of a at coordinates (x, y, z).
|
| get [Bigarray.Array2] | Array2.get a x y, also written a.{x,y},
returns the element of a at coordinates (x, y).
|
| get [Bigarray.Array1] | Array1.get a x, or alternatively a.{x},
returns the element of a at index x.
|
| get [Bigarray.Array0] | Array0.get a returns the only element in a.
|
| get [Bigarray.Genarray] |
Read an element of a generic big array.
|
| get [ArrayLabels] | Array.get a n returns the element number n of array a.
|
| get [Array] | Array.get a n returns the element number n of array a.
|
| get [Arg_helper.Make] | |
| get_all_formatter_output_functions [Format] | |
| get_approx_printing [Arith_status] | |
| get_backtrace [Printexc] | Printexc.get_backtrace () returns a string containing the
same exception backtrace that Printexc.print_backtrace would
print.
|
| get_bucket [Gc] | get_bucket n returns the current size of the n-th future bucket
of the GC smoothing system.
|
| get_callstack [Printexc] | Printexc.get_callstack n returns a description of the top of the
call stack on the current program point (for the current thread),
with at most n entries.
|
| get_cookie [Ast_mapper] | |
| get_copy [Weak] | Weak.get_copy ar n returns None if the nth cell of ar is
empty, Some x (where x is a (shallow) copy of the value) if
it is full.
|
| get_credit [Gc] | get_credit () returns the current size of the "work done in advance"
counter of the GC smoothing system.
|
| get_data [Obj.Ephemeron] |
Same as
Ephemeron.K1.get_data
|
| get_data [Ephemeron.Kn] |
Same as
Ephemeron.K1.get_data
|
| get_data [Ephemeron.K2] |
Same as
Ephemeron.K1.get_data
|
| get_data [Ephemeron.K1] | Ephemeron.K1.get_data eph returns None if the data of eph is
empty, Some x (where x is the data) if it is full.
|
| get_data_copy [Obj.Ephemeron] |
Same as
Ephemeron.K1.get_data_copy
|
| get_data_copy [Ephemeron.Kn] |
Same as
Ephemeron.K1.get_data_copy
|
| get_data_copy [Ephemeron.K2] |
Same as
Ephemeron.K1.get_data_copy
|
| get_data_copy [Ephemeron.K1] | Ephemeron.K1.get_data_copy eph returns None if the data of eph is
empty, Some x (where x is a (shallow) copy of the data) if
it is full.
|
| get_ellipsis_text [Format] |
Return the text of the ellipsis.
|
| get_error_when_null_denominator [Arith_status] | |
| get_floating_precision [Arith_status] | |
| get_formatter_out_functions [Format] |
Return the current output functions of the pretty-printer,
including line splitting and indentation functions.
|
| get_formatter_output_functions [Format] |
Return the current output functions of the pretty-printer.
|
| get_formatter_tag_functions [Format] |
Return the current tag functions of the pretty-printer.
|
| get_image [Graphics] |
Capture the contents of a rectangle on the screen as an image.
|
| get_key [Obj.Ephemeron] |
Same as
Ephemeron.K1.get_key
|
| get_key [Ephemeron.Kn] |
Same as
Ephemeron.K1.get_key
|
| get_key [Ephemeron.K1] | Ephemeron.K1.get_key eph returns None if the key of eph is
empty, Some x (where x is the key) if it is full.
|
| get_key1 [Ephemeron.K2] |
Same as
Ephemeron.K1.get_key
|
| get_key1_copy [Ephemeron.K2] |
Same as
Ephemeron.K1.get_key_copy
|
| get_key2 [Ephemeron.K2] |
Same as
Ephemeron.K1.get_key
|
| get_key2_copy [Ephemeron.K2] |
Same as
Ephemeron.K1.get_key_copy
|
| get_key_copy [Obj.Ephemeron] |
Same as
Ephemeron.K1.get_key_copy
|
| get_key_copy [Ephemeron.Kn] |
Same as
Ephemeron.K1.get_key_copy
|
| get_key_copy [Ephemeron.K1] | Ephemeron.K1.get_key_copy eph returns None if the key of eph is
empty, Some x (where x is a (shallow) copy of the key) if
it is full.
|
| get_margin [Format] |
Returns the position of the right margin.
|
| get_mark_tags [Format] |
Return the current status of tags marking.
|
| get_max_boxes [Format] |
Returns the maximum number of boxes allowed before ellipsis.
|
| get_max_indent [Format] |
Return the maximum indentation limit (in characters).
|
| get_method [CamlinternalOO] | |
| get_method_label [CamlinternalOO] | |
| get_method_labels [CamlinternalOO] | |
| get_minor_free [Gc] |
Return the current size of the free space inside the minor heap.
|
| get_no_payload_attribute [Attr_helper] |
The
string list argument of the following functions is a list of
alternative names for the attribute we are looking for.
|
| get_normalize_ratio [Arith_status] | |
| get_normalize_ratio_when_printing [Arith_status] | |
| get_pos_info [Location] | |
| get_print_tags [Format] |
Return the current status of tags printing.
|
| get_public_method [CamlinternalOO] | |
| get_raw_backtrace [Printexc] | Printexc.get_raw_backtrace () returns the same exception
backtrace that Printexc.print_backtrace would print, but in
a raw format.
|
| get_raw_backtrace_next_slot [Printexc] | get_raw_backtrace_next_slot slot returns the next slot inlined, if any.
|
| get_raw_backtrace_slot [Printexc] | get_raw_backtrace_slot bckt pos returns the slot in position pos in the
backtrace bckt.
|
| get_ref [Misc] | |
| get_state [Random] |
Return the current state of the generator used by the basic functions.
|
| get_styles [Misc.Color] | |
| get_temp_dir_name [Filename] |
The name of the temporary directory:
Under Unix, the value of the
TMPDIR environment variable, or "/tmp"
if the variable is not set.
|
| get_variable [CamlinternalOO] | |
| get_variables [CamlinternalOO] | |
| getaddrinfo [UnixLabels] | getaddrinfo host service opts returns a list of Unix.addr_info
records describing socket parameters and addresses suitable for
communicating with the given host and service.
|
| getaddrinfo [Unix] | getaddrinfo host service opts returns a list of Unix.addr_info
records describing socket parameters and addresses suitable for
communicating with the given host and service.
|
| getcwd [UnixLabels] |
Return the name of the current working directory.
|
| getcwd [Unix] |
Return the name of the current working directory.
|
| getcwd [Sys] |
Return the current working directory of the process.
|
| getegid [UnixLabels] |
Return the effective group id under which the process runs.
|
| getegid [Unix] |
Return the effective group id under which the process runs.
|
| getenv [UnixLabels] |
Return the value associated to a variable in the process
environment.
|
| getenv [Unix] |
Return the value associated to a variable in the process
environment, unless the process has special privileges.
|
| getenv [Sys] |
Return the value associated to a variable in the process
environment.
|
| getenv_opt [Sys] |
Return the value associated to a variable in the process
environment or
None if the variable is unbound.
|
| geteuid [UnixLabels] |
Return the effective user id under which the process runs.
|
| geteuid [Unix] |
Return the effective user id under which the process runs.
|
| getgid [UnixLabels] |
Return the group id of the user executing the process.
|
| getgid [Unix] |
Return the group id of the user executing the process.
|
| getgrgid [UnixLabels] |
Find an entry in
group with the given group id, or raise
Not_found.
|
| getgrgid [Unix] |
Find an entry in
group with the given group id.
|
| getgrnam [UnixLabels] |
Find an entry in
group with the given name, or raise
Not_found.
|
| getgrnam [Unix] |
Find an entry in
group with the given name.
|
| getgroups [UnixLabels] |
Return the list of groups to which the user executing the process
belongs.
|
| getgroups [Unix] |
Return the list of groups to which the user executing the process
belongs.
|
| gethostbyaddr [UnixLabels] |
Find an entry in
hosts with the given address, or raise
Not_found.
|
| gethostbyaddr [Unix] |
Find an entry in
hosts with the given address.
|
| gethostbyname [UnixLabels] |
Find an entry in
hosts with the given name, or raise
Not_found.
|
| gethostbyname [Unix] |
Find an entry in
hosts with the given name.
|
| gethostname [UnixLabels] |
Return the name of the local host.
|
| gethostname [Unix] |
Return the name of the local host.
|
| getitimer [UnixLabels] |
Return the current status of the given interval timer.
|
| getitimer [Unix] |
Return the current status of the given interval timer.
|
| getlogin [UnixLabels] |
Return the login name of the user executing the process.
|
| getlogin [Unix] |
Return the login name of the user executing the process.
|
| getnameinfo [UnixLabels] | getnameinfo addr opts returns the host name and service name
corresponding to the socket address addr.
|
| getnameinfo [Unix] | getnameinfo addr opts returns the host name and service name
corresponding to the socket address addr.
|
| getpeername [UnixLabels] |
Return the address of the host connected to the given socket.
|
| getpeername [Unix] |
Return the address of the host connected to the given socket.
|
| getpid [UnixLabels] |
Return the pid of the process.
|
| getpid [Unix] |
Return the pid of the process.
|
| getppid [UnixLabels] |
Return the pid of the parent process.
|
| getppid [Unix] |
Return the pid of the parent process.
|
| getprotobyname [UnixLabels] |
Find an entry in
protocols with the given name, or raise
Not_found.
|
| getprotobyname [Unix] |
Find an entry in
protocols with the given name.
|
| getprotobynumber [UnixLabels] |
Find an entry in
protocols with the given protocol number,
or raise Not_found.
|
| getprotobynumber [Unix] |
Find an entry in
protocols with the given protocol number.
|
| getpwnam [UnixLabels] |
Find an entry in
passwd with the given name, or raise
Not_found.
|
| getpwnam [Unix] |
Find an entry in
passwd with the given name.
|
| getpwuid [UnixLabels] |
Find an entry in
passwd with the given user id, or raise
Not_found.
|
| getpwuid [Unix] |
Find an entry in
passwd with the given user id.
|
| getservbyname [UnixLabels] |
Find an entry in
services with the given name, or raise
Not_found.
|
| getservbyname [Unix] |
Find an entry in
services with the given name.
|
| getservbyport [UnixLabels] |
Find an entry in
services with the given service number,
or raise Not_found.
|
| getservbyport [Unix] |
Find an entry in
services with the given service number.
|
| getsockname [UnixLabels] |
Return the address of the given socket.
|
| getsockname [Unix] |
Return the address of the given socket.
|
| getsockopt [UnixLabels] |
Return the current status of a boolean-valued option
in the given socket.
|
| getsockopt [Unix] |
Return the current status of a boolean-valued option
in the given socket.
|
| getsockopt_error [UnixLabels] |
Return the error condition associated with the given socket,
and clear it.
|
| getsockopt_error [Unix] |
Return the error condition associated with the given socket,
and clear it.
|
| getsockopt_float [UnixLabels] |
Same as
Unix.getsockopt for a socket option whose value is a
floating-point number.
|
| getsockopt_float [Unix] |
Same as
Unix.getsockopt for a socket option whose value is a
floating-point number.
|
| getsockopt_int [UnixLabels] |
Same as
Unix.getsockopt for an integer-valued socket option.
|
| getsockopt_int [Unix] |
Same as
Unix.getsockopt for an integer-valued socket option.
|
| getsockopt_optint [UnixLabels] |
Same as
Unix.getsockopt for a socket option whose value is
an int option.
|
| getsockopt_optint [Unix] |
Same as
Unix.getsockopt for a socket option whose value is an
int option.
|
| gettimeofday [UnixLabels] |
Same as
UnixLabels.time, but with resolution better than 1 second.
|
| gettimeofday [Unix] |
Same as
Unix.time, but with resolution better than 1 second.
|
| getuid [UnixLabels] |
Return the user id of the user executing the process.
|
| getuid [Unix] |
Return the user id of the user executing the process.
|
| global_replace [Str] | global_replace regexp templ s returns a string identical to s,
except that all substrings of s that match regexp have been
replaced by templ.
|
| global_substitute [Str] | global_substitute regexp subst s returns a string identical
to s, except that all substrings of s that match regexp
have been replaced by the result of function subst.
|
| gmtime [UnixLabels] |
Convert a time in seconds, as returned by
UnixLabels.time, into a date
and a time.
|
| gmtime [Unix] |
Convert a time in seconds, as returned by
Unix.time, into a date and
a time.
|
| gprofile [Clflags] | |
| green [Graphics] | |
| group_beginning [Str] | group_beginning n returns the position of the first character
of the substring that was matched by the nth group of
the regular expression that was matched by the last call to a
matching or searching function (see Str.matched_string for details).
|
| group_end [Str] | group_end n returns
the position of the character following the last character of
substring that was matched by the nth group of the regular
expression that was matched by the last call to a matching or
searching function (see Str.matched_string for details).
|
| gt_big_int [Big_int] |
Usual boolean comparisons between two big integers.
|
| gt_num [Num] | |
| guard [Event] | guard fn returns the event that, when synchronized, computes
fn() and behaves as the resulting event.
|
H | |
| handle_docstrings [Lexer] | |
| handle_unix_error [UnixLabels] | handle_unix_error f x applies f to x and returns the result.
|
| handle_unix_error [Unix] | handle_unix_error f x applies f to x and returns the result.
|
| has_boxed [Builtin_attributes] | |
| has_no_payload_attribute [Attr_helper] | |
| has_symlink [UnixLabels] |
Returns
true if the user is able to create symbolic links.
|
| has_symlink [Unix] |
Returns
true if the user is able to create symbolic links.
|
| has_unboxed [Builtin_attributes] | |
| hash [Uchar] | hash u associates a non-negative integer to u.
|
| hash [MoreLabels.Hashtbl] | |
| hash [Hashtbl.SeededHashedType] |
A seeded hashing function on keys.
|
| hash [Hashtbl.HashedType] |
A hashing function on keys.
|
| hash [Hashtbl] | Hashtbl.hash x associates a nonnegative integer to any value of
any type.
|
| hash_param [MoreLabels.Hashtbl] | |
| hash_param [Hashtbl] | Hashtbl.hash_param meaningful total x computes a hash value for x,
with the same properties as for hash.
|
| hd [ListLabels] |
Return the first element of the given list.
|
| hd [List] |
Return the first element of the given list.
|
| header_size [Marshal] |
The bytes representing a marshaled value are composed of
a fixed-size header and a variable-sized data part,
whose size can be determined from the header.
|
| help_warnings [Warnings] | |
| highlight_locations [Location] | |
| host [Config] | |
| huge_fallback_count [Gc] |
Return the number of times we tried to map huge pages and had to fall
back to small pages.
|
| hypot [Pervasives] | 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.
|
I | |
| i [Complex] |
The complex number
i.
|
| id [Thread] |
Return the identifier of the given thread.
|
| id [Oo] |
Return an integer identifying this object, unique for
the current execution of the program.
|
| ident [Ast_helper.Mod] | |
| ident [Ast_helper.Mty] | |
| ident [Ast_helper.Exp] | |
| ifprintf [Printf] |
Same as
Printf.fprintf, but does not print anything.
|
| ifprintf [Format] |
Same as
fprintf above, but does not print anything.
|
| ifthenelse [Ast_helper.Exp] | |
| ignore [Pervasives] |
Discard the value of its argument and return
().
|
| ikfprintf [Printf] |
Same as
kfprintf above, but does not print anything.
|
| ikfprintf [Format] |
Same as
kfprintf above, but does not print anything.
|
| ill_formed_ast [Syntaxerr] | |
| immediate [Builtin_attributes] | |
| implementation [Printast] | |
| implementation [Parser] | |
| implementation [Parse] | |
| in_channel_length [Pervasives.LargeFile] | |
| in_channel_length [Pervasives] |
Return the size (number of characters) of the regular file
on which the given channel is opened.
|
| in_channel_of_descr [UnixLabels] |
Create an input channel reading from the given descriptor.
|
| in_channel_of_descr [Unix] |
Create an input channel reading from the given descriptor.
|
| in_comment [Lexer] | |
| in_file [Location] |
Return an empty ghost range located in a given file.
|
| in_string [Lexer] | |
| include_ [Ast_helper.Str] | |
| include_ [Ast_helper.Sig] | |
| include_dirs [Clflags] | |
| incr [Pervasives] |
Increment the integer contained in the given reference.
|
| incr_num [Num] | incr r is r:=!r+1, where r is a reference to a number.
|
| index [String] | String.index s c returns the index of the first
occurrence of character c in string s.
|
| index [StringLabels] | String.index s c returns the index of the first
occurrence of character c in string s.
|
| index [BytesLabels] | index s c returns the index of the first occurrence of byte c
in s.
|
| index [Bytes] | index s c returns the index of the first occurrence of byte c
in s.
|
| index_from [String] | String.index_from s i c returns the index of the
first occurrence of character c in string s after position i.
|
| index_from [StringLabels] | String.index_from s i c returns the index of the
first occurrence of character c in string s after position i.
|
| index_from [BytesLabels] | index_from s i c returns the index of the first occurrence of
byte c in s after position i.
|
| index_from [Bytes] | index_from s i c returns the index of the first occurrence of
byte c in s after position i.
|
| index_from_opt [String] | String.index_from_opt s i c returns the index of the
first occurrence of character c in string s after position i
or None if c does not occur in s after position i.
|
| index_from_opt [StringLabels] | String.index_from_opt s i c returns the index of the
first occurrence of character c in string s after position i
or None if c does not occur in s after position i.
|
| index_from_opt [BytesLabels] | index_from _opts i c returns the index of the first occurrence of
byte c in s after position i or None if c does not occur in s after position i.
|
| index_from_opt [Bytes] | index_from _opts i c returns the index of the first occurrence of
byte c in s after position i or None if c does not occur in s after position i.
|
| index_opt [String] | String.index_opt s c returns the index of the first
occurrence of character c in string s, or
None if c does not occur in s.
|
| index_opt [StringLabels] | String.index_opt s c returns the index of the first
occurrence of character c in string s, or
None if c does not occur in s.
|
| index_opt [BytesLabels] | index_opt s c returns the index of the first occurrence of byte c
in s or None if c does not occur in s.
|
| index_opt [Bytes] | index_opt s c returns the index of the first occurrence of byte c
in s or None if c does not occur in s.
|
| inet6_addr_any [UnixLabels] |
A special IPv6 address, for use only with
bind, representing
all the Internet addresses that the host machine possesses.
|
| inet6_addr_any [Unix] |
A special IPv6 address, for use only with
bind, representing
all the Internet addresses that the host machine possesses.
|
| inet6_addr_loopback [UnixLabels] |
A special IPv6 address representing the host machine (
::1).
|
| inet6_addr_loopback [Unix] |
A special IPv6 address representing the host machine (
::1).
|
| inet_addr_any [UnixLabels] |
A special IPv4 address, for use only with
bind, representing
all the Internet addresses that the host machine possesses.
|
| inet_addr_any [Unix] |
A special IPv4 address, for use only with
bind, representing
all the Internet addresses that the host machine possesses.
|
| inet_addr_loopback [UnixLabels] |
A special IPv4 address representing the host machine (
127.0.0.1).
|
| inet_addr_loopback [Unix] |
A special IPv4 address representing the host machine (
127.0.0.1).
|
| inet_addr_of_string [UnixLabels] |
Conversion from the printable representation of an Internet
address to its internal representation.
|
| inet_addr_of_string [Unix] |
Conversion from the printable representation of an Internet
address to its internal representation.
|
| infinity [Pervasives] |
Positive infinity.
|
| infix_tag [Obj] | |
| info_attr [Docstrings] | |
| inherit_ [Ast_helper.Cf] | |
| inherit_ [Ast_helper.Ctf] | |
| inherits [CamlinternalOO] | |
| init [String] | String.init n f returns a string of length n, with character
i initialized to the result of f i (called in increasing
index order).
|
| init [StringLabels] | init n f returns a string of length n,
with character i initialized to the result of f i.
|
| init [Random] |
Initialize the generator, using the argument as a seed.
|
| init [Location] |
Set the file name and line number of the
lexbuf to be the start
of the named file.
|
| init [Lexer] | |
| init [Dynlink] | |
| init [Docstrings] |
(Re)Initialise all docstring state
|
| init [BytesLabels] | init n f returns a fresh byte sequence of length n,
with character i initialized to the result of f i.
|
| init [Bytes] | Bytes.init n f returns a fresh byte sequence of length n, with
character i initialized to the result of f i (in increasing
index order).
|
| init [ArrayLabels] | Array.init n f returns a fresh array of length n,
with element number i initialized to the result of f i.
|
| init [Array] | Array.init n f returns a fresh array of length n,
with element number i initialized to the result of f i.
|
| init_class [CamlinternalOO] | |
| init_file [Clflags] | |
| init_mod [CamlinternalMod] | |
| initgroups [UnixLabels] | initgroups user group initializes the group access list by
reading the group database /etc/group and using all groups of
which user is a member.
|
| initgroups [Unix] | initgroups user group initializes the group access list by
reading the group database /etc/group and using all groups of
which user is a member.
|
| initializer_ [Ast_helper.Cf] | |
| inline_alloc_cost [Clflags] | |
| inline_branch_cost [Clflags] | |
| inline_branch_factor [Clflags] | |
| inline_call_cost [Clflags] | |
| inline_indirect_cost [Clflags] | |
| inline_lifting_benefit [Clflags] | |
| inline_max_depth [Clflags] | |
| inline_max_unroll [Clflags] | |
| inline_prim_cost [Clflags] | |
| inline_threshold [Clflags] | |
| inline_toplevel_threshold [Clflags] | |
| inlining_report [Clflags] | |
| input [Pervasives] | 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.
|
| input [Digest] |
Read a digest from the given input channel.
|
| input_binary_int [Pervasives] |
Read an integer encoded in binary format (4 bytes, big-endian)
from the given input channel.
|
| input_byte [Pervasives] |
Same as
input_char, but return the 8-bit integer representing
the character.
|
| input_bytes [Misc.LongString] | |
| input_char [Pervasives] |
Read one character from the given input channel.
|
| input_lexbuf [Location] | |
| input_line [Pervasives] |
Read characters from the given input channel, until a
newline character is encountered.
|
| input_name [Location] | |
| input_value [Pervasives] |
Read the representation of a structured value, as produced
by
output_value, and return the corresponding value.
|
| int [Random.State] | |
| int [Random] | Random.int bound returns a random integer between 0 (inclusive)
and bound (exclusive).
|
| int [Misc.Int_literal_converter] | |
| int [Bigarray] |
See
Bigarray.char.
|
| int [Ast_helper.Const] | |
| int16_signed [Bigarray] |
See
Bigarray.char.
|
| int16_unsigned [Bigarray] |
See
Bigarray.char.
|
| int32 [Random.State] | |
| int32 [Random] | Random.int32 bound returns a random integer between 0 (inclusive)
and bound (exclusive).
|
| int32 [Misc.Int_literal_converter] | |
| int32 [Bigarray] |
See
Bigarray.char.
|
| int32 [Ast_helper.Const] | |
| int32_of_big_int [Big_int] |
Convert a big integer to a 32-bit integer.
|
| int32_of_big_int_opt [Big_int] |
Convert a big integer to a 32-bit integer.
|
| int64 [Random.State] | |
| int64 [Random] | Random.int64 bound returns a random integer between 0 (inclusive)
and bound (exclusive).
|
| int64 [Misc.Int_literal_converter] | |
| int64 [Bigarray] |
See
Bigarray.char.
|
| int64 [Ast_helper.Const] | |
| int64_of_big_int [Big_int] |
Convert a big integer to a 64-bit integer.
|
| int64_of_big_int_opt [Big_int] |
Convert a big integer to a 64-bit integer.
|
| int8_signed [Bigarray] |
See
Bigarray.char.
|
| int8_unsigned [Bigarray] |
See
Bigarray.char.
|
| int_of_big_int [Big_int] |
Convert a big integer to a small integer (type
int).
|
| int_of_big_int_opt [Big_int] |
Convert a big integer to a small integer (type
int).
|
| int_of_char [Pervasives] |
Return the ASCII code of the argument.
|
| int_of_float [Pervasives] |
Truncate the given floating-point number to an integer.
|
| int_of_num [Num] | |
| int_of_num_opt [Num] | |
| int_of_string [Pervasives] |
Convert the given string to an integer.
|
| int_of_string_opt [Pervasives] |
Same as
int_of_string, but returs None instead of raising.
|
| int_size [Sys] |
Size of an int.
|
| int_tag [Obj] | |
| integer [Ast_helper.Const] | |
| integer_num [Num] | integer_num n returns the integer closest to n.
|
| inter [MoreLabels.Set.S] | |
| inter [Set.S] |
Set intersection.
|
| interactive [Sys] |
This reference is initially set to
false in standalone
programs and to true if the code is being executed under
the interactive toplevel system ocaml.
|
| interface [Printast] | |
| interface [Parser] | |
| interface [Parse] | |
| interface_suffix [Config] | |
| interval [Ast_helper.Pat] | |
| inv [Complex] |
Multiplicative inverse (
1/z).
|
| invalid_arg [Pervasives] |
Raise exception
Invalid_argument with the given string.
|
| is_active [Warnings] | |
| is_block [Obj] | |
| is_char [Uchar] | is_char u is true iff u is a latin1 OCaml character.
|
| is_directory [Sys] |
Returns
true if the given name refers to a directory,
false if it refers to another kind of file.
|
| is_empty [Stack] |
Return
true if the given stack is empty, false otherwise.
|
| is_empty [Queue] |
Return
true if the given queue is empty, false otherwise.
|
| is_empty [MoreLabels.Set.S] | |
| is_empty [MoreLabels.Map.S] | |
| is_empty [Map.S] |
Test whether a map is empty or not.
|
| is_empty [Set.S] |
Test whether a set is empty or not.
|
| is_error [Warnings] | |
| is_implicit [Filename] |
Return
true if the file name is relative and does not start
with an explicit reference to the current directory (./ or
../ in Unix), false if it starts with an explicit reference
to the root directory or the current directory.
|
| is_in_char_set [CamlinternalFormat] | |
| is_inline [Printexc.Slot] | is_inline slot is true when slot refers to a call
that got inlined by the compiler, and false when it comes from
any other context.
|
| is_int [Obj] | |
| is_int_big_int [Big_int] |
Test whether the given big integer is small enough to
be representable as a small integer (type
int)
without loss of precision.
|
| is_integer_num [Num] |
Test if a number is an integer
|
| is_native [Dynlink] | true if the program is native,
false if the program is bytecode.
|
| is_raise [Printexc.Slot] | is_raise slot is true when slot refers to a raising
point in the code, and false when it comes from a simple
function call.
|
| is_randomized [MoreLabels.Hashtbl] | |
| is_randomized [Hashtbl] |
return if the tables are currently created in randomized mode by default
|
| is_relative [Filename] |
Return
true if the file name is relative to the current
directory, false if it is absolute (i.e.
|
| is_val [Lazy] | is_val x returns true if x has already been forced and
did not raise an exception.
|
| is_valid [Uchar] | is_valid n is true iff n is an Unicode scalar value
(i.e.
|
| isatty [UnixLabels] |
Return
true if the given file descriptor refers to a terminal or
console window, false otherwise.
|
| isatty [Unix] |
Return
true if the given file descriptor refers to a terminal or
console window, false otherwise.
|
| iter [Weak.S] | iter f t calls f on each element of t, in some unspecified
order.
|
| iter [Tbl] | |
| iter [String] | String.iter f s applies function f in turn to all
the characters of s.
|
| iter [Stream] | Stream.iter f s scans the whole stream s, applying function f
in turn to each stream element encountered.
|
| iter [StringLabels] | String.iter f s applies function f in turn to all
the characters of s.
|
| iter [Stack] | iter f s applies f in turn to all elements of s,
from the element at the top of the stack to the element at the
bottom of the stack.
|
| iter [Queue] | iter f q applies f in turn to all elements of q,
from the least recently entered to the most recently entered.
|
| iter [MoreLabels.Set.S] | |
| iter [MoreLabels.Map.S] | |
| iter [MoreLabels.Hashtbl.SeededS] | |
| iter [MoreLabels.Hashtbl.S] | |
| iter [MoreLabels.Hashtbl] | |
| iter [Misc.Stdlib.Option] | |
| iter [ListLabels] | List.iter f [a1; ...; an] applies function f in turn to
a1; ...; an.
|
| iter [List] | List.iter f [a1; ...; an] applies function f in turn to
a1; ...; an.
|
| iter [Hashtbl.SeededS] | |
| iter [Hashtbl.S] | |
| iter [Hashtbl] | Hashtbl.iter f tbl applies f to all bindings in table tbl.
|
| iter [Map.S] | iter f m applies f to all bindings in map m.
|
| iter [Set.S] | iter f s applies f in turn to all elements of s.
|
| iter [BytesLabels] | iter f s applies function f in turn to all the bytes of s.
|
| iter [Bytes] | iter f s applies function f in turn to all the bytes of s.
|
| iter [ArrayLabels] | Array.iter f a applies function f in turn to all
the elements of a.
|
| iter [Array] | Array.iter f a applies function f in turn to all
the elements of a.
|
| iter2 [ListLabels] | List.iter2 f [a1; ...; an] [b1; ...; bn] calls in turn
f a1 b1; ...; f an bn.
|
| iter2 [List] | List.iter2 f [a1; ...; an] [b1; ...; bn] calls in turn
f a1 b1; ...; f an bn.
|
| iter2 [ArrayLabels] | Array.iter2 f a b applies function f to all the elements of a
and b.
|
| iter2 [Array] | Array.iter2 f a b applies function f to all the elements of a
and b.
|
| iteri [String] |
Same as
String.iter, but the
function is applied to the index of the element as first argument
(counting from 0), and the character itself as second argument.
|
| iteri [StringLabels] |
Same as
String.iter, but the
function is applied to the index of the element as first argument
(counting from 0), and the character itself as second argument.
|
| iteri [ListLabels] |
Same as
List.iter, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.
|
| iteri [List] |
Same as
List.iter, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.
|
| iteri [BytesLabels] |
Same as
Bytes.iter, but the function is applied to the index of
the byte as first argument and the byte itself as second
argument.
|
| iteri [Bytes] |
Same as
Bytes.iter, but the function is applied to the index of
the byte as first argument and the byte itself as second
argument.
|
| iteri [ArrayLabels] |
Same as
Array.iter, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.
|
| iteri [Array] |
Same as
Array.iter, but the
function is applied with the index of the element as first argument,
and the element itself as second argument.
|
J | |
| join [Thread] | join th suspends the execution of the calling thread
until the thread th has terminated.
|
| junk [Stream] |
Remove the first element of the stream, possibly unfreezing
it before.
|
K | |
| kasprintf [Format] |
Same as
asprintf above, but instead of returning the string,
passes it to the first argument.
|
| kbprintf [Printf] |
Same as
bprintf, but instead of returning immediately,
passes the buffer to its first argument at the end of printing.
|
| keep_asm_file [Clflags] | |
| keep_docs [Clflags] | |
| keep_locs [Clflags] | |
| keep_startup_file [Clflags] | |
| key_pressed [Graphics] |
Return
true if a keypress is available; that is, if read_key
would not block.
|
| keys [Identifiable.S.Map] | |
| kfprintf [Printf] |
Same as
fprintf, but instead of returning immediately,
passes the out channel to its first argument at the end of printing.
|
| kfprintf [Format] |
Same as
fprintf above, but instead of returning immediately,
passes the formatter to its first argument at the end of printing.
|
| kfscanf [Scanf] | |
| kill [UnixLabels] | kill pid sig sends signal number sig to the process
with id pid.
|
| kill [Unix] | kill pid sig sends signal number sig to the process
with id pid.
|
| kill [Thread] |
Terminate prematurely the thread whose handle is given.
|
| kind [Bigarray.Array3] |
Return the kind of the given big array.
|
| kind [Bigarray.Array2] |
Return the kind of the given big array.
|
| kind [Bigarray.Array1] |
Return the kind of the given big array.
|
| kind [Bigarray.Array0] |
Return the kind of the given big array.
|
| kind [Bigarray.Genarray] |
Return the kind of the given big array.
|
| kind_size_in_bytes [Bigarray] | kind_size_in_bytes k is the number of bytes used to store
an element of type k.
|
| kprintf [Printf] |
A deprecated synonym for
ksprintf.
|
| kprintf [Format] | |
| kscanf [Scanf] |
Same as
Scanf.bscanf, but takes an additional function argument
ef that is called in case of error: if the scanning process or
some conversion fails, the scanning function aborts and calls the
error handling function ef with the formatted input channel and the
exception that aborted the scanning process as arguments.
|
| ksprintf [Printf] |
Same as
sprintf above, but instead of returning the string,
passes it to the first argument.
|
| ksprintf [Format] |
Same as
sprintf above, but instead of returning the string,
passes it to the first argument.
|
| ksscanf [Scanf] |
Same as
Scanf.kscanf but reads from the given string.
|
L | |
| last [Longident] | |
| last_chars [Str] | last_chars s n returns the last n characters of s.
|
| last_non_constant_constructor_tag [Obj] | |
| layout [Bigarray.Array3] |
Return the layout of the given big array.
|
| layout [Bigarray.Array2] |
Return the layout of the given big array.
|
| layout [Bigarray.Array1] |
Return the layout of the given big array.
|
| layout [Bigarray.Array0] |
Return the layout of the given big array.
|
| layout [Bigarray.Genarray] |
Return the layout of the given big array.
|
| lazy_ [Ast_helper.Exp] | |
| lazy_ [Ast_helper.Pat] | |
| lazy_from_fun [Lazy] | |
| lazy_from_val [Lazy] | |
| lazy_is_val [Lazy] | |
| lazy_tag [Obj] | |
| lazy_tag [Config] | |
| ldexp [Pervasives] | ldexp x n returns x *. 2 ** n.
|
| le_big_int [Big_int] | |
| le_num [Num] | |
| length [Weak] | Weak.length ar returns the length (number of elements) of
ar.
|
| length [String] |
Return the length (number of characters) of the given string.
|
| length [StringLabels] |
Return the length (number of characters) of the given string.
|
| length [Stack] |
Return the number of elements in a stack.
|
| length [Queue] |
Return the number of elements in a queue.
|
| length [Obj.Ephemeron] |
return the number of keys
|
| length [MoreLabels.Hashtbl.SeededS] | |
| length [MoreLabels.Hashtbl.S] | |
| length [MoreLabels.Hashtbl] | |
| length [Misc.LongString] | |
| length [ListLabels] |
Return the length (number of elements) of the given list.
|
| length [List] |
Return the length (number of elements) of the given list.
|
| length [Hashtbl.SeededS] | |
| length [Hashtbl.S] | |
| length [Hashtbl] | Hashtbl.length tbl returns the number of bindings in tbl.
|
| length [BytesLabels] |
Return the length (number of bytes) of the argument.
|
| length [Bytes] |
Return the length (number of bytes) of the argument.
|
| length [Buffer] |
Return the number of characters currently contained in the buffer.
|
| length [ArrayLabels] |
Return the length (number of elements) of the given array.
|
| length [Array] |
Return the length (number of elements) of the given array.
|
| let_ [Ast_helper.Cl] | |
| let_ [Ast_helper.Exp] | |
| letexception [Ast_helper.Exp] | |
| letmodule [Ast_helper.Exp] | |
| lexeme [Lexing] | Lexing.lexeme lexbuf returns the string matched by
the regular expression.
|
| lexeme_char [Lexing] | Lexing.lexeme_char lexbuf i returns character number i in
the matched string.
|
| lexeme_end [Lexing] | Lexing.lexeme_end lexbuf returns the offset in the input stream
of the character following the last character of the matched
string.
|
| lexeme_end_p [Lexing] |
Like
lexeme_end, but return a complete position instead
of an offset.
|
| lexeme_start [Lexing] | Lexing.lexeme_start lexbuf returns the offset in the
input stream of the first character of the matched string.
|
| lexeme_start_p [Lexing] |
Like
lexeme_start, but return a complete position instead
of an offset.
|
| libunwind_available [Config] | |
| libunwind_link_flags [Config] | |
| lineto [Graphics] |
Draw a line with endpoints the current point and the given point,
and move the current point to the given point.
|
| link [UnixLabels] | link source dest creates a hard link named dest to the file
named source.
|
| link [Unix] | link source dest creates a hard link named dest to the file
named source.
|
| link_everything [Clflags] | |
| list [Sort] |
Sort a list in increasing order according to an ordering predicate.
|
| list_remove [Misc] | |
| listen [UnixLabels] |
Set up a socket for receiving connection requests.
|
| listen [Unix] |
Set up a socket for receiving connection requests.
|
| lnot [Pervasives] |
Bitwise logical negation.
|
| load_path [Config] | |
| loadfile [Dynlink] |
In bytecode: load the given bytecode object file (
.cmo file) or
bytecode library file (.cma file), and link it with the running
program.
|
| loadfile_private [Dynlink] |
Same as
loadfile, except that the compilation units just loaded
are hidden (cannot be referenced) from other modules dynamically
loaded afterwards.
|
| localtime [UnixLabels] |
Convert a time in seconds, as returned by
UnixLabels.time, into a date
and a time.
|
| localtime [Unix] |
Convert a time in seconds, as returned by
Unix.time, into a date and
a time.
|
| location [Printexc.Slot] | location slot returns the location information of the slot,
if available, and None otherwise.
|
| location_of_error [Syntaxerr] | |
| lock [Mutex] |
Lock the given mutex.
|
| lockf [UnixLabels] | lockf fd cmd size puts a lock on a region of the file opened
as fd.
|
| lockf [Unix] | lockf fd cmd size puts a lock on a region of the file opened
as fd.
|
| log [Pervasives] |
Natural logarithm.
|
| log [Complex] |
Natural logarithm (in base
e).
|
| log10 [Pervasives] |
Base 10 logarithm.
|
| log1p [Pervasives] | log1p x computes log(1.0 +. x) (natural logarithm),
giving numerically-accurate results even if x is close to 0.0.
|
| log2 [Misc] | |
| logand [Targetint] |
Bitwise logical and.
|
| logand [Nativeint] |
Bitwise logical and.
|
| logand [Int64] |
Bitwise logical and.
|
| logand [Int32] |
Bitwise logical and.
|
| lognot [Targetint] |
Bitwise logical negation
|
| lognot [Nativeint] |
Bitwise logical negation
|
| lognot [Int64] |
Bitwise logical negation
|
| lognot [Int32] |
Bitwise logical negation
|
| logor [Targetint] |
Bitwise logical or.
|
| logor [Nativeint] |
Bitwise logical or.
|
| logor [Int64] |
Bitwise logical or.
|
| logor [Int32] |
Bitwise logical or.
|
| logxor [Targetint] |
Bitwise logical exclusive or.
|
| logxor [Nativeint] |
Bitwise logical exclusive or.
|
| logxor [Int64] |
Bitwise logical exclusive or.
|
| logxor [Int32] |
Bitwise logical exclusive or.
|
| lookup_tables [CamlinternalOO] | |
| loop_at_exit [Graphics] |
Loop before exiting the program, the list given as argument is the
list of handlers and the events on which these handlers are called.
|
| lowercase [String] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| lowercase [StringLabels] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| lowercase [Char] |
Convert the given character to its equivalent lowercase character,
using the ISO Latin-1 (8859-1) character set.
|
| lowercase [BytesLabels] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| lowercase [Bytes] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| lowercase_ascii [String] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, using the US-ASCII character set.
|
| lowercase_ascii [StringLabels] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, using the US-ASCII character set.
|
| lowercase_ascii [Char] |
Convert the given character to its equivalent lowercase character,
using the US-ASCII character set.
|
| lowercase_ascii [BytesLabels] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, using the US-ASCII character set.
|
| lowercase_ascii [Bytes] |
Return a copy of the argument, with all uppercase letters
translated to lowercase, using the US-ASCII character set.
|
| lseek [UnixLabels.LargeFile] | |
| lseek [UnixLabels] |
Set the current position for a file descriptor, and return the resulting
offset (from the beginning of the file).
|
| lseek [Unix.LargeFile] |
See
Unix.lseek.
|
| lseek [Unix] |
Set the current position for a file descriptor, and return the resulting
offset (from the beginning of the file).
|
| lstat [UnixLabels.LargeFile] | |
| lstat [UnixLabels] |
Same as
UnixLabels.stat, but in case the file is a symbolic link,
return the information for the link itself.
|
| lstat [Unix.LargeFile] | |
| lstat [Unix] |
Same as
Unix.stat, but in case the file is a symbolic link,
return the information for the link itself.
|
| lt_big_int [Big_int] | |
| lt_num [Num] | |
M | |
| magenta [Graphics] | |
| magic [Obj] | |
| major [Gc] |
Do a minor collection and finish the current major collection cycle.
|
| major_slice [Gc] | major_slice n
Do a minor collection and a slice of major collection.
|
| make [String] | String.make n c returns a fresh string of length n,
filled with the character c.
|
| make [StringLabels] | String.make n c returns a fresh string of length n,
filled with the character c.
|
| make [Random.State] |
Create a new state and initialize it with the given seed.
|
| make [BytesLabels] | make n c returns a new byte sequence of length n, filled with
the byte c.
|
| make [Bytes] | make n c returns a new byte sequence of length n, filled with
the byte c.
|
| make [ArrayLabels] | Array.make n x returns a fresh array of length n,
initialized with x.
|
| make [Array] | Array.make n x returns a fresh array of length n,
initialized with x.
|
| make_archive [Clflags] | |
| make_class [CamlinternalOO] | |
| make_class_store [CamlinternalOO] | |
| make_float [ArrayLabels] | |
| make_float [Array] | |
| make_formatter [Format] | make_formatter out flush returns a new formatter that writes according
to the output function out, and the flushing function flush.
|
| make_image [Graphics] |
Convert the given color matrix to an image.
|
| make_iprintf [CamlinternalFormat] | |
| make_leaf [Depend] | |
| make_lexer [Genlex] |
Construct the lexer function.
|
| make_matrix [ArrayLabels] | Array.make_matrix dimx dimy e returns a two-dimensional array
(an array of arrays) with first dimension dimx and
second dimension dimy.
|
| make_matrix [Array] | Array.make_matrix dimx dimy e returns a two-dimensional array
(an array of arrays) with first dimension dimx and
second dimension dimy.
|
| make_node [Depend] | |
| make_package [Clflags] | |
| make_printf [CamlinternalFormat] | |
| make_runtime [Clflags] | |
| make_self_init [Random.State] |
Create a new state and initialize it with a system-dependent
low-entropy seed.
|
| map [Tbl] | |
| map [String] | String.map f s applies function f in turn to all the
characters of s (in increasing index order) and stores the
results in a new string that is returned.
|
| map [StringLabels] | String.map f s applies function f in turn to all
the characters of s and stores the results in a new string that
is returned.
|
| map [MoreLabels.Set.S] | |
| map [MoreLabels.Map.S] | |
| map [Misc.Stdlib.Option] | |
| map [ListLabels] | List.map f [a1; ...; an] applies function f to a1, ..., an,
and builds the list [f a1; ...; f an]
with the results returned by f.
|
| map [List] | List.map f [a1; ...; an] applies function f to a1, ..., an,
and builds the list [f a1; ...; f an]
with the results returned by f.
|
| map [Identifiable.S.Tbl] | |
| map [Identifiable.S.Set] | |
| map [Map.S] | map f m returns a map with same domain as m, where the
associated value a of all bindings of m has been
replaced by the result of the application of f to a.
|
| map [Set.S] | map f s is the set whose elements are f a0,f a1...
|
| map [BytesLabels] | map f s applies function f in turn to all the bytes of s and
stores the resulting bytes in a new sequence that is returned as
the result.
|
| map [Bytes] | map f s applies function f in turn to all the bytes of s
(in increasing index order) and stores the resulting bytes in
a new sequence that is returned as the result.
|
| map [ArrayLabels] | Array.map f a applies function f to all the elements of a,
and builds an array with the results returned by f:
[| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |].
|
| map [Array] | Array.map f a applies function f to all the elements of a,
and builds an array with the results returned by f:
[| f a.(0); f a.(1); ...; f a.(Array.length a - 1) |].
|
| map2 [ListLabels] | List.map2 f [a1; ...; an] [b1; ...; bn] is
[f a1 b1; ...; f an bn].
|
| map2 [List] | List.map2 f [a1; ...; an] [b1; ...; bn] is
[f a1 b1; ...; f an bn].
|
| map2 [ArrayLabels] | Array.map2 f a b applies function f to all the elements of a
and b, and builds an array with the results returned by f:
[| f a.(0) b.(0); ...; f a.(Array.length a - 1) b.(Array.length b - 1)|].
|
| map2 [Array] | Array.map2 f a b applies function f to all the elements of a
and b, and builds an array with the results returned by f:
[| f a.(0) b.(0); ...; f a.(Array.length a - 1) b.(Array.length b - 1)|].
|
| map2_prefix [Misc.Stdlib.List] | let r1, r2 = map2_prefix f l1 l2
If l1 is of length n and l2 = h2 @ t2 with h2 of length n,
r1 is List.map2 f l1 h1 and r2 is t2.
|
| map_end [Misc] | |
| map_file [Bigarray.Array3] |
Memory mapping of a file as a three-dimensional big array.
|
| map_file [Bigarray.Array2] |
Memory mapping of a file as a two-dimensional big array.
|
| map_file [Bigarray.Array1] |
Memory mapping of a file as a one-dimensional big array.
|
| map_file [Bigarray.Genarray] |
Memory mapping of a file as a big array.
|
| map_keys [Identifiable.S.Map] | |
| map_left_right [Misc] | |
| map_opt [Ast_mapper] | |
| mapi [String] | String.mapi f s calls f with each character of s and its
index (in increasing index order) and stores the results in a new
string that is returned.
|
| mapi [StringLabels] | String.mapi f s calls f with each character of s and its
index (in increasing index order) and stores the results in a new
string that is returned.
|
| mapi [MoreLabels.Map.S] | |
| mapi [ListLabels] |
Same as
List.map, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.
|
| mapi [List] |
Same as
List.map, but the function is applied to the index of
the element as first argument (counting from 0), and the element
itself as second argument.
|
| mapi [Map.S] |
Same as
Map.S.map, but the function receives as arguments both the
key and the associated value for each binding of the map.
|
| mapi [BytesLabels] | mapi f s calls f with each character of s and its
index (in increasing index order) and stores the resulting bytes
in a new sequence that is returned as the result.
|
| mapi [Bytes] | mapi f s calls f with each character of s and its
index (in increasing index order) and stores the resulting bytes
in a new sequence that is returned as the result.
|
| mapi [ArrayLabels] |
Same as
Array.map, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.
|
| mapi [Array] |
Same as
Array.map, but the
function is applied to the index of the element as first argument,
and the element itself as second argument.
|
| mark_rhs_docs [Docstrings] |
Mark as associated the item documentation for the symbols between
two positions (for ambiguity warnings)
|
| mark_symbol_docs [Docstrings] |
Mark the item documentation for the current symbol (for ambiguity
warnings).
|
| marshal [Obj] | |
| match_ [Ast_helper.Exp] | |
| match_beginning [Str] | match_beginning() returns the position of the first character
of the substring that was matched by the last call to a matching
or searching function (see Str.matched_string for details).
|
| match_end [Str] | match_end() returns the position of the character following the
last character of the substring that was matched by the last call
to a matching or searching function (see Str.matched_string for
details).
|
| matched_group [Str] | matched_group n s returns the substring of s that was matched
by the nth group \(...\) of the regular expression that was
matched by the last call to a matching or searching function (see
Str.matched_string for details).
|
| matched_string [Str] | matched_string s returns the substring of s that was matched
by the last call to one of the following matching or searching
functions: Str.string_match, Str.search_forward, Str.search_backward, Str.string_partial_match, Str.global_substitute, Str.substitute_first
provided that none of the following functions was called inbetween: Str.global_replace, Str.replace_first, Str.split, Str.bounded_split, Str.split_delim, Str.bounded_split_delim, Str.full_split, Str.bounded_full_split
Note: in the case of global_substitute and substitute_first,
a call to matched_string is only valid within the subst argument,
not after global_substitute or substitute_first returns.
|
| max [Uchar] | max is U+10FFFF.
|
| max [Pervasives] |
Return the greater of the two arguments.
|
| max_array_length [Sys] |
Maximum length of a normal array.
|
| max_big_int [Big_int] |
Return the greater of its two arguments.
|
| max_binding [MoreLabels.Map.S] | |
| max_binding [Map.S] |
Same as
Map.S.min_binding, but returns the largest binding
of the given map.
|
| max_binding_opt [MoreLabels.Map.S] | |
| max_binding_opt [Map.S] |
Same as
Map.S.min_binding_opt, but returns the largest binding
of the given map.
|
| max_elt [MoreLabels.Set.S] | |
| max_elt [Set.S] |
Same as
Set.S.min_elt, but returns the largest element of the
given set.
|
| max_elt_opt [MoreLabels.Set.S] | |
| max_elt_opt [Set.S] |
Same as
Set.S.min_elt_opt, but returns the largest element of the
given set.
|
| max_float [Pervasives] |
The largest positive finite value of type
float.
|
| max_int [Targetint] |
The greatest representable target integer,
either 231 - 1 on a 32-bit platform,
or 263 - 1 on a 64-bit platform.
|
| max_int [Pervasives] |
The greatest representable integer.
|
| max_int [Nativeint] |
The greatest representable native integer,
either 231 - 1 on a 32-bit platform,
or 263 - 1 on a 64-bit platform.
|
| max_int [Int64] |
The greatest representable 64-bit integer, 263 - 1.
|
| max_int [Int32] |
The greatest representable 32-bit integer, 231 - 1.
|
| max_num [Num] |
Return the greater of the two arguments.
|
| max_string_length [Sys] |
Maximum length of strings and byte sequences.
|
| max_tag [Config] | |
| max_young_wosize [Config] | |
| may [Misc] | |
| may_map [Misc] | |
| mem [Weak.S] | mem t x returns true if there is at least one instance
of x in t, false otherwise.
|
| mem [Tbl] | |
| mem [MoreLabels.Set.S] | |
| mem [MoreLabels.Map.S] | |
| mem [MoreLabels.Hashtbl.SeededS] | |
| mem [MoreLabels.Hashtbl.S] | |
| mem [MoreLabels.Hashtbl] | |
| mem [ListLabels] | mem a l is true if and only if a is equal
to an element of l.
|
| mem [List] | mem a l is true if and only if a is equal
to an element of l.
|
| mem [Hashtbl.SeededS] | |
| mem [Hashtbl.S] | |
| mem [Hashtbl] | Hashtbl.mem tbl x checks if x is bound in tbl.
|
| mem [Map.S] | mem x m returns true if m contains a binding for x,
and false otherwise.
|
| mem [Set.S] | mem x s tests whether x belongs to the set s.
|
| mem [ArrayLabels] | mem x a is true if and only if x is equal
to an element of a.
|
| mem [Array] | mem a l is true if and only if a is equal
to an element of l.
|
| mem_assoc [ListLabels] |
Same as
List.assoc, but simply return true if a binding exists,
and false if no bindings exist for the given key.
|
| mem_assoc [List] |
Same as
List.assoc, but simply return true if a binding exists,
and false if no bindings exist for the given key.
|
| mem_assq [ListLabels] |
Same as
List.mem_assoc, but uses physical equality instead of
structural equality to compare keys.
|
| mem_assq [List] |
Same as
List.mem_assoc, but uses physical equality instead of
structural equality to compare keys.
|
| memoize [Identifiable.S.Tbl] | |
| memq [ListLabels] |
Same as
List.mem, but uses physical equality instead of structural
equality to compare list elements.
|
| memq [List] |
Same as
List.mem, but uses physical equality instead of structural
equality to compare list elements.
|
| memq [ArrayLabels] |
Same as
Array.mem, but uses physical equality instead of structural
equality to compare list elements.
|
| memq [Array] |
Same as
Array.mem, but uses physical equality instead of structural
equality to compare array elements.
|
| merge [Weak.S] | merge t x returns an instance of x found in t if any,
or else adds x to t and return x.
|
| merge [Sort] |
Merge two lists according to the given predicate.
|
| merge [MoreLabels.Map.S] | |
| merge [ListLabels] |
Merge two lists:
Assuming that
l1 and l2 are sorted according to the
comparison function cmp, merge cmp l1 l2 will return a
sorted list containting all the elements of l1 and l2.
|
| merge [List] |
Merge two lists:
Assuming that
l1 and l2 are sorted according to the
comparison function cmp, merge cmp l1 l2 will return a
sorted list containting all the elements of l1 and l2.
|
| merge [Map.S] | merge f m1 m2 computes a map whose keys is a subset of keys of m1
and of m2.
|
| method_ [Ast_helper.Cf] | |
| method_ [Ast_helper.Ctf] | |
| min [Uchar] | min is U+0000.
|
| min [Pervasives] |
Return the smaller of the two arguments.
|
| min_big_int [Big_int] |
Return the smaller of its two arguments.
|
| min_binding [MoreLabels.Map.S] | |
| min_binding [Map.S] |
Return the smallest binding of the given map
(with respect to the
Ord.compare ordering), or raise
Not_found if the map is empty.
|
| min_binding_opt [MoreLabels.Map.S] | |
| min_binding_opt [Map.S] |
Return the smallest binding of the given map
(with respect to the
Ord.compare ordering), or None
if the map is empty.
|
| min_elt [MoreLabels.Set.S] | |
| min_elt [Set.S] |
Return the smallest element of the given set
(with respect to the
Ord.compare ordering), or raise
Not_found if the set is empty.
|
| min_elt_opt [MoreLabels.Set.S] | |
| min_elt_opt [Set.S] |
Return the smallest element of the given set
(with respect to the
Ord.compare ordering), or None
if the set is empty.
|
| min_float [Pervasives] |
The smallest positive, non-zero, non-denormalized value of type
float.
|
| min_int [Targetint] |
The smallest representable target integer,
either -231 on a 32-bit platform,
or -263 on a 64-bit platform.
|
| min_int [Pervasives] |
The smallest representable integer.
|
| min_int [Nativeint] |
The smallest representable native integer,
either -231 on a 32-bit platform,
or -263 on a 64-bit platform.
|
| min_int [Int64] |
The smallest representable 64-bit integer, -263.
|
| min_int [Int32] |
The smallest representable 32-bit integer, -231.
|
| min_num [Num] |
Return the smaller of the two arguments.
|
| minor [Gc] |
Trigger a minor collection.
|
| minor_words [Gc] |
Number of words allocated in the minor heap since the program was
started.
|
| minus_big_int [Big_int] |
Unary negation.
|
| minus_num [Num] |
Unary negation.
|
| minus_one [Targetint] |
The target integer -1.
|
| minus_one [Nativeint] |
The native integer -1.
|
| minus_one [Int64] |
The 64-bit integer -1.
|
| minus_one [Int32] |
The 32-bit integer -1.
|
| mk [Ast_helper.Cstr] | |
| mk [Ast_helper.Csig] | |
| mk [Ast_helper.Ci] | |
| mk [Ast_helper.Cf] | |
| mk [Ast_helper.Cl] | |
| mk [Ast_helper.Ctf] | |
| mk [Ast_helper.Cty] | |
| mk [Ast_helper.Vb] | |
| mk [Ast_helper.Incl] | |
| mk [Ast_helper.Opn] | |
| mk [Ast_helper.Mb] | |
| mk [Ast_helper.Mtd] | |
| mk [Ast_helper.Md] | |
| mk [Ast_helper.Str] | |
| mk [Ast_helper.Sig] | |
| mk [Ast_helper.Mod] | |
| mk [Ast_helper.Mty] | |
| mk [Ast_helper.Te] | |
| mk [Ast_helper.Type] | |
| mk [Ast_helper.Val] | |
| mk [Ast_helper.Exp] | |
| mk [Ast_helper.Pat] | |
| mk [Ast_helper.Typ] | |
| mkdir [UnixLabels] |
Create a directory with the given permissions.
|
| mkdir [Unix] |
Create a directory with the given permissions (see
Unix.umask).
|
| mkdll [Config] | |
| mkexe [Config] | |
| mkfifo [UnixLabels] |
Create a named pipe with the given permissions.
|
| mkfifo [Unix] |
Create a named pipe with the given permissions (see
Unix.umask).
|
| mkloc [Location] | |
| mkmaindll [Config] | |
| mknoloc [Location] | |
| mktime [UnixLabels] |
Convert a date and time, specified by the
tm argument, into
a time in seconds, as returned by UnixLabels.time.
|
| mktime [Unix] |
Convert a date and time, specified by the
tm argument, into
a time in seconds, as returned by Unix.time.
|
| mod_big_int [Big_int] |
Euclidean modulus of two big integers.
|
| mod_float [Pervasives] | mod_float a b returns the remainder of a with respect to
b.
|
| mod_num [Num] |
Euclidean division: remainder.
|
| model [Config] | |
| modf [Pervasives] | modf f returns the pair of the fractional and integral
part of f.
|
| modtype [Ast_helper.Str] | |
| modtype [Ast_helper.Sig] | |
| module_ [Ast_helper.Str] | |
| module_ [Ast_helper.Sig] | |
| mouse_pos [Graphics] |
Return the position of the mouse cursor, relative to the
graphics window.
|
| moveto [Graphics] |
Position the current point.
|
| mul [Targetint] |
Multiplication.
|
| mul [Nativeint] |
Multiplication.
|
| mul [Int64] |
Multiplication.
|
| mul [Int32] |
Multiplication.
|
| mul [Complex] |
Multiplication
|
| mult_big_int [Big_int] |
Multiplication of two big integers.
|
| mult_int_big_int [Big_int] |
Multiplication of a big integer by a small integer
|
| mult_num [Num] |
Multiplication
|
N | |
| name_of_input [Scanf.Scanning] | Scanning.name_of_input ic returns the name of the character source
for the given Scanf.Scanning.in_channel formatted input channel.
|
| nan [Pervasives] |
A special floating-point value denoting the result of an
undefined operation such as
0.0 /. 0.0.
|
| narrow [CamlinternalOO] | |
| nat_of_num [Num] | |
| nat_of_num_opt [Num] | |
| native_c_compiler [Config] | |
| native_c_libraries [Config] | |
| native_code [Clflags] | |
| native_pack_linker [Config] | |
| nativeint [Random.State] | |
| nativeint [Random] | Random.nativeint bound returns a random integer between 0 (inclusive)
and bound (exclusive).
|
| nativeint [Misc.Int_literal_converter] | |
| nativeint [Bigarray] |
See
Bigarray.char.
|
| nativeint [Ast_helper.Const] | |
| nativeint_of_big_int [Big_int] |
Convert a big integer to a native integer.
|
| nativeint_of_big_int_opt [Big_int] |
Convert a big integer to a native integer.
|
| neg [Targetint] |
Unary negation.
|
| neg [Nativeint] |
Unary negation.
|
| neg [Int64] |
Unary negation.
|
| neg [Int32] |
Unary negation.
|
| neg [Complex] |
Unary negation.
|
| neg_infinity [Pervasives] |
Negative infinity.
|
| new_ [Ast_helper.Exp] | |
| new_block [Obj] | |
| new_channel [Event] |
Return a new channel.
|
| new_line [Lexing] |
Update the
lex_curr_p field of the lexbuf to reflect the start
of a new line.
|
| new_method [CamlinternalOO] | |
| new_methods_variables [CamlinternalOO] | |
| new_variable [CamlinternalOO] | |
| newtype [Ast_helper.Exp] | |
| next [Stream] |
Return the first element of the stream and remove it from the
stream.
|
| nice [UnixLabels] |
Change the process priority.
|
| nice [Unix] |
Change the process priority.
|
| no_auto_link [Clflags] | |
| no_check_prims [Clflags] | |
| no_overflow_add [Misc] | |
| no_overflow_lsl [Misc] | |
| no_overflow_mul [Misc] | |
| no_overflow_sub [Misc] | |
| no_scan_tag [Obj] | |
| no_std_include [Clflags] | |
| noassert [Clflags] | |
| noinit [Clflags] | |
| none [Location] |
An arbitrary value of type
t; describes an empty ghost range.
|
| nopervasives [Clflags] | |
| noprompt [Clflags] | |
| nopromptcont [Clflags] | |
| norm [Complex] |
Norm: given
x + i.y, returns sqrt(x^2 + y^2).
|
| norm2 [Complex] |
Norm squared: given
x + i.y, returns x^2 + y^2.
|
| normalise_eol [Misc] | normalise_eol s returns a fresh copy of s with any '\r' characters
removed.
|
| not [Pervasives] |
The boolean negation.
|
| noversion [Clflags] | |
| npeek [Stream] | npeek n returns the list of the n first elements of
the stream, or all its remaining elements if less than n
elements are available.
|
| nth [ListLabels] |
Return the
n-th element of the given list.
|
| nth [List] |
Return the
n-th element of the given list.
|
| nth [Buffer] |
Get the n-th character of the buffer.
|
| nth_dim [Bigarray.Genarray] | Genarray.nth_dim a n returns the n-th dimension of the
big array a.
|
| nth_opt [ListLabels] |
Return the
n-th element of the given list.
|
| nth_opt [List] |
Return the
n-th element of the given list.
|
| num_bits_big_int [Big_int] |
Return the number of significant bits in the absolute
value of the given big integer.
|
| num_digits_big_int [Big_int] |
Return the number of machine words used to store the
given big integer.
|
| num_dims [Bigarray.Genarray] |
Return the number of dimensions of the given big array.
|
| num_of_big_int [Num] | |
| num_of_int [Num] | |
| num_of_nat [Num] | |
| num_of_ratio [Num] | |
| num_of_string [Num] |
Convert a string to a number.
|
| num_of_string_opt [Num] |
Convert a string to a number.
|
O | |
| o1_arguments [Clflags] | |
| o2_arguments [Clflags] | |
| o3_arguments [Clflags] | |
| obj [Obj] | |
| object_ [Ast_helper.Exp] | |
| object_ [Ast_helper.Typ] | |
| object_tag [Obj] | |
| objfiles [Clflags] | |
| ocaml_version [Sys] | ocaml_version is the version of OCaml.
|
| of_array [Bigarray.Array3] |
Build a three-dimensional big array initialized from the
given array of arrays of arrays.
|
| of_array [Bigarray.Array2] |
Build a two-dimensional big array initialized from the
given array of arrays.
|
| of_array [Bigarray.Array1] |
Build a one-dimensional big array initialized from the
given array.
|
| of_bytes [Stream] |
Return the stream of the characters of the bytes parameter.
|
| of_channel [Stream] |
Return the stream of the characters read from the input channel.
|
| of_char [Uchar] | of_char c is c as an Unicode character.
|
| of_float [Targetint] |
Convert the given floating-point number to a target integer,
discarding the fractional part (truncate towards 0).
|
| of_float [Nativeint] |
Convert the given floating-point number to a native integer,
discarding the fractional part (truncate towards 0).
|
| of_float [Int64] |
Convert the given floating-point number to a 64-bit integer,
discarding the fractional part (truncate towards 0).
|
| of_float [Int32] |
Convert the given floating-point number to a 32-bit integer,
discarding the fractional part (truncate towards 0).
|
| of_int [Uchar] | of_int i is i as an Unicode character.
|
| of_int [Targetint] |
Convert the given integer (type
int) to a target integer
(type t), module the target word size.
|
| of_int [Nativeint] |
Convert the given integer (type
int) to a native integer
(type nativeint).
|
| of_int [Int64] |
Convert the given integer (type
int) to a 64-bit integer
(type int64).
|
| of_int [Int32] |
Convert the given integer (type
int) to a 32-bit integer
(type int32).
|
| of_int32 [Targetint] |
Convert the given 32-bit integer (type
int32)
to a target integer.
|
| of_int32 [Nativeint] |
Convert the given 32-bit integer (type
int32)
to a native integer.
|
| of_int32 [Int64] |
Convert the given 32-bit integer (type
int32)
to a 64-bit integer (type int64).
|
| of_int64 [Targetint] |
Convert the given 64-bit integer (type
int64)
to a target integer.
|
| of_int_exn [Targetint] |
Convert the given integer (type
int) to a target integer
(type t).
|
| of_list [Stream] |
Return the stream holding the elements of the list in the same
order.
|
| of_list [MoreLabels.Set.S] | |
| of_list [Identifiable.S.Tbl] | |
| of_list [Identifiable.S.Map] | |
| of_list [Identifiable.S.Set] | |
| of_list [Set.S] | of_list l creates a set from a list of elements.
|
| of_list [ArrayLabels] | Array.of_list l returns a fresh array containing the elements
of l.
|
| of_list [Array] | Array.of_list l returns a fresh array containing the elements
of l.
|
| of_map [Identifiable.S.Tbl] | |
| of_nativeint [Int64] |
Convert the given native integer (type
nativeint)
to a 64-bit integer (type int64).
|
| of_set [Identifiable.S.Map] | |
| of_string [Targetint] |
Convert the given string to a target integer.
|
| of_string [Stream] |
Return the stream of the characters of the string parameter.
|
| of_string [Nativeint] |
Convert the given string to a native integer.
|
| of_string [Int64] |
Convert the given string to a 64-bit integer.
|
| of_string [Int32] |
Convert the given string to a 32-bit integer.
|
| of_string [BytesLabels] |
Return a new byte sequence that contains the same bytes as the
given string.
|
| of_string [Bytes] |
Return a new byte sequence that contains the same bytes as the
given string.
|
| of_string_opt [Nativeint] |
Same as
of_string, but return None instead of raising.
|
| of_string_opt [Int64] |
Same as
of_string, but return None instead of raising.
|
| of_string_opt [Int32] |
Same as
of_string, but return None instead of raising.
|
| of_value [Bigarray.Array0] |
Build a zero-dimensional big array initialized from the
given value.
|
| one [Targetint] |
The target integer 1.
|
| one [Nativeint] |
The native integer 1.
|
| one [Int64] |
The 64-bit integer 1.
|
| one [Int32] |
The 32-bit integer 1.
|
| one [Complex] |
The complex number
1.
|
| opaque [Clflags] | |
| opaque_identity [Sys] |
For the purposes of optimization,
opaque_identity behaves like an
unknown (and thus possibly side-effecting) function.
|
| open_ [Ast_helper.Str] | |
| open_ [Ast_helper.Sig] | |
| open_ [Ast_helper.Exp] | |
| open_ [Ast_helper.Pat] | |
| open_box [Format] | open_box d opens a new pretty-printing box
with offset d.
|
| open_box_of_string [CamlinternalFormat] | |
| open_connection [UnixLabels] |
Connect to a server at the given address.
|
| open_connection [Unix] |
Connect to a server at the given address.
|
| open_connection [ThreadUnix] | |
| open_graph [Graphics] |
Show the graphics window or switch the screen to graphic mode.
|
| open_hbox [Format] | open_hbox () opens a new 'horizontal' pretty-printing box.
|
| open_hovbox [Format] | open_hovbox d opens a new 'horizontal-or-vertical' pretty-printing box
with offset d.
|
| open_hvbox [Format] | open_hvbox d opens a new 'horizontal-vertical' pretty-printing box
with offset d.
|
| open_in [Scanf.Scanning] | Scanning.open_in fname returns a Scanf.Scanning.in_channel formatted input
channel for bufferized reading in text mode from file fname.
|
| open_in [Pervasives] |
Open the named file for reading, and return a new input channel
on that file, positioned at the beginning of the file.
|
| open_in_bin [Scanf.Scanning] | Scanning.open_in_bin fname returns a Scanf.Scanning.in_channel formatted
input channel for bufferized reading in binary mode from file fname.
|
| open_in_bin [Pervasives] |
Same as
open_in, but the file is opened in binary mode,
so that no translation takes place during reads.
|
| open_in_gen [Pervasives] | open_in_gen mode perm filename opens the named file for reading,
as described above.
|
| open_module [Depend] | |
| open_modules [Clflags] | |
| open_out [Pervasives] |
Open the named file for writing, and return a new output channel
on that file, positioned at the beginning of the file.
|
| open_out_bin [Pervasives] |
Same as
open_out, but the file is opened in binary mode,
so that no translation takes place during writes.
|
| open_out_gen [Pervasives] | open_out_gen mode perm filename opens the named file for writing,
as described above.
|
| open_process [UnixLabels] |
Same as
UnixLabels.open_process_out, but redirects both the standard
input and standard output of the command to pipes connected to the two
returned channels.
|
| open_process [Unix] |
Same as
Unix.open_process_out, but redirects both the standard input
and standard output of the command to pipes connected to the two
returned channels.
|
| open_process [ThreadUnix] | |
| open_process_full [UnixLabels] |
Similar to
UnixLabels.open_process, but the second argument specifies
the environment passed to the command.
|
| open_process_full [Unix] |
Similar to
Unix.open_process, but the second argument specifies
the environment passed to the command.
|
| open_process_in [UnixLabels] |
High-level pipe and process management.
|
| open_process_in [Unix] |
High-level pipe and process management.
|
| open_process_in [ThreadUnix] | |
| open_process_out [UnixLabels] |
Same as
UnixLabels.open_process_in, but redirect the standard input of
the command to a pipe.
|
| open_process_out [Unix] |
Same as
Unix.open_process_in, but redirect the standard input of
the command to a pipe.
|
| open_process_out [ThreadUnix] | |
| open_subwindow [GraphicsX11] |
Create a sub-window of the current OCaml graphics window
and return its identifier.
|
| open_tag [Format] | open_tag t opens the tag named t; the print_open_tag
function of the formatter is called with t as argument;
the tag marker mark_open_tag t will be flushed into the output
device of the formatter.
|
| open_tbox [Format] | |
| open_temp_file [Filename] |
Same as
Filename.temp_file, but returns both the name of a fresh
temporary file, and an output channel opened (atomically) on
this file.
|
| open_vbox [Format] | open_vbox d opens a new 'vertical' pretty-printing box
with offset d.
|
| opendir [UnixLabels] |
Open a descriptor on a directory
|
| opendir [Unix] |
Open a descriptor on a directory
|
| openfile [UnixLabels] |
Open the named file with the given flags.
|
| openfile [Unix] |
Open the named file with the given flags.
|
| optimize_for_speed [Clflags] | |
| or_ [Ast_helper.Pat] | |
| or_big_int [Big_int] |
Bitwise logical 'or'.
|
| os_type [Sys] |
Operating system currently executing the OCaml program.
|
| out_channel_length [Pervasives.LargeFile] | |
| out_channel_length [Pervasives] |
Return the size (number of characters) of the regular file
on which the given channel is opened.
|
| out_channel_of_descr [UnixLabels] |
Create an output channel writing on the given descriptor.
|
| out_channel_of_descr [Unix] |
Create an output channel writing on the given descriptor.
|
| out_of_heap_tag [Obj] | |
| output [Pervasives] | output oc buf pos len writes len characters from byte sequence buf,
starting at offset pos, to the given output channel oc.
|
| output [Misc.LongString] | |
| output [Identifiable.S.Set] | |
| output [Identifiable.Thing] | |
| output [Digest] |
Write a digest on the given output channel.
|
| output_acc [CamlinternalFormat] | |
| output_binary_int [Pervasives] |
Write one integer in binary format (4 bytes, big-endian)
on the given output channel.
|
| output_buffer [Buffer] | output_buffer oc b writes the current contents of buffer b
on the output channel oc.
|
| output_byte [Pervasives] |
Write one 8-bit integer (as the single character with that code)
on the given output channel.
|
| output_bytes [Pervasives] |
Write the byte sequence on the given output channel.
|
| output_c_object [Clflags] | |
| output_char [Pervasives] |
Write the character on the given output channel.
|
| output_complete_object [Clflags] | |
| output_name [Clflags] | |
| output_string [Pervasives] |
Write the string on the given output channel.
|
| output_substring [Pervasives] |
Same as
output but take a string as argument instead of
a byte sequence.
|
| output_value [Pervasives] |
Write the representation of a structured value of any type
to a channel.
|
| over_max_boxes [Format] |
Tests if the maximum number of boxes allowed have already been opened.
|
| override [Ast_helper.Exp] | |
P | |
| pack [Ast_helper.Exp] | |
| package [Ast_helper.Typ] | |
| param_format_of_ignored_format [CamlinternalFormat] | |
| params [CamlinternalOO] | |
| parent_dir_name [Filename] |
The conventional name for the parent of the current directory
(e.g.
|
| parse [Longident] | |
| parse [Clflags.Float_arg_helper] | |
| parse [Clflags.Int_arg_helper] | |
| parse [Arg_helper.Make] | |
| parse [Arg] | Arg.parse speclist anon_fun usage_msg parses the command line.
|
| parse_and_expand_argv_dynamic [Arg] |
Same as
Arg.parse_argv_dynamic, except that the argv argument is a
reference and may be updated during the parsing of Expand arguments.
|
| parse_arguments [Clflags] | |
| parse_argv [Arg] | Arg.parse_argv ~current args speclist anon_fun usage_msg parses
the array args as if it were the command line.
|
| parse_argv_dynamic [Arg] |
Same as
Arg.parse_argv, except that the speclist argument is a
reference and may be updated during the parsing.
|
| parse_color_setting [Clflags] | |
| parse_core_type [Parser] | |
| parse_dynamic [Arg] |
Same as
Arg.parse, except that the speclist argument is a reference
and may be updated during the parsing.
|
| parse_expand [Arg] |
Same as
Arg.parse, except that the Expand arguments are allowed and
the Arg.current reference is not updated.
|
| parse_expression [Parser] | |
| parse_no_error [Clflags.Float_arg_helper] | |
| parse_no_error [Clflags.Int_arg_helper] | |
| parse_no_error [Arg_helper.Make] | |
| parse_options [Warnings] | |
| parse_pattern [Parser] | |
| partition [MoreLabels.Set.S] | |
| partition [MoreLabels.Map.S] | |
| partition [ListLabels] | partition p l returns a pair of lists (l1, l2), where
l1 is the list of all the elements of l that
satisfy the predicate p, and l2 is the list of all the
elements of l that do not satisfy p.
|
| partition [List] | partition p l returns a pair of lists (l1, l2), where
l1 is the list of all the elements of l that
satisfy the predicate p, and l2 is the list of all the
elements of l that do not satisfy p.
|
| partition [Map.S] | partition p m returns a pair of maps (m1, m2), where
m1 contains all the bindings of s that satisfy the
predicate p, and m2 is the map with all the bindings of
s that do not satisfy p.
|
| partition [Set.S] | partition p s returns a pair of sets (s1, s2), where
s1 is the set of all the elements of s that satisfy the
predicate p, and s2 is the set of all the elements of
s that do not satisfy p.
|
| pattern [Pprintast] | |
| pattern [Parse] | |
| pause [UnixLabels] |
Wait until a non-ignored, non-blocked signal is delivered.
|
| pause [Unix] |
Wait until a non-ignored, non-blocked signal is delivered.
|
| payload [Printast] | |
| peek [Stream] |
Return
Some of "the first element" of the stream, or None if
the stream is empty.
|
| peek [Queue] | peek q returns the first element in queue q, without removing
it from the queue, or raises Queue.Empty if the queue is empty.
|
| pic_code [Clflags] | |
| pipe [UnixLabels] |
Create a pipe.
|
| pipe [Unix] |
Create a pipe.
|
| pipe [ThreadUnix] | |
| plot [Graphics] |
Plot the given point with the current drawing color.
|
| plots [Graphics] |
Plot the given points with the current drawing color.
|
| point_color [Graphics] |
Return the color of the given point in the backing store
(see "Double buffering" below).
|
| polar [Complex] | polar norm arg returns the complex having norm norm
and argument arg.
|
| poll [Event] |
Non-blocking version of
Event.sync: offer all the communication
possibilities specified in the event to the outside world,
and if one can take place immediately, perform it and return
Some r where r is the result value of that communication.
|
| poly [Ast_helper.Exp] | |
| poly [Ast_helper.Typ] | |
| pop [Stack] | pop s removes and returns the topmost element in stack s,
or raises Stack.Empty if the stack is empty.
|
| pop [Queue] | pop is a synonym for take.
|
| pos_in [Pervasives.LargeFile] | |
| pos_in [Pervasives] |
Return the current reading position for the given channel.
|
| pos_out [Pervasives.LargeFile] | |
| pos_out [Pervasives] |
Return the current writing position for the given channel.
|
| pow [Complex] |
Power function.
|
| power_big_int_positive_big_int [Big_int] |
Exponentiation functions.
|
| power_big_int_positive_int [Big_int] | |
| power_int_positive_big_int [Big_int] | |
| power_int_positive_int [Big_int] | |
| power_num [Num] |
Exponentiation
|
| pp_close_box [Format] | |
| pp_close_tag [Format] | |
| pp_close_tbox [Format] | |
| pp_flush_formatter [Format] | pp_flush_formatter fmt flushes fmt's internal queue, ensuring that all
the printing and flushing actions have been performed.
|
| pp_force_newline [Format] | |
| pp_get_all_formatter_output_functions [Format] | |
| pp_get_ellipsis_text [Format] | |
| pp_get_formatter_out_functions [Format] |
These functions are the basic ones: usual functions
operating on the standard formatter are defined via partial
evaluation of these primitives.
|
| pp_get_formatter_output_functions [Format] | |
| pp_get_formatter_tag_functions [Format] | |
| pp_get_margin [Format] | |
| pp_get_mark_tags [Format] | |
| pp_get_max_boxes [Format] | |
| pp_get_max_indent [Format] | |
| pp_get_print_tags [Format] | |
| pp_open_box [Format] | |
| pp_open_hbox [Format] | |
| pp_open_hovbox [Format] | |
| pp_open_hvbox [Format] | |
| pp_open_tag [Format] | |
| pp_open_tbox [Format] | |
| pp_open_vbox [Format] | |
| pp_over_max_boxes [Format] | |
| pp_print_as [Format] | |
| pp_print_bool [Format] | |
| pp_print_break [Format] | |
| pp_print_char [Format] | |
| pp_print_cut [Format] | |
| pp_print_float [Format] | |
| pp_print_flush [Format] | |
| pp_print_if_newline [Format] | |
| pp_print_int [Format] | |
| pp_print_list [Format] | pp_print_list ?pp_sep pp_v ppf l prints items of list l,
using pp_v to print each item, and calling pp_sep
between items (pp_sep defaults to Format.pp_print_cut).
|
| pp_print_newline [Format] | |
| pp_print_space [Format] | |
| pp_print_string [Format] | |
| pp_print_tab [Format] | |
| pp_print_tbreak [Format] | |
| pp_print_text [Format] | pp_print_text ppf s prints s with spaces and newlines
respectively printed with Format.pp_print_space and
Format.pp_force_newline.
|
| pp_set_all_formatter_output_functions [Format] | |
| pp_set_ellipsis_text [Format] | |
| pp_set_formatter_out_channel [Format] | |
| pp_set_formatter_out_functions [Format] | |
| pp_set_formatter_output_functions [Format] | |
| pp_set_formatter_tag_functions [Format] | |
| pp_set_margin [Format] | |
| pp_set_mark_tags [Format] | |
| pp_set_max_boxes [Format] | |
| pp_set_max_indent [Format] | |
| pp_set_print_tags [Format] | |
| pp_set_tab [Format] | |
| pp_set_tags [Format] | |
| pred [Uchar] | pred u is the scalar value before u in the set of Unicode scalar
values.
|
| pred [Targetint] |
Predecessor.
|
| pred [Pervasives] | pred x is x - 1.
|
| pred [Nativeint] |
Predecessor.
|
| pred [Int64] |
Predecessor.
|
| pred [Int32] |
Predecessor.
|
| pred_big_int [Big_int] |
Predecessor (subtract 1).
|
| pred_num [Num] | pred n is n-1
|
| preprocessor [Clflags] | |
| prerr_bytes [Pervasives] |
Print a byte sequence on standard error.
|
| prerr_char [Pervasives] |
Print a character on standard error.
|
| prerr_endline [Pervasives] |
Print a string, followed by a newline character on standard
error and flush standard error.
|
| prerr_float [Pervasives] |
Print a floating-point number, in decimal, on standard error.
|
| prerr_int [Pervasives] |
Print an integer, in decimal, on standard error.
|
| prerr_newline [Pervasives] |
Print a newline character on standard error, and flush
standard error.
|
| prerr_string [Pervasives] |
Print a string on standard error.
|
| prerr_warning [Location] | |
| primitive [Ast_helper.Str] | |
| principal [Clflags] | |
| print [Warnings] | |
| print [Timings] |
Prints all recorded timings to the formatter.
|
| print [Tbl] | |
| print [Printexc] | Printexc.print fn x applies fn to x and returns the result.
|
| print [Location] | |
| print [Identifiable.S.Map] | |
| print [Identifiable.S.Set] | |
| print [Identifiable.Thing] | |
| print_arguments [Clflags] | |
| print_as [Format] | print_as len str prints str in the
current box.
|
| print_backtrace [Printexc] | Printexc.print_backtrace oc prints an exception backtrace
on the output channel oc.
|
| print_bool [Format] |
Prints a boolean in the current box.
|
| print_break [Format] | print_break nspaces offset the 'full' break hint:
the pretty-printer may split the line at this
point, otherwise it prints nspaces spaces.
|
| print_bytes [Pervasives] |
Print a byte sequence on standard output.
|
| print_char [Pervasives] |
Print a character on standard output.
|
| print_char [Format] |
Prints a character in the current box.
|
| print_compact [Location] | |
| print_config [Config] | |
| print_cut [Format] | print_cut () the 'cut' break hint:
the pretty-printer may split the line at this
point, otherwise it prints nothing.
|
| print_endline [Pervasives] |
Print a string, followed by a newline character, on
standard output and flush standard output.
|
| print_error [Location] | |
| print_error_cur_file [Location] | |
| print_error_prefix [Location] | |
| print_filename [Location] | |
| print_float [Pervasives] |
Print a floating-point number, in decimal, on standard output.
|
| print_float [Format] |
Prints a floating point number in the current box.
|
| print_flush [Format] |
Flushes the pretty printer: all opened boxes are closed,
and all pending text is displayed.
|
| print_if_newline [Format] |
Executes the next formatting command if the preceding line
has just been split.
|
| print_int [Pervasives] |
Print an integer, in decimal, on standard output.
|
| print_int [Format] |
Prints an integer in the current box.
|
| print_loc [Location] | |
| print_newline [Pervasives] |
Print a newline character on standard output, and flush
standard output.
|
| print_newline [Format] |
Equivalent to
print_flush followed by a new line.
|
| print_raw_backtrace [Printexc] |
Print a raw backtrace in the same format
Printexc.print_backtrace uses.
|
| print_space [Format] | print_space () the 'space' break hint:
the pretty-printer may split the line at this
point, otherwise it prints one space.
|
| print_stat [Gc] |
Print the current values of the memory management counters (in
human-readable form) into the channel argument.
|
| print_string [Pervasives] |
Print a string on standard output.
|
| print_string [Format] | print_string str prints str in the current box.
|
| print_tab [Format] | |
| print_tbreak [Format] | |
| print_timings [Clflags] | |
| print_types [Clflags] | |
| print_warning [Location] | |
| print_warnings [Lexer] | |
| printf [Printf] |
Same as
Printf.fprintf, but output on stdout.
|
| printf [Format] |
Same as
fprintf above, but output on std_formatter.
|
| profiling [Config] | |
| profinfo [Config] | |
| profinfo_width [Config] | |
| prohibit [Dynlink] | prohibit units prohibits dynamically-linked units from referencing
the units named in list units.
|
| protect_refs [Misc] | protect_refs l f temporarily sets r to v for each R (r, v) in l
while executing f.
|
| public_method_label [CamlinternalOO] | |
| push [Stack] | push x s adds the element x at the top of stack s.
|
| push [Queue] | push is a synonym for add.
|
| putenv [UnixLabels] | Unix.putenv name value sets the value associated to a
variable in the process environment.
|
| putenv [Unix] | Unix.putenv name value sets the value associated to a
variable in the process environment.
|
Q | |
| quick_stat [Gc] |
Same as
stat except that live_words, live_blocks, free_words,
free_blocks, largest_free, and fragments are set to 0.
|
| quo_num [Num] |
Euclidean division: quotient.
|
| quomod_big_int [Big_int] |
Euclidean division of two big integers.
|
| quote [Str] | Str.quote s returns a regexp string that matches exactly
s and nothing else.
|
| quote [Filename] |
Return a quoted version of a file name, suitable for use as
one argument in a command line, escaping all meta-characters.
|
| quote_files [Ccomp] | |
| quote_optfile [Ccomp] | |
R | |
| raise [Pervasives] |
Raise the given exception value
|
| raise_direct_hook_exn [Misc] |
A hook can use
raise_unwrapped_hook_exn to raise an exception that will
not be wrapped into a Misc.HookExnWrapper.
|
| raise_errorf [Location] | |
| raise_notrace [Pervasives] |
A faster version
raise which does not record the backtrace.
|
| raise_with_backtrace [Printexc] |
Reraise the exception using the given raw_backtrace for the
origin of the exception
|
| randomize [MoreLabels.Hashtbl] | |
| randomize [Hashtbl] |
After a call to
Hashtbl.randomize(), hash tables are created in
randomized mode by default: Hashtbl.create returns randomized
hash tables, unless the ~random:false optional parameter is given.
|
| ranlib [Config] | |
| ratio_of_num [Num] | |
| raw_backtrace_length [Printexc] | raw_backtrace_length bckt returns the number of slots in the
backtrace bckt.
|
| raw_backtrace_to_string [Printexc] |
Return a string from a raw backtrace, in the same format
Printexc.get_backtrace uses.
|
| rcontains_from [String] | String.rcontains_from s stop c tests if character c
appears in s before position stop+1.
|
| rcontains_from [StringLabels] | String.rcontains_from s stop c tests if character c
appears in s before position stop+1.
|
| rcontains_from [BytesLabels] | rcontains_from s stop c tests if byte c appears in s before
position stop+1.
|
| rcontains_from [Bytes] | rcontains_from s stop c tests if byte c appears in s before
position stop+1.
|
| reachable_words [Obj] |
Computes the total size (in words, including the headers) of all
heap blocks accessible from the argument.
|
| read [UnixLabels] | read fd buff ofs len reads len bytes from descriptor fd,
storing them in byte sequence buff, starting at position ofs in
buff.
|
| read [Unix] | read fd buff ofs len reads len bytes from descriptor fd,
storing them in byte sequence buff, starting at position ofs in
buff.
|
| read [ThreadUnix] | |
| read_arg [Arg] | Arg.read_arg file reads newline-terminated command line arguments from
file file.
|
| read_arg0 [Arg] |
Identical to
Arg.read_arg but assumes null character terminated command line
arguments.
|
| read_float [Pervasives] |
Flush standard output, then read one line from standard input
and convert it to a floating-point number.
|
| read_float_opt [Pervasives] |
Flush standard output, then read one line from standard input
and convert it to a floating-point number.
|
| read_int [Pervasives] |
Flush standard output, then read one line from standard input
and convert it to an integer.
|
| read_int_opt [Pervasives] |
Same as
read_int_opt, but returs None instead of raising.
|
| read_key [Graphics] |
Wait for a key to be pressed, and return the corresponding
character.
|
| read_line [Pervasives] |
Flush standard output, then read characters from standard input
until a newline character is encountered.
|
| readdir [UnixLabels] |
Return the next entry in a directory.
|
| readdir [Unix] |
Return the next entry in a directory.
|
| readdir [Sys] |
Return the names of all files present in the given directory.
|
| readlink [UnixLabels] |
Read the contents of a link.
|
| readlink [Unix] |
Read the contents of a symbolic link.
|
| real_paths [Clflags] | |
| really_input [Pervasives] | really_input ic buf pos len reads len characters from channel ic,
storing them in byte sequence buf, starting at character number pos.
|
| really_input_string [Pervasives] | really_input_string ic len reads len characters from channel ic
and returns them in a new string.
|
| rebind [Ast_helper.Te] | |
| rec_module [Ast_helper.Str] | |
| rec_module [Ast_helper.Sig] | |
| recast [CamlinternalFormat] | |
| receive [Event] | receive ch returns the event consisting in receiving a value
from the channel ch.
|
| record [Ast_helper.Exp] | |
| record [Ast_helper.Pat] | |
| record_backtrace [Printexc] | Printexc.record_backtrace b turns recording of exception backtraces
on (if b = true) or off (if b = false).
|
| recursive_types [Clflags] | |
| recv [UnixLabels] |
Receive data from a connected socket.
|
| recv [Unix] |
Receive data from a connected socket.
|
| recv [ThreadUnix] | |
| recvfrom [UnixLabels] |
Receive data from an unconnected socket.
|
| recvfrom [Unix] |
Receive data from an unconnected socket.
|
| recvfrom [ThreadUnix] | |
| red [Graphics] | |
| ref [Pervasives] |
Return a fresh reference containing the given value.
|
| regexp [Str] |
Compile a regular expression.
|
| regexp_case_fold [Str] |
Same as
regexp, but the compiled expression will match text
in a case-insensitive way: uppercase and lowercase letters will
be considered equivalent.
|
| regexp_string [Str] | Str.regexp_string s returns a regular expression
that matches exactly s and nothing else.
|
| regexp_string_case_fold [Str] | Str.regexp_string_case_fold is similar to Str.regexp_string,
but the regexp matches in a case-insensitive way.
|
| register [Docstrings] |
Register a docstring
|
| register [Callback] | Callback.register n v registers the value v under
the name n.
|
| register [Ast_mapper] |
Apply the
register_function.
|
| register_error_of_exn [Location] | |
| register_exception [Callback] | Callback.register_exception n exn registers the
exception contained in the exception value exn
under the name n.
|
| register_function [Ast_mapper] | |
| register_printer [Printexc] | Printexc.register_printer fn registers fn as an exception
printer.
|
| rem [Targetint] |
Integer remainder.
|
| rem [Nativeint] |
Integer remainder.
|
| rem [Int64] |
Integer remainder.
|
| rem [Int32] |
Integer remainder.
|
| remember_mode [Graphics] |
Set remember mode on or off.
|
| remove [Weak.S] | remove t x removes from t one instance of x.
|
| remove [Tbl] | |
| remove [Sys] |
Remove the given file name from the file system.
|
| remove [MoreLabels.Set.S] | |
| remove [MoreLabels.Map.S] | |
| remove [MoreLabels.Hashtbl.SeededS] | |
| remove [MoreLabels.Hashtbl.S] | |
| remove [MoreLabels.Hashtbl] | |
| remove [Hashtbl.SeededS] | |
| remove [Hashtbl.S] | |
| remove [Hashtbl] | Hashtbl.remove tbl x removes the current binding of x in tbl,
restoring the previous binding if it exists.
|
| remove [Map.S] | remove x m returns a map containing the same bindings as
m, except for x which is unbound in the returned map.
|
| remove [Set.S] | remove x s returns a set containing all elements of s,
except x.
|
| remove_assoc [ListLabels] | remove_assoc a l returns the list of
pairs l without the first pair with key a, if any.
|
| remove_assoc [List] | remove_assoc a l returns the list of
pairs l without the first pair with key a, if any.
|
| remove_assq [ListLabels] |
Same as
List.remove_assoc, but uses physical equality instead
of structural equality to compare keys.
|
| remove_assq [List] |
Same as
List.remove_assoc, but uses physical equality instead
of structural equality to compare keys.
|
| remove_extension [Filename] |
Return the given file name without its extension, as defined
in
Filename.extension.
|
| remove_file [Misc] | |
| remove_unused_arguments [Clflags] | |
| rename [UnixLabels] | rename old new changes the name of a file from old to new.
|
| rename [Unix] | rename old new changes the name of a file from old to new.
|
| rename [Sys] |
Rename a file.
|
| rename [Identifiable.S.Map] | |
| replace [MoreLabels.Hashtbl.SeededS] | |
| replace [MoreLabels.Hashtbl.S] | |
| replace [MoreLabels.Hashtbl] | |
| replace [Hashtbl.SeededS] | |
| replace [Hashtbl.S] | |
| replace [Hashtbl] | Hashtbl.replace tbl x y replaces the current binding of x
in tbl by a binding of x to y.
|
| replace_first [Str] |
Same as
Str.global_replace, except that only the first substring
matching the regular expression is replaced.
|
| replace_matched [Str] | replace_matched repl s returns the replacement text repl
in which \1, \2, etc.
|
| replace_substring [Misc] | |
| replicate_list [Misc] | |
| report_error [Syntaxerr] | |
| report_error [Location] | |
| report_error [Lexer] | |
| report_error [Attr_helper] | |
| report_exception [Location] | |
| repr [Targetint] |
The concrete representation of a native integer.
|
| repr [Obj] | |
| reset [Timings] |
erase all recorded times
|
| reset [MoreLabels.Hashtbl.SeededS] | |
| reset [MoreLabels.Hashtbl.S] | |
| reset [MoreLabels.Hashtbl] | |
| reset [Location] | |
| reset [Hashtbl.SeededS] | |
| reset [Hashtbl.S] | |
| reset [Hashtbl] |
Empty a hash table and shrink the size of the bucket table
to its initial size.
|
| reset [Buffer] |
Empty the buffer and deallocate the internal byte sequence holding the
buffer contents, replacing it with the initial internal byte sequence
of length
n that was allocated by Buffer.create n.
|
| reset_base_overrides [Arg_helper.Make] | |
| reset_fatal [Warnings] | |
| reshape [Bigarray] | reshape b [|d1;...;dN|] converts the big array b to a
N-dimensional array of dimensions d1...
|
| reshape_0 [Bigarray] |
Specialized version of
Bigarray.reshape for reshaping to
zero-dimensional arrays.
|
| reshape_1 [Bigarray] |
Specialized version of
Bigarray.reshape for reshaping to
one-dimensional arrays.
|
| reshape_2 [Bigarray] |
Specialized version of
Bigarray.reshape for reshaping to
two-dimensional arrays.
|
| reshape_3 [Bigarray] |
Specialized version of
Bigarray.reshape for reshaping to
three-dimensional arrays.
|
| resize_window [Graphics] |
Resize and erase the graphics window.
|
| restore [Warnings] | |
| resume [Terminfo] | |
| rev [ListLabels] |
List reversal.
|
| rev [List] |
List reversal.
|
| rev_append [ListLabels] | List.rev_append l1 l2 reverses l1 and concatenates it to l2.
|
| rev_append [List] | List.rev_append l1 l2 reverses l1 and concatenates it to l2.
|
| rev_char_set [CamlinternalFormat] | |
| rev_map [ListLabels] | |
| rev_map [List] | |
| rev_map2 [ListLabels] | |
| rev_map2 [List] | |
| rev_split_words [Misc] | |
| rewinddir [UnixLabels] |
Reposition the descriptor to the beginning of the directory
|
| rewinddir [Unix] |
Reposition the descriptor to the beginning of the directory
|
| rgb [Graphics] | rgb r g b returns the integer encoding the color with red
component r, green component g, and blue component b.
|
| rhs_docs [Docstrings] |
Fetch the item documentation for the symbols between two
positions.
|
| rhs_docs_lazy [Docstrings] | |
| rhs_end [Parsing] |
See
Parsing.rhs_start.
|
| rhs_end_pos [Parsing] |
Same as
rhs_end, but return a position instead of an offset.
|
| rhs_info [Docstrings] |
Fetch the field info following the symbol at a given position.
|
| rhs_loc [Location] | rhs_loc n returns the location of the symbol at position n, starting
at 1, in the current parser rule.
|
| rhs_post_extra_text [Docstrings] |
Fetch additional text following the symbol at the given position
|
| rhs_pre_extra_text [Docstrings] |
Fetch additional text preceding the symbol at the given position
|
| rhs_start [Parsing] |
Same as
Parsing.symbol_start and Parsing.symbol_end, but
return the offset of the string matching the nth item on the
right-hand side of the rule, where n is the integer parameter
to rhs_start and rhs_end.
|
| rhs_start_pos [Parsing] |
Same as
rhs_start, but return a position instead of an offset.
|
| rhs_text [Docstrings] |
Fetch the text preceding the symbol at the given position.
|
| rhs_text_lazy [Docstrings] | |
| rindex [String] | String.rindex s c returns the index of the last
occurrence of character c in string s.
|
| rindex [StringLabels] | String.rindex s c returns the index of the last
occurrence of character c in string s.
|
| rindex [BytesLabels] | rindex s c returns the index of the last occurrence of byte c
in s.
|
| rindex [Bytes] | rindex s c returns the index of the last occurrence of byte c
in s.
|
| rindex_from [String] | String.rindex_from s i c returns the index of the
last occurrence of character c in string s before position i+1.
|
| rindex_from [StringLabels] | String.rindex_from s i c returns the index of the
last occurrence of character c in string s before position i+1.
|
| rindex_from [BytesLabels] | rindex_from s i c returns the index of the last occurrence of
byte c in s before position i+1.
|
| rindex_from [Bytes] | rindex_from s i c returns the index of the last occurrence of
byte c in s before position i+1.
|
| rindex_from_opt [String] | String.rindex_from_opt s i c returns the index of the
last occurrence of character c in string s before position i+1
or None if c does not occur in s before position i+1.
|
| rindex_from_opt [StringLabels] | String.rindex_from_opt s i c returns the index of the
last occurrence of character c in string s before position i+1
or None if c does not occur in s before position i+1.
|
| rindex_from_opt [BytesLabels] | rindex_from_opt s i c returns the index of the last occurrence
of byte c in s before position i+1 or None if c does not
occur in s before position i+1.
|
| rindex_from_opt [Bytes] | rindex_from_opt s i c returns the index of the last occurrence
of byte c in s before position i+1 or None if c does not
occur in s before position i+1.
|
| rindex_opt [String] | String.rindex_opt s c returns the index of the last occurrence
of character c in string s, or None if c does not occur in
s.
|
| rindex_opt [StringLabels] | String.rindex_opt s c returns the index of the last occurrence
of character c in string s, or None if c does not occur in
s.
|
| rindex_opt [BytesLabels] | rindex_opt s c returns the index of the last occurrence of byte c
in s or None if c does not occur in s.
|
| rindex_opt [Bytes] | rindex_opt s c returns the index of the last occurrence of byte c
in s or None if c does not occur in s.
|
| rlineto [Graphics] |
Draw a line with endpoints the current point and the
current point translated of the given vector,
and move the current point to this point.
|
| rmdir [UnixLabels] |
Remove an empty directory.
|
| rmdir [Unix] |
Remove an empty directory.
|
| rmoveto [Graphics] | rmoveto dx dy translates the current point by the given vector.
|
| round_num [Num] | round_num n returns the integer closest to n.
|
| rounds [Clflags] | |
| run_command [Ccomp] | |
| run_initializers [CamlinternalOO] | |
| run_initializers_opt [CamlinternalOO] | |
| run_main [Ast_mapper] |
Entry point to call to implement a standalone -ppx rewriter from a
mapper, parametrized by the command line arguments.
|
| runtime_parameters [Sys] |
Return the value of the runtime parameters, in the same format
as the contents of the
OCAMLRUNPARAM environment variable.
|
| runtime_variant [Sys] |
Return the name of the runtime variant the program is running on.
|
| runtime_variant [Clflags] | |
| runtime_warnings_enabled [Sys] |
Return whether runtime warnings are currently enabled.
|
S | |
| safe_string [Config] | |
| save_and_close [Spacetime.Series] | save_and_close series writes information into series required for
interpeting the snapshots that series contains and then closes the
series file.
|
| save_event [Spacetime.Series] | save_event writes an event, which is an arbitrary string, into the
given series file.
|
| save_event_for_automatic_snapshots [Spacetime] |
Like
Spacetime.Series.save_event, but writes to the automatic snapshot file.
|
| scanf [Scanf] |
Same as
Scanf.bscanf, but reads from the predefined formatted input
channel Scanf.Scanning.stdin that is connected to stdin.
|
| search_backward [Str] | search_backward r s last searches the string s for a
substring matching the regular expression r.
|
| search_forward [Str] | search_forward r s start searches the string s for a substring
matching the regular expression r.
|
| search_substring [Misc] | |
| seeded_hash [MoreLabels.Hashtbl] | |
| seeded_hash [Hashtbl] |
A variant of
Hashtbl.hash that is further parameterized by
an integer seed.
|
| seeded_hash_param [MoreLabels.Hashtbl] | |
| seeded_hash_param [Hashtbl] |
A variant of
Hashtbl.hash_param that is further parameterized by
an integer seed.
|
| seek_in [Pervasives.LargeFile] | |
| seek_in [Pervasives] | seek_in chan pos sets the current reading position to pos
for channel chan.
|
| seek_out [Pervasives.LargeFile] | |
| seek_out [Pervasives] | seek_out chan pos sets the current writing position to pos
for channel chan.
|
| select [UnixLabels] |
Wait until some input/output operations become possible on
some channels.
|
| select [Unix] |
Wait until some input/output operations become possible on
some channels.
|
| select [ThreadUnix] | |
| select [Thread] |
Suspend the execution of the calling thread until input/output
becomes possible on the given Unix file descriptors.
|
| select [Event] |
'Synchronize' on an alternative of events.
|
| self [Thread] |
Return the thread currently executing.
|
| self_init [Random] |
Initialize the generator with a random seed chosen
in a system-dependent way.
|
| send [UnixLabels] |
Send data over a connected socket.
|
| send [Unix] |
Send data over a connected socket.
|
| send [ThreadUnix] | |
| send [Event] | send ch v returns the event consisting in sending the value v
over the channel ch.
|
| send [CamlinternalOO] | |
| send [Ast_helper.Exp] | |
| send_substring [UnixLabels] |
Same as
send, but take the data from a string instead of a byte
sequence.
|
| send_substring [Unix] |
Same as
send, but take the data from a string instead of a byte
sequence.
|
| send_substring [ThreadUnix] | |
| sendcache [CamlinternalOO] | |
| sendself [CamlinternalOO] | |
| sendto [UnixLabels] |
Send data over an unconnected socket.
|
| sendto [Unix] |
Send data over an unconnected socket.
|
| sendto [ThreadUnix] | |
| sendto_substring [UnixLabels] |
Same as
sendto, but take the data from a string instead of a
byte sequence.
|
| sendto_substring [Unix] |
Same as
sendto, but take the data from a string instead of a
byte sequence.
|
| sendto_substring [ThreadUnix] | |
| sequence [Ast_helper.Exp] | |
| set [Weak] | Weak.set ar n (Some el) sets the nth cell of ar to be a
(full) pointer to el; Weak.set ar n None sets the nth
cell of ar to empty.
|
| set [String] | String.set s n c modifies byte sequence s in place,
replacing the byte at index n with c.
|
| set [StringLabels] | String.set s n c modifies byte sequence s in place,
replacing the byte at index n with c.
|
| set [Misc.LongString] | |
| set [Gc] | set r changes the GC parameters according to the control record r.
|
| set [Consistbl] | |
| set [BytesLabels] | set s n c modifies s in place, replacing the byte at index n
with c.
|
| set [Bytes] | set s n c modifies s in place, replacing the byte at index n
with c.
|
| set [Bigarray.Array3] | Array3.set a x y v, or alternatively a.{x,y,z} <- v,
stores the value v at coordinates (x, y, z) in a.
|
| set [Bigarray.Array2] | Array2.set a x y v, or alternatively a.{x,y} <- v,
stores the value v at coordinates (x, y) in a.
|
| set [Bigarray.Array1] | Array1.set a x v, also written a.{x} <- v,
stores the value v at index x in a.
|
| set [Bigarray.Array0] | Array0.set a x v stores the value v in a.
|
| set [Bigarray.Genarray] |
Assign an element of a generic big array.
|
| set [ArrayLabels] | Array.set a n x modifies array a in place, replacing
element number n with x.
|
| set [Array] | Array.set a n x modifies array a in place, replacing
element number n with x.
|
| set_all_formatter_output_functions [Format] | |
| set_approx_printing [Arith_status] |
Get or set the flag
approx_printing.
|
| set_base_default [Arg_helper.Make] | |
| set_binary_mode_in [Pervasives] | set_binary_mode_in ic true sets the channel ic to binary
mode: no translations take place during input.
|
| set_binary_mode_out [Pervasives] | set_binary_mode_out oc true sets the channel oc to binary
mode: no translations take place during output.
|
| set_close_on_exec [UnixLabels] |
Set the ``close-on-exec'' flag on the given descriptor.
|
| set_close_on_exec [Unix] |
Set the ``close-on-exec'' flag on the given descriptor.
|
| set_color [Graphics] |
Set the current drawing color.
|
| set_color_tag_handling [Misc.Color] | |
| set_cookie [Ast_mapper] | |
| set_data [Obj.Ephemeron] |
Same as
Ephemeron.K1.set_data
|
| set_data [Ephemeron.Kn] |
Same as
Ephemeron.K1.set_data
|
| set_data [Ephemeron.K2] |
Same as
Ephemeron.K1.set_data
|
| set_data [Ephemeron.K1] | Ephemeron.K1.set_data eph el sets the data of eph to be a
(full) data to el
|
| set_double_field [Obj] | |
| set_dumped_pass [Clflags] | |
| set_ellipsis_text [Format] |
Set the text of the ellipsis printed when too many boxes
are opened (a single dot,
., by default).
|
| set_error_when_null_denominator [Arith_status] |
Get or set the flag
null_denominator.
|
| set_field [Obj] |
When using flambda:
|
| set_floating_docstrings [Docstrings] |
Docstrings not immediately adjacent to a token
|
| set_floating_precision [Arith_status] |
Get or set the parameter
floating_precision.
|
| set_font [Graphics] |
Set the font used for drawing text.
|
| set_formatter_out_channel [Format] |
Redirect the pretty-printer output to the given channel.
|
| set_formatter_out_functions [Format] | set_formatter_out_functions f
Redirect the pretty-printer output to the functions f.out_string
and f.out_flush as described in
set_formatter_output_functions.
|
| set_formatter_output_functions [Format] | set_formatter_output_functions out flush redirects the
pretty-printer output functions to the functions out and
flush.
|
| set_formatter_tag_functions [Format] | set_formatter_tag_functions tag_funs changes the meaning of
opening and closing tags to use the functions in tag_funs.
|
| set_key [Obj.Ephemeron] |
Same as
Ephemeron.K1.set_key
|
| set_key [Ephemeron.Kn] |
Same as
Ephemeron.K1.set_key
|
| set_key [Ephemeron.K1] | Ephemeron.K1.set_key eph el sets the key of eph to be a
(full) key to el
|
| set_key1 [Ephemeron.K2] |
Same as
Ephemeron.K1.set_key
|
| set_key2 [Ephemeron.K2] |
Same as
Ephemeron.K1.set_key
|
| set_line_width [Graphics] |
Set the width of points and lines drawn with the functions above.
|
| set_margin [Format] | set_margin d sets the right margin to d (in characters):
the pretty-printer splits lines that overflow the right margin according to
the break hints given.
|
| set_mark_tags [Format] | set_mark_tags b turns on or off the output of tag markers.
|
| set_max_boxes [Format] | set_max_boxes max sets the maximum number of boxes simultaneously
opened.
|
| set_max_indent [Format] | set_max_indent d sets the maximum indentation limit of lines to d (in
characters):
once this limit is reached, new boxes are rejected to the left,
if they do not fit on the current line.
|
| set_method [CamlinternalOO] | |
| set_methods [CamlinternalOO] | |
| set_nonblock [UnixLabels] |
Set the ``non-blocking'' flag on the given descriptor.
|
| set_nonblock [Unix] |
Set the ``non-blocking'' flag on the given descriptor.
|
| set_normalize_ratio [Arith_status] |
Get or set the flag
normalize_ratio.
|
| set_normalize_ratio_when_printing [Arith_status] |
Get or set the flag
normalize_ratio_when_printing.
|
| set_post_docstrings [Docstrings] |
Docstrings immediately following a token
|
| set_post_extra_docstrings [Docstrings] |
Docstrings immediately preceding the token which follows this one
|
| set_pre_docstrings [Docstrings] |
Docstrings immediately preceding a token
|
| set_pre_extra_docstrings [Docstrings] |
Docstrings immediately following the token which precedes this one
|
| set_preprocessor [Lexer] | |
| set_print_tags [Format] | set_print_tags b turns on or off the printing of tags.
|
| set_signal [Sys] |
Same as
Sys.signal but return value is ignored.
|
| set_state [Random] |
Set the state of the generator used by the basic functions.
|
| set_styles [Misc.Color] | |
| set_tab [Format] | |
| set_tag [Obj] | |
| set_tags [Format] | set_tags b turns on or off the treatment of tags (default is off).
|
| set_temp_dir_name [Filename] |
Change the temporary directory returned by
Filename.get_temp_dir_name
and used by Filename.temp_file and Filename.open_temp_file.
|
| set_text_size [Graphics] |
Set the character size used for drawing text.
|
| set_trace [Parsing] |
Control debugging support for
ocamlyacc-generated parsers.
|
| set_uncaught_exception_handler [Printexc] | Printexc.set_uncaught_exception_handler fn registers fn as the handler
for uncaught exceptions.
|
| set_user_default [Arg_helper.Make] | |
| set_window_title [Graphics] |
Set the title of the graphics window.
|
| setfield [Ast_helper.Exp] | |
| setgid [UnixLabels] |
Set the real group id and effective group id for the process.
|
| setgid [Unix] |
Set the real group id and effective group id for the process.
|
| setgroups [UnixLabels] | setgroups groups sets the supplementary group IDs for the
calling process.
|
| setgroups [Unix] | setgroups groups sets the supplementary group IDs for the
calling process.
|
| setinstvar [Ast_helper.Exp] | |
| setitimer [UnixLabels] | setitimer t s sets the interval timer t and returns
its previous status.
|
| setitimer [Unix] | setitimer t s sets the interval timer t and returns
its previous status.
|
| setsid [UnixLabels] |
Put the calling process in a new session and detach it from
its controlling terminal.
|
| setsid [Unix] |
Put the calling process in a new session and detach it from
its controlling terminal.
|
| setsockopt [UnixLabels] |
Set or clear a boolean-valued option in the given socket.
|
| setsockopt [Unix] |
Set or clear a boolean-valued option in the given socket.
|
| setsockopt_float [UnixLabels] |
Same as
Unix.setsockopt for a socket option whose value is a
floating-point number.
|
| setsockopt_float [Unix] |
Same as
Unix.setsockopt for a socket option whose value is a
floating-point number.
|
| setsockopt_int [UnixLabels] |
Same as
Unix.setsockopt for an integer-valued socket option.
|
| setsockopt_int [Unix] |
Same as
Unix.setsockopt for an integer-valued socket option.
|
| setsockopt_optint [UnixLabels] |
Same as
Unix.setsockopt for a socket option whose value is
an int option.
|
| setsockopt_optint [Unix] |
Same as
Unix.setsockopt for a socket option whose value is an
int option.
|
| setuid [UnixLabels] |
Set the real user id and effective user id for the process.
|
| setuid [Unix] |
Set the real user id and effective user id for the process.
|
| setup [Terminfo] | |
| setup [Misc.Color] | |
| shared [Clflags] | |
| shift_left [Targetint] | Targetint.shift_left x y shifts x to the left by y bits.
|
| shift_left [Nativeint] | Nativeint.shift_left x y shifts x to the left by y bits.
|
| shift_left [Int64] | Int64.shift_left x y shifts x to the left by y bits.
|
| shift_left [Int32] | Int32.shift_left x y shifts x to the left by y bits.
|
| shift_left_big_int [Big_int] | shift_left_big_int b n returns b shifted left by n bits.
|
| shift_right [Targetint] | Targetint.shift_right x y shifts x to the right by y bits.
|
| shift_right [Nativeint] | Nativeint.shift_right x y shifts x to the right by y bits.
|
| shift_right [Int64] | Int64.shift_right x y shifts x to the right by y bits.
|
| shift_right [Int32] | Int32.shift_right x y shifts x to the right by y bits.
|
| shift_right_big_int [Big_int] | shift_right_big_int b n returns b shifted right by n bits.
|
| shift_right_logical [Targetint] | Targetint.shift_right_logical x y shifts x to the right
by y bits.
|
| shift_right_logical [Nativeint] | Nativeint.shift_right_logical x y shifts x to the right
by y bits.
|
| shift_right_logical [Int64] | Int64.shift_right_logical x y shifts x to the right by y bits.
|
| shift_right_logical [Int32] | Int32.shift_right_logical x y shifts x to the right by y bits.
|
| shift_right_towards_zero_big_int [Big_int] | shift_right_towards_zero_big_int b n returns b shifted
right by n bits.
|
| show_filename [Location] |
In -absname mode, return the absolute path for this filename.
|
| shutdown [UnixLabels] |
Shutdown a socket connection.
|
| shutdown [Unix] |
Shutdown a socket connection.
|
| shutdown_connection [UnixLabels] |
``Shut down'' a connection established with
UnixLabels.open_connection;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.
|
| shutdown_connection [Unix] |
``Shut down'' a connection established with
Unix.open_connection;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.
|
| sigabrt [Sys] |
Abnormal termination
|
| sigalrm [Sys] |
Timeout
|
| sigbus [Sys] |
Bus error
|
| sigchld [Sys] |
Child process terminated
|
| sigcont [Sys] |
Continue
|
| sigfpe [Sys] |
Arithmetic exception
|
| sighup [Sys] |
Hangup on controlling terminal
|
| sigill [Sys] |
Invalid hardware instruction
|
| sigint [Sys] |
Interactive interrupt (ctrl-C)
|
| sigkill [Sys] |
Termination (cannot be ignored)
|
| sigmask [Thread] | sigmask cmd sigs changes the set of blocked signals for the
calling thread.
|
| sign_big_int [Big_int] |
Return
0 if the given big integer is zero,
1 if it is positive, and -1 if it is negative.
|
| sign_num [Num] |
Return
-1, 0 or 1 according to the sign of the argument.
|
| signal [Sys] |
Set the behavior of the system on receipt of a given signal.
|
| signal [Condition] | signal c restarts one of the processes waiting on the
condition variable c.
|
| signature [Pprintast] | |
| signature [Ast_invariants] | |
| signature [Ast_helper.Cty] | |
| signature [Ast_helper.Mty] | |
| sigpending [UnixLabels] |
Return the set of blocked signals that are currently pending.
|
| sigpending [Unix] |
Return the set of blocked signals that are currently pending.
|
| sigpipe [Sys] |
Broken pipe
|
| sigpoll [Sys] |
Pollable event
|
| sigprocmask [UnixLabels] | sigprocmask cmd sigs changes the set of blocked signals.
|
| sigprocmask [Unix] | sigprocmask cmd sigs changes the set of blocked signals.
|
| sigprof [Sys] |
Profiling interrupt
|
| sigquit [Sys] |
Interactive termination
|
| sigsegv [Sys] |
Invalid memory reference
|
| sigstop [Sys] |
Stop
|
| sigsuspend [UnixLabels] | sigsuspend sigs atomically sets the blocked signals to sigs
and waits for a non-ignored, non-blocked signal to be delivered.
|
| sigsuspend [Unix] | sigsuspend sigs atomically sets the blocked signals to sigs
and waits for a non-ignored, non-blocked signal to be delivered.
|
| sigsys [Sys] |
Bad argument to routine
|
| sigterm [Sys] |
Termination
|
| sigtrap [Sys] |
Trace/breakpoint trap
|
| sigtstp [Sys] |
Interactive stop
|
| sigttin [Sys] |
Terminal read from background process
|
| sigttou [Sys] |
Terminal write from background process
|
| sigurg [Sys] |
Urgent condition on socket
|
| sigusr1 [Sys] |
Application-defined signal 1
|
| sigusr2 [Sys] |
Application-defined signal 2
|
| sigvtalrm [Sys] |
Timeout in virtual time
|
| sigxcpu [Sys] |
Timeout in cpu time
|
| sigxfsz [Sys] |
File size limit exceeded
|
| simplify_rounds [Clflags] | |
| sin [Pervasives] |
Sine.
|
| single_write [UnixLabels] |
Same as
write, but attempts to write only once.
|
| single_write [Unix] |
Same as
write, but attempts to write only once.
|
| single_write_substring [UnixLabels] |
Same as
single_write, but take the data from a string instead of
a byte sequence.
|
| single_write_substring [Unix] |
Same as
single_write, but take the data from a string instead of
a byte sequence.
|
| singleton [MoreLabels.Set.S] | |
| singleton [MoreLabels.Map.S] | |
| singleton [Map.S] | singleton x y returns the one-element map that contains a binding y
for x.
|
| singleton [Set.S] | singleton x returns the one-element set containing only x.
|
| sinh [Pervasives] |
Hyperbolic sine.
|
| size [Targetint] |
The size in bits of a target native integer.
|
| size [Obj] | |
| size [Nativeint] |
The size in bits of a native integer.
|
| size_in_bytes [Bigarray.Array3] | |
| size_in_bytes [Bigarray.Array2] | |
| size_in_bytes [Bigarray.Array1] | |
| size_in_bytes [Bigarray.Array0] | |
| size_in_bytes [Bigarray.Genarray] | |
| size_x [Graphics] |
See
Graphics.size_y.
|
| size_y [Graphics] |
Return the size of the graphics window.
|
| skip_hash_bang [Lexer] | |
| sleep [UnixLabels] |
Stop execution for the given number of seconds.
|
| sleep [Unix] |
Stop execution for the given number of seconds.
|
| sleep [ThreadUnix] | |
| sleepf [Unix] |
Stop execution for the given number of seconds.
|
| slice [Bigarray.Array1] |
Extract a scalar (zero-dimensional slice) of the given one-dimensional
big array.
|
| slice_left [Bigarray.Array2] |
Extract a row (one-dimensional slice) of the given two-dimensional
big array.
|
| slice_left [Bigarray.Genarray] |
Extract a sub-array of lower dimension from the given big array
by fixing one or several of the first (left-most) coordinates.
|
| slice_left_1 [Bigarray.Array3] |
Extract a one-dimensional slice of the given three-dimensional
big array by fixing the first two coordinates.
|
| slice_left_2 [Bigarray.Array3] |
Extract a two-dimensional slice of the given three-dimensional
big array by fixing the first coordinate.
|
| slice_right [Bigarray.Array2] |
Extract a column (one-dimensional slice) of the given
two-dimensional big array.
|
| slice_right [Bigarray.Genarray] |
Extract a sub-array of lower dimension from the given big array
by fixing one or several of the last (right-most) coordinates.
|
| slice_right_1 [Bigarray.Array3] |
Extract a one-dimensional slice of the given three-dimensional
big array by fixing the last two coordinates.
|
| slice_right_2 [Bigarray.Array3] |
Extract a two-dimensional slice of the given
three-dimensional big array by fixing the last coordinate.
|
| snd [Pervasives] |
Return the second component of a pair.
|
| snd3 [Misc] | |
| snd4 [Misc] | |
| socket [UnixLabels] |
Create a new socket in the given domain, and with the
given kind.
|
| socket [Unix] |
Create a new socket in the given domain, and with the
given kind.
|
| socket [ThreadUnix] | |
| socketpair [UnixLabels] |
Create a pair of unnamed sockets, connected together.
|
| socketpair [Unix] |
Create a pair of unnamed sockets, connected together.
|
| some_if_all_elements_are_some [Misc.Stdlib.List] |
If all elements of the given list are
Some _ then Some xs
is returned with the xs being the contents of those Somes, with
order preserved.
|
| sort [ListLabels] |
Sort a list in increasing order according to a comparison
function.
|
| sort [List] |
Sort a list in increasing order according to a comparison
function.
|
| sort [ArrayLabels] |
Sort an array in increasing order according to a comparison
function.
|
| sort [Array] |
Sort an array in increasing order according to a comparison
function.
|
| sort_uniq [ListLabels] |
Same as
List.sort, but also remove duplicates.
|
| sort_uniq [List] |
Same as
List.sort, but also remove duplicates.
|
| sound [Graphics] | sound freq dur plays a sound at frequency freq (in hertz)
for a duration dur (in milliseconds).
|
| source [Consistbl] | |
| spacetime [Config] | |
| spellcheck [Misc] | spellcheck env name takes a list of names env that exist in
the current environment and an erroneous name, and returns a
list of suggestions taken from env, that are close enough to
name that it may be a typo for one of them.
|
| split [Str] | split r s splits s into substrings, taking as delimiters
the substrings that match r, and returns the list of substrings.
|
| split [MoreLabels.Set.S] | |
| split [MoreLabels.Map.S] | |
| split [ListLabels] |
Transform a list of pairs into a pair of lists:
split [(a1,b1); ...; (an,bn)] is ([a1; ...; an], [b1; ...; bn]).
|
| split [List] |
Transform a list of pairs into a pair of lists:
split [(a1,b1); ...; (an,bn)] is ([a1; ...; an], [b1; ...; bn]).
|
| split [Map.S] | split x m returns a triple (l, data, r), where
l is the map with all the bindings of m whose key
is strictly less than x;
r is the map with all the bindings of m whose key
is strictly greater than x;
data is None if m contains no binding for x,
or Some v if m binds v to x.
|
| split [Set.S] | split x s returns a triple (l, present, r), where
l is the set of elements of s that are
strictly less than x;
r is the set of elements of s that are
strictly greater than x;
present is false if s contains no element equal to x,
or true if s contains an element equal to x.
|
| split_at [Misc.Stdlib.List] | split_at n l returns the pair before, after where before is
the n first elements of l and after the remaining ones.
|
| split_delim [Str] |
Same as
Str.split but occurrences of the
delimiter at the beginning and at the end of the string are
recognized and returned as empty strings in the result.
|
| split_last [Misc] | |
| split_on_char [String] | String.split_on_char sep s returns the list of all (possibly empty)
substrings of s that are delimited by the sep character.
|
| split_on_char [StringLabels] | String.split_on_char sep s returns the list of all (possibly empty)
substrings of s that are delimited by the sep character.
|
| sprintf [Printf] |
Same as
Printf.fprintf, but instead of printing on an output channel,
return a string containing the result of formatting the arguments.
|
| sprintf [Format] |
Same as
printf above, but instead of printing on a formatter,
returns a string containing the result of formatting the arguments.
|
| sqrt [Pervasives] |
Square root.
|
| sqrt [Complex] |
Square root.
|
| sqrt_big_int [Big_int] | sqrt_big_int a returns the integer square root of a,
that is, the largest big integer r such that r * r <= a.
|
| square_big_int [Big_int] |
Return the square of the given big integer
|
| square_num [Num] |
Squaring
|
| sscanf [Scanf] |
Same as
Scanf.bscanf, but reads from the given string.
|
| sscanf_format [Scanf] |
Same as
Scanf.bscanf_format, but reads from the given string.
|
| stable_sort [ListLabels] |
Same as
List.sort, but the sorting algorithm is guaranteed to
be stable (i.e.
|
| stable_sort [List] |
Same as
List.sort, but the sorting algorithm is guaranteed to
be stable (i.e.
|
| stable_sort [ArrayLabels] |
Same as
Array.sort, but the sorting algorithm is stable (i.e.
|
| stable_sort [Array] |
Same as
Array.sort, but the sorting algorithm is stable (i.e.
|
| stack_safety_margin [Config] | |
| stack_threshold [Config] | |
| standard_library [Config] | |
| standard_runtime [Config] | |
| standout [Terminfo] | |
| stat [UnixLabels.LargeFile] | |
| stat [UnixLabels] |
Return the information for the named file.
|
| stat [Unix.LargeFile] | |
| stat [Unix] |
Return the information for the named file.
|
| stat [Gc] |
Return the current values of the memory management counters in a
stat record.
|
| stats [Weak.S] |
Return statistics on the table.
|
| stats [MoreLabels.Hashtbl.SeededS] | |
| stats [MoreLabels.Hashtbl.S] | |
| stats [MoreLabels.Hashtbl] | |
| stats [Hashtbl.SeededS] | |
| stats [Hashtbl.S] | |
| stats [Hashtbl] | Hashtbl.stats tbl returns statistics about the table tbl:
number of buckets, size of the biggest bucket, distribution of
buckets by size.
|
| stats [CamlinternalOO] | |
| stats_alive [Ephemeron.SeededS] |
same as
Hashtbl.SeededS.stats but only count the alive bindings
|
| stats_alive [Ephemeron.S] |
same as
Hashtbl.SeededS.stats but only count the alive bindings
|
| std_formatter [Format] |
The standard formatter used by the formatting functions
above.
|
| std_include_dir [Clflags] | |
| std_include_flag [Clflags] | |
| stdbuf [Format] |
The string buffer in which
str_formatter writes.
|
| stderr [UnixLabels] |
File descriptor for standard error.
|
| stderr [Unix] |
File descriptor for standard error.
|
| stderr [Pervasives] |
The standard error output for the process.
|
| stdib [Scanf.Scanning] |
A deprecated alias for
Scanf.Scanning.stdin, the scanning buffer reading from
stdin.
|
| stdin [UnixLabels] |
File descriptor for standard input.
|
| stdin [Unix] |
File descriptor for standard input.
|
| stdin [Scanf.Scanning] |
The standard input notion for the
Scanf module.
|
| stdin [Pervasives] |
The standard input for the process.
|
| stdout [UnixLabels] |
File descriptor for standard output.
|
| stdout [Unix] |
File descriptor for standard output.
|
| stdout [Pervasives] |
The standard output for the process.
|
| str_formatter [Format] |
A formatter to use with formatting functions below for
output to the
stdbuf string buffer.
|
| strict_formats [Clflags] | |
| strict_sequence [Clflags] | |
| string [Digest] |
Return the digest of the given string.
|
| string [Ast_helper.Const] | |
| string_after [Str] | string_after s n returns the substring of all characters of s
that follow position n (including the character at
position n).
|
| string_before [Str] | string_before s n returns the substring of all characters of s
that precede position n (excluding the character at
position n).
|
| string_match [Str] | string_match r s start tests whether a substring of s that
starts at position start matches the regular expression r.
|
| string_of_big_int [Big_int] |
Return the string representation of the given big integer,
in decimal (base 10).
|
| string_of_bool [Pervasives] |
Return the string representation of a boolean.
|
| string_of_expression [Pprintast] | |
| string_of_file [Misc] | |
| string_of_float [Pervasives] |
Return the string representation of a floating-point number.
|
| string_of_fmt [CamlinternalFormat] | |
| string_of_fmtty [CamlinternalFormat] | |
| string_of_format [Pervasives] |
Converts a format string into a string.
|
| string_of_formatting_gen [CamlinternalFormat] | |
| string_of_formatting_lit [CamlinternalFormat] | |
| string_of_inet_addr [UnixLabels] |
Return the printable representation of the given Internet address.
|
| string_of_inet_addr [Unix] |
Return the printable representation of the given Internet address.
|
| string_of_int [Pervasives] |
Return the string representation of an integer, in decimal.
|
| string_of_num [Num] |
Convert a number to a string, using fractional notation.
|
| string_of_structure [Pprintast] | |
| string_partial_match [Str] |
Similar to
Str.string_match, but also returns true if
the argument string is a prefix of a string that matches.
|
| string_tag [Obj] | |
| strput_acc [CamlinternalFormat] | |
| structure [Printast] | |
| structure [Pprintast] | |
| structure [Ast_invariants] | |
| structure [Ast_helper.Cl] | |
| structure [Ast_helper.Mod] | |
| sub [Targetint] |
Subtraction.
|
| sub [String] | String.sub s start len returns a fresh string of length len,
containing the substring of s that starts at position start and
has length len.
|
| sub [StringLabels] | String.sub s start len returns a fresh string of length len,
containing the substring of s that starts at position start and
has length len.
|
| sub [Nativeint] |
Subtraction.
|
| sub [Int64] |
Subtraction.
|
| sub [Int32] |
Subtraction.
|
| sub [Complex] |
Subtraction
|
| sub [BytesLabels] | sub s start len returns a new byte sequence of length len,
containing the subsequence of s that starts at position start
and has length len.
|
| sub [Bytes] | sub s start len returns a new byte sequence of length len,
containing the subsequence of s that starts at position start
and has length len.
|
| sub [Buffer] | Buffer.sub b off len returns a copy of len bytes from the
current contents of the buffer b, starting at offset off.
|
| sub [Bigarray.Array1] |
Extract a sub-array of the given one-dimensional big array.
|
| sub [ArrayLabels] | Array.sub a start len returns a fresh array of length len,
containing the elements number start to start + len - 1
of array a.
|
| sub [Array] | Array.sub a start len returns a fresh array of length len,
containing the elements number start to start + len - 1
of array a.
|
| sub_big_int [Big_int] |
Subtraction.
|
| sub_left [Bigarray.Array3] |
Extract a three-dimensional sub-array of the given
three-dimensional big array by restricting the first dimension.
|
| sub_left [Bigarray.Array2] |
Extract a two-dimensional sub-array of the given two-dimensional
big array by restricting the first dimension.
|
| sub_left [Bigarray.Genarray] |
Extract a sub-array of the given big array by restricting the
first (left-most) dimension.
|
| sub_num [Num] |
Subtraction
|
| sub_right [Bigarray.Array3] |
Extract a three-dimensional sub-array of the given
three-dimensional big array by restricting the second dimension.
|
| sub_right [Bigarray.Array2] |
Extract a two-dimensional sub-array of the given two-dimensional
big array by restricting the second dimension.
|
| sub_right [Bigarray.Genarray] |
Extract a sub-array of the given big array by restricting the
last (right-most) dimension.
|
| sub_string [BytesLabels] |
Same as
sub but return a string instead of a byte sequence.
|
| sub_string [Bytes] |
Same as
sub but return a string instead of a byte sequence.
|
| subbytes [Digest] | Digest.subbytes s ofs len returns the digest of the subsequence
of s starting at index ofs and containing len bytes.
|
| subset [MoreLabels.Set.S] | |
| subset [Set.S] | subset s1 s2 tests whether the set s1 is a subset of
the set s2.
|
| substitute_first [Str] |
Same as
Str.global_substitute, except that only the first substring
matching the regular expression is replaced.
|
| substring [Digest] | Digest.substring s ofs len returns the digest of the substring
of s starting at index ofs and containing len characters.
|
| succ [Uchar] | succ u is the scalar value after u in the set of Unicode scalar
values.
|
| succ [Targetint] |
Successor.
|
| succ [Pervasives] | succ x is x + 1.
|
| succ [Nativeint] |
Successor.
|
| succ [Int64] |
Successor.
|
| succ [Int32] |
Successor.
|
| succ_big_int [Big_int] |
Successor (add 1).
|
| succ_num [Num] | succ n is n+1
|
| symbol_docs [Docstrings] |
Fetch the item documentation for the current symbol.
|
| symbol_docs_lazy [Docstrings] | |
| symbol_end [Parsing] |
See
Parsing.symbol_start.
|
| symbol_end_pos [Parsing] |
Same as
symbol_end, but return a position instead of an offset.
|
| symbol_gloc [Location] | |
| symbol_info [Docstrings] |
Fetch the field info for the current symbol.
|
| symbol_post_extra_text [Docstrings] |
Fetch additional text following the current symbol
|
| symbol_pre_extra_text [Docstrings] |
Fetch additional text preceding the current symbol
|
| symbol_rloc [Location] | |
| symbol_start [Parsing] | symbol_start and Parsing.symbol_end are to be called in the
action part of a grammar rule only.
|
| symbol_start_pos [Parsing] |
Same as
symbol_start, but return a position instead of an offset.
|
| symbol_text [Docstrings] |
Fetch the text preceding the current symbol.
|
| symbol_text_lazy [Docstrings] | |
| symlink [UnixLabels] | symlink source dest creates the file dest as a symbolic link
to the file source.
|
| symlink [Unix] | symlink ?to_dir source dest creates the file dest as a symbolic link
to the file source.
|
| symm [CamlinternalFormat] | |
| sync [Event] |
'Synchronize' on an event: offer all the communication
possibilities specified in the event to the outside world,
and block until one of the communications succeed.
|
| synchronize [Graphics] |
Synchronize the backing store and the on-screen window, by
copying the contents of the backing store onto the graphics
window.
|
| system [UnixLabels] |
Execute the given command, wait until it terminates, and return
its termination status.
|
| system [Unix] |
Execute the given command, wait until it terminates, and return
its termination status.
|
| system [ThreadUnix] | |
| system [Config] | |
| systhread_supported [Config] | |
T | |
| tag [Obj] | |
| take [Spacetime.Snapshot] | take series takes a snapshot of the profiling annotations on the values
in the minor and major heaps, together with GC stats, and write the
result to the series file.
|
| take [Queue] | take q removes and returns the first element in queue q,
or raises Queue.Empty if the queue is empty.
|
| tan [Pervasives] |
Tangent.
|
| tanh [Pervasives] |
Hyperbolic tangent.
|
| target [Config] | |
| tcdrain [UnixLabels] |
Waits until all output written on the given file descriptor
has been transmitted.
|
| tcdrain [Unix] |
Waits until all output written on the given file descriptor
has been transmitted.
|
| tcflow [UnixLabels] |
Suspend or restart reception or transmission of data on
the given file descriptor, depending on the second argument:
TCOOFF suspends output, TCOON restarts output,
TCIOFF transmits a STOP character to suspend input,
and TCION transmits a START character to restart input.
|
| tcflow [Unix] |
Suspend or restart reception or transmission of data on
the given file descriptor, depending on the second argument:
TCOOFF suspends output, TCOON restarts output,
TCIOFF transmits a STOP character to suspend input,
and TCION transmits a START character to restart input.
|
| tcflush [UnixLabels] |
Discard data written on the given file descriptor but not yet
transmitted, or data received but not yet read, depending on the
second argument:
TCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.
|
| tcflush [Unix] |
Discard data written on the given file descriptor but not yet
transmitted, or data received but not yet read, depending on the
second argument:
TCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.
|
| tcgetattr [UnixLabels] |
Return the status of the terminal referred to by the given
file descriptor.
|
| tcgetattr [Unix] |
Return the status of the terminal referred to by the given
file descriptor.
|
| tcsendbreak [UnixLabels] |
Send a break condition on the given file descriptor.
|
| tcsendbreak [Unix] |
Send a break condition on the given file descriptor.
|
| tcsetattr [UnixLabels] |
Set the status of the terminal referred to by the given
file descriptor.
|
| tcsetattr [Unix] |
Set the status of the terminal referred to by the given
file descriptor.
|
| temp_dir_name [Filename] |
The name of the initial temporary directory:
Under Unix, the value of the
TMPDIR environment variable, or "/tmp"
if the variable is not set.
|
| temp_file [Filename] | temp_file prefix suffix returns the name of a
fresh temporary file in the temporary directory.
|
| text [Ast_helper.Cf] | |
| text [Ast_helper.Ctf] | |
| text [Ast_helper.Str] | |
| text [Ast_helper.Sig] | |
| text_attr [Docstrings] | |
| text_size [Graphics] |
Return the dimensions of the given text, if it were drawn with
the current font and size.
|
| thd3 [Misc] | |
| thd4 [Misc] | |
| time [UnixLabels] |
Return the current time since 00:00:00 GMT, Jan.
|
| time [Unix] |
Return the current time since 00:00:00 GMT, Jan.
|
| time [Timings] | time pass f arg records the runtime of f arg
|
| time [Sys] |
Return the processor time, in seconds, used by the program
since the beginning of execution.
|
| time_call [Timings] | time_call pass f calls f and records its runtime.
|
| timed_read [ThreadUnix] | |
| timed_write [ThreadUnix] |
Behave as
ThreadUnix.read and ThreadUnix.write, except that
Unix_error(ETIMEDOUT,_,_) is raised if no data is
available for reading or ready for writing after d seconds.
|
| timed_write_substring [ThreadUnix] | |
| times [UnixLabels] |
Return the execution times of the process.
|
| times [Unix] |
Return the execution times of the process.
|
| tl [ListLabels] |
Return the given list without its first element.
|
| tl [List] |
Return the given list without its first element.
|
| to_buffer [Marshal] | Marshal.to_buffer buff ofs len v flags marshals the value v,
storing its byte representation in the sequence buff,
starting at index ofs, and writing at most
len bytes.
|
| to_bytes [Marshal] | Marshal.to_bytes v flags returns a byte sequence containing
the representation of v.
|
| to_bytes [Buffer] |
Return a copy of the current contents of the buffer.
|
| to_channel [Marshal] | Marshal.to_channel chan v flags writes the representation
of v on channel chan.
|
| to_char [Uchar] | to_char u is u as an OCaml latin1 character.
|
| to_float [Targetint] |
Convert the given target integer to a floating-point number.
|
| to_float [Nativeint] |
Convert the given native integer to a floating-point number.
|
| to_float [Int64] |
Convert the given 64-bit integer to a floating-point number.
|
| to_float [Int32] |
Convert the given 32-bit integer to a floating-point number.
|
| to_hex [Digest] |
Return the printable hexadecimal representation of the given digest.
|
| to_int [Uchar] | to_int u is u as an integer.
|
| to_int [Targetint] |
Convert the given target integer (type
t) to an
integer (type int).
|
| to_int [Nativeint] |
Convert the given native integer (type
nativeint) to an
integer (type int).
|
| to_int [Int64] |
Convert the given 64-bit integer (type
int64) to an
integer (type int).
|
| to_int [Int32] |
Convert the given 32-bit integer (type
int32) to an
integer (type int).
|
| to_int32 [Targetint] |
Convert the given target integer to a
32-bit integer (type
int32).
|
| to_int32 [Nativeint] |
Convert the given native integer to a
32-bit integer (type
int32).
|
| to_int32 [Int64] |
Convert the given 64-bit integer (type
int64) to a
32-bit integer (type int32).
|
| to_int64 [Targetint] |
Convert the given target integer to a
64-bit integer (type
int64).
|
| to_list [Identifiable.S.Tbl] | |
| to_list [ArrayLabels] | Array.to_list a returns the list of all the elements of a.
|
| to_list [Array] | Array.to_list a returns the list of all the elements of a.
|
| to_map [Identifiable.S.Tbl] | |
| to_nativeint [Int64] |
Convert the given 64-bit integer (type
int64) to a
native integer.
|
| to_string [Targetint] |
Return the string representation of its argument, in decimal.
|
| to_string [Printexc] | Printexc.to_string e returns a string representation of
the exception e.
|
| to_string [Nativeint] |
Return the string representation of its argument, in decimal.
|
| to_string [Marshal] |
Same as
to_bytes but return the result as a string instead of
a byte sequence.
|
| to_string [Int64] |
Return the string representation of its argument, in decimal.
|
| to_string [Int32] |
Return the string representation of its argument, in signed decimal.
|
| to_string [Identifiable.S.Set] | |
| to_string [BytesLabels] |
Return a new string that contains the same bytes as the given byte
sequence.
|
| to_string [Bytes] |
Return a new string that contains the same bytes as the given byte
sequence.
|
| token [Lexer] | |
| token_with_comments [Lexer] | |
| tool_name [Ast_mapper] |
Can be used within a ppx preprocessor to know which tool is
calling it
"ocamlc", "ocamlopt", "ocamldoc", "ocamldep",
"ocaml", ...
|
| top [Stack] | |
| top [Queue] | top is a synonym for peek.
|
| top_phrase [Printast] | |
| top_phrase [Pprintast] | |
| toplevel_phrase [Pprintast] | |
| toplevel_phrase [Parser] | |
| toplevel_phrase [Parse] | |
| total_size [Marshal] |
See
Marshal.header_size.
|
| trans [CamlinternalFormat] | |
| transfer [Queue] | transfer q1 q2 adds all of q1's elements at the end of
the queue q2, then clears q1.
|
| transp [Graphics] |
In matrices of colors, this color represent a 'transparent'
point: when drawing the corresponding image, all pixels on the
screen corresponding to a transparent pixel in the image will
not be modified, while other points will be set to the color
of the corresponding point in the image.
|
| transparent_modules [Clflags] | |
| transpose_keys_and_data [Identifiable.S.Map] | |
| transpose_keys_and_data_set [Identifiable.S.Map] | |
| trim [String] |
Return a copy of the argument, without leading and trailing
whitespace.
|
| trim [StringLabels] |
Return a copy of the argument, without leading and trailing
whitespace.
|
| trim [BytesLabels] |
Return a copy of the argument, without leading and trailing
whitespace.
|
| trim [Bytes] |
Return a copy of the argument, without leading and trailing
whitespace.
|
| truncate [UnixLabels.LargeFile] | |
| truncate [UnixLabels] |
Truncates the named file to the given size.
|
| truncate [Unix.LargeFile] |
See
Unix.truncate.
|
| truncate [Unix] |
Truncates the named file to the given size.
|
| truncate [Pervasives] |
Same as
int_of_float.
|
| truncate [Obj] | |
| truncate [Buffer] | truncate b len truncates the length of b to len
Note: the internal byte sequence is not shortened.
|
| try_ [Ast_helper.Exp] | |
| try_finally [Misc] | |
| try_lock [Mutex] |
Same as
Mutex.lock, but does not suspend the calling thread if
the mutex is already locked: just return false immediately
in that case.
|
| tuple [Ast_helper.Exp] | |
| tuple [Ast_helper.Pat] | |
| tuple [Ast_helper.Typ] | |
| type_ [Ast_helper.Str] | |
| type_ [Ast_helper.Sig] | |
| type_ [Ast_helper.Pat] | |
| type_extension [Ast_helper.Str] | |
| type_extension [Ast_helper.Sig] | |
| type_format [CamlinternalFormat] | |
| typeof_ [Ast_helper.Mty] | |
U | |
| umask [UnixLabels] |
Set the process's file mode creation mask, and return the previous
mask.
|
| umask [Unix] |
Set the process's file mode creation mask, and return the previous
mask.
|
| unaligned_tag [Obj] | |
| unbox_closures [Clflags] | |
| unbox_closures_factor [Clflags] | |
| unbox_free_vars_of_closures [Clflags] | |
| unbox_specialised_args [Clflags] | |
| unboxed_types [Clflags] | |
| uncapitalize [String] |
Return a copy of the argument, with the first character set to lowercase,
using the ISO Latin-1 (8859-1) character set..
|
| uncapitalize [StringLabels] |
Return a copy of the argument, with the first character set to lowercase,
using the ISO Latin-1 (8859-1) character set..
|
| uncapitalize [BytesLabels] |
Return a copy of the argument, with the first character set to lowercase,
using the ISO Latin-1 (8859-1) character set..
|
| uncapitalize [Bytes] |
Return a copy of the argument, with the first character set to lowercase,
using the ISO Latin-1 (8859-1) character set..
|
| uncapitalize_ascii [String] |
Return a copy of the argument, with the first character set to lowercase,
using the US-ASCII character set.
|
| uncapitalize_ascii [StringLabels] |
Return a copy of the argument, with the first character set to lowercase,
using the US-ASCII character set.
|
| uncapitalize_ascii [BytesLabels] |
Return a copy of the argument, with the first character set to lowercase,
using the US-ASCII character set.
|
| uncapitalize_ascii [Bytes] |
Return a copy of the argument, with the first character set to lowercase,
using the US-ASCII character set.
|
| unescaped [Scanf] | unescaped s return a copy of s with escape sequences (according to
the lexical conventions of OCaml) replaced by their corresponding special
characters.
|
| union [MoreLabels.Set.S] | |
| union [MoreLabels.Map.S] | |
| union [Map.S] | union f m1 m2 computes a map whose keys is the union of keys
of m1 and of m2.
|
| union [Set.S] |
Set union.
|
| union_left [Identifiable.S.Map] | union_left m1 m2 = union_right m2 m1
|
| union_merge [Identifiable.S.Map] | |
| union_right [Identifiable.S.Map] | union_right m1 m2 contains all bindings from m1 and m2.
|
| unit_big_int [Big_int] |
The big integer
1.
|
| unix [Sys] |
True if
Sys.os_type = "Unix".
|
| unlink [UnixLabels] |
Removes the named file
|
| unlink [Unix] |
Removes the named file.
|
| unlock [Mutex] |
Unlock the given mutex.
|
| unmarshal [Obj] | |
| unpack [Ast_helper.Mod] | |
| unpack [Ast_helper.Pat] | |
| unreachable [Ast_helper.Exp] | |
| unsafe_blit_to_bytes [Misc.LongString] | |
| unsafe_get [Bigarray.Array3] |
Like
Bigarray.Array3.get, but bounds checking is not always
performed.
|
| unsafe_get [Bigarray.Array2] |
Like
Bigarray.Array2.get, but bounds checking is not always
performed.
|
| unsafe_get [Bigarray.Array1] |
Like
Bigarray.Array1.get, but bounds checking is not always performed.
|
| unsafe_of_string [Bytes] |
Unsafely convert a shared string to a byte sequence that should
not be mutated.
|
| unsafe_set [Bigarray.Array3] |
Like
Bigarray.Array3.set, but bounds checking is not always
performed.
|
| unsafe_set [Bigarray.Array2] |
Like
Bigarray.Array2.set, but bounds checking is not always
performed.
|
| unsafe_set [Bigarray.Array1] |
Like
Bigarray.Array1.set, but bounds checking is not always performed.
|
| unsafe_string [Clflags] | |
| unsafe_to_string [Bytes] |
Unsafely convert a byte sequence into a string.
|
| unset_data [Obj.Ephemeron] |
Same as
Ephemeron.K1.unset_data
|
| unset_data [Ephemeron.Kn] |
Same as
Ephemeron.K1.unset_data
|
| unset_data [Ephemeron.K2] |
Same as
Ephemeron.K1.unset_data
|
| unset_data [Ephemeron.K1] | Ephemeron.K1.unset_data eph el sets the key of eph to be an
empty key.
|
| unset_key [Obj.Ephemeron] |
Same as
Ephemeron.K1.unset_key
|
| unset_key [Ephemeron.Kn] |
Same as
Ephemeron.K1.unset_key
|
| unset_key [Ephemeron.K1] | Ephemeron.K1.unset_key eph el sets the key of eph to be an
empty key.
|
| unset_key1 [Ephemeron.K2] |
Same as
Ephemeron.K1.unset_key
|
| unset_key2 [Ephemeron.K2] |
Same as
Ephemeron.K1.unset_key
|
| update_mod [CamlinternalMod] | |
| uppercase [String] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| uppercase [StringLabels] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| uppercase [Char] |
Convert the given character to its equivalent uppercase character,
using the ISO Latin-1 (8859-1) character set.
|
| uppercase [BytesLabels] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| uppercase [Bytes] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, including accented letters of the ISO
Latin-1 (8859-1) character set.
|
| uppercase_ascii [String] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, using the US-ASCII character set.
|
| uppercase_ascii [StringLabels] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, using the US-ASCII character set.
|
| uppercase_ascii [Char] |
Convert the given character to its equivalent uppercase character,
using the US-ASCII character set.
|
| uppercase_ascii [BytesLabels] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, using the US-ASCII character set.
|
| uppercase_ascii [Bytes] |
Return a copy of the argument, with all lowercase letters
translated to uppercase, using the US-ASCII character set.
|
| usage [Arg] | Arg.usage speclist usage_msg prints to standard error
an error message that includes the list of valid options.
|
| usage_string [Arg] |
Returns the message that would have been printed by
Arg.usage,
if provided with the same parameters.
|
| use_file [Parser] | |
| use_file [Parse] | |
| use_inlining_arguments_set [Clflags] |
Set all the inlining arguments for a round.
|
| use_prims [Clflags] | |
| use_runtime [Clflags] | |
| use_threads [Clflags] | |
| use_vmthreads [Clflags] | |
| utimes [UnixLabels] |
Set the last access time (second arg) and last modification time
(third arg) for a file.
|
| utimes [Unix] |
Set the last access time (second arg) and last modification time
(third arg) for a file.
|
V | |
| val_ [Ast_helper.Cf] | |
| val_ [Ast_helper.Ctf] | |
| value [Ast_helper.Str] | |
| value [Ast_helper.Sig] | |
| value_default [Misc.Stdlib.Option] | |
| var [Ast_helper.Pat] | |
| var [Ast_helper.Typ] | |
| variant [Ast_helper.Exp] | |
| variant [Ast_helper.Pat] | |
| variant [Ast_helper.Typ] | |
| varify_constructors [Ast_helper.Typ] | varify_constructors newtypes te is type expression te, of which
any of nullary type constructor tc is replaced by type variable of
the same name, if tc's name appears in newtypes.
|
| verbose [Clflags] | |
| version [Config] | |
| virtual_ [Ast_helper.Cf] | |
W | |
| wait [UnixLabels] |
Wait until one of the children processes die, and return its pid
and termination status.
|
| wait [Unix] |
Wait until one of the children processes die, and return its pid
and termination status.
|
| wait [ThreadUnix] | |
| wait [Condition] | wait c m atomically unlocks the mutex m and suspends the
calling process on the condition variable c.
|
| wait_next_event [Graphics] |
Wait until one of the events specified in the given event list
occurs, and return the status of the mouse and keyboard at
that time.
|
| wait_pid [Thread] | wait_pid p suspends the execution of the calling thread
until the process specified by the process identifier p
terminates.
|
| wait_read [Thread] |
See
Thread.wait_write.
|
| wait_signal [Thread] | wait_signal sigs suspends the execution of the calling thread
until the process receives one of the signals specified in the
list sigs.
|
| wait_timed_read [Thread] | |
| wait_timed_write [Thread] |
Suspend the execution of the calling thread until at least
one character is available for reading (
wait_read) or
one character can be written without blocking (wait_write)
on the given Unix file descriptor.
|
| wait_write [Thread] |
This function does nothing in this implementation.
|
| waitpid [UnixLabels] |
Same as
UnixLabels.wait, but waits for the child process whose pid
is given.
|
| waitpid [Unix] |
Same as
Unix.wait, but waits for the child process whose pid is given.
|
| waitpid [ThreadUnix] | |
| warn_bad_docstrings [Docstrings] |
Emit warnings for unattached and ambiguous docstrings
|
| warn_on_literal_pattern [Builtin_attributes] | |
| warning_attribute [Builtin_attributes] | |
| warning_enter_scope [Builtin_attributes] | |
| warning_leave_scope [Builtin_attributes] | |
| warning_printer [Location] |
Hook for intercepting warnings.
|
| weaken_map [Depend] | |
| while_ [Ast_helper.Exp] | |
| white [Graphics] | |
| widen [CamlinternalOO] | |
| win32 [Sys] |
True if
Sys.os_type = "Win32".
|
| window_id [GraphicsX11] |
Return the unique identifier of the OCaml graphics window.
|
| with_ [Ast_helper.Mty] | |
| with_default_loc [Ast_helper] |
Set the
default_loc within the scope of the execution
of the provided function.
|
| with_frame_pointers [Config] | |
| with_warning_attribute [Builtin_attributes] | |
| word_size [Sys] |
Size of one word on the machine currently executing the OCaml
program, in bits: 32 or 64.
|
| wrap [Event] | wrap ev fn returns the event that performs the same communications
as ev, then applies the post-processing function fn
on the return value.
|
| wrap_abort [Event] | wrap_abort ev fn returns the event that performs
the same communications as ev, but if it is not selected
the function fn is called after the synchronization.
|
| write [UnixLabels] | write fd buff ofs len writes len bytes to descriptor fd,
taking them from byte sequence buff, starting at position ofs
in buff.
|
| write [Unix] | write fd buff ofs len writes len bytes to descriptor fd,
taking them from byte sequence buff, starting at position ofs
in buff.
|
| write [ThreadUnix] | |
| write_arg [Arg] | Arg.write_arg file args writes the arguments args newline-terminated
into the file file.
|
| write_arg0 [Arg] |
Identical to
Arg.write_arg but uses the null character for terminator
instead of newline.
|
| write_substring [UnixLabels] |
Same as
write, but take the data from a string instead of a byte
sequence.
|
| write_substring [Unix] |
Same as
write, but take the data from a string instead of a byte
sequence.
|
| write_substring [ThreadUnix] | |
X | |
| xor_big_int [Big_int] |
Bitwise logical 'exclusive or'.
|
Y | |
| yellow [Graphics] | |
| yield [Thread] |
Re-schedule the calling thread without suspending it.
|
Z | |
| zero [Targetint] |
The target integer 0.
|
| zero [Nativeint] |
The native integer 0.
|
| zero [Int64] |
The 64-bit integer 0.
|
| zero [Int32] |
The 32-bit integer 0.
|
| zero [Complex] |
The complex number
0.
|
| zero_big_int [Big_int] |
The big integer
0.
|
| zero_to_n [Numbers.Int] | zero_to_n n is the set of numbers {0, ..., n} (inclusive).
|
module String: StringLabelsval length : string -> intval get : string -> int -> charString.get s n returns the character at index n in string s.
You can also write s.[n] instead of String.get s n.
Raise Invalid_argument if n not a valid index in s.
val set : bytes -> int -> char -> unitBytesLabels.set.String.set s n c modifies byte sequence s in place,
replacing the byte at index n with c.
You can also write s.[n] <- c instead of String.set s n c.
Raise Invalid_argument if n is not a valid index in s.
val create : int -> bytesBytesLabels.create.String.create n returns a fresh byte sequence of length n.
The sequence is uninitialized and contains arbitrary bytes.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val make : int -> char -> stringString.make n c returns a fresh string of length n,
filled with the character c.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val init : int -> f:(int -> char) -> stringinit n f returns a string of length n,
with character i initialized to the result of f i.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
Since 4.02.0
val copy : string -> stringval sub : string -> pos:int -> len:int -> stringString.sub s start len returns a fresh string of length len,
containing the substring of s that starts at position start and
has length len.
Raise Invalid_argument if start and len do not
designate a valid substring of s.
val fill : bytes -> pos:int -> len:int -> char -> unitBytesLabels.fill.String.fill s start len c modifies byte sequence s in place,
replacing len bytes by c, starting at start.
Raise Invalid_argument if start and len do not
designate a valid substring of s.
val blit : src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitString.blit src srcoff dst dstoff len copies len bytes
from the string src, starting at index srcoff,
to byte sequence dst, starting at character number dstoff.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
val concat : sep:string -> string list -> stringString.concat sep sl concatenates the list of strings sl,
inserting the separator string sep between each.val iter : f:(char -> unit) -> string -> unitString.iter f s applies function f in turn to all
the characters of s. It is equivalent to
f s.[0]; f s.[1]; ...; f s.[String.length s - 1]; ().val iteri : f:(int -> char -> unit) -> string -> unitString.iter, but the
function is applied to the index of the element as first argument
(counting from 0), and the character itself as second argument.val map : f:(char -> char) -> string -> stringString.map f s applies function f in turn to all
the characters of s and stores the results in a new string that
is returned.val mapi : f:(int -> char -> char) -> string -> stringString.mapi f s calls f with each character of s and its
index (in increasing index order) and stores the results in a new
string that is returned.val trim : string -> string' ',
'\012', '\n', '\r', and '\t'. If there is no leading nor
trailing whitespace character in the argument, return the original
string itself, not a copy.val escaped : string -> stringval index : string -> char -> intString.index s c returns the index of the first
occurrence of character c in string s.
Raise Not_found if c does not occur in s.
val index_opt : string -> char -> int optionString.index_opt s c returns the index of the first
occurrence of character c in string s, or
None if c does not occur in s.val rindex : string -> char -> intString.rindex s c returns the index of the last
occurrence of character c in string s.
Raise Not_found if c does not occur in s.
val rindex_opt : string -> char -> int optionString.rindex_opt s c returns the index of the last occurrence
of character c in string s, or None if c does not occur in
s.val index_from : string -> int -> char -> intString.index_from s i c returns the index of the
first occurrence of character c in string s after position i.
String.index s c is equivalent to String.index_from s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Raise Not_found if c does not occur in s after position i.
val index_from_opt : string -> int -> char -> int optionString.index_from_opt s i c returns the index of the
first occurrence of character c in string s after position i
or None if c does not occur in s after position i.
String.index_opt s c is equivalent to String.index_from_opt s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Since 4.05
val rindex_from : string -> int -> char -> intString.rindex_from s i c returns the index of the
last occurrence of character c in string s before position i+1.
String.rindex s c is equivalent to
String.rindex_from s (String.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Raise Not_found if c does not occur in s before position i+1.
val rindex_from_opt : string -> int -> char -> int optionString.rindex_from_opt s i c returns the index of the
last occurrence of character c in string s before position i+1
or None if c does not occur in s before position i+1.
String.rindex_opt s c is equivalent to
String.rindex_from_opt s (String.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Since 4.05
val contains : string -> char -> boolString.contains s c tests if character c
appears in the string s.val contains_from : string -> int -> char -> boolString.contains_from s start c tests if character c
appears in s after position start.
String.contains s c is equivalent to
String.contains_from s 0 c.
Raise Invalid_argument if start is not a valid position in s.
val rcontains_from : string -> int -> char -> boolString.rcontains_from s stop c tests if character c
appears in s before position stop+1.
Raise Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.
val uppercase : string -> stringval lowercase : string -> stringval capitalize : string -> stringval uncapitalize : string -> stringval uppercase_ascii : string -> stringval lowercase_ascii : string -> stringval capitalize_ascii : string -> stringval uncapitalize_ascii : string -> stringtypet =string
val compare : t -> t -> intcompare. Along with the type t, this function compare
allows the module String to be passed as argument to the functors
Set.Make and Map.Make.val equal : t -> t -> boolval split_on_char : sep:char -> string -> string listString.split_on_char sep s returns the list of all (possibly empty)
substrings of s that are delimited by the sep character.
The function's output is specified by the following invariants:
sep as a separator returns a
string equal to the input (String.concat (String.make 1 sep)
(String.split_on_char sep s) = s).sep character.sig
val execv : string -> string array -> unit
val execve : string -> string array -> string array -> unit
val execvp : string -> string array -> unit
val wait : unit -> int * Unix.process_status
val waitpid : Unix.wait_flag list -> int -> int * Unix.process_status
val system : string -> Unix.process_status
val read : Unix.file_descr -> bytes -> int -> int -> int
val write : Unix.file_descr -> bytes -> int -> int -> int
val write_substring : Unix.file_descr -> string -> int -> int -> int
val timed_read : Unix.file_descr -> bytes -> int -> int -> float -> int
val timed_write : Unix.file_descr -> bytes -> int -> int -> float -> int
val timed_write_substring :
Unix.file_descr -> string -> int -> int -> float -> int
val select :
Unix.file_descr list ->
Unix.file_descr list ->
Unix.file_descr list ->
float ->
Unix.file_descr list * Unix.file_descr list * Unix.file_descr list
val pipe : ?cloexec:bool -> unit -> Unix.file_descr * Unix.file_descr
val open_process_in : string -> Pervasives.in_channel
val open_process_out : string -> Pervasives.out_channel
val open_process : string -> Pervasives.in_channel * Pervasives.out_channel
val sleep : int -> unit
val socket :
?cloexec:bool ->
Unix.socket_domain -> Unix.socket_type -> int -> Unix.file_descr
val accept :
?cloexec:bool -> Unix.file_descr -> Unix.file_descr * Unix.sockaddr
val connect : Unix.file_descr -> Unix.sockaddr -> unit
val recv :
Unix.file_descr -> bytes -> int -> int -> Unix.msg_flag list -> int
val recvfrom :
Unix.file_descr ->
bytes -> int -> int -> Unix.msg_flag list -> int * Unix.sockaddr
val send :
Unix.file_descr -> bytes -> int -> int -> Unix.msg_flag list -> int
val send_substring :
Unix.file_descr -> string -> int -> int -> Unix.msg_flag list -> int
val sendto :
Unix.file_descr ->
bytes -> int -> int -> Unix.msg_flag list -> Unix.sockaddr -> int
val sendto_substring :
Unix.file_descr ->
string -> int -> int -> Unix.msg_flag list -> Unix.sockaddr -> int
val open_connection :
Unix.sockaddr -> Pervasives.in_channel * Pervasives.out_channel
end ocaml-doc-4.05/ocaml.html/libref/type_Printexc.Slot.html 0000644 0001750 0001750 00000016765 13131636450 022223 0 ustar mehdi mehdi
sig
type t = Printexc.backtrace_slot
val is_raise : Printexc.Slot.t -> bool
val is_inline : Printexc.Slot.t -> bool
val location : Printexc.Slot.t -> Printexc.location option
val format : int -> Printexc.Slot.t -> string option
end ocaml-doc-4.05/ocaml.html/libref/Misc.LongString.html 0000644 0001750 0001750 00000021346 13131636446 021422 0 ustar mehdi mehdi
module LongString:sig..end
typet =bytes array
val create : int -> t
val length : t -> int
val get : t -> int -> char
val set : t -> int -> char -> unit
val blit : t -> int -> t -> int -> int -> unit
val output : out_channel -> t -> int -> int -> unit
val unsafe_blit_to_bytes : t -> int -> bytes -> int -> int -> unit
val input_bytes : in_channel -> int -> t ocaml-doc-4.05/ocaml.html/libref/type_Hashtbl.MakeSeeded.html 0000644 0001750 0001750 00000026440 13131636444 023054 0 ustar mehdi mehdi
functor (H : SeededHashedType) ->
sig
type key = H.t
type 'a t
val create : ?random:bool -> int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unit
val fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> statistics
end ocaml-doc-4.05/ocaml.html/libref/Hashtbl.Make.html 0000644 0001750 0001750 00000027707 13131636444 020710 0 ustar mehdi mehdi
module Make:
Hashtbl.Make returns a structure containing
a type key of keys and a type 'a t of hash tables
associating data of type 'a to keys of type key.
The operations perform similarly to those of the generic
interface, but use the hashing and equality functions
specified in the functor argument H instead of generic
equality and hashing. Since the hash function is not seeded,
the create operation of the result structure always returns
non-randomized hash tables.| Parameters: |
|
type
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unitval copy : 'a t -> 'a t
val add : 'a t -> key -> 'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a optionval find_all : 'a t -> key -> 'a list
val replace : 'a t -> key -> 'a -> unit
val mem : 'a t -> key -> bool
val iter : (key -> 'a -> unit) -> 'a t -> unit
val filter_map_inplace : (key -> 'a -> 'a option) -> 'a t -> unitval fold : (key -> 'a -> 'b -> 'b) -> 'a t -> 'b -> 'b
val length : 'a t -> int
val stats : 'a t -> Hashtbl.statisticsmodule UnixLabels:sig..end
Unix module,
add module Unix = UnixLabels in your implementation.typeerror =Unix.error=
| |
E2BIG |
(* |
Argument list too long
| *) |
| |
EACCES |
(* |
Permission denied
| *) |
| |
EAGAIN |
(* |
Resource temporarily unavailable; try again
| *) |
| |
EBADF |
(* |
Bad file descriptor
| *) |
| |
EBUSY |
(* |
Resource unavailable
| *) |
| |
ECHILD |
(* |
No child process
| *) |
| |
EDEADLK |
(* |
Resource deadlock would occur
| *) |
| |
EDOM |
(* |
Domain error for math functions, etc.
| *) |
| |
EEXIST |
(* |
File exists
| *) |
| |
EFAULT |
(* |
Bad address
| *) |
| |
EFBIG |
(* |
File too large
| *) |
| |
EINTR |
(* |
Function interrupted by signal
| *) |
| |
EINVAL |
(* |
Invalid argument
| *) |
| |
EIO |
(* |
Hardware I/O error
| *) |
| |
EISDIR |
(* |
Is a directory
| *) |
| |
EMFILE |
(* |
Too many open files by the process
| *) |
| |
EMLINK |
(* |
Too many links
| *) |
| |
ENAMETOOLONG |
(* |
Filename too long
| *) |
| |
ENFILE |
(* |
Too many open files in the system
| *) |
| |
ENODEV |
(* |
No such device
| *) |
| |
ENOENT |
(* |
No such file or directory
| *) |
| |
ENOEXEC |
(* |
Not an executable file
| *) |
| |
ENOLCK |
(* |
No locks available
| *) |
| |
ENOMEM |
(* |
Not enough memory
| *) |
| |
ENOSPC |
(* |
No space left on device
| *) |
| |
ENOSYS |
(* |
Function not supported
| *) |
| |
ENOTDIR |
(* |
Not a directory
| *) |
| |
ENOTEMPTY |
(* |
Directory not empty
| *) |
| |
ENOTTY |
(* |
Inappropriate I/O control operation
| *) |
| |
ENXIO |
(* |
No such device or address
| *) |
| |
EPERM |
(* |
Operation not permitted
| *) |
| |
EPIPE |
(* |
Broken pipe
| *) |
| |
ERANGE |
(* |
Result too large
| *) |
| |
EROFS |
(* |
Read-only file system
| *) |
| |
ESPIPE |
(* |
Invalid seek e.g. on a pipe
| *) |
| |
ESRCH |
(* |
No such process
| *) |
| |
EXDEV |
(* |
Invalid link
| *) |
| |
EWOULDBLOCK |
(* |
Operation would block
| *) |
| |
EINPROGRESS |
(* |
Operation now in progress
| *) |
| |
EALREADY |
(* |
Operation already in progress
| *) |
| |
ENOTSOCK |
(* |
Socket operation on non-socket
| *) |
| |
EDESTADDRREQ |
(* |
Destination address required
| *) |
| |
EMSGSIZE |
(* |
Message too long
| *) |
| |
EPROTOTYPE |
(* |
Protocol wrong type for socket
| *) |
| |
ENOPROTOOPT |
(* |
Protocol not available
| *) |
| |
EPROTONOSUPPORT |
(* |
Protocol not supported
| *) |
| |
ESOCKTNOSUPPORT |
(* |
Socket type not supported
| *) |
| |
EOPNOTSUPP |
(* |
Operation not supported on socket
| *) |
| |
EPFNOSUPPORT |
(* |
Protocol family not supported
| *) |
| |
EAFNOSUPPORT |
(* |
Address family not supported by protocol family
| *) |
| |
EADDRINUSE |
(* |
Address already in use
| *) |
| |
EADDRNOTAVAIL |
(* |
Can't assign requested address
| *) |
| |
ENETDOWN |
(* |
Network is down
| *) |
| |
ENETUNREACH |
(* |
Network is unreachable
| *) |
| |
ENETRESET |
(* |
Network dropped connection on reset
| *) |
| |
ECONNABORTED |
(* |
Software caused connection abort
| *) |
| |
ECONNRESET |
(* |
Connection reset by peer
| *) |
| |
ENOBUFS |
(* |
No buffer space available
| *) |
| |
EISCONN |
(* |
Socket is already connected
| *) |
| |
ENOTCONN |
(* |
Socket is not connected
| *) |
| |
ESHUTDOWN |
(* |
Can't send after socket shutdown
| *) |
| |
ETOOMANYREFS |
(* |
Too many references: can't splice
| *) |
| |
ETIMEDOUT |
(* |
Connection timed out
| *) |
| |
ECONNREFUSED |
(* |
Connection refused
| *) |
| |
EHOSTDOWN |
(* |
Host is down
| *) |
| |
EHOSTUNREACH |
(* |
No route to host
| *) |
| |
ELOOP |
(* |
Too many levels of symbolic links
| *) |
| |
EOVERFLOW |
(* |
File size or position not representable
| *) |
| |
EUNKNOWNERR of |
(* |
Unknown error
| *) |
exception Unix_error of error * string * string
val error_message : error -> stringval handle_unix_error : ('a -> 'b) -> 'a -> 'bhandle_unix_error f x applies f to x and returns the result.
If the exception Unix_error is raised, it prints a message
describing the error and exits with code 2.val environment : unit -> string arrayval getenv : string -> stringNot_found if the variable is unbound.
(This function is identical to Sys.getenv.)val putenv : string -> string -> unitUnix.putenv name value sets the value associated to a
variable in the process environment.
name is the name of the environment variable,
and value its new associated value.typeprocess_status =Unix.process_status=
| |
WEXITED of |
(* |
The process terminated normally by
exit;
the argument is the return code. | *) |
| |
WSIGNALED of |
(* |
The process was killed by a signal;
the argument is the signal number.
| *) |
| |
WSTOPPED of |
(* |
The process was stopped by a signal; the argument is the
signal number.
| *) |
Sys for the
definitions of the standard signal numbers. Note that they are
not the numbers used by the OS.typewait_flag =Unix.wait_flag=
| |
WNOHANG |
(* |
do not block if no child has
died yet, but immediately return with a pid equal to 0.
| *) |
| |
WUNTRACED |
(* |
report also the children that receive stop signals.
| *) |
UnixLabels.waitpid.val execv : prog:string -> args:string array -> 'aexecv prog args execute the program in file prog, with
the arguments args, and the current process environment.
These execv* functions never return: on success, the current
program is replaced by the new one;
on failure, a UnixLabels.Unix_error exception is raised.val execve : prog:string -> args:string array -> env:string array -> 'aUnixLabels.execv, except that the third argument provides the
environment to the program executed.val execvp : prog:string -> args:string array -> 'aUnixLabels.execv, except that
the program is searched in the path.val execvpe : prog:string -> args:string array -> env:string array -> 'aUnixLabels.execve, except that
the program is searched in the path.val fork : unit -> intval wait : unit -> int * process_statusval waitpid : mode:wait_flag list -> int -> int * process_statusUnixLabels.wait, but waits for the child process whose pid
is given.
A pid of -1 means wait for any child.
A pid of 0 means wait for any child in the same process group
as the current process.
Negative pid arguments represent process groups.
The list of options indicates whether waitpid should return
immediately without waiting, or also report stopped children.val system : string -> process_status/bin/sh and therefore can contain redirections, quotes, variables,
etc. The result WEXITED 127 indicates that the shell couldn't
be executed.val getpid : unit -> intval getppid : unit -> intval nice : int -> inttypefile_descr =Unix.file_descr
val stdin : file_descrval stdout : file_descrval stderr : file_descrtypeopen_flag =Unix.open_flag=
| |
O_RDONLY |
(* |
Open for reading
| *) |
| |
O_WRONLY |
(* |
Open for writing
| *) |
| |
O_RDWR |
(* |
Open for reading and writing
| *) |
| |
O_NONBLOCK |
(* |
Open in non-blocking mode
| *) |
| |
O_APPEND |
(* |
Open for append
| *) |
| |
O_CREAT |
(* |
Create if nonexistent
| *) |
| |
O_TRUNC |
(* |
Truncate to 0 length if existing
| *) |
| |
O_EXCL |
(* |
Fail if existing
| *) |
| |
O_NOCTTY |
(* |
Don't make this dev a controlling tty
| *) |
| |
O_DSYNC |
(* |
Writes complete as `Synchronised I/O data
integrity completion'
| *) |
| |
O_SYNC |
(* |
Writes complete as `Synchronised I/O file
integrity completion'
| *) |
| |
O_RSYNC |
(* |
Reads complete as writes (depending
on O_SYNC/O_DSYNC)
| *) |
| |
O_SHARE_DELETE |
(* |
Windows only: allow the file to be deleted
while still open
| *) |
| |
O_CLOEXEC |
(* |
Set the close-on-exec flag on the
descriptor returned by
UnixLabels.openfile | *) |
| |
O_KEEPEXEC |
(* |
Clear the close-on-exec flag.
This is currently the default.
| *) |
UnixLabels.openfile.typefile_perm =int
0o640 is read and write for user,
read for group, none for othersval openfile : string ->
mode:open_flag list ->
perm:file_perm -> file_descrval close : file_descr -> unitval read : file_descr -> buf:bytes -> pos:int -> len:int -> intread fd buff ofs len reads len bytes from descriptor fd,
storing them in byte sequence buff, starting at position ofs in
buff. Return the number of bytes actually read.val write : file_descr -> buf:bytes -> pos:int -> len:int -> intwrite fd buff ofs len writes len bytes to descriptor fd,
taking them from byte sequence buff, starting at position ofs
in buff. Return the number of bytes actually written. write
repeats the writing operation until all bytes have been written or
an error occurs.val single_write : file_descr -> buf:bytes -> pos:int -> len:int -> intwrite, but attempts to write only once.
Thus, if an error occurs, single_write guarantees that no data
has been written.val write_substring : file_descr -> buf:string -> pos:int -> len:int -> intwrite, but take the data from a string instead of a byte
sequence.val single_write_substring : file_descr -> buf:string -> pos:int -> len:int -> intsingle_write, but take the data from a string instead of
a byte sequence.val in_channel_of_descr : file_descr -> in_channelset_binary_mode_in ic false if text mode is desired.val out_channel_of_descr : file_descr -> out_channelset_binary_mode_out oc false if text mode is desired.val descr_of_in_channel : in_channel -> file_descrval descr_of_out_channel : out_channel -> file_descrtypeseek_command =Unix.seek_command=
| |
SEEK_SET |
(* |
indicates positions relative to the beginning of the file
| *) |
| |
SEEK_CUR |
(* |
indicates positions relative to the current position
| *) |
| |
SEEK_END |
(* |
indicates positions relative to the end of the file
| *) |
UnixLabels.lseek.val lseek : file_descr -> int -> mode:seek_command -> intval truncate : string -> len:int -> unitval ftruncate : file_descr -> len:int -> unittypefile_kind =Unix.file_kind=
| |
S_REG |
(* |
Regular file
| *) |
| |
S_DIR |
(* |
Directory
| *) |
| |
S_CHR |
(* |
Character device
| *) |
| |
S_BLK |
(* |
Block device
| *) |
| |
S_LNK |
(* |
Symbolic link
| *) |
| |
S_FIFO |
(* |
Named pipe
| *) |
| |
S_SOCK |
(* |
Socket
| *) |
typestats =Unix.stats= {
|
st_dev : |
(* |
Device number
| *) |
|
st_ino : |
(* |
Inode number
| *) |
|
st_kind : |
(* |
Kind of the file
| *) |
|
st_perm : |
(* |
Access rights
| *) |
|
st_nlink : |
(* |
Number of links
| *) |
|
st_uid : |
(* |
User id of the owner
| *) |
|
st_gid : |
(* |
Group ID of the file's group
| *) |
|
st_rdev : |
(* |
Device minor number
| *) |
|
st_size : |
(* |
Size in bytes
| *) |
|
st_atime : |
(* |
Last access time
| *) |
|
st_mtime : |
(* |
Last modification time
| *) |
|
st_ctime : |
(* |
Last status change time
| *) |
UnixLabels.stat calls.val stat : string -> statsval lstat : string -> statsUnixLabels.stat, but in case the file is a symbolic link,
return the information for the link itself.val fstat : file_descr -> statsval isatty : file_descr -> booltrue if the given file descriptor refers to a terminal or
console window, false otherwise.module LargeFile:sig..end
val unlink : string -> unitval rename : src:string -> dst:string -> unitrename old new changes the name of a file from old to new.val link : src:string -> dst:string -> unitlink source dest creates a hard link named dest to the file
named source.typeaccess_permission =Unix.access_permission=
| |
R_OK |
(* |
Read permission
| *) |
| |
W_OK |
(* |
Write permission
| *) |
| |
X_OK |
(* |
Execution permission
| *) |
| |
F_OK |
(* |
File exists
| *) |
UnixLabels.access call.val chmod : string -> perm:file_perm -> unitval fchmod : file_descr -> perm:file_perm -> unitval chown : string -> uid:int -> gid:int -> unitval fchown : file_descr -> uid:int -> gid:int -> unitval umask : int -> intval access : string -> perm:access_permission list -> unitUnix_error otherwise.val dup : ?cloexec:bool -> file_descr -> file_descrval dup2 : ?cloexec:bool ->
src:file_descr -> dst:file_descr -> unitdup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already
opened.val set_nonblock : file_descr -> unitEAGAIN or EWOULDBLOCK error instead of blocking;
writing on a descriptor on which there is temporarily no room
for writing also raises EAGAIN or EWOULDBLOCK.val clear_nonblock : file_descr -> unitUnixLabels.set_nonblock.val set_close_on_exec : file_descr -> unitexec functions.val clear_close_on_exec : file_descr -> unitUnixLabels.set_close_on_exec.val mkdir : string -> perm:file_perm -> unitval rmdir : string -> unitval chdir : string -> unitval getcwd : unit -> stringval chroot : string -> unittypedir_handle =Unix.dir_handle
val opendir : string -> dir_handleval readdir : dir_handle -> stringEnd_of_file when the end of the directory has been reached.val rewinddir : dir_handle -> unitval closedir : dir_handle -> unitval pipe : ?cloexec:bool -> unit -> file_descr * file_descrval mkfifo : string -> perm:file_perm -> unitval create_process : prog:string ->
args:string array ->
stdin:file_descr ->
stdout:file_descr -> stderr:file_descr -> intcreate_process prog args new_stdin new_stdout new_stderr
forks a new process that executes the program
in file prog, with arguments args. The pid of the new
process is returned immediately; the new process executes
concurrently with the current process.
The standard input and outputs of the new process are connected
to the descriptors new_stdin, new_stdout and new_stderr.
Passing e.g. stdout for new_stdout prevents the redirection
and causes the new process to have the same standard output
as the current process.
The executable file prog is searched in the path.
The new process has the same environment as the current process.val create_process_env : prog:string ->
args:string array ->
env:string array ->
stdin:file_descr ->
stdout:file_descr -> stderr:file_descr -> intcreate_process_env prog args env new_stdin new_stdout new_stderr
works as UnixLabels.create_process, except that the extra argument
env specifies the environment passed to the program.val open_process_in : string -> in_channel/bin/sh (cf. system).val open_process_out : string -> out_channelUnixLabels.open_process_in, but redirect the standard input of
the command to a pipe. Data written to the returned output channel
is sent to the standard input of the command.
Warning: writes on output channels are buffered, hence be careful
to call flush at the right times to ensure
correct synchronization.val open_process : string -> in_channel * out_channelUnixLabels.open_process_out, but redirects both the standard
input and standard output of the command to pipes connected to the two
returned channels. The input channel is connected to the output
of the command, and the output channel to the input of the command.val open_process_full : string ->
env:string array ->
in_channel * out_channel * in_channelUnixLabels.open_process, but the second argument specifies
the environment passed to the command. The result is a triple
of channels connected respectively to the standard output, standard input,
and standard error of the command.val close_process_in : in_channel -> process_statusUnixLabels.open_process_in,
wait for the associated command to terminate,
and return its termination status.val close_process_out : out_channel -> process_statusUnixLabels.open_process_out,
wait for the associated command to terminate,
and return its termination status.val close_process : in_channel * out_channel -> process_statusUnixLabels.open_process,
wait for the associated command to terminate,
and return its termination status.val close_process_full : in_channel * out_channel * in_channel ->
process_statusUnixLabels.open_process_full,
wait for the associated command to terminate,
and return its termination status.val symlink : ?to_dir:bool -> src:string -> dst:string -> unitsymlink source dest creates the file dest as a symbolic link
to the file source. See Unix.symlink for details of ~to_dirval has_symlink : unit -> booltrue if the user is able to create symbolic links. On Windows,
this indicates that the user not only has the SeCreateSymbolicLinkPrivilege
but is also running elevated, if necessary. On other platforms, this is
simply indicates that the symlink system call is available.val readlink : string -> stringval select : read:file_descr list ->
write:file_descr list ->
except:file_descr list ->
timeout:float ->
file_descr list * file_descr list *
file_descr listtypelock_command =Unix.lock_command=
| |
F_ULOCK |
(* |
Unlock a region
| *) |
| |
F_LOCK |
(* |
Lock a region for writing, and block if already locked
| *) |
| |
F_TLOCK |
(* |
Lock a region for writing, or fail if already locked
| *) |
| |
F_TEST |
(* |
Test a region for other process locks
| *) |
| |
F_RLOCK |
(* |
Lock a region for reading, and block if already locked
| *) |
| |
F_TRLOCK |
(* |
Lock a region for reading, or fail if already locked
| *) |
UnixLabels.lockf.val lockf : file_descr -> mode:lock_command -> len:int -> unitlockf fd cmd size puts a lock on a region of the file opened
as fd. The region starts at the current read/write position for
fd (as set by UnixLabels.lseek), and extends size bytes forward if
size is positive, size bytes backwards if size is negative,
or to the end of the file if size is zero.
A write lock prevents any other
process from acquiring a read or write lock on the region.
A read lock prevents any other
process from acquiring a write lock on the region, but lets
other processes acquire read locks on it.
The F_LOCK and F_TLOCK commands attempts to put a write lock
on the specified region.
The F_RLOCK and F_TRLOCK commands attempts to put a read lock
on the specified region.
If one or several locks put by another process prevent the current process
from acquiring the lock, F_LOCK and F_RLOCK block until these locks
are removed, while F_TLOCK and F_TRLOCK fail immediately with an
exception.
The F_ULOCK removes whatever locks the current process has on
the specified region.
Finally, the F_TEST command tests whether a write lock can be
acquired on the specified region, without actually putting a lock.
It returns immediately if successful, or fails otherwise.
Sys.signal and Sys.set_signal.val kill : pid:int -> signal:int -> unitkill pid sig sends signal number sig to the process
with id pid.typesigprocmask_command =Unix.sigprocmask_command=
| |
SIG_SETMASK |
| |
SIG_BLOCK |
| |
SIG_UNBLOCK |
val sigprocmask : mode:sigprocmask_command -> int list -> int listsigprocmask cmd sigs changes the set of blocked signals.
If cmd is SIG_SETMASK, blocked signals are set to those in
the list sigs.
If cmd is SIG_BLOCK, the signals in sigs are added to
the set of blocked signals.
If cmd is SIG_UNBLOCK, the signals in sigs are removed
from the set of blocked signals.
sigprocmask returns the set of previously blocked signals.val sigpending : unit -> int listval sigsuspend : int list -> unitsigsuspend sigs atomically sets the blocked signals to sigs
and waits for a non-ignored, non-blocked signal to be delivered.
On return, the blocked signals are reset to their initial value.val pause : unit -> unittypeprocess_times =Unix.process_times= {
|
tms_utime : |
(* |
User time for the process
| *) |
|
tms_stime : |
(* |
System time for the process
| *) |
|
tms_cutime : |
(* |
User time for the children processes
| *) |
|
tms_cstime : |
(* |
System time for the children processes
| *) |
typetm =Unix.tm= {
|
tm_sec : |
(* |
Seconds 0..60
| *) |
|
tm_min : |
(* |
Minutes 0..59
| *) |
|
tm_hour : |
(* |
Hours 0..23
| *) |
|
tm_mday : |
(* |
Day of month 1..31
| *) |
|
tm_mon : |
(* |
Month of year 0..11
| *) |
|
tm_year : |
(* |
Year - 1900
| *) |
|
tm_wday : |
(* |
Day of week (Sunday is 0)
| *) |
|
tm_yday : |
(* |
Day of year 0..365
| *) |
|
tm_isdst : |
(* |
Daylight time savings in effect
| *) |
val time : unit -> floatval gettimeofday : unit -> floatUnixLabels.time, but with resolution better than 1 second.val gmtime : float -> tmUnixLabels.time, into a date
and a time. Assumes UTC (Coordinated Universal Time), also known as GMT.val localtime : float -> tmUnixLabels.time, into a date
and a time. Assumes the local time zone.val mktime : tm -> float * tmtm argument, into
a time in seconds, as returned by UnixLabels.time. The tm_isdst,
tm_wday and tm_yday fields of tm are ignored. Also return a
normalized copy of the given tm record, with the tm_wday,
tm_yday, and tm_isdst fields recomputed from the other fields,
and the other fields normalized (so that, e.g., 40 October is
changed into 9 November). The tm argument is interpreted in the
local time zone.val alarm : int -> intSIGALRM signal after the given number of seconds.val sleep : int -> unitval times : unit -> process_timesval utimes : string -> access:float -> modif:float -> unit0.0 is interpreted as the
current time.typeinterval_timer =Unix.interval_timer=
| |
ITIMER_REAL |
(* |
decrements in real time, and sends the signal
SIGALRM when
expired. | *) |
| |
ITIMER_VIRTUAL |
(* |
decrements in process virtual time, and sends
SIGVTALRM when
expired. | *) |
| |
ITIMER_PROF |
(* |
(for profiling) decrements both when the process
is running and when the system is running on behalf of the
process; it sends
SIGPROF when expired. | *) |
typeinterval_timer_status =Unix.interval_timer_status= {
|
it_interval : |
(* |
Period
| *) |
|
it_value : |
(* |
Current value of the timer
| *) |
val getitimer : interval_timer -> interval_timer_statusval setitimer : interval_timer ->
interval_timer_status -> interval_timer_statussetitimer t s sets the interval timer t and returns
its previous status. The s argument is interpreted as follows:
s.it_value, if nonzero, is the time to the next timer expiration;
s.it_interval, if nonzero, specifies a value to
be used in reloading it_value when the timer expires.
Setting s.it_value to zero disable the timer.
Setting s.it_interval to zero causes the timer to be disabled
after its next expiration.val getuid : unit -> intval geteuid : unit -> intval setuid : int -> unitval getgid : unit -> intval getegid : unit -> intval setgid : int -> unitval getgroups : unit -> int arrayval setgroups : int array -> unitsetgroups groups sets the supplementary group IDs for the
calling process. Appropriate privileges are required.val initgroups : string -> int -> unitinitgroups user group initializes the group access list by
reading the group database /etc/group and using all groups of
which user is a member. The additional group group is also
added to the list.typepasswd_entry =Unix.passwd_entry= {
|
pw_name : |
|
pw_passwd : |
|
pw_uid : |
|
pw_gid : |
|
pw_gecos : |
|
pw_dir : |
|
pw_shell : |
passwd database.typegroup_entry =Unix.group_entry= {
|
gr_name : |
|
gr_passwd : |
|
gr_gid : |
|
gr_mem : |
groups database.val getlogin : unit -> stringval getpwnam : string -> passwd_entrypasswd with the given name, or raise
Not_found.val getgrnam : string -> group_entrygroup with the given name, or raise
Not_found.val getpwuid : int -> passwd_entrypasswd with the given user id, or raise
Not_found.val getgrgid : int -> group_entrygroup with the given group id, or raise
Not_found.typeinet_addr =Unix.inet_addr
val inet_addr_of_string : string -> inet_addrXXX.YYY.ZZZ.TTT)
for IPv4 addresses, and up to 8 numbers separated by colons
for IPv6 addresses. Raise Failure when given a string that
does not match these formats.val string_of_inet_addr : inet_addr -> stringUnix.inet_addr_of_string for a description of the
printable representation.val inet_addr_any : inet_addrbind, representing
all the Internet addresses that the host machine possesses.val inet_addr_loopback : inet_addr127.0.0.1).val inet6_addr_any : inet_addrbind, representing
all the Internet addresses that the host machine possesses.val inet6_addr_loopback : inet_addr::1).typesocket_domain =Unix.socket_domain=
| |
PF_UNIX |
(* |
Unix domain
| *) |
| |
PF_INET |
(* |
Internet domain (IPv4)
| *) |
| |
PF_INET6 |
(* |
Internet domain (IPv6)
| *) |
PF_INET6).typesocket_type =Unix.socket_type=
| |
SOCK_STREAM |
(* |
Stream socket
| *) |
| |
SOCK_DGRAM |
(* |
Datagram socket
| *) |
| |
SOCK_RAW |
(* |
Raw socket
| *) |
| |
SOCK_SEQPACKET |
(* |
Sequenced packets socket
| *) |
typesockaddr =Unix.sockaddr=
| |
ADDR_UNIX of |
|||
| |
ADDR_INET of |
(* |
The type of socket addresses.
ADDR_UNIX name is a socket
address in the Unix domain; name is a file name in the file
system. ADDR_INET(addr,port) is a socket address in the Internet
domain; addr is the Internet address of the machine, and
port is the port number. | *) |
val socket : ?cloexec:bool ->
domain:socket_domain ->
kind:socket_type -> protocol:int -> file_descrval domain_of_sockaddr : sockaddr -> socket_domainval socketpair : ?cloexec:bool ->
domain:socket_domain ->
kind:socket_type ->
protocol:int -> file_descr * file_descrval accept : ?cloexec:bool ->
file_descr -> file_descr * sockaddrval bind : file_descr -> addr:sockaddr -> unitval connect : file_descr -> addr:sockaddr -> unitval listen : file_descr -> max:int -> unittypeshutdown_command =Unix.shutdown_command=
| |
SHUTDOWN_RECEIVE |
(* |
Close for receiving
| *) |
| |
SHUTDOWN_SEND |
(* |
Close for sending
| *) |
| |
SHUTDOWN_ALL |
(* |
Close both
| *) |
shutdown.val shutdown : file_descr -> mode:shutdown_command -> unitSHUTDOWN_SEND as second argument
causes reads on the other end of the connection to return
an end-of-file condition.
SHUTDOWN_RECEIVE causes writes on the other end of the connection
to return a closed pipe condition (SIGPIPE signal).val getsockname : file_descr -> sockaddrval getpeername : file_descr -> sockaddrtypemsg_flag =Unix.msg_flag=
| |
MSG_OOB |
|||
| |
MSG_DONTROUTE |
|||
| |
MSG_PEEK |
(* | *) |
val recv : file_descr ->
buf:bytes -> pos:int -> len:int -> mode:msg_flag list -> intval recvfrom : file_descr ->
buf:bytes ->
pos:int ->
len:int -> mode:msg_flag list -> int * sockaddrval send : file_descr ->
buf:bytes -> pos:int -> len:int -> mode:msg_flag list -> intval send_substring : file_descr ->
buf:string -> pos:int -> len:int -> mode:msg_flag list -> intsend, but take the data from a string instead of a byte
sequence.val sendto : file_descr ->
buf:bytes ->
pos:int ->
len:int -> mode:msg_flag list -> addr:sockaddr -> intval sendto_substring : file_descr ->
buf:string ->
pos:int ->
len:int -> mode:msg_flag list -> sockaddr -> intsendto, but take the data from a string instead of a
byte sequence.type
| |
SO_DEBUG |
(* |
Record debugging information
| *) |
| |
SO_BROADCAST |
(* |
Permit sending of broadcast messages
| *) |
| |
SO_REUSEADDR |
(* |
Allow reuse of local addresses for bind
| *) |
| |
SO_KEEPALIVE |
(* |
Keep connection active
| *) |
| |
SO_DONTROUTE |
(* |
Bypass the standard routing algorithms
| *) |
| |
SO_OOBINLINE |
(* |
Leave out-of-band data in line
| *) |
| |
SO_ACCEPTCONN |
(* |
Report whether socket listening is enabled
| *) |
| |
TCP_NODELAY |
(* |
Control the Nagle algorithm for TCP sockets
| *) |
| |
IPV6_ONLY |
(* |
Forbid binding an IPv6 socket to an IPv4 address
| *) |
UnixLabels.getsockopt
and modified with UnixLabels.setsockopt. These options have a boolean
(true/false) value.type
| |
SO_SNDBUF |
(* |
Size of send buffer
| *) |
| |
SO_RCVBUF |
(* |
Size of received buffer
| *) |
| |
SO_ERROR |
(* |
Deprecated. Use
Unix.getsockopt_error instead. | *) |
| |
SO_TYPE |
(* |
Report the socket type
| *) |
| |
SO_RCVLOWAT |
(* |
Minimum number of bytes to process for input operations
| *) |
| |
SO_SNDLOWAT |
(* |
Minimum number of bytes to process for output operations
| *) |
UnixLabels.getsockopt_int
and modified with UnixLabels.setsockopt_int. These options have an
integer value.type
| |
SO_LINGER |
(* |
Whether to linger on closed connections
that have data present, and for how long
(in seconds)
| *) |
Unix.getsockopt_optint
and modified with Unix.setsockopt_optint. These options have a
value of type int option, with None meaning ``disabled''.type
| |
SO_RCVTIMEO |
(* |
Timeout for input operations
| *) |
| |
SO_SNDTIMEO |
(* |
Timeout for output operations
| *) |
UnixLabels.getsockopt_float
and modified with UnixLabels.setsockopt_float. These options have a
floating-point value representing a time in seconds.
The value 0 means infinite timeout.val getsockopt : file_descr -> socket_bool_option -> boolval setsockopt : file_descr -> socket_bool_option -> bool -> unitval getsockopt_int : file_descr -> socket_int_option -> intUnix.getsockopt for an integer-valued socket option.val setsockopt_int : file_descr -> socket_int_option -> int -> unitUnix.setsockopt for an integer-valued socket option.val getsockopt_optint : file_descr -> socket_optint_option -> int option
val setsockopt_optint : file_descr ->
socket_optint_option -> int option -> unit
val getsockopt_float : file_descr -> socket_float_option -> floatUnix.getsockopt for a socket option whose value is a
floating-point number.val setsockopt_float : file_descr -> socket_float_option -> float -> unitUnix.setsockopt for a socket option whose value is a
floating-point number.val getsockopt_error : file_descr -> error optionval open_connection : sockaddr -> in_channel * out_channelflush on the output channel at the right
times to ensure correct synchronization.val shutdown_connection : in_channel -> unitUnixLabels.open_connection;
that is, transmit an end-of-file condition to the server reading
on the other side of the connection.val establish_server : (in_channel -> out_channel -> unit) ->
addr:sockaddr -> unitUnixLabels.establish_server
never returns normally.typehost_entry =Unix.host_entry= {
|
h_name : |
|
h_aliases : |
|
h_addrtype : |
|
h_addr_list : |
hosts database.typeprotocol_entry =Unix.protocol_entry= {
|
p_name : |
|
p_aliases : |
|
p_proto : |
protocols database.typeservice_entry =Unix.service_entry= {
|
s_name : |
|
s_aliases : |
|
s_port : |
|
s_proto : |
services database.val gethostname : unit -> stringval gethostbyname : string -> host_entryhosts with the given name, or raise
Not_found.val gethostbyaddr : inet_addr -> host_entryhosts with the given address, or raise
Not_found.val getprotobyname : string -> protocol_entryprotocols with the given name, or raise
Not_found.val getprotobynumber : int -> protocol_entryprotocols with the given protocol number,
or raise Not_found.val getservbyname : string -> protocol:string -> service_entryservices with the given name, or raise
Not_found.val getservbyport : int -> protocol:string -> service_entryservices with the given service number,
or raise Not_found.type
|
ai_family : |
(* |
Socket domain
| *) |
|
ai_socktype : |
(* |
Socket type
| *) |
|
ai_protocol : |
(* |
Socket protocol number
| *) |
|
ai_addr : |
(* |
Address
| *) |
|
ai_canonname : |
(* |
Canonical host name
| *) |
Unix.getaddrinfo.type
| |
AI_FAMILY of |
(* |
Impose the given socket domain
| *) |
| |
AI_SOCKTYPE of |
(* |
Impose the given socket type
| *) |
| |
AI_PROTOCOL of |
(* |
Impose the given protocol
| *) |
| |
AI_NUMERICHOST |
(* |
Do not call name resolver,
expect numeric IP address
| *) |
| |
AI_CANONNAME |
(* |
Fill the
ai_canonname field
of the result | *) |
| |
AI_PASSIVE |
(* |
Set address to ``any'' address
for use with
Unix.bind | *) |
Unix.getaddrinfo.val getaddrinfo : string ->
string -> getaddrinfo_option list -> addr_info listgetaddrinfo host service opts returns a list of Unix.addr_info
records describing socket parameters and addresses suitable for
communicating with the given host and service. The empty list is
returned if the host or service names are unknown, or the constraints
expressed in opts cannot be satisfied.
host is either a host name or the string representation of an IP
address. host can be given as the empty string; in this case,
the ``any'' address or the ``loopback'' address are used,
depending whether opts contains AI_PASSIVE.
service is either a service name or the string representation of
a port number. service can be given as the empty string;
in this case, the port field of the returned addresses is set to 0.
opts is a possibly empty list of options that allows the caller
to force a particular socket domain (e.g. IPv6 only or IPv4 only)
or a particular socket type (e.g. TCP only or UDP only).
type
|
ni_hostname : |
(* |
Name or IP address of host
| *) |
|
ni_service : |
(* |
Name of service or port number
| *) |
Unix.getnameinfo.type
| |
NI_NOFQDN |
(* |
Do not qualify local host names
| *) |
| |
NI_NUMERICHOST |
(* |
Always return host as IP address
| *) |
| |
NI_NAMEREQD |
(* |
Fail if host name cannot be determined
| *) |
| |
NI_NUMERICSERV |
(* |
Always return service as port number
| *) |
| |
NI_DGRAM |
(* |
Consider the service as UDP-based
instead of the default TCP
| *) |
Unix.getnameinfo.val getnameinfo : sockaddr ->
getnameinfo_option list -> name_infogetnameinfo addr opts returns the host name and service name
corresponding to the socket address addr. opts is a possibly
empty list of options that governs how these names are obtained.
Raise Not_found if an error occurs.termios man page for a
complete description.typeterminal_io =Unix.terminal_io= {
|
mutable c_ignbrk : |
(* |
Ignore the break condition.
| *) |
|
mutable c_brkint : |
(* |
Signal interrupt on break condition.
| *) |
|
mutable c_ignpar : |
(* |
Ignore characters with parity errors.
| *) |
|
mutable c_parmrk : |
(* |
Mark parity errors.
| *) |
|
mutable c_inpck : |
(* |
Enable parity check on input.
| *) |
|
mutable c_istrip : |
(* |
Strip 8th bit on input characters.
| *) |
|
mutable c_inlcr : |
(* |
Map NL to CR on input.
| *) |
|
mutable c_igncr : |
(* |
Ignore CR on input.
| *) |
|
mutable c_icrnl : |
(* |
Map CR to NL on input.
| *) |
|
mutable c_ixon : |
(* |
Recognize XON/XOFF characters on input.
| *) |
|
mutable c_ixoff : |
(* |
Emit XON/XOFF chars to control input flow.
| *) |
|
mutable c_opost : |
(* |
Enable output processing.
| *) |
|
mutable c_obaud : |
(* |
Output baud rate (0 means close connection).
| *) |
|
mutable c_ibaud : |
(* |
Input baud rate.
| *) |
|
mutable c_csize : |
(* |
Number of bits per character (5-8).
| *) |
|
mutable c_cstopb : |
(* |
Number of stop bits (1-2).
| *) |
|
mutable c_cread : |
(* |
Reception is enabled.
| *) |
|
mutable c_parenb : |
(* |
Enable parity generation and detection.
| *) |
|
mutable c_parodd : |
(* |
Specify odd parity instead of even.
| *) |
|
mutable c_hupcl : |
(* |
Hang up on last close.
| *) |
|
mutable c_clocal : |
(* |
Ignore modem status lines.
| *) |
|
mutable c_isig : |
(* |
Generate signal on INTR, QUIT, SUSP.
| *) |
|
mutable c_icanon : |
(* |
Enable canonical processing
(line buffering and editing)
| *) |
|
mutable c_noflsh : |
(* |
Disable flush after INTR, QUIT, SUSP.
| *) |
|
mutable c_echo : |
(* |
Echo input characters.
| *) |
|
mutable c_echoe : |
(* |
Echo ERASE (to erase previous character).
| *) |
|
mutable c_echok : |
(* |
Echo KILL (to erase the current line).
| *) |
|
mutable c_echonl : |
(* |
Echo NL even if c_echo is not set.
| *) |
|
mutable c_vintr : |
(* |
Interrupt character (usually ctrl-C).
| *) |
|
mutable c_vquit : |
(* |
Quit character (usually ctrl-\).
| *) |
|
mutable c_verase : |
(* |
Erase character (usually DEL or ctrl-H).
| *) |
|
mutable c_vkill : |
(* |
Kill line character (usually ctrl-U).
| *) |
|
mutable c_veof : |
(* |
End-of-file character (usually ctrl-D).
| *) |
|
mutable c_veol : |
(* |
Alternate end-of-line char. (usually none).
| *) |
|
mutable c_vmin : |
(* |
Minimum number of characters to read
before the read request is satisfied.
| *) |
|
mutable c_vtime : |
(* |
Maximum read wait (in 0.1s units).
| *) |
|
mutable c_vstart : |
(* |
Start character (usually ctrl-Q).
| *) |
|
mutable c_vstop : |
(* |
Stop character (usually ctrl-S).
| *) |
val tcgetattr : file_descr -> terminal_iotypesetattr_when =Unix.setattr_when=
| |
TCSANOW |
| |
TCSADRAIN |
| |
TCSAFLUSH |
val tcsetattr : file_descr ->
mode:setattr_when -> terminal_io -> unitTCSANOW),
when all pending output has been transmitted (TCSADRAIN),
or after flushing all input that has been received but not
read (TCSAFLUSH). TCSADRAIN is recommended when changing
the output parameters; TCSAFLUSH, when changing the input
parameters.val tcsendbreak : file_descr -> duration:int -> unitval tcdrain : file_descr -> unittypeflush_queue =Unix.flush_queue=
| |
TCIFLUSH |
| |
TCOFLUSH |
| |
TCIOFLUSH |
val tcflush : file_descr -> mode:flush_queue -> unitTCIFLUSH flushes data received but not read,
TCOFLUSH flushes data written but not transmitted, and
TCIOFLUSH flushes both.typeflow_action =Unix.flow_action=
| |
TCOOFF |
| |
TCOON |
| |
TCIOFF |
| |
TCION |
val tcflow : file_descr -> mode:flow_action -> unitTCOOFF suspends output, TCOON restarts output,
TCIOFF transmits a STOP character to suspend input,
and TCION transmits a START character to restart input.val setsid : unit -> intmodule Array0:sig..end
Array0 structure provides operations
similar to those of Bigarray.Genarray, but specialized to the case
of zero-dimensional arrays that only contain a single scalar value.
Statically knowing the number of dimensions of the array allows
faster operations, and more precise static type-checking.type ('a, 'b, 'c) t
'a, representation kind 'b, and memory layout 'c.val create : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> ('a, 'b, 'c) tArray0.create kind layout returns a new bigarray of zero dimension.
kind and layout determine the array element kind and the array
layout as described for Bigarray.Genarray.create.val kind : ('a, 'b, 'c) t -> ('a, 'b) Bigarray.kindval layout : ('a, 'b, 'c) t -> 'c Bigarray.layoutval size_in_bytes : ('a, 'b, 'c) t -> int
val get : ('a, 'b, 'c) t -> 'aArray0.get a returns the only element in a.val set : ('a, 'b, 'c) t -> 'a -> unitArray0.set a x v stores the value v in a.val blit : ('a, 'b, 'c) t -> ('a, 'b, 'c) t -> unitBigarray.Genarray.blit for more details.val fill : ('a, 'b, 'c) t -> 'a -> unitBigarray.Genarray.fill for more details.val of_value : ('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a -> ('a, 'b, 'c) tmodule GraphicsX11:sig..end
typewindow_id =string
val window_id : unit -> window_idval open_subwindow : x:int -> y:int -> width:int -> height:int -> window_idval close_subwindow : window_id -> unitsig
val mk :
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
?priv:Asttypes.private_flag ->
Ast_helper.lid ->
Parsetree.extension_constructor list -> Parsetree.type_extension
val constructor :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
Ast_helper.str ->
Parsetree.extension_constructor_kind -> Parsetree.extension_constructor
val decl :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
?args:Parsetree.constructor_arguments ->
?res:Parsetree.core_type ->
Ast_helper.str -> Parsetree.extension_constructor
val rebind :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?info:Docstrings.info ->
Ast_helper.str -> Ast_helper.lid -> Parsetree.extension_constructor
end ocaml-doc-4.05/ocaml.html/libref/type_Pervasives.LargeFile.html 0000644 0001750 0001750 00000017212 13131636450 023453 0 ustar mehdi mehdi
sig
val seek_out : Pervasives.out_channel -> int64 -> unit
val pos_out : Pervasives.out_channel -> int64
val out_channel_length : Pervasives.out_channel -> int64
val seek_in : Pervasives.in_channel -> int64 -> unit
val pos_in : Pervasives.in_channel -> int64
val in_channel_length : Pervasives.in_channel -> int64
end ocaml-doc-4.05/ocaml.html/libref/Set.html 0000644 0001750 0001750 00000024552 13131636450 017172 0 ustar mehdi mehdi
module Set:sig..end
This module implements the set data structure, given a total ordering function over the set elements. All operations over sets are purely applicative (no side-effects). The implementation uses balanced binary trees, and is therefore reasonably efficient: insertion and membership take time logarithmic in the size of the set, for instance.
The Set.Make functor constructs implementations for any type, given a
compare function.
For instance:
module IntPairs =
struct
type t = int * int
let compare (x0,y0) (x1,y1) =
match Pervasives.compare x0 x1 with
0 -> Pervasives.compare y0 y1
| c -> c
end
module PairsSet = Set.Make(IntPairs)
let m = PairsSet.(empty |> add (2,3) |> add (5,7) |> add (11,13))
This creates a new module PairsSet, with a new type PairsSet.t
of sets of int * int.
module type OrderedType =sig..end
Set.Make.
module type S =sig..end
Set.Make.
module Make:
sig
type ('a, 'b, 'c) t
val create :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> int -> int -> ('a, 'b, 'c) Bigarray.Array2.t
external dim1 : ('a, 'b, 'c) Bigarray.Array2.t -> int = "%caml_ba_dim_1"
external dim2 : ('a, 'b, 'c) Bigarray.Array2.t -> int = "%caml_ba_dim_2"
external kind : ('a, 'b, 'c) Bigarray.Array2.t -> ('a, 'b) Bigarray.kind
= "caml_ba_kind"
external layout : ('a, 'b, 'c) Bigarray.Array2.t -> 'c Bigarray.layout
= "caml_ba_layout"
val size_in_bytes : ('a, 'b, 'c) Bigarray.Array2.t -> int
external get : ('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a
= "%caml_ba_ref_2"
external set : ('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a -> unit
= "%caml_ba_set_2"
external sub_left :
('a, 'b, Bigarray.c_layout) Bigarray.Array2.t ->
int -> int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array2.t
= "caml_ba_sub"
external sub_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t ->
int -> int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t
= "caml_ba_sub"
val slice_left :
('a, 'b, Bigarray.c_layout) Bigarray.Array2.t ->
int -> ('a, 'b, Bigarray.c_layout) Bigarray.Array1.t
val slice_right :
('a, 'b, Bigarray.fortran_layout) Bigarray.Array2.t ->
int -> ('a, 'b, Bigarray.fortran_layout) Bigarray.Array1.t
external blit :
('a, 'b, 'c) Bigarray.Array2.t -> ('a, 'b, 'c) Bigarray.Array2.t -> unit
= "caml_ba_blit"
external fill : ('a, 'b, 'c) Bigarray.Array2.t -> 'a -> unit
= "caml_ba_fill"
val of_array :
('a, 'b) Bigarray.kind ->
'c Bigarray.layout -> 'a array array -> ('a, 'b, 'c) Bigarray.Array2.t
val map_file :
Unix.file_descr ->
?pos:int64 ->
('a, 'b) Bigarray.kind ->
'c Bigarray.layout ->
bool -> int -> int -> ('a, 'b, 'c) Bigarray.Array2.t
external unsafe_get : ('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a
= "%caml_ba_unsafe_ref_2"
external unsafe_set :
('a, 'b, 'c) Bigarray.Array2.t -> int -> int -> 'a -> unit
= "%caml_ba_unsafe_set_2"
end ocaml-doc-4.05/ocaml.html/libref/Gc.html 0000644 0001750 0001750 00000113723 13131636444 016772 0 ustar mehdi mehdi
module Gc:sig..end
type
|
minor_words : |
(* |
Number of words allocated in the minor heap since
the program was started. This number is accurate in
byte-code programs, but only an approximation in programs
compiled to native code.
| *) |
|
promoted_words : |
(* |
Number of words allocated in the minor heap that
survived a minor collection and were moved to the major heap
since the program was started.
| *) |
|
major_words : |
(* |
Number of words allocated in the major heap, including
the promoted words, since the program was started.
| *) |
|
minor_collections : |
(* |
Number of minor collections since the program was started.
| *) |
|
major_collections : |
(* |
Number of major collection cycles completed since the program
was started.
| *) |
|
heap_words : |
(* |
Total size of the major heap, in words.
| *) |
|
heap_chunks : |
(* |
Number of contiguous pieces of memory that make up the major heap.
| *) |
|
live_words : |
(* |
Number of words of live data in the major heap, including the header
words.
| *) |
|
live_blocks : |
(* |
Number of live blocks in the major heap.
| *) |
|
free_words : |
(* |
Number of words in the free list.
| *) |
|
free_blocks : |
(* |
Number of blocks in the free list.
| *) |
|
largest_free : |
(* |
Size (in words) of the largest block in the free list.
| *) |
|
fragments : |
(* |
Number of wasted words due to fragmentation. These are
1-words free blocks placed between two live blocks. They
are not available for allocation.
| *) |
|
compactions : |
(* |
Number of heap compactions since the program was started.
| *) |
|
top_heap_words : |
(* |
Maximum size reached by the major heap, in words.
| *) |
|
stack_size : |
(* |
Current size of the stack, in words.
Since 3.12.0 | *) |
stat record.
The total amount of memory allocated by the program since it was started
is (in words) minor_words + major_words - promoted_words. Multiply by
the word size (4 on a 32-bit machine, 8 on a 64-bit machine) to get
the number of bytes.
type
|
mutable minor_heap_size : |
(* |
The size (in words) of the minor heap. Changing
this parameter will trigger a minor collection. Default: 256k.
| *) |
|
mutable major_heap_increment : |
(* |
How much to add to the major heap when increasing it. If this
number is less than or equal to 1000, it is a percentage of
the current heap size (i.e. setting it to 100 will double the heap
size at each increase). If it is more than 1000, it is a fixed
number of words that will be added to the heap. Default: 15.
| *) |
|
mutable space_overhead : |
(* |
The major GC speed is computed from this parameter.
This is the memory that will be "wasted" because the GC does not
immediatly collect unreachable blocks. It is expressed as a
percentage of the memory used for live data.
The GC will work more (use more CPU time and collect
blocks more eagerly) if
space_overhead is smaller.
Default: 80. | *) |
|
mutable verbose : |
(* |
This value controls the GC messages on standard error output.
It is a sum of some of the following flags, to print messages
on the corresponding events:
| *) |
|
mutable max_overhead : |
(* |
Heap compaction is triggered when the estimated amount
of "wasted" memory is more than
max_overhead percent of the
amount of live data. If max_overhead is set to 0, heap
compaction is triggered at the end of each major GC cycle
(this setting is intended for testing purposes only).
If max_overhead >= 1000000, compaction is never triggered.
If compaction is permanently disabled, it is strongly suggested
to set allocation_policy to 1.
Default: 500. | *) |
|
mutable stack_limit : |
(* |
The maximum size of the stack (in words). This is only
relevant to the byte-code runtime, as the native code runtime
uses the operating system's stack. Default: 1024k.
| *) |
|
mutable allocation_policy : |
(* |
The policy used for allocating in the heap. Possible
values are 0 and 1. 0 is the next-fit policy, which is
quite fast but can result in fragmentation. 1 is the
first-fit policy, which can be slower in some cases but
can be better for programs with fragmentation problems.
Default: 0.
Since 3.11.0 | *) |
|
window_size : |
(* |
The size of the window used by the major GC for smoothing
out variations in its workload. This is an integer between
1 and 50.
Default: 1.
Since 4.03.0 | *) |
control record. Note that
these parameters can also be initialised by setting the
OCAMLRUNPARAM environment variable. See the documentation of
ocamlrun.val stat : unit -> statstat record. This function examines every heap block to get the
statistics.val quick_stat : unit -> statstat except that live_words, live_blocks, free_words,
free_blocks, largest_free, and fragments are set to 0. This
function is much faster than stat because it does not need to go
through the heap.val counters : unit -> float * float * float(minor_words, promoted_words, major_words). This function
is as fast as quick_stat.val minor_words : unit -> float
In native code this function does not allocate.
Since 4.04
val get : unit -> controlcontrol record.val set : control -> unitset r changes the GC parameters according to the control record r.
The normal usage is: Gc.set { (Gc.get()) with Gc.verbose = 0x00d }val minor : unit -> unitval major_slice : int -> intmajor_slice n
Do a minor collection and a slice of major collection. n is the
size of the slice: the GC will do enough work to free (on average)
n words of memory. If n = 0, the GC will try to do enough work
to ensure that the next automatic slice has no work to do.
This function returns an unspecified integer (currently: 0).val major : unit -> unitval full_major : unit -> unitval compact : unit -> unitval print_stat : out_channel -> unitval allocated_bytes : unit -> floatfloat to avoid overflow problems
with int on 32-bit machines.val get_minor_free : unit -> intval get_bucket : int -> intget_bucket n returns the current size of the n-th future bucket
of the GC smoothing system. The unit is one millionth of a full GC.
Raise Invalid_argument if n is negative, return 0 if n is larger
than the smoothing window.val get_credit : unit -> intget_credit () returns the current size of the "work done in advance"
counter of the GC smoothing system. The unit is one millionth of a
full GC.val huge_fallback_count : unit -> intOCAMLRUNPARAM contains H=1.val finalise : ('a -> unit) -> 'a -> unitfinalise f v registers f as a finalisation function for v.
v must be heap-allocated. f will be called with v as
argument at some point between the first time v becomes unreachable
(including through weak pointers) and the time v is collected by
the GC. Several functions can
be registered for the same value, or even several instances of the
same function. Each instance will be called once (or never,
if the program terminates before v becomes unreachable).
The GC will call the finalisation functions in the order of
deallocation. When several values become unreachable at the
same time (i.e. during the same GC cycle), the finalisation
functions will be called in the reverse order of the corresponding
calls to finalise. If finalise is called in the same order
as the values are allocated, that means each value is finalised
before the values it depends upon. Of course, this becomes
false if additional dependencies are introduced by assignments.
In the presence of multiple OCaml threads it should be assumed that any particular finaliser may be executed in any of the threads.
Anything reachable from the closure of finalisation functions is considered reachable, so the following code will not work as expected:
let v = ... in Gc.finalise (fun _ -> ...v...) v v is not in the closure of
the finalisation function by writing: let f = fun x -> ... let v = ... in Gc.finalise f v f function can use all features of OCaml, including
assignments that make the value reachable again. It can also
loop forever (in this case, the other
finalisation functions will not be called during the execution of f,
unless it calls finalise_release).
It can call finalise on v or other values to register other
functions or even itself. It can raise an exception; in this case
the exception will interrupt whatever the program was doing when
the function was called.
finalise will raise Invalid_argument if v is not
guaranteed to be heap-allocated. Some examples of values that are not
heap-allocated are integers, constant constructors, booleans,
the empty array, the empty list, the unit value. The exact list
of what is heap-allocated or not is implementation-dependent.
Some constant values can be heap-allocated but never deallocated
during the lifetime of the program, for example a list of integer
constants; this is also implementation-dependent.
Note that values of types float are sometimes allocated and
sometimes not, so finalising them is unsafe, and finalise will
also raise Invalid_argument for them. Values of type 'a Lazy.t
(for any 'a) are like float in this respect, except that the
compiler sometimes optimizes them in a way that prevents finalise
from detecting them. In this case, it will not raise
Invalid_argument, but you should still avoid calling finalise
on lazy values.
The results of calling String.make, Bytes.make, Bytes.create,
Array.make, and ref are guaranteed to be
heap-allocated and non-constant except when the length argument is 0.
val finalise_last : (unit -> unit) -> 'a -> unitGc.finalise except the value is not given as argument. So
you can't use the given value for the computation of the
finalisation function. The benefit is that the function is called
after the value is unreachable for the last time instead of the
first time. So contrary to Gc.finalise the value will never be
reachable again or used again. In particular every weak pointer
and ephemeron that contained this value as key or data is unset
before running the finalisation function. Moreover the
finalisation function attached with `GC.finalise` are always
called before the finalisation function attached with `GC.finalise_last`.val finalise_release : unit -> unitfinalise_release to tell the
GC that it can launch the next finalisation function without waiting
for the current one to return.type
val create_alarm : (unit -> unit) -> alarmcreate_alarm f will arrange for f to be called at the end of each
major GC cycle, starting with the current cycle or the next one.
A value of type alarm is returned that you can
use to call delete_alarm.val delete_alarm : alarm -> unitdelete_alarm a will stop the calls to the function associated
to a. Calling delete_alarm a again has no effect.sig
type elt = string
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
end ocaml-doc-4.05/ocaml.html/libref/Ephemeron.html 0000644 0001750 0001750 00000027625 13131636443 020367 0 ustar mehdi mehdi
module Ephemeron:sig..end
Ephemerons and weak hash table are useful when one wants to cache or memorize the computation of a function, as long as the arguments and the function are used, without creating memory leaks by continuously keeping old computation results that are not useful anymore because one argument or the function is freed. An implementation using is not suitable because all associations would keep in memory the arguments and the result.
Ephemerons can also be used for "adding" a field to an arbitrary boxed ocaml value: you can attach an information to a value created by an external library without memory leaks.
Ephemerons hold some keys and one or no data. They are all boxed ocaml values. The keys of an ephemeron have the same behavior than weak pointers according to the garbage collector. In fact ocaml weak pointers are implemented as ephemerons without data.
The keys and data of an ephemeron are said to be full if they
point to a value, empty if the value have never been set, have
been unset, or was erased by the GC. In the function that accesses
the keys or data these two states are represented by the option
type.
The data is considered by the garbage collector alive if all the full keys are alive and if the ephemeron is alive. When one of the keys is not considered alive anymore by the GC, the data is emptied from the ephemeron. The data could be alive for another reason and in that case the GC will not free it, but the ephemeron will not hold the data anymore.
The ephemerons complicate the notion of liveness of values, because it is not anymore an equivalence with the reachability from root value by usual pointers (not weak and not ephemerons). With ephemerons the notion of liveness is constructed by the least fixpoint of: A value is alive if:
output_value or the functions of the
Marshal module.module type S =sig..end
Ephemeron.K1.Make and Ephemeron.K2.Make.
module type SeededS =sig..end
Ephemeron.K1.MakeSeeded and Ephemeron.K2.MakeSeeded.
module K1:sig..end
module K2:sig..end
module Kn:sig..end
module GenHashTable:ocaml-doc-4.05/ocaml.html/libref/type_Misc.Stdlib.html 0000644 0001750 0001750 00000036621 13131636446 021620 0 ustar mehdi mehdisig..end
sig
module List :
sig
type 'a t = 'a list
val compare :
('a -> 'a -> int) ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t -> int
val equal :
('a -> 'a -> bool) ->
'a Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t -> bool
val filter_map :
('a -> 'b option) -> 'a Misc.Stdlib.List.t -> 'b Misc.Stdlib.List.t
val some_if_all_elements_are_some :
'a option Misc.Stdlib.List.t -> 'a Misc.Stdlib.List.t option
val map2_prefix :
('a -> 'b -> 'c) ->
'a Misc.Stdlib.List.t ->
'b Misc.Stdlib.List.t ->
'c Misc.Stdlib.List.t * 'b Misc.Stdlib.List.t
val split_at :
int ->
'a Misc.Stdlib.List.t ->
'a Misc.Stdlib.List.t * 'a Misc.Stdlib.List.t
end
module Option :
sig
type 'a t = 'a option
val equal :
('a -> 'a -> bool) ->
'a Misc.Stdlib.Option.t -> 'a Misc.Stdlib.Option.t -> bool
val iter : ('a -> unit) -> 'a Misc.Stdlib.Option.t -> unit
val map :
('a -> 'b) -> 'a Misc.Stdlib.Option.t -> 'b Misc.Stdlib.Option.t
val fold : ('a -> 'b -> 'b) -> 'a Misc.Stdlib.Option.t -> 'b -> 'b
val value_default :
('a -> 'b) -> default:'b -> 'a Misc.Stdlib.Option.t -> 'b
end
end ocaml-doc-4.05/ocaml.html/libref/Builtin_attributes.html 0000644 0001750 0001750 00000024413 13131636442 022310 0 ustar mehdi mehdi
module Builtin_attributes:sig..end
val check_deprecated : Location.t -> Parsetree.attributes -> string -> unit
val deprecated_of_attrs : Parsetree.attributes -> string option
val deprecated_of_sig : Parsetree.signature -> string option
val deprecated_of_str : Parsetree.structure -> string option
val check_deprecated_mutable : Location.t -> Parsetree.attributes -> string -> unit
val error_of_extension : Parsetree.extension -> Location.error
val warning_enter_scope : unit -> unit
val warning_leave_scope : unit -> unit
val warning_attribute : Parsetree.attributes -> unit
val with_warning_attribute : Parsetree.attributes -> (unit -> 'a) -> 'a
val emit_external_warnings : Ast_iterator.iterator
val warn_on_literal_pattern : Parsetree.attributes -> bool
val explicit_arity : Parsetree.attributes -> bool
val immediate : Parsetree.attributes -> bool
val has_unboxed : Parsetree.attributes -> bool
val has_boxed : Parsetree.attributes -> bool ocaml-doc-4.05/ocaml.html/libref/Hashtbl.html 0000644 0001750 0001750 00000103636 13131636444 020030 0 ustar mehdi mehdi
module Hashtbl:sig..end
Hash tables are hashed association tables, with in-place modification.
type ('a, 'b) t
'a to type 'b.val create : ?random:bool -> int -> ('a, 'b) tHashtbl.create n creates a new, empty hash table, with
initial size n. For best results, n should be on the
order of the expected number of elements that will be in
the table. The table grows as needed, so n is just an
initial guess.
The optional random parameter (a boolean) controls whether
the internal organization of the hash table is randomized at each
execution of Hashtbl.create or deterministic over all executions.
A hash table that is created with ~random:false uses a
fixed hash function (Hashtbl.hash) to distribute keys among
buckets. As a consequence, collisions between keys happen
deterministically. In Web-facing applications or other
security-sensitive applications, the deterministic collision
patterns can be exploited by a malicious user to create a
denial-of-service attack: the attacker sends input crafted to
create many collisions in the table, slowing the application down.
A hash table that is created with ~random:true uses the seeded
hash function Hashtbl.seeded_hash with a seed that is randomly
chosen at hash table creation time. In effect, the hash function
used is randomly selected among 2^{30} different hash functions.
All these hash functions have different collision patterns,
rendering ineffective the denial-of-service attack described above.
However, because of randomization, enumerating all elements of the
hash table using Hashtbl.fold or Hashtbl.iter is no longer
deterministic: elements are enumerated in different orders at
different runs of the program.
If no ~random parameter is given, hash tables are created
in non-random mode by default. This default can be changed
either programmatically by calling Hashtbl.randomize or by
setting the R flag in the OCAMLRUNPARAM environment variable.
Before 4.00.0 the random parameter was not present and all
hash tables were created in non-randomized mode.
val clear : ('a, 'b) t -> unitreset instead of clear to shrink the
size of the bucket table to its initial size.val reset : ('a, 'b) t -> unitval copy : ('a, 'b) t -> ('a, 'b) tval add : ('a, 'b) t -> 'a -> 'b -> unitHashtbl.add tbl x y adds a binding of x to y in table tbl.
Previous bindings for x are not removed, but simply
hidden. That is, after performing Hashtbl.remove tbl x,
the previous binding for x, if any, is restored.
(Same behavior as with association lists.)val find : ('a, 'b) t -> 'a -> 'bHashtbl.find tbl x returns the current binding of x in tbl,
or raises Not_found if no such binding exists.val find_opt : ('a, 'b) t -> 'a -> 'b optionHashtbl.find_opt tbl x returns the current binding of x in tbl,
or None if no such binding exists.val find_all : ('a, 'b) t -> 'a -> 'b listHashtbl.find_all tbl x returns the list of all data
associated with x in tbl.
The current binding is returned first, then the previous
bindings, in reverse order of introduction in the table.val mem : ('a, 'b) t -> 'a -> boolHashtbl.mem tbl x checks if x is bound in tbl.val remove : ('a, 'b) t -> 'a -> unitHashtbl.remove tbl x removes the current binding of x in tbl,
restoring the previous binding if it exists.
It does nothing if x is not bound in tbl.val replace : ('a, 'b) t -> 'a -> 'b -> unitHashtbl.replace tbl x y replaces the current binding of x
in tbl by a binding of x to y. If x is unbound in tbl,
a binding of x to y is added to tbl.
This is functionally equivalent to Hashtbl.remove tbl x
followed by Hashtbl.add tbl x y.val iter : ('a -> 'b -> unit) -> ('a, 'b) t -> unitHashtbl.iter f tbl applies f to all bindings in table tbl.
f receives the key as first argument, and the associated value
as second argument. Each binding is presented exactly once to f.
The order in which the bindings are passed to f is unspecified.
However, if the table contains several bindings for the same key,
they are passed to f in reverse order of introduction, that is,
the most recent binding is passed first.
If the hash table was created in non-randomized mode, the order in which the bindings are enumerated is reproducible between successive runs of the program, and even between minor versions of OCaml. For randomized hash tables, the order of enumeration is entirely random.
The behavior is not defined if the hash table is modified
by f during the iteration.
val filter_map_inplace : ('a -> 'b -> 'b option) -> ('a, 'b) t -> unitHashtbl.filter_map_inplace f tbl applies f to all bindings in
table tbl and update each binding depending on the result of
f. If f returns None, the binding is discarded. If it
returns Some new_val, the binding is update to associate the key
to new_val.
Other comments for Hashtbl.iter apply as well.
Since 4.03.0
val fold : ('a -> 'b -> 'c -> 'c) -> ('a, 'b) t -> 'c -> 'cHashtbl.fold f tbl init computes
(f kN dN ... (f k1 d1 init)...),
where k1 ... kN are the keys of all bindings in tbl,
and d1 ... dN are the associated values.
Each binding is presented exactly once to f.
The order in which the bindings are passed to f is unspecified.
However, if the table contains several bindings for the same key,
they are passed to f in reverse order of introduction, that is,
the most recent binding is passed first.
If the hash table was created in non-randomized mode, the order in which the bindings are enumerated is reproducible between successive runs of the program, and even between minor versions of OCaml. For randomized hash tables, the order of enumeration is entirely random.
The behavior is not defined if the hash table is modified
by f during the iteration.
val length : ('a, 'b) t -> intHashtbl.length tbl returns the number of bindings in tbl.
It takes constant time. Multiple bindings are counted once each, so
Hashtbl.length gives the number of times Hashtbl.iter calls its
first argument.val randomize : unit -> unitHashtbl.randomize(), hash tables are created in
randomized mode by default: Hashtbl.create returns randomized
hash tables, unless the ~random:false optional parameter is given.
The same effect can be achieved by setting the R parameter in
the OCAMLRUNPARAM environment variable.
It is recommended that applications or Web frameworks that need to
protect themselves against the denial-of-service attack described
in Hashtbl.create call Hashtbl.randomize() at initialization
time.
Note that once Hashtbl.randomize() was called, there is no way
to revert to the non-randomized default behavior of Hashtbl.create.
This is intentional. Non-randomized hash tables can still be
created using Hashtbl.create ~random:false.
Since 4.00.0
val is_randomized : unit -> booltype
|
num_bindings : |
(* |
Number of bindings present in the table.
Same value as returned by
Hashtbl.length. | *) |
|
num_buckets : |
(* |
Number of buckets in the table.
| *) |
|
max_bucket_length : |
(* |
Maximal number of bindings per bucket.
| *) |
|
bucket_histogram : |
(* |
Histogram of bucket sizes. This array
histo has
length max_bucket_length + 1. The value of
histo.(i) is the number of buckets whose size is i. | *) |
val stats : ('a, 'b) t -> statisticsHashtbl.stats tbl returns statistics about the table tbl:
number of buckets, size of the biggest bucket, distribution of
buckets by size.For instance, one might want to specialize a table for integer keys:
module IntHash =
struct
type t = int
let equal i j = i=j
let hash i = i land max_int
end
module IntHashtbl = Hashtbl.Make(IntHash)
let h = IntHashtbl.create 17 in
IntHashtbl.add h 12 "hello"
This creates a new module IntHashtbl, with a new type 'a of tables from
IntHashtbl.tint to 'a. In this example, h
contains string values so its type is string IntHashtbl.t.
Note that the new type 'a IntHashtbl.t is not compatible with
the type ('a,'b) Hashtbl.t of the generic interface. For
example, Hashtbl.length h would not type-check, you must use
IntHashtbl.length.
module type HashedType =sig..end
Hashtbl.Make.
module type S =sig..end
Hashtbl.Make.
module Make:
module type SeededHashedType =sig..end
Hashtbl.MakeSeeded.
module type SeededS =sig..end
Hashtbl.MakeSeeded.
module MakeSeeded:
val hash : 'a -> intHashtbl.hash x associates a nonnegative integer to any value of
any type. It is guaranteed that
if x = y or Pervasives.compare x y = 0, then hash x = hash y.
Moreover, hash always terminates, even on cyclic structures.val seeded_hash : int -> 'a -> int
val hash_param : int -> int -> 'a -> intHashtbl.hash_param meaningful total x computes a hash value for x,
with the same properties as for hash. The two extra integer
parameters meaningful and total give more precise control over
hashing. Hashing performs a breadth-first, left-to-right traversal
of the structure x, stopping after meaningful meaningful nodes
were encountered, or total nodes (meaningful or not) were
encountered. If total as specified by the user exceeds a certain
value, currently 256, then it is capped to that value.
Meaningful nodes are: integers; floating-point
numbers; strings; characters; booleans; and constant
constructors. Larger values of meaningful and total means that
more nodes are taken into account to compute the final hash value,
and therefore collisions are less likely to happen. However,
hashing takes longer. The parameters meaningful and total
govern the tradeoff between accuracy and speed. As default
choices, Hashtbl.hash and Hashtbl.seeded_hash take
meaningful = 10 and total = 100.val seeded_hash_param : int -> int -> int -> 'a -> intHashtbl.hash_param that is further parameterized by
an integer seed. Usage:
Hashtbl.seeded_hash_param meaningful total seed x.sig
val to_string : exn -> string
val print : ('a -> 'b) -> 'a -> 'b
val catch : ('a -> 'b) -> 'a -> 'b
val print_backtrace : Pervasives.out_channel -> unit
val get_backtrace : unit -> string
val record_backtrace : bool -> unit
val backtrace_status : unit -> bool
val register_printer : (exn -> string option) -> unit
type raw_backtrace
val get_raw_backtrace : unit -> Printexc.raw_backtrace
val print_raw_backtrace :
Pervasives.out_channel -> Printexc.raw_backtrace -> unit
val raw_backtrace_to_string : Printexc.raw_backtrace -> string
external raise_with_backtrace : exn -> Printexc.raw_backtrace -> 'a
= "%raise_with_backtrace"
val get_callstack : int -> Printexc.raw_backtrace
val set_uncaught_exception_handler :
(exn -> Printexc.raw_backtrace -> unit) -> unit
type backtrace_slot
val backtrace_slots :
Printexc.raw_backtrace -> Printexc.backtrace_slot array option
type location = {
filename : string;
line_number : int;
start_char : int;
end_char : int;
}
module Slot :
sig
type t = Printexc.backtrace_slot
val is_raise : Printexc.Slot.t -> bool
val is_inline : Printexc.Slot.t -> bool
val location : Printexc.Slot.t -> Printexc.location option
val format : int -> Printexc.Slot.t -> string option
end
type raw_backtrace_slot
val raw_backtrace_length : Printexc.raw_backtrace -> int
val get_raw_backtrace_slot :
Printexc.raw_backtrace -> int -> Printexc.raw_backtrace_slot
val convert_raw_backtrace_slot :
Printexc.raw_backtrace_slot -> Printexc.backtrace_slot
val get_raw_backtrace_next_slot :
Printexc.raw_backtrace_slot -> Printexc.raw_backtrace_slot option
val exn_slot_id : exn -> int
val exn_slot_name : exn -> string
end ocaml-doc-4.05/ocaml.html/libref/type_Dynlink.html 0000644 0001750 0001750 00000025555 13131636443 021116 0 ustar mehdi mehdi
sig
val is_native : bool
val loadfile : string -> unit
val loadfile_private : string -> unit
val adapt_filename : string -> string
val allow_only : string list -> unit
val prohibit : string list -> unit
val default_available_units : unit -> unit
val allow_unsafe_modules : bool -> unit
val add_interfaces : string list -> string list -> unit
val add_available_units : (string * Digest.t) list -> unit
val clear_available_units : unit -> unit
val init : unit -> unit
type linking_error =
Undefined_global of string
| Unavailable_primitive of string
| Uninitialized_global of string
type error =
Not_a_bytecode_file of string
| Inconsistent_import of string
| Unavailable_unit of string
| Unsafe_file
| Linking_error of string * Dynlink.linking_error
| Corrupted_interface of string
| File_not_found of string
| Cannot_open_dll of string
| Inconsistent_implementation of string
exception Error of Dynlink.error
val error_message : Dynlink.error -> string
val digest_interface : string -> string list -> Digest.t
end ocaml-doc-4.05/ocaml.html/libref/type_Set.html 0000644 0001750 0001750 00000072323 13131636450 020232 0 ustar mehdi mehdi
sig
module type OrderedType =
sig
type t
val compare : Set.OrderedType.t -> Set.OrderedType.t -> int
end
module type S =
sig
type elt
type t
val empty : Set.S.t
val is_empty : Set.S.t -> bool
val mem : Set.S.elt -> Set.S.t -> bool
val add : Set.S.elt -> Set.S.t -> Set.S.t
val singleton : Set.S.elt -> Set.S.t
val remove : Set.S.elt -> Set.S.t -> Set.S.t
val union : Set.S.t -> Set.S.t -> Set.S.t
val inter : Set.S.t -> Set.S.t -> Set.S.t
val diff : Set.S.t -> Set.S.t -> Set.S.t
val compare : Set.S.t -> Set.S.t -> int
val equal : Set.S.t -> Set.S.t -> bool
val subset : Set.S.t -> Set.S.t -> bool
val iter : (Set.S.elt -> unit) -> Set.S.t -> unit
val map : (Set.S.elt -> Set.S.elt) -> Set.S.t -> Set.S.t
val fold : (Set.S.elt -> 'a -> 'a) -> Set.S.t -> 'a -> 'a
val for_all : (Set.S.elt -> bool) -> Set.S.t -> bool
val exists : (Set.S.elt -> bool) -> Set.S.t -> bool
val filter : (Set.S.elt -> bool) -> Set.S.t -> Set.S.t
val partition : (Set.S.elt -> bool) -> Set.S.t -> Set.S.t * Set.S.t
val cardinal : Set.S.t -> int
val elements : Set.S.t -> Set.S.elt list
val min_elt : Set.S.t -> Set.S.elt
val min_elt_opt : Set.S.t -> Set.S.elt option
val max_elt : Set.S.t -> Set.S.elt
val max_elt_opt : Set.S.t -> Set.S.elt option
val choose : Set.S.t -> Set.S.elt
val choose_opt : Set.S.t -> Set.S.elt option
val split : Set.S.elt -> Set.S.t -> Set.S.t * bool * Set.S.t
val find : Set.S.elt -> Set.S.t -> Set.S.elt
val find_opt : Set.S.elt -> Set.S.t -> Set.S.elt option
val find_first : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt
val find_first_opt : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt option
val find_last : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt
val find_last_opt : (Set.S.elt -> bool) -> Set.S.t -> Set.S.elt option
val of_list : Set.S.elt list -> Set.S.t
end
module Make :
functor (Ord : OrderedType) ->
sig
type elt = Ord.t
type t
val empty : t
val is_empty : t -> bool
val mem : elt -> t -> bool
val add : elt -> t -> t
val singleton : elt -> t
val remove : elt -> t -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val compare : t -> t -> int
val equal : t -> t -> bool
val subset : t -> t -> bool
val iter : (elt -> unit) -> t -> unit
val map : (elt -> elt) -> t -> t
val fold : (elt -> 'a -> 'a) -> t -> 'a -> 'a
val for_all : (elt -> bool) -> t -> bool
val exists : (elt -> bool) -> t -> bool
val filter : (elt -> bool) -> t -> t
val partition : (elt -> bool) -> t -> t * t
val cardinal : t -> int
val elements : t -> elt list
val min_elt : t -> elt
val min_elt_opt : t -> elt option
val max_elt : t -> elt
val max_elt_opt : t -> elt option
val choose : t -> elt
val choose_opt : t -> elt option
val split : elt -> t -> t * bool * t
val find : elt -> t -> elt
val find_opt : elt -> t -> elt option
val find_first : (elt -> bool) -> t -> elt
val find_first_opt : (elt -> bool) -> t -> elt option
val find_last : (elt -> bool) -> t -> elt
val find_last_opt : (elt -> bool) -> t -> elt option
val of_list : elt list -> t
end
end ocaml-doc-4.05/ocaml.html/libref/Arg.html 0000644 0001750 0001750 00000102153 13131636440 017141 0 ustar mehdi mehdi
module Arg:sig..end
This module provides a general mechanism for extracting options and arguments from the command line to the program.
Syntax of command lines:
A keyword is a character string starting with a -.
An option is a keyword alone or followed by an argument.
The types of keywords are: Unit, Bool, Set, Clear,
String, Set_string, Int, Set_int, Float, Set_float,
Tuple, Symbol, and Rest.
Unit, Set and Clear keywords take no argument. A Rest
keyword takes the remaining of the command line as arguments.
Every other keyword takes the following word on the command line
as argument. For compatibility with GNU getopt_long, keyword=arg
is also allowed.
Arguments not preceded by a keyword are called anonymous arguments.
Examples (cmd is assumed to be the command name):
cmd -flag (a unit option)cmd -int 1 (an int option with argument 1)cmd -string foobar (a string option with argument "foobar")cmd -float 12.34 (a float option with argument 12.34)cmd a b c (three anonymous arguments: "a", "b", and "c")cmd a b -- c d (two anonymous arguments and a rest option with
two arguments)type
| |
Unit of |
(* |
Call the function with unit argument
| *) |
| |
Bool of |
(* |
Call the function with a bool argument
| *) |
| |
Set of |
(* |
Set the reference to true
| *) |
| |
Clear of |
(* |
Set the reference to false
| *) |
| |
String of |
(* |
Call the function with a string argument
| *) |
| |
Set_string of |
(* |
Set the reference to the string argument
| *) |
| |
Int of |
(* |
Call the function with an int argument
| *) |
| |
Set_int of |
(* |
Set the reference to the int argument
| *) |
| |
Float of |
(* |
Call the function with a float argument
| *) |
| |
Set_float of |
(* |
Set the reference to the float argument
| *) |
| |
Tuple of |
(* |
Take several arguments according to the
spec list
| *) |
| |
Symbol of |
(* |
Take one of the symbols as argument and
call the function with the symbol
| *) |
| |
Rest of |
(* |
Stop interpreting keywords and call the
function with each remaining argument
| *) |
| |
Expand of |
(* |
If the remaining arguments to process
are of the form
["-foo"; "arg"] @ rest where "foo" is
registered as Expand f, then the
arguments f "arg" @ rest are
processed. Only allowed in
parse_and_expand_argv_dynamic. | *) |
typekey =string
typedoc =string
typeusage_msg =string
typeanon_fun =string -> unit
val parse : (key * spec * doc) list -> anon_fun -> usage_msg -> unitArg.parse speclist anon_fun usage_msg parses the command line.
speclist is a list of triples (key, spec, doc).
key is the option keyword, it must start with a '-' character.
spec gives the option type and the function to call when this option
is found on the command line.
doc is a one-line description of this option.
anon_fun is called on anonymous arguments.
The functions in spec and anon_fun are called in the same order
as their arguments appear on the command line.
If an error occurs, Arg.parse exits the program, after printing
to standard error an error message as follows:
usage_msgdoc string.
Beware: options that have an empty doc string will not be included in the
list.-, include for example ("-", String anon_fun, doc) in speclist.
By default, parse recognizes two unit options, -help and --help,
which will print to standard output usage_msg and the list of
options, and exit the program. You can override this behaviour
by specifying your own -help and --help options in speclist.
val parse_dynamic : (key * spec * doc) list ref ->
anon_fun -> usage_msg -> unitArg.parse, except that the speclist argument is a reference
and may be updated during the parsing. A typical use for this feature
is to parse command lines of the form:options
where the list of options depends on the value of the subcommand argument.val parse_argv : ?current:int ref ->
string array ->
(key * spec * doc) list -> anon_fun -> usage_msg -> unitArg.parse_argv ~current args speclist anon_fun usage_msg parses
the array args as if it were the command line. It uses and updates
the value of ~current (if given), or Arg.current. You must set
it before calling parse_argv. The initial value of current
is the index of the program name (argument 0) in the array.
If an error occurs, Arg.parse_argv raises Arg.Bad with
the error message as argument. If option -help or --help is
given, Arg.parse_argv raises Arg.Help with the help message
as argument.val parse_argv_dynamic : ?current:int ref ->
string array ->
(key * spec * doc) list ref ->
anon_fun -> string -> unitArg.parse_argv, except that the speclist argument is a
reference and may be updated during the parsing.
See Arg.parse_dynamic.val parse_and_expand_argv_dynamic : int ref ->
string array ref ->
(key * spec * doc) list ref ->
anon_fun -> string -> unitArg.parse_argv_dynamic, except that the argv argument is a
reference and may be updated during the parsing of Expand arguments.
See Arg.parse_argv_dynamic.val parse_expand : (key * spec * doc) list -> anon_fun -> usage_msg -> unitArg.parse, except that the Expand arguments are allowed and
the Arg.current reference is not updated.exception Help of string
Arg.parse_argv when the user asks for help.exception Bad of string
spec or anon_fun can raise Arg.Bad with an error
message to reject invalid arguments.
Arg.Bad is also raised by Arg.parse_argv in case of an error.val usage : (key * spec * doc) list -> usage_msg -> unitArg.usage speclist usage_msg prints to standard error
an error message that includes the list of valid options. This is
the same message that Arg.parse prints in case of error.
speclist and usage_msg are the same as for Arg.parse.val usage_string : (key * spec * doc) list -> usage_msg -> stringArg.usage,
if provided with the same parameters.val align : ?limit:int ->
(key * spec * doc) list -> (key * spec * doc) listSymbol arguments are aligned on the next line.limit : options with keyword and message longer than
limit will not be used to compute the alignement.val current : int refSys.argv) of the argument being processed. You can
change this value, e.g. to force Arg.parse to skip some arguments.
Arg.parse uses the initial value of Arg.current as the index of
argument 0 (the program name) and starts parsing arguments
at the next element.val read_arg : string -> string arrayArg.read_arg file reads newline-terminated command line arguments from
file file.val read_arg0 : string -> string arrayArg.read_arg but assumes null character terminated command line
arguments.val write_arg : string -> string array -> unitArg.write_arg file args writes the arguments args newline-terminated
into the file file. If the any of the arguments in args contains a
newline, use Arg.write_arg0 instead.val write_arg0 : string -> string array -> unitArg.write_arg but uses the null character for terminator
instead of newline.sig
type t
val equal : Hashtbl.HashedType.t -> Hashtbl.HashedType.t -> bool
val hash : Hashtbl.HashedType.t -> int
end ocaml-doc-4.05/ocaml.html/libref/Ast_helper.Type.html 0000644 0001750 0001750 00000022756 13131636441 021451 0 ustar mehdi mehdi
module Type:sig..end
val mk : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?docs:Docstrings.docs ->
?text:Docstrings.text ->
?params:(Parsetree.core_type * Asttypes.variance) list ->
?cstrs:(Parsetree.core_type * Parsetree.core_type * Ast_helper.loc) list ->
?kind:Parsetree.type_kind ->
?priv:Asttypes.private_flag ->
?manifest:Parsetree.core_type -> Ast_helper.str -> Parsetree.type_declaration
val constructor : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?info:Docstrings.info ->
?args:Parsetree.constructor_arguments ->
?res:Parsetree.core_type ->
Ast_helper.str -> Parsetree.constructor_declaration
val field : ?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
?info:Docstrings.info ->
?mut:Asttypes.mutable_flag ->
Ast_helper.str -> Parsetree.core_type -> Parsetree.label_declaration ocaml-doc-4.05/ocaml.html/libref/type_Uchar.html 0000644 0001750 0001750 00000022046 13131636451 020537 0 ustar mehdi mehdi
sig
type t
val min : Uchar.t
val max : Uchar.t
val succ : Uchar.t -> Uchar.t
val pred : Uchar.t -> Uchar.t
val is_valid : int -> bool
val of_int : int -> Uchar.t
val unsafe_of_int : int -> Uchar.t
val to_int : Uchar.t -> int
val is_char : Uchar.t -> bool
val of_char : char -> Uchar.t
val to_char : Uchar.t -> char
val unsafe_to_char : Uchar.t -> char
val equal : Uchar.t -> Uchar.t -> bool
val compare : Uchar.t -> Uchar.t -> int
val hash : Uchar.t -> int
end ocaml-doc-4.05/ocaml.html/libref/StdLabels.Bytes.html 0000644 0001750 0001750 00000075072 13131636450 021404 0 ustar mehdi mehdi
module Bytes: BytesLabelsval length : bytes -> intval get : bytes -> int -> charget s n returns the byte at index n in argument s.
Raise Invalid_argument if n is not a valid index in s.
val set : bytes -> int -> char -> unitset s n c modifies s in place, replacing the byte at index n
with c.
Raise Invalid_argument if n is not a valid index in s.
val create : int -> bytescreate n returns a new byte sequence of length n. The
sequence is uninitialized and contains arbitrary bytes.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val make : int -> char -> bytesmake n c returns a new byte sequence of length n, filled with
the byte c.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val init : int -> f:(int -> char) -> bytesinit n f returns a fresh byte sequence of length n,
with character i initialized to the result of f i.
Raise Invalid_argument if n < 0 or n > Sys.max_string_length.
val empty : bytesval copy : bytes -> bytesval of_string : string -> bytesval to_string : bytes -> stringval sub : bytes -> pos:int -> len:int -> bytessub s start len returns a new byte sequence of length len,
containing the subsequence of s that starts at position start
and has length len.
Raise Invalid_argument if start and len do not designate a
valid range of s.
val sub_string : bytes -> int -> int -> stringsub but return a string instead of a byte sequence.val extend : bytes -> left:int -> right:int -> bytesextend s left right returns a new byte sequence that contains
the bytes of s, with left uninitialized bytes prepended and
right uninitialized bytes appended to it. If left or right
is negative, then bytes are removed (instead of appended) from
the corresponding side of s.
Raise Invalid_argument if the result length is negative or
longer than Sys.max_string_length bytes.
Since 4.05.0
val fill : bytes -> pos:int -> len:int -> char -> unitfill s start len c modifies s in place, replacing len
characters with c, starting at start.
Raise Invalid_argument if start and len do not designate a
valid range of s.
val blit : src:bytes -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitblit src srcoff dst dstoff len copies len bytes from sequence
src, starting at index srcoff, to sequence dst, starting at
index dstoff. It works correctly even if src and dst are the
same byte sequence, and the source and destination intervals
overlap.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
val blit_string : src:string -> src_pos:int -> dst:bytes -> dst_pos:int -> len:int -> unitblit src srcoff dst dstoff len copies len bytes from string
src, starting at index srcoff, to byte sequence dst,
starting at index dstoff.
Raise Invalid_argument if srcoff and len do not
designate a valid range of src, or if dstoff and len
do not designate a valid range of dst.
Since 4.05.0
val concat : sep:bytes -> bytes list -> bytesconcat sep sl concatenates the list of byte sequences sl,
inserting the separator byte sequence sep between each, and
returns the result as a new byte sequence.val cat : bytes -> bytes -> bytescat s1 s2 concatenates s1 and s2 and returns the result
as new byte sequence.
Raise Invalid_argument if the result is longer than
Sys.max_string_length bytes.
Since 4.05.0
val iter : f:(char -> unit) -> bytes -> unititer f s applies function f in turn to all the bytes of s.
It is equivalent to f (get s 0); f (get s 1); ...; f (get s
(length s - 1)); ().val iteri : f:(int -> char -> unit) -> bytes -> unitBytes.iter, but the function is applied to the index of
the byte as first argument and the byte itself as second
argument.val map : f:(char -> char) -> bytes -> bytesmap f s applies function f in turn to all the bytes of s and
stores the resulting bytes in a new sequence that is returned as
the result.val mapi : f:(int -> char -> char) -> bytes -> bytesmapi f s calls f with each character of s and its
index (in increasing index order) and stores the resulting bytes
in a new sequence that is returned as the result.val trim : bytes -> bytes' ', '\012', '\n', '\r', and '\t'.val escaped : bytes -> bytesval index : bytes -> char -> intindex s c returns the index of the first occurrence of byte c
in s.
Raise Not_found if c does not occur in s.
val index_opt : bytes -> char -> int optionindex_opt s c returns the index of the first occurrence of byte c
in s or None if c does not occur in s.val rindex : bytes -> char -> intrindex s c returns the index of the last occurrence of byte c
in s.
Raise Not_found if c does not occur in s.
val rindex_opt : bytes -> char -> int optionrindex_opt s c returns the index of the last occurrence of byte c
in s or None if c does not occur in s.val index_from : bytes -> int -> char -> intindex_from s i c returns the index of the first occurrence of
byte c in s after position i. Bytes.index s c is
equivalent to Bytes.index_from s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Raise Not_found if c does not occur in s after position i.
val index_from_opt : bytes -> int -> char -> int optionindex_from _opts i c returns the index of the first occurrence of
byte c in s after position i or None if c does not occur in s after position i.
Bytes.index_opt s c is equivalent to Bytes.index_from_opt s 0 c.
Raise Invalid_argument if i is not a valid position in s.
Since 4.05
val rindex_from : bytes -> int -> char -> intrindex_from s i c returns the index of the last occurrence of
byte c in s before position i+1. rindex s c is equivalent
to rindex_from s (Bytes.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Raise Not_found if c does not occur in s before position i+1.
val rindex_from_opt : bytes -> int -> char -> int optionrindex_from_opt s i c returns the index of the last occurrence
of byte c in s before position i+1 or None if c does not
occur in s before position i+1. rindex_opt s c is equivalent to
rindex_from s (Bytes.length s - 1) c.
Raise Invalid_argument if i+1 is not a valid position in s.
Since 4.05
val contains : bytes -> char -> boolcontains s c tests if byte c appears in s.val contains_from : bytes -> int -> char -> boolcontains_from s start c tests if byte c appears in s after
position start. contains s c is equivalent to contains_from
s 0 c.
Raise Invalid_argument if start is not a valid position in s.
val rcontains_from : bytes -> int -> char -> boolrcontains_from s stop c tests if byte c appears in s before
position stop+1.
Raise Invalid_argument if stop < 0 or stop+1 is not a valid
position in s.
val uppercase : bytes -> bytesval lowercase : bytes -> bytesval capitalize : bytes -> bytesval uncapitalize : bytes -> bytesval uppercase_ascii : bytes -> bytesval lowercase_ascii : bytes -> bytesval capitalize_ascii : bytes -> bytesval uncapitalize_ascii : bytes -> bytestypet =bytes
val compare : t -> t -> intcompare. Along with the type t,
this function compare allows the module Bytes to be passed as
argument to the functors Set.Make and Map.Make.val equal : t -> t -> boolmodule Parsing:sig..end
ocamlyacc.val symbol_start : unit -> intsymbol_start and Parsing.symbol_end are to be called in the
action part of a grammar rule only. They return the offset of the
string that matches the left-hand side of the rule: symbol_start()
returns the offset of the first character; symbol_end() returns the
offset after the last character. The first character in a file is at
offset 0.val symbol_end : unit -> intParsing.symbol_start.val rhs_start : int -> intParsing.symbol_start and Parsing.symbol_end, but
return the offset of the string matching the nth item on the
right-hand side of the rule, where n is the integer parameter
to rhs_start and rhs_end. n is 1 for the leftmost item.val rhs_end : int -> intParsing.rhs_start.val symbol_start_pos : unit -> Lexing.positionsymbol_start, but return a position instead of an offset.val symbol_end_pos : unit -> Lexing.positionsymbol_end, but return a position instead of an offset.val rhs_start_pos : int -> Lexing.positionrhs_start, but return a position instead of an offset.val rhs_end_pos : int -> Lexing.positionrhs_end, but return a position instead of an offset.val clear_parser : unit -> unitexception Parse_error
val set_trace : bool -> boolocamlyacc-generated parsers.
After Parsing.set_trace true, the pushdown automaton that
executes the parsers prints a trace of its actions (reading a token,
shifting a state, reducing by a rule) on standard output.
Parsing.set_trace false turns this debugging trace off.
The boolean returned is the previous state of the trace flag.module Dynlink:sig..end
val is_native : booltrue if the program is native,
false if the program is bytecode.val loadfile : string -> unit.cmo file) or
bytecode library file (.cma file), and link it with the running
program. In native code: load the given OCaml plugin file (usually
.cmxs), and link it with the running
program.
All toplevel expressions in the loaded compilation units
are evaluated. No facilities are provided to
access value names defined by the unit. Therefore, the unit
must register itself its entry points with the main program,
e.g. by modifying tables of functions.val loadfile_private : string -> unitloadfile, except that the compilation units just loaded
are hidden (cannot be referenced) from other modules dynamically
loaded afterwards.val adapt_filename : string -> string.cmxs.val allow_only : string list -> unitallow_only units restricts the compilation units that
dynamically-linked units can reference: it forbids all references
to units other than those named in the list units. References
to any other compilation unit will cause a Unavailable_unit
error during loadfile or loadfile_private.
Initially (or after calling default_available_units) all
compilation units composing the program currently running are
available for reference from dynamically-linked units.
allow_only can be used to restrict access to a subset of these
units, e.g. to the units that compose the API for
dynamically-linked code, and prevent access to all other units,
e.g. private, internal modules of the running program. If
allow_only is called several times, access will be restricted to
the intersection of the given lists (i.e. a call to allow_only
can never increase the set of available units).
val prohibit : string list -> unitprohibit units prohibits dynamically-linked units from referencing
the units named in list units. This can be used to prevent
access to selected units, e.g. private, internal modules of
the running program.val default_available_units : unit -> unitval allow_unsafe_modules : bool -> unitval add_interfaces : string list -> string list -> unitadd_interfaces units path grants dynamically-linked object
files access to the compilation units named in list units.
The interfaces (.cmi files) for these units are searched in
path (a list of directory names).val add_available_units : (string * Digest.t) list -> unitDynlink.add_interfaces, but instead of searching .cmi files
to find the unit interfaces, uses the interface digests given
for each unit. This way, the .cmi interface files need not be
available at run-time. The digests can be extracted from .cmi
files using the extract_crc program installed in the
OCaml standard library directory.val clear_available_units : unit -> unitval init : unit -> unitDynlink library. This function is called
automatically when needed.type
| |
Undefined_global of |
| |
of |
| |
Uninitialized_global of |
type
| |
Not_a_bytecode_file of |
| |
Inconsistent_import of |
| |
of |
| |
Unsafe_file |
| |
Linking_error of |
| |
Corrupted_interface of |
| |
File_not_found of |
| |
Cannot_open_dll of |
| |
Inconsistent_implementation of |
exception Error of error
Error
exception with a description of the error.val error_message : error -> stringmodule type HookSig =sig..end
type
val add_hook : string -> (Misc.hook_info -> t -> t) -> unit
val apply_hooks : Misc.hook_info -> t -> t ocaml-doc-4.05/ocaml.html/libref/Asttypes.html 0000644 0001750 0001750 00000040327 13131636441 020251 0 ustar mehdi mehdi
module Asttypes:sig..end
type
| |
Const_int of |
| |
Const_char of |
| |
Const_string of |
| |
Const_float of |
| |
Const_int32 of |
| |
Const_int64 of |
| |
Const_nativeint of |
type
| |
Nonrecursive |
| |
Recursive |
type
| |
Upto |
| |
Downto |
type
| |
Private |
| |
Public |
type
| |
Immutable |
| |
Mutable |
type
| |
Virtual |
| |
Concrete |
type
| |
Override |
| |
Fresh |
type
| |
Closed |
| |
Open |
typelabel =string
type
| |
Nolabel |
| |
Labelled of |
| |
Optional of |
type'aloc ='a Location.loc= {
|
txt : |
|
loc : |
type
| |
Covariant |
| |
Contravariant |
| |
Invariant |
module Map:sig..end
This module implements applicative association tables, also known as finite maps or dictionaries, given a total ordering function over the keys. All operations over maps are purely applicative (no side-effects). The implementation uses balanced binary trees, and therefore searching and insertion take time logarithmic in the size of the map.
For instance:
module IntPairs =
struct
type t = int * int
let compare (x0,y0) (x1,y1) =
match Pervasives.compare x0 x1 with
0 -> Pervasives.compare y0 y1
| c -> c
end
module PairsMap = Map.Make(IntPairs)
let m = PairsMap.(empty |> add (0,1) "hello" |> add (1,0) "world")
This creates a new module PairsMap, with a new type 'a PairsMap.t
of maps from int * int to 'a. In this example, m contains string
values so its type is string PairsMap.t.
module type OrderedType =sig..end
Map.Make.
module type S =sig..end
Map.Make.
module Make:
sig
val mk :
?loc:Ast_helper.loc ->
Parsetree.structure_item_desc -> Parsetree.structure_item
val eval :
?loc:Ast_helper.loc ->
?attrs:Parsetree.attributes ->
Parsetree.expression -> Parsetree.structure_item
val value :
?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.value_binding list -> Parsetree.structure_item
val primitive :
?loc:Ast_helper.loc ->
Parsetree.value_description -> Parsetree.structure_item
val type_ :
?loc:Ast_helper.loc ->
Asttypes.rec_flag ->
Parsetree.type_declaration list -> Parsetree.structure_item
val type_extension :
?loc:Ast_helper.loc ->
Parsetree.type_extension -> Parsetree.structure_item
val exception_ :
?loc:Ast_helper.loc ->
Parsetree.extension_constructor -> Parsetree.structure_item
val module_ :
?loc:Ast_helper.loc ->
Parsetree.module_binding -> Parsetree.structure_item
val rec_module :
?loc:Ast_helper.loc ->
Parsetree.module_binding list -> Parsetree.structure_item
val modtype :
?loc:Ast_helper.loc ->
Parsetree.module_type_declaration -> Parsetree.structure_item
val open_ :
?loc:Ast_helper.loc ->
Parsetree.open_description -> Parsetree.structure_item
val class_ :
?loc:Ast_helper.loc ->
Parsetree.class_declaration list -> Parsetree.structure_item
val class_type :
?loc:Ast_helper.loc ->
Parsetree.class_type_declaration list -> Parsetree.structure_item
val include_ :
?loc:Ast_helper.loc ->
Parsetree.include_declaration -> Parsetree.structure_item
val extension :
?loc:Ast_helper.loc ->
?attrs:Ast_helper.attrs ->
Parsetree.extension -> Parsetree.structure_item
val attribute :
?loc:Ast_helper.loc -> Parsetree.attribute -> Parsetree.structure_item
val text : Docstrings.text -> Parsetree.structure_item list
end ocaml-doc-4.05/ocaml.html/libref/MoreLabels.Set.OrderedType.html 0000644 0001750 0001750 00000020110 13131636446 023432 0 ustar mehdi mehdi
module type OrderedType = Set.OrderedTypetype
val compare : t -> t -> intf such that
f e1 e2 is zero if the elements e1 and e2 are equal,
f e1 e2 is strictly negative if e1 is smaller than e2,
and f e1 e2 is strictly positive if e1 is greater than e2.
Example: a suitable ordering function is the generic structural
comparison function compare.module type S =sig..end
type
type 'a t
val create : int -> 'a t
val clear : 'a t -> unit
val reset : 'a t -> unit
val copy : 'a t -> 'a t
val add : 'a t -> key:key -> data:'a -> unit
val remove : 'a t -> key -> unit
val find : 'a t -> key -> 'a
val find_opt : 'a t -> key -> 'a option
val find_all : 'a t -> key -> 'a list
val replace : 'a t -> key:key -> data:'a -> unit
val mem : 'a t -> key -> bool
val iter : f:(key:key -> data:'a -> unit) ->
'a t -> unit
val filter_map_inplace : f:(key:key -> data:'a -> 'a option) ->
'a t -> unit
val fold : f:(key:key -> data:'a -> 'b -> 'b) ->
'a t -> init:'b -> 'b
val length : 'a t -> int
val stats : 'a t -> MoreLabels.Hashtbl.statistics ocaml-doc-4.05/ocaml.html/libref/Arg_helper.Make.html 0000644 0001750 0001750 00000026512 13131636440 021360 0 ustar mehdi mehdi
module Make:
| Parameters: |
|
type
val default : S.Value.t -> parsed
val set_base_default : S.Value.t -> parsed -> parsed
val add_base_override : S.Key.t -> S.Value.t -> parsed -> parsed
val reset_base_overrides : parsed -> parsed
val set_user_default : S.Value.t -> parsed -> parsed
val add_user_override : S.Key.t -> S.Value.t -> parsed -> parsed
val parse : string -> string -> parsed ref -> unit
type
| |
Ok |
| |
Parse_failed of |
val parse_no_error : string ->
parsed ref -> parse_result
val get : key:S.Key.t -> parsed -> S.Value.t ocaml-doc-4.05/ocaml.html/coreexamples.html 0000644 0001750 0001750 00000077420 13131636457 017674 0 ustar mehdi mehdi
This part of the manual is a tutorial introduction to the OCaml language. A good familiarity with programming in a conventional languages (say, Pascal or C) is assumed, but no prior exposure to functional languages is required. The present chapter introduces the core language. Chapter 2 deals with the module system, chapter 3 with the object-oriented features, chapter 4 with extensions to the core language (labeled arguments and polymorphic variants), and chapter 5 gives some advanced examples.
For this overview of OCaml, we use the interactive system, which is started by running ocaml from the Unix shell, or by launching the OCamlwin.exe application under Windows. This tutorial is presented as the transcript of a session with the interactive system: lines starting with # represent user input; the system responses are printed below, without a leading #.
Under the interactive system, the user types OCaml phrases terminated by ;; in response to the # prompt, and the system compiles them on the fly, executes them, and prints the outcome of evaluation. Phrases are either simple expressions, or let definitions of identifiers (either values or functions).
1+2*3;;- : int = 7
let pi = 4.0 *. atan 1.0;;val pi : float = 3.14159265358979312
let square x = x *. x;;val square : float -> float = <fun>
square (sin pi) +. square (cos pi);;- : float = 1.
The OCaml system computes both the value and the type for each phrase. Even function parameters need no explicit type declaration: the system infers their types from their usage in the function. Notice also that integers and floating-point numbers are distinct types, with distinct operators: + and * operate on integers, but +. and *. operate on floats.
1.0 * 2;;Error: This expression has type float but an expression was expected of type int
Recursive functions are defined with the let rec binding:
let rec fib n = if n < 2 then n else fib (n-1) + fib (n-2);;val fib : int -> int = <fun>
fib 10;;- : int = 55
In addition to integers and floating-point numbers, OCaml offers the usual basic data types: booleans, characters, and immutable character strings.
(1 < 2) = false;;- : bool = false
'a';;- : char = 'a'
"Hello world";;- : string = "Hello world"
Predefined data structures include tuples, arrays, and lists. General mechanisms for defining your own data structures are also provided. They will be covered in more details later; for now, we concentrate on lists. Lists are either given in extension as a bracketed list of semicolon-separated elements, or built from the empty list [] (pronounce “nil”) by adding elements in front using the :: (“cons”) operator.
let l = ["is"; "a"; "tale"; "told"; "etc."];;val l : string list = ["is"; "a"; "tale"; "told"; "etc."]
"Life" :: l;;- : string list = ["Life"; "is"; "a"; "tale"; "told"; "etc."]
As with all other OCaml data structures, lists do not need to be explicitly allocated and deallocated from memory: all memory management is entirely automatic in OCaml. Similarly, there is no explicit handling of pointers: the OCaml compiler silently introduces pointers where necessary.
As with most OCaml data structures, inspecting and destructuring lists is performed by pattern-matching. List patterns have the exact same shape as list expressions, with identifier representing unspecified parts of the list. As an example, here is insertion sort on a list:
let rec sort lst = match lst with [] -> [] | head :: tail -> insert head (sort tail) and insert elt lst = match lst with [] -> [elt] | head :: tail -> if elt <= head then elt :: lst else head :: insert elt tail ;;val sort : 'a list -> 'a list = <fun> val insert : 'a -> 'a list -> 'a list = <fun>
sort l;;- : string list = ["a"; "etc."; "is"; "tale"; "told"]
The type inferred for sort, 'a list -> 'a list, means that sort can actually apply to lists of any type, and returns a list of the same type. The type 'a is a type variable, and stands for any given type. The reason why sort can apply to lists of any type is that the comparisons (=, <=, etc.) are polymorphic in OCaml: they operate between any two values of the same type. This makes sort itself polymorphic over all list types.
sort [6;2;5;3];;- : int list = [2; 3; 5; 6]
sort [3.14; 2.718];;- : float list = [2.718; 3.14]
The sort function above does not modify its input list: it builds and returns a new list containing the same elements as the input list, in ascending order. There is actually no way in OCaml to modify in-place a list once it is built: we say that lists are immutable data structures. Most OCaml data structures are immutable, but a few (most notably arrays) are mutable, meaning that they can be modified in-place at any time.
OCaml is a functional language: functions in the full mathematical sense are supported and can be passed around freely just as any other piece of data. For instance, here is a deriv function that takes any float function as argument and returns an approximation of its derivative function:
let deriv f dx = function x -> (f (x +. dx) -. f x) /. dx;;val deriv : (float -> float) -> float -> float -> float = <fun>
let sin' = deriv sin 1e-6;;val sin' : float -> float = <fun>
sin' pi;;- : float = -1.00000000013961143
Even function composition is definable:
let compose f g = function x -> f (g x);;val compose : ('a -> 'b) -> ('c -> 'a) -> 'c -> 'b = <fun>
let cos2 = compose square cos;;val cos2 : float -> float = <fun>
Functions that take other functions as arguments are called “functionals”, or “higher-order functions”. Functionals are especially useful to provide iterators or similar generic operations over a data structure. For instance, the standard OCaml library provides a List.map functional that applies a given function to each element of a list, and returns the list of the results:
List.map (function n -> n * 2 + 1) [0;1;2;3;4];;- : int list = [1; 3; 5; 7; 9]
This functional, along with a number of other list and array functionals, is predefined because it is often useful, but there is nothing magic with it: it can easily be defined as follows.
let rec map f l = match l with [] -> [] | hd :: tl -> f hd :: map f tl;;val map : ('a -> 'b) -> 'a list -> 'b list = <fun>
User-defined data structures include records and variants. Both are defined with the type declaration. Here, we declare a record type to represent rational numbers.
type ratio = {num: int; denom: int};;type ratio = { num : int; denom : int; }
let add_ratio r1 r2 = {num = r1.num * r2.denom + r2.num * r1.denom; denom = r1.denom * r2.denom};;val add_ratio : ratio -> ratio -> ratio = <fun>
add_ratio {num=1; denom=3} {num=2; denom=5};;- : ratio = {num = 11; denom = 15}
The declaration of a variant type lists all possible shapes for values of that type. Each case is identified by a name, called a constructor, which serves both for constructing values of the variant type and inspecting them by pattern-matching. Constructor names are capitalized to distinguish them from variable names (which must start with a lowercase letter). For instance, here is a variant type for doing mixed arithmetic (integers and floats):
type number = Int of int | Float of float | Error;;type number = Int of int | Float of float | Error
This declaration expresses that a value of type number is either an integer, a floating-point number, or the constant Error representing the result of an invalid operation (e.g. a division by zero).
Enumerated types are a special case of variant types, where all alternatives are constants:
type sign = Positive | Negative;;type sign = Positive | Negative
let sign_int n = if n >= 0 then Positive else Negative;;val sign_int : int -> sign = <fun>
To define arithmetic operations for the number type, we use pattern-matching on the two numbers involved:
let add_num n1 n2 = match (n1, n2) with (Int i1, Int i2) -> (* Check for overflow of integer addition *) if sign_int i1 = sign_int i2 && sign_int (i1 + i2) <> sign_int i1 then Float(float i1 +. float i2) else Int(i1 + i2) | (Int i1, Float f2) -> Float(float i1 +. f2) | (Float f1, Int i2) -> Float(f1 +. float i2) | (Float f1, Float f2) -> Float(f1 +. f2) | (Error, _) -> Error | (_, Error) -> Error;;val add_num : number -> number -> number = <fun>
add_num (Int 123) (Float 3.14159);;- : number = Float 126.14159
The most common usage of variant types is to describe recursive data structures. Consider for example the type of binary trees:
type 'a btree = Empty | Node of 'a * 'a btree * 'a btree;;type 'a btree = Empty | Node of 'a * 'a btree * 'a btree
This definition reads as follows: a binary tree containing values of type 'a (an arbitrary type) is either empty, or is a node containing one value of type 'a and two subtrees containing also values of type 'a, that is, two 'a btree.
Operations on binary trees are naturally expressed as recursive functions following the same structure as the type definition itself. For instance, here are functions performing lookup and insertion in ordered binary trees (elements increase from left to right):
let rec member x btree = match btree with Empty -> false | Node(y, left, right) -> if x = y then true else if x < y then member x left else member x right;;val member : 'a -> 'a btree -> bool = <fun>
let rec insert x btree = match btree with Empty -> Node(x, Empty, Empty) | Node(y, left, right) -> if x <= y then Node(y, insert x left, right) else Node(y, left, insert x right);;val insert : 'a -> 'a btree -> 'a btree = <fun>
Though all examples so far were written in purely applicative style, OCaml is also equipped with full imperative features. This includes the usual while and for loops, as well as mutable data structures such as arrays. Arrays are either given in extension between [| and |] brackets, or allocated and initialized with the Array.make function, then filled up later by assignments. For instance, the function below sums two vectors (represented as float arrays) componentwise.
let add_vect v1 v2 = let len = min (Array.length v1) (Array.length v2) in let res = Array.make len 0.0 in for i = 0 to len - 1 do res.(i) <- v1.(i) +. v2.(i) done; res;;val add_vect : float array -> float array -> float array = <fun>
add_vect [| 1.0; 2.0 |] [| 3.0; 4.0 |];;- : float array = [|4.; 6.|]
Record fields can also be modified by assignment, provided they are declared mutable in the definition of the record type:
type mutable_point = { mutable x: float; mutable y: float };;type mutable_point = { mutable x : float; mutable y : float; }
let translate p dx dy = p.x <- p.x +. dx; p.y <- p.y +. dy;;val translate : mutable_point -> float -> float -> unit = <fun>
let mypoint = { x = 0.0; y = 0.0 };;val mypoint : mutable_point = {x = 0.; y = 0.}
translate mypoint 1.0 2.0;;- : unit = ()
mypoint;;- : mutable_point = {x = 1.; y = 2.}
OCaml has no built-in notion of variable – identifiers whose current value can be changed by assignment. (The let binding is not an assignment, it introduces a new identifier with a new scope.) However, the standard library provides references, which are mutable indirection cells (or one-element arrays), with operators ! to fetch the current contents of the reference and := to assign the contents. Variables can then be emulated by let-binding a reference. For instance, here is an in-place insertion sort over arrays:
let insertion_sort a = for i = 1 to Array.length a - 1 do let val_i = a.(i) in let j = ref i in while !j > 0 && val_i < a.(!j - 1) do a.(!j) <- a.(!j - 1); j := !j - 1 done; a.(!j) <- val_i done;;val insertion_sort : 'a array -> unit = <fun>
References are also useful to write functions that maintain a current state between two calls to the function. For instance, the following pseudo-random number generator keeps the last returned number in a reference:
let current_rand = ref 0;;val current_rand : int ref = {contents = 0}
let random () = current_rand := !current_rand * 25713 + 1345; !current_rand;;val random : unit -> int = <fun>
Again, there is nothing magical with references: they are implemented as a single-field mutable record, as follows.
type 'a ref = { mutable contents: 'a };;type 'a ref = { mutable contents : 'a; }
let ( ! ) r = r.contents;;val ( ! ) : 'a ref -> 'a = <fun>
let ( := ) r newval = r.contents <- newval;;val ( := ) : 'a ref -> 'a -> unit = <fun>
In some special cases, you may need to store a polymorphic function in a data structure, keeping its polymorphism. Without user-provided type annotations, this is not allowed, as polymorphism is only introduced on a global level. However, you can give explicitly polymorphic types to record fields.
type idref = { mutable id: 'a. 'a -> 'a };;type idref = { mutable id : 'a. 'a -> 'a; }
let r = {id = fun x -> x};;val r : idref = {id = <fun>}
let g s = (s.id 1, s.id true);;val g : idref -> int * bool = <fun>
r.id <- (fun x -> print_string "called id\n"; x);;- : unit = ()
g r;;called id called id - : int * bool = (1, true)
OCaml provides exceptions for signalling and handling exceptional conditions. Exceptions can also be used as a general-purpose non-local control structure. Exceptions are declared with the exception construct, and signalled with the raise operator. For instance, the function below for taking the head of a list uses an exception to signal the case where an empty list is given.
exception Empty_list;;exception Empty_list
let head l = match l with [] -> raise Empty_list | hd :: tl -> hd;;val head : 'a list -> 'a = <fun>
head [1;2];;- : int = 1
head [];;Exception: Empty_list.
Exceptions are used throughout the standard library to signal cases where the library functions cannot complete normally. For instance, the List.assoc function, which returns the data associated with a given key in a list of (key, data) pairs, raises the predefined exception Not_found when the key does not appear in the list:
List.assoc 1 [(0, "zero"); (1, "one")];;- : string = "one"
List.assoc 2 [(0, "zero"); (1, "one")];;Exception: Not_found.
Exceptions can be trapped with the try…with construct:
let name_of_binary_digit digit = try List.assoc digit [0, "zero"; 1, "one"] with Not_found -> "not a binary digit";;val name_of_binary_digit : int -> string = <fun>
name_of_binary_digit 0;;- : string = "zero"
name_of_binary_digit (-1);;- : string = "not a binary digit"
The with part is actually a regular pattern-matching on the exception value. Thus, several exceptions can be caught by one try…with construct. Also, finalization can be performed by trapping all exceptions, performing the finalization, then raising again the exception:
let temporarily_set_reference ref newval funct = let oldval = !ref in try ref := newval; let res = funct () in ref := oldval; res with x -> ref := oldval; raise x;;val temporarily_set_reference : 'a ref -> 'a -> (unit -> 'b) -> 'b = <fun>
We finish this introduction with a more complete example representative of the use of OCaml for symbolic processing: formal manipulations of arithmetic expressions containing variables. The following variant type describes the expressions we shall manipulate:
type expression = Const of float | Var of string | Sum of expression * expression (* e1 + e2 *) | Diff of expression * expression (* e1 - e2 *) | Prod of expression * expression (* e1 * e2 *) | Quot of expression * expression (* e1 / e2 *) ;;type expression = Const of float | Var of string | Sum of expression * expression | Diff of expression * expression | Prod of expression * expression | Quot of expression * expression
We first define a function to evaluate an expression given an environment that maps variable names to their values. For simplicity, the environment is represented as an association list.
exception Unbound_variable of string;;exception Unbound_variable of string
let rec eval env exp = match exp with Const c -> c | Var v -> (try List.assoc v env with Not_found -> raise (Unbound_variable v)) | Sum(f, g) -> eval env f +. eval env g | Diff(f, g) -> eval env f -. eval env g | Prod(f, g) -> eval env f *. eval env g | Quot(f, g) -> eval env f /. eval env g;;val eval : (string * float) list -> expression -> float = <fun>
eval [("x", 1.0); ("y", 3.14)] (Prod(Sum(Var "x", Const 2.0), Var "y"));;- : float = 9.42
Now for a real symbolic processing, we define the derivative of an expression with respect to a variable dv:
let rec deriv exp dv = match exp with Const c -> Const 0.0 | Var v -> if v = dv then Const 1.0 else Const 0.0 | Sum(f, g) -> Sum(deriv f dv, deriv g dv) | Diff(f, g) -> Diff(deriv f dv, deriv g dv) | Prod(f, g) -> Sum(Prod(f, deriv g dv), Prod(deriv f dv, g)) | Quot(f, g) -> Quot(Diff(Prod(deriv f dv, g), Prod(f, deriv g dv)), Prod(g, g)) ;;val deriv : expression -> string -> expression = <fun>
deriv (Quot(Const 1.0, Var "x")) "x";;- : expression = Quot (Diff (Prod (Const 0., Var "x"), Prod (Const 1., Const 1.)), Prod (Var "x", Var "x"))
As shown in the examples above, the internal representation (also called abstract syntax) of expressions quickly becomes hard to read and write as the expressions get larger. We need a printer and a parser to go back and forth between the abstract syntax and the concrete syntax, which in the case of expressions is the familiar algebraic notation (e.g. 2*x+1).
For the printing function, we take into account the usual precedence rules (i.e. * binds tighter than +) to avoid printing unnecessary parentheses. To this end, we maintain the current operator precedence and print parentheses around an operator only if its precedence is less than the current precedence.
let print_expr exp = (* Local function definitions *) let open_paren prec op_prec = if prec > op_prec then print_string "(" in let close_paren prec op_prec = if prec > op_prec then print_string ")" in let rec print prec exp = (* prec is the current precedence *) match exp with Const c -> print_float c | Var v -> print_string v | Sum(f, g) -> open_paren prec 0; print 0 f; print_string " + "; print 0 g; close_paren prec 0 | Diff(f, g) -> open_paren prec 0; print 0 f; print_string " - "; print 1 g; close_paren prec 0 | Prod(f, g) -> open_paren prec 2; print 2 f; print_string " * "; print 2 g; close_paren prec 2 | Quot(f, g) -> open_paren prec 2; print 2 f; print_string " / "; print 3 g; close_paren prec 2 in print 0 exp;;val print_expr : expression -> unit = <fun>
let e = Sum(Prod(Const 2.0, Var "x"), Const 1.0);;val e : expression = Sum (Prod (Const 2., Var "x"), Const 1.)
print_expr e; print_newline ();;2. * x + 1. - : unit = ()
print_expr (deriv e "x"); print_newline ();;2. * 1. + 0. * x + 0. - : unit = ()
All examples given so far were executed under the interactive system. OCaml code can also be compiled separately and executed non-interactively using the batch compilers ocamlc and ocamlopt. The source code must be put in a file with extension .ml. It consists of a sequence of phrases, which will be evaluated at runtime in their order of appearance in the source file. Unlike in interactive mode, types and values are not printed automatically; the program must call printing functions explicitly to produce some output. Here is a sample standalone program to print Fibonacci numbers:
(* File fib.ml *) let rec fib n = if n < 2 then 1 else fib (n-1) + fib (n-2);; let main () = let arg = int_of_string Sys.argv.(1) in print_int (fib arg); print_newline (); exit 0;; main ();;
Sys.argv is an array of strings containing the command-line parameters. Sys.argv.(1) is thus the first command-line parameter. The program above is compiled and executed with the following shell commands:
$ ocamlc -o fib fib.ml $ ./fib 10 89 $ ./fib 20 10946
More complex standalone OCaml programs are typically composed of multiple source files, and can link with precompiled libraries. Chapters 8 and 11 explain how to use the batch compilers ocamlc and ocamlopt. Recompilation of multi-file OCaml projects can be automated using third-party build systems, such as the ocamlbuild compilation manager.
ocaml-doc-4.05/ocaml.html/names.html 0000644 0001750 0001750 00000036562 13131636457 016312 0 ustar mehdi mehdi
Identifiers are used to give names to several classes of language objects and refer to these objects by name later:
These eleven name spaces are distinguished both by the context and by the capitalization of the identifier: whether the first letter of the identifier is in lowercase (written lowercase-ident below) or in uppercase (written capitalized-ident). Underscore is considered a lowercase letter for this purpose.
|
As shown above, prefix and infix symbols as well as some keywords can be used as value names, provided they are written between parentheses. The capitalization rules are summarized in the table below.
| Name space | Case of first letter |
| Values | lowercase |
| Constructors | uppercase |
| Labels | lowercase |
| Polymorphic variant tags | uppercase |
| Exceptions | uppercase |
| Type constructors | lowercase |
| Record fields | lowercase |
| Classes | lowercase |
| Instance variables | lowercase |
| Methods | lowercase |
| Modules | uppercase |
| Module types | any |
Note on polymorphic variant tags: the current implementation accepts lowercase variant tags in addition to capitalized variant tags, but we suggest you avoid lowercase variant tags for portability and compatibility with future OCaml versions.
|
A named object can be referred to either by its name (following the usual static scoping rules for names) or by an access path prefix . name, where prefix designates a module and name is the name of an object defined in that module. The first component of the path, prefix, is either a simple module name or an access path name1 . name2 …, in case the defining module is itself nested inside other modules. For referring to type constructors, module types, or class types, the prefix can also contain simple functor applications (as in the syntactic class extended-module-path above) in case the defining module is the result of a functor application.
Label names, tag names, method names and instance variable names need not be qualified: the former three are global labels, while the latter are local to a class.
ocaml-doc-4.05/ocaml.html/profil.html 0000644 0001750 0001750 00000027634 13131636457 016502 0 ustar mehdi mehdi
This chapter describes how the execution of OCaml programs can be profiled, by recording how many times functions are called, branches of conditionals are taken, …
Before profiling an execution, the program must be compiled in profiling mode, using the ocamlcp front-end to the ocamlc compiler (see chapter 8) or the ocamloptp front-end to the ocamlopt compiler (see chapter 11). When compiling modules separately, ocamlcp or ocamloptp must be used when compiling the modules (production of .cmo or .cmx files), and can also be used (though this is not strictly necessary) when linking them together.
If a module (.ml file) doesn’t have a corresponding interface (.mli file), then compiling it with ocamlcp will produce object files (.cmi and .cmo) that are not compatible with the ones produced by ocamlc, which may lead to problems (if the .cmi or .cmo is still around) when switching between profiling and non-profiling compilations. To avoid this problem, you should always have a .mli file for each .ml file. The same problem exists with ocamloptp.
To make sure your programs can be compiled in profiling mode, avoid using any identifier that begins with __ocaml_prof.
The amount of profiling information can be controlled through the -P option to ocamlcp or ocamloptp, followed by one or several letters indicating which parts of the program should be profiled:
For instance, compiling with ocamlcp -P film profiles function calls, if…then…else…, loops and pattern matching.
Calling ocamlcp or ocamloptp without the -P option defaults to -P fm, meaning that only function calls and pattern matching are profiled.
For compatibility with previous releases, ocamlcp also accepts the -p option, with the same arguments and behaviour as -P.
The ocamlcp and ocamloptp commands also accept all the options of the corresponding ocamlc or ocamlopt compiler, except the -pp (preprocessing) option.
Running an executable that has been compiled with ocamlcp or ocamloptp records the execution counts for the specified parts of the program and saves them in a file called ocamlprof.dump in the current directory.
If the environment variable OCAMLPROF_DUMP is set when the program exits, its value is used as the file name instead of ocamlprof.dump.
The dump file is written only if the program terminates normally (by calling exit or by falling through). It is not written if the program terminates with an uncaught exception.
If a compatible dump file already exists in the current directory, then the profiling information is accumulated in this dump file. This allows, for instance, the profiling of several executions of a program on different inputs. Note that dump files produced by byte-code executables (compiled with ocamlcp) are compatible with the dump files produced by native executables (compiled with ocamloptp).
The ocamlprof command produces a source listing of the program modules where execution counts have been inserted as comments. For instance,
ocamlprof foo.ml
prints the source code for the foo module, with comments indicating how many times the functions in this module have been called. Naturally, this information is accurate only if the source file has not been modified after it was compiled.
The following options are recognized by ocamlprof:
Profiling with ocamlprof only records execution counts, not the actual time spent within each function. There is currently no way to perform time profiling on bytecode programs generated by ocamlc.
Native-code programs generated by ocamlopt can be profiled for time and execution counts using the -p option and the standard Unix profiler gprof. Just add the -p option when compiling and linking the program:
ocamlopt -o myprog -p other-options files
./myprog
gprof myprog
OCaml function names in the output of gprof have the following format:
Module-name_function-name_unique-number
Other functions shown are either parts of the OCaml run-time system or external C functions linked with the program.
The output of gprof is described in the Unix manual page for gprof(1). It generally consists of two parts: a “flat” profile showing the time spent in each function and the number of invocation of each function, and a “hierarchical” profile based on the call graph. Currently, only the Intel x86 ports of ocamlopt under Linux, BSD and MacOS X support the two profiles. On other platforms, gprof will report only the “flat” profile with just time information. When reading the output of gprof, keep in mind that the accumulated times computed by gprof are based on heuristics and may not be exact.
The ocamloptp command also accepts the -p option. In that case, both kinds of profiling are performed by the program, and you can display the results with the gprof and ocamlprof commands, respectively.
ocaml-doc-4.05/ocaml.html/debugger.html 0000644 0001750 0001750 00000127676 13131636457 017002 0 ustar mehdi mehdi
This chapter describes the OCaml source-level replay debugger ocamldebug.
Unix: The debugger is available on Unix systems that provide BSD sockets.
Windows: The debugger is available under the Cygwin port of OCaml, but not under the native Win32 ports.
Before the debugger can be used, the program must be compiled and linked with the -g option: all .cmo and .cma files that are part of the program should have been created with ocamlc -g, and they must be linked together with ocamlc -g.
Compiling with -g entails no penalty on the running time of programs: object files and bytecode executable files are bigger and take longer to produce, but the executable files run at exactly the same speed as if they had been compiled without -g.
The OCaml debugger is invoked by running the program ocamldebug with the name of the bytecode executable file as first argument:
ocamldebug [options] program [arguments]
The arguments following program are optional, and are passed as command-line arguments to the program being debugged. (See also the set arguments command.)
The following command-line options are recognized:
On start-up, the debugger will read commands from an initialization file before giving control to the user. The default file is .ocamldebug in the current directory if it exists, otherwise .ocamldebug in the user’s home directory.
The command quit exits the debugger. You can also exit the debugger by typing an end-of-file character (usually ctrl-D).
Typing an interrupt character (usually ctrl-C) will not exit the debugger, but will terminate the action of any debugger command that is in progress and return to the debugger command level.
A debugger command is a single line of input. It starts with a command name, which is followed by arguments depending on this name. Examples:
run
goto 1000
set arguments arg1 arg2
A command name can be truncated as long as there is no ambiguity. For instance, go 1000 is understood as goto 1000, since there are no other commands whose name starts with go. For the most frequently used commands, ambiguous abbreviations are allowed. For instance, r stands for run even though there are others commands starting with r. You can test the validity of an abbreviation using the help command.
If the previous command has been successful, a blank line (typing just RET) will repeat it.
The OCaml debugger has a simple on-line help system, which gives a brief description of each command and variable.
Events are “interesting” locations in the source code, corresponding to the beginning or end of evaluation of “interesting” sub-expressions. Events are the unit of single-stepping (stepping goes to the next or previous event encountered in the program execution). Also, breakpoints can only be set at events. Thus, events play the role of line numbers in debuggers for conventional languages.
During program execution, a counter is incremented at each event encountered. The value of this counter is referred as the current time. Thanks to reverse execution, it is possible to jump back and forth to any time of the execution.
Here is where the debugger events (written §§) are located in the source code:
(f arg)§§
fun x y z -> §§ ...
function pat1 -> §§ expr1
| ...
| patN -> §§ exprN
expr1; §§ expr2; §§ ...; §§ exprN
if cond then §§ expr1 else §§ expr2
while cond do §§ body done for i = a to b do §§ body done
Exceptions: A function application followed by a function return is replaced by the compiler by a jump (tail-call optimization). In this case, no event is put after the function application.
The debugger starts executing the debugged program only when needed. This allows setting breakpoints or assigning debugger variables before execution starts. There are several ways to start execution:
The execution of a program is affected by certain information it receives when the debugger starts it, such as the command-line arguments to the program and its working directory. The debugger provides commands to specify this information (set arguments and cd). These commands must be used before program execution starts. If you try to change the arguments or the working directory after starting your program, the debugger will kill the program (after asking for confirmation).
The following commands execute the program forward or backward, starting at the current time. The execution will stop either when specified by the command or when a breakpoint is encountered.
You can jump directly to a given time, without stopping on breakpoints, using the goto command.
As you move through the program, the debugger maintains an history of the successive times you stop at. The last command can be used to revisit these times: each last command moves one step back through the history. That is useful mainly to undo commands such as step and next.
A breakpoint causes the program to stop whenever a certain point in the program is reached. It can be set in several ways using the break command. Breakpoints are assigned numbers when set, for further reference. The most comfortable way to set breakpoints is through the Emacs interface (see section 16.10).
Each time the program performs a function application, it saves the location of the application (the return address) in a block of data called a stack frame. The frame also contains the local variables of the caller function. All the frames are allocated in a region of memory called the call stack. The command backtrace (or bt) displays parts of the call stack.
At any time, one of the stack frames is “selected” by the debugger; several debugger commands refer implicitly to the selected frame. In particular, whenever you ask the debugger for the value of a local variable, the value is found in the selected frame. The commands frame, up and down select whichever frame you are interested in.
When the program stops, the debugger automatically selects the currently executing frame and describes it briefly as the frame command does.
The debugger can print the current value of simple expressions. The expressions can involve program variables: all the identifiers that are in scope at the selected program point can be accessed.
Expressions that can be printed are a subset of OCaml expressions, as described by the following grammar:
|
The first two cases refer to a value identifier, either unqualified or qualified by the path to the structure that define it. * refers to the result just computed (typically, the value of a function application), and is valid only if the selected event is an “after” event (typically, a function application). $ integer refer to a previously printed value. The remaining four forms select part of an expression: respectively, a record field, an array element, a string element, and the current contents of a reference.
When printing a complex expression, a name of the form $integer is automatically assigned to its value. Such names are also assigned to parts of the value that cannot be printed because the maximal printing depth is exceeded. Named values can be printed later on with the commands p $integer or d $integer. Named values are valid only as long as the program is stopped. They are forgotten as soon as the program resumes execution.
A shell is used to pass the arguments to the debugged program. You can therefore use wildcards, shell variables, and file redirections inside the arguments. To debug programs that read from standard input, it is recommended to redirect their input from a file (using set arguments < input-file), otherwise input to the program and input to the debugger are not properly separated, and inputs are not properly replayed when running the program backwards.
The loadingmode variable controls how the program is executed.
The debugger searches for source files and compiled interface files in a list of directories, the search path. The search path initially contains the current directory . and the standard library directory. The directory command adds directories to the path.
Whenever the search path is modified, the debugger will clear any information it may have cached about the files.
Each time a program is started in the debugger, it inherits its working directory from the current working directory of the debugger. This working directory is initially whatever it inherited from its parent process (typically the shell), but you can specify a new working directory in the debugger with the cd command or the -cd command-line option.
In some cases, you may want to turn reverse execution off. This speeds up the program execution, and is also sometimes useful for interactive programs.
Normally, the debugger takes checkpoints of the program state from time to time. That is, it makes a copy of the current state of the program (using the Unix system call fork). If the variable checkpoints is set to off, the debugger will not take any checkpoints.
The debugger communicate with the program being debugged through a Unix socket. You may need to change the socket name, for example if you need to run the debugger on a machine and your program on another.
On the debugged program side, the socket name is passed through the CAML_DEBUG_SOCKET environment variable.
Several variables enables to fine-tune the debugger. Reasonable defaults are provided, and you should normally not have to change them.
As checkpointing is quite expensive, it must not be done too often. On the other hand, backward execution is faster when checkpoints are taken more often. In particular, backward single-stepping is more responsive when many checkpoints have been taken just before the current time. To fine-tune the checkpointing strategy, the debugger does not take checkpoints at the same frequency for long displacements (e.g. run) and small ones (e.g. step). The two variables bigstep and smallstep contain the number of events between two checkpoints in each case.
The following commands display information on checkpoints and events:
Just as in the toplevel system (section 9.2), the user can register functions for printing values of certain types. For technical reasons, the debugger cannot call printing functions that reside in the program being debugged. The code for the printing functions must therefore be loaded explicitly in the debugger.
The value path printer-name must refer to one of the functions defined by the object files loaded using load_printer. It cannot reference the functions of the program being debugged.
The most user-friendly way to use the debugger is to run it under Emacs. See the file emacs/README in the distribution for information on how to load the Emacs Lisp files for OCaml support.
The OCaml debugger is started under Emacs by the command M-x camldebug, with argument the name of the executable file progname to debug. Communication with the debugger takes place in an Emacs buffer named *camldebug-progname*. The editing and history facilities of Shell mode are available for interacting with the debugger.
In addition, Emacs displays the source files containing the current event (the current position in the program execution) and highlights the location of the event. This display is updated synchronously with the debugger action.
The following bindings for the most common debugger commands are available in the *camldebug-progname* buffer:
In all buffers in OCaml editing mode, the following debugger commands are also available:
ocaml-doc-4.05/ocaml.html/browser.html 0000644 0001750 0001750 00000002175 13131636457 016663 0 ustar mehdi mehdi
Since OCaml version 4.02, the OCamlBrowser tool and the Labltk library are distributed separately from the OCaml compiler. The project is now hosted at https://forge.ocamlcore.org/projects/labltk/.
ocaml-doc-4.05/ocaml.html/advexamples.html 0000644 0001750 0001750 00000102216 13131636457 017506 0 ustar mehdi mehdi
(Chapter written by Didier Rémy)
In this chapter, we show some larger examples using objects, classes and modules. We review many of the object features simultaneously on the example of a bank account. We show how modules taken from the standard library can be expressed as classes. Lastly, we describe a programming pattern know of as virtual types through the example of window managers.
In this section, we illustrate most aspects of Object and inheritance by refining, debugging, and specializing the following initial naive definition of a simple bank account. (We reuse the module Euro defined at the end of chapter 3.)
let euro = new Euro.c;;val euro : float -> Euro.c = <fun>
let zero = euro 0.;;val zero : Euro.c = <obj>
let neg x = x#times (-1.);;val neg : < times : float -> 'a; .. > -> 'a = <fun>
class account = object val mutable balance = zero method balance = balance method deposit x = balance <- balance # plus x method withdraw x = if x#leq balance then (balance <- balance # plus (neg x); x) else zero end;;class account : object val mutable balance : Euro.c method balance : Euro.c method deposit : Euro.c -> unit method withdraw : Euro.c -> Euro.c end
let c = new account in c # deposit (euro 100.); c # withdraw (euro 50.);;- : Euro.c = <obj>
We now refine this definition with a method to compute interest.
class account_with_interests = object (self) inherit account method private interest = self # deposit (self # balance # times 0.03) end;;class account_with_interests : object val mutable balance : Euro.c method balance : Euro.c method deposit : Euro.c -> unit method private interest : unit method withdraw : Euro.c -> Euro.c end
We make the method interest private, since clearly it should not be called freely from the outside. Here, it is only made accessible to subclasses that will manage monthly or yearly updates of the account.
We should soon fix a bug in the current definition: the deposit method can be used for withdrawing money by depositing negative amounts. We can fix this directly:
class safe_account = object inherit account method deposit x = if zero#leq x then balance <- balance#plus x end;;class safe_account : object val mutable balance : Euro.c method balance : Euro.c method deposit : Euro.c -> unit method withdraw : Euro.c -> Euro.c end
However, the bug might be fixed more safely by the following definition:
class safe_account = object inherit account as unsafe method deposit x = if zero#leq x then unsafe # deposit x else raise (Invalid_argument "deposit") end;;class safe_account : object val mutable balance : Euro.c method balance : Euro.c method deposit : Euro.c -> unit method withdraw : Euro.c -> Euro.c end
In particular, this does not require the knowledge of the implementation of the method deposit.
To keep track of operations, we extend the class with a mutable field history and a private method trace to add an operation in the log. Then each method to be traced is redefined.
type 'a operation = Deposit of 'a | Retrieval of 'a;;type 'a operation = Deposit of 'a | Retrieval of 'a
class account_with_history = object (self) inherit safe_account as super val mutable history = [] method private trace x = history <- x :: history method deposit x = self#trace (Deposit x); super#deposit x method withdraw x = self#trace (Retrieval x); super#withdraw x method history = List.rev history end;;class account_with_history : object val mutable balance : Euro.c val mutable history : Euro.c operation list method balance : Euro.c method deposit : Euro.c -> unit method history : Euro.c operation list method private trace : Euro.c operation -> unit method withdraw : Euro.c -> Euro.c end
One may wish to open an account and simultaneously deposit some initial amount. Although the initial implementation did not address this requirement, it can be achieved by using an initializer.
class account_with_deposit x = object inherit account_with_history initializer balance <- x end;;class account_with_deposit : Euro.c -> object val mutable balance : Euro.c val mutable history : Euro.c operation list method balance : Euro.c method deposit : Euro.c -> unit method history : Euro.c operation list method private trace : Euro.c operation -> unit method withdraw : Euro.c -> Euro.c end
A better alternative is:
class account_with_deposit x = object (self) inherit account_with_history initializer self#deposit x end;;class account_with_deposit : Euro.c -> object val mutable balance : Euro.c val mutable history : Euro.c operation list method balance : Euro.c method deposit : Euro.c -> unit method history : Euro.c operation list method private trace : Euro.c operation -> unit method withdraw : Euro.c -> Euro.c end
Indeed, the latter is safer since the call to deposit will automatically benefit from safety checks and from the trace. Let’s test it:
let ccp = new account_with_deposit (euro 100.) in let _balance = ccp#withdraw (euro 50.) in ccp#history;;- : Euro.c operation list = [Deposit <obj>; Retrieval <obj>]
Closing an account can be done with the following polymorphic function:
let close c = c#withdraw c#balance;;val close : < balance : 'a; withdraw : 'a -> 'b; .. > -> 'b = <fun>
Of course, this applies to all sorts of accounts.
Finally, we gather several versions of the account into a module Account abstracted over some currency.
let today () = (01,01,2000) (* an approximation *) module Account (M:MONEY) = struct type m = M.c let m = new M.c let zero = m 0. class bank = object (self) val mutable balance = zero method balance = balance val mutable history = [] method private trace x = history <- x::history method deposit x = self#trace (Deposit x); if zero#leq x then balance <- balance # plus x else raise (Invalid_argument "deposit") method withdraw x = if x#leq balance then (balance <- balance # plus (neg x); self#trace (Retrieval x); x) else zero method history = List.rev history end class type client_view = object method deposit : m -> unit method history : m operation list method withdraw : m -> m method balance : m end class virtual check_client x = let y = if (m 100.)#leq x then x else raise (Failure "Insufficient initial deposit") in object (self) initializer self#deposit y method virtual deposit: m -> unit end module Client (B : sig class bank : client_view end) = struct class account x : client_view = object inherit B.bank inherit check_client x end let discount x = let c = new account x in if today() < (1998,10,30) then c # deposit (m 100.); c end end;;
This shows the use of modules to group several class definitions that can in fact be thought of as a single unit. This unit would be provided by a bank for both internal and external uses. This is implemented as a functor that abstracts over the currency so that the same code can be used to provide accounts in different currencies.
The class bank is the real implementation of the bank account (it could have been inlined). This is the one that will be used for further extensions, refinements, etc. Conversely, the client will only be given the client view.
module Euro_account = Account(Euro);;
module Client = Euro_account.Client (Euro_account);;
new Client.account (new Euro.c 100.);;
Hence, the clients do not have direct access to the balance, nor the history of their own accounts. Their only way to change their balance is to deposit or withdraw money. It is important to give the clients a class and not just the ability to create accounts (such as the promotional discount account), so that they can personalize their account. For instance, a client may refine the deposit and withdraw methods so as to do his own financial bookkeeping, automatically. On the other hand, the function discount is given as such, with no possibility for further personalization.
It is important to provide the client’s view as a functor Client so that client accounts can still be built after a possible specialization of the bank. The functor Client may remain unchanged and be passed the new definition to initialize a client’s view of the extended account.
module Investment_account (M : MONEY) = struct type m = M.c module A = Account(M) class bank = object inherit A.bank as super method deposit x = if (new M.c 1000.)#leq x then print_string "Would you like to invest?"; super#deposit x end module Client = A.Client end;;
The functor Client may also be redefined when some new features of the account can be given to the client.
module Internet_account (M : MONEY) = struct type m = M.c module A = Account(M) class bank = object inherit A.bank method mail s = print_string s end class type client_view = object method deposit : m -> unit method history : m operation list method withdraw : m -> m method balance : m method mail : string -> unit end module Client (B : sig class bank : client_view end) = struct class account x : client_view = object inherit B.bank inherit A.check_client x end end end;;
One may wonder whether it is possible to treat primitive types such as integers and strings as objects. Although this is usually uninteresting for integers or strings, there may be some situations where this is desirable. The class money above is such an example. We show here how to do it for strings.
A naive definition of strings as objects could be:
class ostring s = object method get n = String.get s n method print = print_string s method escaped = new ostring (String.escaped s) end;;class ostring : string -> object method escaped : ostring method get : int -> char method print : unit end
However, the method escaped returns an object of the class ostring, and not an object of the current class. Hence, if the class is further extended, the method escaped will only return an object of the parent class.
class sub_string s = object inherit ostring s method sub start len = new sub_string (String.sub s start len) end;;class sub_string : string -> object method escaped : ostring method get : int -> char method print : unit method sub : int -> int -> sub_string end
As seen in section 3.16, the solution is to use functional update instead. We need to create an instance variable containing the representation s of the string.
class better_string s = object val repr = s method get n = String.get repr n method print = print_string repr method escaped = {< repr = String.escaped repr >} method sub start len = {< repr = String.sub s start len >} end;;class better_string : string -> object ('a) val repr : string method escaped : 'a method get : int -> char method print : unit method sub : int -> int -> 'a end
As shown in the inferred type, the methods escaped and sub now return objects of the same type as the one of the class.
Another difficulty is the implementation of the method concat. In order to concatenate a string with another string of the same class, one must be able to access the instance variable externally. Thus, a method repr returning s must be defined. Here is the correct definition of strings:
class ostring s = object (self : 'mytype) val repr = s method repr = repr method get n = String.get repr n method print = print_string repr method escaped = {< repr = String.escaped repr >} method sub start len = {< repr = String.sub s start len >} method concat (t : 'mytype) = {< repr = repr ^ t#repr >} end;;class ostring : string -> object ('a) val repr : string method concat : 'a -> 'a method escaped : 'a method get : int -> char method print : unit method repr : string method sub : int -> int -> 'a end
Another constructor of the class string can be defined to return a new string of a given length:
class cstring n = ostring (String.make n ' ');;class cstring : int -> ostring
Here, exposing the representation of strings is probably harmless. We do could also hide the representation of strings as we hid the currency in the class money of section 3.17.
There is sometimes an alternative between using modules or classes for parametric data types. Indeed, there are situations when the two approaches are quite similar. For instance, a stack can be straightforwardly implemented as a class:
exception Empty;;exception Empty
class ['a] stack = object val mutable l = ([] : 'a list) method push x = l <- x::l method pop = match l with [] -> raise Empty | a::l' -> l <- l'; a method clear = l <- [] method length = List.length l end;;class ['a] stack : object val mutable l : 'a list method clear : unit method length : int method pop : 'a method push : 'a -> unit end
However, writing a method for iterating over a stack is more problematic. A method fold would have type ('b -> 'a -> 'b) -> 'b -> 'b. Here 'a is the parameter of the stack. The parameter 'b is not related to the class 'a stack but to the argument that will be passed to the method fold. A naive approach is to make 'b an extra parameter of class stack:
class ['a, 'b] stack2 = object inherit ['a] stack method fold f (x : 'b) = List.fold_left f x l end;;class ['a, 'b] stack2 : object val mutable l : 'a list method clear : unit method fold : ('b -> 'a -> 'b) -> 'b -> 'b method length : int method pop : 'a method push : 'a -> unit end
However, the method fold of a given object can only be applied to functions that all have the same type:
let s = new stack2;;val s : ('_a, '_b) stack2 = <obj>
s#fold ( + ) 0;;- : int = 0
s;;- : (int, int) stack2 = <obj>
A better solution is to use polymorphic methods, which were introduced in OCaml version 3.05. Polymorphic methods makes it possible to treat the type variable 'b in the type of fold as universally quantified, giving fold the polymorphic type Forall 'b. ('b -> 'a -> 'b) -> 'b -> 'b. An explicit type declaration on the method fold is required, since the type checker cannot infer the polymorphic type by itself.
class ['a] stack3 = object inherit ['a] stack method fold : 'b. ('b -> 'a -> 'b) -> 'b -> 'b = fun f x -> List.fold_left f x l end;;class ['a] stack3 : object val mutable l : 'a list method clear : unit method fold : ('b -> 'a -> 'b) -> 'b -> 'b method length : int method pop : 'a method push : 'a -> unit end
A simplified version of object-oriented hash tables should have the following class type.
class type ['a, 'b] hash_table = object method find : 'a -> 'b method add : 'a -> 'b -> unit end;;class type ['a, 'b] hash_table = object method add : 'a -> 'b -> unit method find : 'a -> 'b end
A simple implementation, which is quite reasonable for small hash tables is to use an association list:
class ['a, 'b] small_hashtbl : ['a, 'b] hash_table = object val mutable table = [] method find key = List.assoc key table method add key valeur = table <- (key, valeur) :: table end;;class ['a, 'b] small_hashtbl : ['a, 'b] hash_table
A better implementation, and one that scales up better, is to use a true hash table… whose elements are small hash tables!
class ['a, 'b] hashtbl size : ['a, 'b] hash_table = object (self) val table = Array.init size (fun i -> new small_hashtbl) method private hash key = (Hashtbl.hash key) mod (Array.length table) method find key = table.(self#hash key) # find key method add key = table.(self#hash key) # add key end;;class ['a, 'b] hashtbl : int -> ['a, 'b] hash_table
Implementing sets leads to another difficulty. Indeed, the method union needs to be able to access the internal representation of another object of the same class.
This is another instance of friend functions as seen in section 3.17. Indeed, this is the same mechanism used in the module Set in the absence of objects.
In the object-oriented version of sets, we only need to add an additional method tag to return the representation of a set. Since sets are parametric in the type of elements, the method tag has a parametric type 'a tag, concrete within the module definition but abstract in its signature. From outside, it will then be guaranteed that two objects with a method tag of the same type will share the same representation.
module type SET = sig type 'a tag class ['a] c : object ('b) method is_empty : bool method mem : 'a -> bool method add : 'a -> 'b method union : 'b -> 'b method iter : ('a -> unit) -> unit method tag : 'a tag end end;;
module Set : SET = struct let rec merge l1 l2 = match l1 with [] -> l2 | h1 :: t1 -> match l2 with [] -> l1 | h2 :: t2 -> if h1 < h2 then h1 :: merge t1 l2 else if h1 > h2 then h2 :: merge l1 t2 else merge t1 l2 type 'a tag = 'a list class ['a] c = object (_ : 'b) val repr = ([] : 'a list) method is_empty = (repr = []) method mem x = List.exists (( = ) x) repr method add x = {< repr = merge [x] repr >} method union (s : 'b) = {< repr = merge repr s#tag >} method iter (f : 'a -> unit) = List.iter f repr method tag = repr end end;;
The following example, known as the subject/observer pattern, is often presented in the literature as a difficult inheritance problem with inter-connected classes. The general pattern amounts to the definition a pair of two classes that recursively interact with one another.
The class observer has a distinguished method notify that requires two arguments, a subject and an event to execute an action.
class virtual ['subject, 'event] observer = object method virtual notify : 'subject -> 'event -> unit end;;class virtual ['subject, 'event] observer : object method virtual notify : 'subject -> 'event -> unit end
The class subject remembers a list of observers in an instance variable, and has a distinguished method notify_observers to broadcast the message notify to all observers with a particular event e.
class ['observer, 'event] subject = object (self) val mutable observers = ([]:'observer list) method add_observer obs = observers <- (obs :: observers) method notify_observers (e : 'event) = List.iter (fun x -> x#notify self e) observers end;;class ['a, 'event] subject : object ('b) constraint 'a = < notify : 'b -> 'event -> unit; .. > val mutable observers : 'a list method add_observer : 'a -> unit method notify_observers : 'event -> unit end
The difficulty usually lies in defining instances of the pattern above by inheritance. This can be done in a natural and obvious manner in OCaml, as shown on the following example manipulating windows.
type event = Raise | Resize | Move;;type event = Raise | Resize | Move
let string_of_event = function Raise -> "Raise" | Resize -> "Resize" | Move -> "Move";;val string_of_event : event -> string = <fun>
let count = ref 0;;val count : int ref = {contents = 0}
class ['observer] window_subject = let id = count := succ !count; !count in object (self) inherit ['observer, event] subject val mutable position = 0 method identity = id method move x = position <- position + x; self#notify_observers Move method draw = Printf.printf "{Position = %d}\n" position; end;;class ['a] window_subject : object ('b) constraint 'a = < notify : 'b -> event -> unit; .. > val mutable observers : 'a list val mutable position : int method add_observer : 'a -> unit method draw : unit method identity : int method move : int -> unit method notify_observers : event -> unit end
class ['subject] window_observer = object inherit ['subject, event] observer method notify s e = s#draw end;;class ['a] window_observer : object constraint 'a = < draw : unit; .. > method notify : 'a -> event -> unit end
As can be expected, the type of window is recursive.
let window = new window_subject;;val window : < notify : 'a -> event -> unit; _.. > window_subject as 'a = <obj>
However, the two classes of window_subject and window_observer are not mutually recursive.
let window_observer = new window_observer;;val window_observer : < draw : unit; _.. > window_observer = <obj>
window#add_observer window_observer;;- : unit = ()
window#move 1;;{Position = 1} - : unit = ()
Classes window_observer and window_subject can still be extended by inheritance. For instance, one may enrich the subject with new behaviors and refine the behavior of the observer.
class ['observer] richer_window_subject = object (self) inherit ['observer] window_subject val mutable size = 1 method resize x = size <- size + x; self#notify_observers Resize val mutable top = false method raise = top <- true; self#notify_observers Raise method draw = Printf.printf "{Position = %d; Size = %d}\n" position size; end;;class ['a] richer_window_subject : object ('b) constraint 'a = < notify : 'b -> event -> unit; .. > val mutable observers : 'a list val mutable position : int val mutable size : int val mutable top : bool method add_observer : 'a -> unit method draw : unit method identity : int method move : int -> unit method notify_observers : event -> unit method raise : unit method resize : int -> unit end
class ['subject] richer_window_observer = object inherit ['subject] window_observer as super method notify s e = if e <> Raise then s#raise; super#notify s e end;;class ['a] richer_window_observer : object constraint 'a = < draw : unit; raise : unit; .. > method notify : 'a -> event -> unit end
We can also create a different kind of observer:
class ['subject] trace_observer = object inherit ['subject, event] observer method notify s e = Printf.printf "<Window %d <== %s>\n" s#identity (string_of_event e) end;;class ['a] trace_observer : object constraint 'a = < identity : int; .. > method notify : 'a -> event -> unit end
and attach several observers to the same object:
let window = new richer_window_subject;;val window : < notify : 'a -> event -> unit; _.. > richer_window_subject as 'a = <obj>
window#add_observer (new richer_window_observer);;- : unit = ()
window#add_observer (new trace_observer);;- : unit = ()
window#move 1; window#resize 2;;<Window 1 <== Move> <Window 1 <== Raise> {Position = 1; Size = 1} {Position = 1; Size = 1} <Window 1 <== Resize> <Window 1 <== Raise> {Position = 1; Size = 3} {Position = 1; Size = 3} - : unit = ()
ocaml-doc-4.05/ocaml.html/extn.html 0000644 0001750 0001750 00000560627 13131636457 016171 0 ustar mehdi mehdi
This chapter describes language extensions and convenience features that are implemented in OCaml, but not described in the OCaml reference manual.
(Introduced in Objective Caml 3.07)
|
An integer literal can be followed by one of the letters l, L or n to indicate that this integer has type int32, int64 or nativeint respectively, instead of the default type int for integer literals. The library modules Int32[Int32], Int64[Int64] and Nativeint[Nativeint] provide operations on these integer types.
(Introduced in Objective Caml 1.00)
As mentioned in section 6.7.1, the let rec binding construct, in addition to the definition of recursive functions, also supports a certain class of recursive definitions of non-functional values, such as
which binds name1 to the cyclic list 1::2::1::2::…, and name2 to the cyclic list 2::1::2::1::…Informally, the class of accepted definitions consists of those definitions where the defined names occur only inside function bodies or as argument to a data constructor.
More precisely, consider the expression:
It will be accepted if each one of expr1 … exprn is statically constructive with respect to name1 … namen, is not immediately linked to any of name1 … namen, and is not an array constructor whose arguments have abstract type.
An expression e is said to be statically constructive with respect to the variables name1 … namen if at least one of the following conditions is true:
An expression e is said to be immediately linked to the variable name in the following cases:
(Introduced in Objective Caml 3.11)
|
The pattern lazy pattern matches a value v of type Lazy.t, provided pattern matches the result of forcing v with Lazy.force. A successful match of a pattern containing lazy sub-patterns forces the corresponding parts of the value being matched, even those that imply no test such as lazy value-name or lazy _. Matching a value with a pattern-matching where some patterns contain lazy sub-patterns may imply forcing parts of the value, even when the pattern selected in the end has no lazy sub-pattern.
For more information, see the description of module Lazy in the standard library ( Module Lazy).
(Introduced in Objective Caml 3.07)
|
Recursive module definitions, introduced by the module rec …and … construction, generalize regular module definitions module module-name = module-expr and module specifications module module-name : module-type by allowing the defining module-expr and the module-type to refer recursively to the module identifiers being defined. A typical example of a recursive module definition is:
module rec A : sig
type t = Leaf of string | Node of ASet.t
val compare: t -> t -> int
end
= struct
type t = Leaf of string | Node of ASet.t
let compare t1 t2 =
match (t1, t2) with
(Leaf s1, Leaf s2) -> Pervasives.compare s1 s2
| (Leaf _, Node _) -> 1
| (Node _, Leaf _) -> -1
| (Node n1, Node n2) -> ASet.compare n1 n2
end
and ASet : Set.S with type elt = A.t
= Set.Make(A)
It can be given the following specification:
module rec A : sig
type t = Leaf of string | Node of ASet.t
val compare: t -> t -> int
end
and ASet : Set.S with type elt = A.t
This is an experimental extension of OCaml: the class of recursive definitions accepted, as well as its dynamic semantics are not final and subject to change in future releases.
Currently, the compiler requires that all dependency cycles between the recursively-defined module identifiers go through at least one “safe” module. A module is “safe” if all value definitions that it contains have function types typexpr1 -> typexpr2. Evaluation of a recursive module definition proceeds by building initial values for the safe modules involved, binding all (functional) values to fun _ -> raise Undefined_recursive_module. The defining module expressions are then evaluated, and the initial values for the safe modules are replaced by the values thus computed. If a function component of a safe module is applied during this computation (which corresponds to an ill-founded recursive definition), the Undefined_recursive_module exception is raised.
Note that, in the specification case, the module-types must be parenthesized if they use the with mod-constraint construct.
Private type declarations in module signatures, of the form type t = private ..., enable libraries to reveal some, but not all aspects of the implementation of a type to clients of the library. In this respect, they strike a middle ground between abstract type declarations, where no information is revealed on the type implementation, and data type definitions and type abbreviations, where all aspects of the type implementation are publicized. Private type declarations come in three flavors: for variant and record types (section 7.5.1), for type abbreviations (section 7.5.2), and for row types (section 7.5.3).
(Introduced in Objective Caml 3.07)
|
Values of a variant or record type declared private can be de-structured normally in pattern-matching or via the expr . field notation for record accesses. However, values of these types cannot be constructed directly by constructor application or record construction. Moreover, assignment on a mutable field of a private record type is not allowed.
The typical use of private types is in the export signature of a module, to ensure that construction of values of the private type always go through the functions provided by the module, while still allowing pattern-matching outside the defining module. For example:
module M : sig
type t = private A | B of int
val a : t
val b : int -> t
end
= struct
type t = A | B of int
let a = A
let b n = assert (n > 0); B n
end
Here, the private declaration ensures that in any value of type M.t, the argument to the B constructor is always a positive integer.
With respect to the variance of their parameters, private types are handled like abstract types. That is, if a private type has parameters, their variance is the one explicitly given by prefixing the parameter by a ‘+’ or a ‘-’, it is invariant otherwise.
(Introduced in Objective Caml 3.11)
|
Unlike a regular type abbreviation, a private type abbreviation declares a type that is distinct from its implementation type typexpr. However, coercions from the type to typexpr are permitted. Moreover, the compiler “knows” the implementation type and can take advantage of this knowledge to perform type-directed optimizations. For ambiguity reasons, typexpr cannot be an object or polymorphic variant type, but a similar behaviour can be obtained through private row types.
The following example uses a private type abbreviation to define a module of nonnegative integers:
module N : sig
type t = private int
val of_int: int -> t
val to_int: t -> int
end
= struct
type t = int
let of_int n = assert (n >= 0); n
let to_int n = n
end
The type N.t is incompatible with int, ensuring that nonnegative integers and regular integers are not confused. However, if x has type N.t, the coercion (x :> int) is legal and returns the underlying integer, just like N.to_int x. Deep coercions are also supported: if l has type N.t list, the coercion (l :> int list) returns the list of underlying integers, like List.map N.to_int l but without copying the list l.
Note that the coercion ( expr :> typexpr ) is actually an abbreviated form, and will only work in presence of private abbreviations if neither the type of expr nor typexpr contain any type variables. If they do, you must use the full form ( expr : typexpr1 :> typexpr2 ) where typexpr1 is the expected type of expr. Concretely, this would be (x : N.t :> int) and (l : N.t list :> int list) for the above examples.
(Introduced in Objective Caml 3.09)
|
Private row types are type abbreviations where part of the structure of the type is left abstract. Concretely typexpr in the above should denote either an object type or a polymorphic variant type, with some possibility of refinement left. If the private declaration is used in an interface, the corresponding implementation may either provide a ground instance, or a refined private type.
module M : sig type c = private < x : int; .. > val o : c end =
struct
class c = object method x = 3 method y = 2 end
let o = new c
end
This declaration does more than hiding the y method, it also makes the type c incompatible with any other closed object type, meaning that only o will be of type c. In that respect it behaves similarly to private record types. But private row types are more flexible with respect to incremental refinement. This feature can be used in combination with functors.
module F(X : sig type c = private < x : int; .. > end) =
struct
let get_x (o : X.c) = o#x
end
module G(X : sig type c = private < x : int; y : int; .. > end) =
struct
include F(X)
let get_y (o : X.c) = o#y
end
A polymorphic variant type [t], for example
type t = [ `A of int | `B of bool ]
can be refined in two ways. A definition [u] may add new field to [t], and the declaration
type u = private [> t]
will keep those new fields abstract. Construction of values of type [u] is possible using the known variants of [t], but any pattern-matching will require a default case to handle the potential extra fields. Dually, a declaration [u] may restrict the fields of [t] through abstraction: the declaration
type v = private [< t > `A]
corresponds to private variant types. One cannot create a value of the private type [v], except using the constructors that are explicitly listed as present, (`A n) in this example; yet, when patter-matching on a [v], one should assume that any of the constructors of [t] could be present.
Similarly to abstract types, the variance of type parameters is not inferred, and must be given explicitly.
(Introduced in OCaml 3.12, extended to patterns in 4.04)
|
The expressions let open module-path in expr and module-path.( expr) are strictly equivalent. On the pattern side, only the pattern module-path.( pattern) is available. These constructions locally open the module referred to by the module path module-path in the respective scope of the expression expr or pattern pattern.
Restricting opening to the scope of a single expression or pattern instead of a whole structure allows one to benefit from shorter syntax to refer to components of the opened module, without polluting the global scope. Also, this can make the code easier to read (the open statement is closer to where it is used) and to refactor (because the code fragment is more self-contained).
(Introduced in OCaml 4.02)
|
When the body of a local open expression or pattern is delimited by [ ], [| |], or { }, the parentheses can be omitted. For expression, parentheses can also be omitted for {< >}. For example, module-path.[ expr] is equivalent to module-path.([ expr]), and module-path.[| pattern |] is equivalent to module-path.([| pattern |]).
(Introduced in OCaml 3.12, object copy notation added in Ocaml 4.03)
|
In a record pattern, a record construction expression or an object copy expression, a single identifier id stands for id = id, and a qualified identifier module-path . id stands for module-path . id = id. For example, assuming the record type
type point = { x: float; y: float }
has been declared, the following expressions are equivalent:
let x = 1. and y = 2. in { x = x; y = y },
let x = 1. and y = 2. in { x; y },
let x = 1. and y = 2. in { x = x; y }
On the object side, all following methods are equivalent:
object
val x=0. val y=0. val z=0.
method f_0 x y = {< x; y >}
method f_1 x y = {< x = x; y >}
method f_2 x y = {< x=x ; y = y >}
end
Likewise, the following functions are equivalent:
fun {x = x; y = y} -> x +. y
fun {x; y} -> x +. y
Optionally, a record pattern can be terminated by ; _ to convey the fact that not all fields of the record type are listed in the record pattern and that it is intentional. By default, the compiler ignores the ; _ annotation. If warning 9 is turned on, the compiler will warn when a record pattern fails to list all fields of the corresponding record type and is not terminated by ; _. Continuing the point example above,
fun {x} -> x +. 1.
will warn if warning 9 is on, while
fun {x; _} -> x +. 1.
will not warn. This warning can help spot program points where record patterns may need to be modified after new fields are added to a record type.
(Introduced in OCaml 3.12)
|
Polymorphic type annotations in let-definitions behave in a way similar to polymorphic methods: they explicitly require the defined value to be polymorphic, and allow one to use this polymorphism in recursive occurrences (when using let rec). Note however that this is a normal polymorphic type, unifiable with any instance of itself.
There are two possible applications of this feature. One is polymorphic recursion:
type 'a t = Leaf of 'a | Node of ('a * 'a) t
let rec depth : 'a. 'a t -> 'b = function
Leaf _ -> 1
| Node x -> 1 + depth x
Note that 'b is not explicitly polymorphic here, and it will actually be unified with int.
The other application is to ensure that some definition is sufficiently polymorphic:
let id: 'a. 'a -> 'a = fun x -> x + 1;;Error: This definition has type int -> int which is less general than 'a. 'a -> 'a
(Introduced in OCaml 3.12, short syntax added in 4.03)
|
The expression fun ( type typeconstr-name ) -> expr introduces a type constructor named typeconstr-name which is considered abstract in the scope of the sub-expression, but then replaced by a fresh type variable. Note that contrary to what the syntax could suggest, the expression fun ( type typeconstr-name ) -> expr itself does not suspend the evaluation of expr as a regular abstraction would. The syntax has been chosen to fit nicely in the context of function declarations, where it is generally used. It is possible to freely mix regular function parameters with pseudo type parameters, as in:
let f = fun (type t) (foo : t list) -> ...
and even use the alternative syntax for declaring functions:
let f (type t) (foo : t list) = ...
If several locally abstract types need to be introduced, it is possible to use the syntax fun ( type typeconstr-name1 … typeconstr-namen ) -> expr as syntactic sugar for fun ( type typeconstr-name1 ) -> … -> fun ( type typeconstr-namen ) -> expr. For instance,
let f = fun (type t u v) -> fun (foo : (t * u * v) list) -> ...
let f' (type t u v) (foo : (t * u * v) list) = ...
This construction is useful because the type constructors it introduces can be used in places where a type variable is not allowed. For instance, one can use it to define an exception in a local module within a polymorphic function.
let f (type t) () =
let module M = struct exception E of t end in
(fun x -> M.E x), (function M.E x -> Some x | _ -> None)
Here is another example:
let sort_uniq (type s) (cmp : s -> s -> int) =
let module S = Set.Make(struct type t = s let compare = cmp end) in
fun l ->
S.elements (List.fold_right S.add l S.empty)
It is also extremely useful for first-class modules (see section 7.10) and generalized algebraic datatypes (GADTs: see section 7.16).
(Introduced in OCaml 4.00)
|
The (type typeconstr-name) syntax construction by itself does not make polymorphic the type variable it introduces, but it can be combined with explicit polymorphic annotations where needed. The above rule is provided as syntactic sugar to make this easier:
let rec f : type t1 t2. t1 * t2 list -> t1 = ...
is automatically expanded into
let rec f : 't1 't2. 't1 * 't2 list -> 't1 =
fun (type t1) (type t2) -> (... : t1 * t2 list -> t1)
This syntax can be very useful when defining recursive functions involving GADTs, see the section 7.16 for a more detailed explanation.
The same feature is provided for method definitions. The method! form combines this extension with the “explicit overriding” extension described in section 7.14.
(Introduced in OCaml 3.12; pattern syntax and package type inference introduced in 4.00; structural comparison of package types introduced in 4.02.; fewer parens required starting from 4.05)
|
Modules are typically thought of as static components. This extension makes it possible to pack a module as a first-class value, which can later be dynamically unpacked into a module.
The expression ( module module-expr : package-type ) converts the module (structure or functor) denoted by module expression module-expr to a value of the core language that encapsulates this module. The type of this core language value is ( module package-type ). The package-type annotation can be omitted if it can be inferred from the context.
Conversely, the module expression ( val expr : package-type ) evaluates the core language expression expr to a value, which must have type module package-type, and extracts the module that was encapsulated in this value. Again package-type can be omitted if the type of expr is known. If the module expression is already parenthesized, like the arguments of functors are, no additional parens are needed: Map.Make(val key).
The pattern ( module module-name : package-type ) matches a package with type package-type and binds it to module-name. It is not allowed in toplevel let bindings. Again package-type can be omitted if it can be inferred from the enclosing pattern.
The package-type syntactic class appearing in the ( module package-type ) type expression and in the annotated forms represents a subset of module types. This subset consists of named module types with optional constraints of a limited form: only non-parametrized types can be specified.
For type-checking purposes (and starting from OCaml 4.02), package types are compared using the structural comparison of module types.
In general, the module expression ( val expr : package-type ) cannot be used in the body of a functor, because this could cause unsoundness in conjunction with applicative functors. Since OCaml 4.02, this is relaxed in two ways: if package-type does not contain nominal type declarations (i.e. types that are created with a proper identity), then this expression can be used anywhere, and even if it contains such types it can be used inside the body of a generative functor, described in section 7.23. It can also be used anywhere in the context of a local module binding let module module-name = ( val expr1 : package-type ) in expr2.
A typical use of first-class modules is to select at run-time among several implementations of a signature. Each implementation is a structure that we can encapsulate as a first-class module, then store in a data structure such as a hash table:
module type DEVICE = sig ... end
let devices : (string, (module DEVICE)) Hashtbl.t = Hashtbl.create 17
module SVG = struct ... end
let _ = Hashtbl.add devices "SVG" (module SVG : DEVICE)
module PDF = struct ... end
let _ = Hashtbl.add devices "PDF" (module PDF: DEVICE)
We can then select one implementation based on command-line arguments, for instance:
module Device =
(val (try Hashtbl.find devices (parse_cmdline())
with Not_found -> eprintf "Unknown device %s\n"; exit 2)
: DEVICE)
Alternatively, the selection can be performed within a function:
let draw_using_device device_name picture =
let module Device =
(val (Hashtbl.find_devices device_name) : DEVICE)
in
Device.draw picture
With first-class modules, it is possible to parametrize some code over the implementation of a module without using a functor.
let sort (type s) (module Set : Set.S with type elt = s) l =
Set.elements (List.fold_right Set.add l Set.empty)
val sort : (module Set.S with type elt = 'a) -> 'a list -> 'a list
To use this function, one can wrap the Set.Make functor:
let make_set (type s) cmp =
let module S = Set.Make(struct
type t = s
let compare = cmp
end) in
(module S : Set.S with type elt = s)
val make_set : ('a -> 'a -> int) -> (module Set.S with type elt = 'a)
(Introduced in OCaml 3.12)
|
The construction module type of module-expr expands to the module type (signature or functor type) inferred for the module expression module-expr. To make this module type reusable in many situations, it is intentionally not strengthened: abstract types and datatypes are not explicitly related with the types of the original module. For the same reason, module aliases in the inferred type are expanded.
A typical use, in conjunction with the signature-level include construct, is to extend the signature of an existing structure. In that case, one wants to keep the types equal to types in the original module. This can done using the following idiom.
module type MYHASH = sig
include module type of struct include Hashtbl end
val replace: ('a, 'b) t -> 'a -> 'b -> unit
end
The signature MYHASH then contains all the fields of the signature of the module Hashtbl (with strengthened type definitions), plus the new field replace. An implementation of this signature can be obtained easily by using the include construct again, but this time at the structure level:
module MyHash : MYHASH = struct
include Hashtbl
let replace t k v = remove t k; add t k v
end
Another application where the absence of strengthening comes handy, is to provide an alternative implementation for an existing module.
module MySet : module type of Set = struct
...
end
This idiom guarantees that Myset is compatible with Set, but allows it to represent sets internally in a different way.
(Introduced in OCaml 3.12)
|
“Destructive” substitution (with ... := ...) behaves essentially like normal signature constraints (with ... = ...), but it additionally removes the redefined type or module from the signature. There are a number of restrictions: one can only remove types and modules at the outermost level (not inside submodules), and in the case of with type the definition must be another type constructor with the same type parameters.
A natural application of destructive substitution is merging two signatures sharing a type name.
module type Printable = sig type t val print : Format.formatter -> t -> unit end module type Comparable = sig type t val compare : t -> t -> int end module type PrintableComparable = sig include Printable include Comparable with type t := t end;;
One can also use this to completely remove a field:
module type S = Comparable with type t := int;;module type S = sig val compare : int -> int -> int end
or to rename one:
module type S = sig type u include Comparable with type t := u end;;module type S = sig type u val compare : u -> u -> int end
Note that you can also remove manifest types, by substituting with the same type.
module type ComparableInt = Comparable with type t = int ;;module type ComparableInt = sig type t = int val compare : t -> t -> int end
module type CompareInt = ComparableInt with type t := int ;;module type CompareInt = sig val compare : int -> int -> int end
(Introduced in OCaml 4.02)
|
The above specification, inside a signature, only matches a module definition equal to module-path. Conversely, a type-level module alias can be matched by itself, or by any supertype of the type of the module it references.
There are several restrictions on module-path:
Such specifications are also inferred. Namely, when P is a path satisfying the above constraints,
module N = P;;
has type
module N = P
Type-level module aliases are used when checking module path equalities. That is, in a context where module name N is known to be an alias for P, not only these two module paths check as equal, but F (N) and F (P) are also recognized as equal. In the default compilation mode, this is the only difference with the previous approach of module aliases having just the same module type as the module they reference.
When the compiler flag -no-alias-deps is enabled, type-level module aliases are also exploited to avoid introducing dependencies between compilation units. Namely, a module alias referring to a module inside another compilation unit does not introduce a link-time dependency on that compilation unit, as long as it is not dereferenced; it still introduces a compile-time dependency if the interface needs to be read, i.e. if the module is a submodule of the compilation unit, or if some type components are referred to. Additionally, accessing a module alias introduces a link-time dependency on the compilation unit containing the module referenced by the alias, rather than the compilation unit containing the alias. Note that these differences in link-time behavior may be incompatible with the previous behavior, as some compilation units might not be extracted from libraries, and their side-effects ignored.
These weakened dependencies make possible to use module aliases in place of the -pack mechanism. Suppose that you have a library Mylib composed of modules A and B. Using -pack, one would issue the command line
ocamlc -pack a.cmo b.cmo -o mylib.cmo
and as a result obtain a Mylib compilation unit, containing physically A and B as submodules, and with no dependencies on their respective compilation units. Here is a concrete example of a possible alternative approach:
module A = Mylib_A
module B = Mylib_B
ocamlc -c -no-alias-deps Mylib.ml
ocamlc -c -no-alias-deps -open Mylib Mylib_*.mli Mylib_*.ml
ocamlc -a Mylib*.cmo -o Mylib.cma
This approach lets you access A and B directly inside the library, and as Mylib.A and Mylib.B from outside. It also has the advantage that Mylib is no longer monolithic: if you use Mylib.A, only Mylib_A will be linked in, not Mylib_B.
(Introduced in OCaml 3.12)
|
The keywords inherit!, val! and method! have the same semantics as inherit, val and method, but they additionally require the definition they introduce to be an overriding. Namely, method! requires method-name to be already defined in this class, val! requires inst-var-name to be already defined in this class, and inherit! requires class-expr to override some definitions. If no such overriding occurs, an error is signaled.
As a side-effect, these 3 keywords avoid the warnings 7 (method override) and 13 (instance variable override). Note that warning 7 is disabled by default.
(Introduced in OCaml 4.01)
|
Since OCaml 4.01, open statements shadowing an existing identifier (which is later used) trigger the warning 44. Adding a ! character after the open keyword indicates that such a shadowing is intentional and should not trigger the warning.
(Introduced in OCaml 4.00)
|
Generalized algebraic datatypes, or GADTs, extend usual sum types in two ways: constraints on type parameters may change depending on the value constructor, and some type variables may be existentially quantified. Adding constraints is done by giving an explicit return type (the rightmost typexpr in the above syntax), where type parameters are instantiated. This return type must use the same type constructor as the type being defined, and have the same number of parameters. Variables are made existential when they appear inside a constructor’s argument, but not in its return type.
Since the use of a return type often eliminates the need to name type parameters in the left-hand side of a type definition, one can replace them with anonymous types _ in that case.
The constraints associated to each constructor can be recovered through pattern-matching. Namely, if the type of the scrutinee of a pattern-matching contains a locally abstract type, this type can be refined according to the constructor used. These extra constraints are only valid inside the corresponding branch of the pattern-matching. If a constructor has some existential variables, fresh locally abstract types are generated, and they must not escape the scope of this branch.
Here is a concrete example:
type _ term =
| Int : int -> int term
| Add : (int -> int -> int) term
| App : ('b -> 'a) term * 'b term -> 'a term
let rec eval : type a. a term -> a = function
| Int n -> n (* a = int *)
| Add -> (fun x y -> x+y) (* a = int -> int -> int *)
| App(f,x) -> (eval f) (eval x)
(* eval called at types (b->a) and b for fresh b *)
let two = eval (App (App (Add, Int 1), Int 1))
val two : int = 2
It is important to remark that the function eval is using the polymorphic syntax for locally abstract types. When defining a recursive function that manipulates a GADT, explicit polymorphic recursion should generally be used. For instance, the following definition fails with a type error:
let rec eval (type a) : a term -> a = function
| Int n -> n
| Add -> (fun x y -> x+y)
| App(f,x) -> (eval f) (eval x)
(* ^
Error: This expression has type ($App_'b -> a) term but an expression was
expected of type 'a
The type constructor $App_'b would escape its scope
*)
In absence of an explicit polymorphic annotation, a monomorphic type is inferred for the recursive function. If a recursive call occurs inside the function definition at a type that involves an existential GADT type variable, this variable flows to the type of the recursive function, and thus escapes its scope. In the above example, this happens in the branch App(f,x) when eval is called with f as an argument. In this branch, the type of f is ($App_ 'b-> a). The prefix $ in $App_ 'b denotes an existential type named by the compiler (see 7.16). Since the type of eval is 'a term -> 'a, the call eval f makes the existential type $App_'b flow to the type variable 'a and escape its scope. This triggers the above error.
Type inference for GADTs is notoriously hard. This is due to the fact some types may become ambiguous when escaping from a branch. For instance, in the Int case above, n could have either type int or a, and they are not equivalent outside of that branch. As a first approximation, type inference will always work if a pattern-matching is annotated with types containing no free type variables (both on the scrutinee and the return type). This is the case in the above example, thanks to the type annotation containing only locally abstract types.
In practice, type inference is a bit more clever than that: type annotations do not need to be immediately on the pattern-matching, and the types do not have to be always closed. As a result, it is usually enough to only annotate functions, as in the example above. Type annotations are propagated in two ways: for the scrutinee, they follow the flow of type inference, in a way similar to polymorphic methods; for the return type, they follow the structure of the program, they are split on functions, propagated to all branches of a pattern matching, and go through tuples, records, and sum types. Moreover, the notion of ambiguity used is stronger: a type is only seen as ambiguous if it was mixed with incompatible types (equated by constraints), without type annotations between them. For instance, the following program types correctly.
let rec sum : type a. a term -> _ = fun x ->
let y =
match x with
| Int n -> n
| Add -> 0
| App(f,x) -> sum f + sum x
in y + 1
val sum : 'a term -> int = <fun>
Here the return type int is never mixed with a, so it is seen as non-ambiguous, and can be inferred. When using such partial type annotations we strongly suggest specifying the -principal mode, to check that inference is principal.
The exhaustiveness check is aware of GADT constraints, and can automatically infer that some cases cannot happen. For instance, the following pattern matching is correctly seen as exhaustive (the Add case cannot happen).
let get_int : int term -> int = function
| Int n -> n
| App(_,_) -> 0
(Introduced in OCaml 4.03)
Usually, the exhaustiveness check only tries to check whether the cases omitted from the pattern matching are typable or not. However, you can force it to try harder by adding refutation cases:
|
In presence of a refutation case, the exhaustiveness check will first compute the intersection of the pattern with the complement of the cases preceding it. It then checks whether the resulting patterns can really match any concrete values by trying to type-check them. Wild cards in the generated patterns are handled in a special way: if their type is a variant type with only GADT constructors, then the pattern is split into the different constructors, in order to check whether any of them is possible (this splitting is not done for arguments of these constructors, to avoid non-termination.) We also split tuples and variant types with only one case, since they may contain GADTs inside. For instance, the following code is deemed exhaustive:
type _ t =
| Int : int t
| Bool : bool t
let deep : (char t * int) option -> char = function
| None -> 'c'
| _ -> .
Namely, the inferred remaining case is Some _, which is split into Some (Int, _) and Some (Bool, _), which are both untypable. Note that the refutation case could be omitted here, because it is automatically added when there is only one case in the pattern matching.
Another addition is that the redundancy check is now aware of GADTs: a case will be detected as redundant if it could be replaced by a refutation case using the same pattern.
The term type we have defined above is an indexed type, where a type parameter reflects a property of the value contents. Another use of GADTs is singleton types, where a GADT value represents exactly one type. This value can be used as runtime representation for this type, and a function receiving it can have a polytypic behavior.
Here is an example of a polymorphic function that takes the runtime representation of some type t and a value of the same type, then pretty-prints the value as a string:
type _ typ =
| Int : int typ
| String : string typ
| Pair : 'a typ * 'b typ -> ('a * 'b) typ
let rec to_string: type t. t typ -> t -> string =
fun t x ->
match t with
| Int -> string_of_int x
| String -> Printf.sprintf "%S" x
| Pair(t1,t2) ->
let (x1, x2) = x in
Printf.sprintf "(%s,%s)" (to_string t1 x1) (to_string t2 x2)
Another frequent application of GADTs is equality witnesses.
type (_,_) eq = Eq : ('a,'a) eq
let cast : type a b. (a,b) eq -> a -> b = fun Eq x -> x
Here type eq has only one constructor, and by matching on it one adds a local constraint allowing the conversion between a and b. By building such equality witnesses, one can make equal types which are syntactically different.
Here is an example using both singleton types and equality witnesses to implement dynamic types.
let rec eq_type : type a b. a typ -> b typ -> (a,b) eq option =
fun a b ->
match a, b with
| Int, Int -> Some Eq
| String, String -> Some Eq
| Pair(a1,a2), Pair(b1,b2) ->
begin match eq_type a1 b1, eq_type a2 b2 with
| Some Eq, Some Eq -> Some Eq
| _ -> None
end
| _ -> None
type dyn = Dyn : 'a typ * 'a -> dyn
let get_dyn : type a. a typ -> dyn -> a option =
fun a (Dyn(b,x)) ->
match eq_type a b with
| None -> None
| Some Eq -> Some x
The typing of pattern matching in presence of GADT can generate many existential types. When necessary, error messages refer to these existential types using compiler-generated names. Currently, the compiler generates these names according to the following nomenclature:
type any = Any : 'name -> any let escape (Any x) = x;;Error: This expression has type $Any_'name but an expression was expected of type 'a The type constructor $Any_'name would escape its scope
type any = Any : _ -> any let escape (Any x) = x;;Error: This expression has type $Any but an expression was expected of type 'a The type constructor $Any would escape its scope
type ('arg,'result,'aux) fn = | Fun: ('a ->'b) -> ('a,'b,unit) fn | Mem1: ('a ->'b) * 'a * 'b -> ('a, 'b, 'a * 'b) fn let apply: ('arg,'result, _ ) fn -> 'arg -> 'result = fun f x -> match f with | Fun f -> f x | Mem1 (f,y,fy) -> if x = y then fy else f x;;Error: This pattern matches values of type ($'arg, 'result, $'arg * 'result) fn but a pattern was expected which matches values of type ($'arg, 'result, unit) fn The type constructor $'arg would escape its scope
As shown by the last item, the current behavior is imperfect and may be improved in future versions.
(Introduced in OCaml 4.04)
GADT pattern-matching may also add type equations to non-local abstract types. The behaviour is the same as with local abstract types. Reusing the above eq type, one can write:
module M : sig type t val x : t val e : (t,int) eq end = struct
type t = int
let x = 33
let e = Eq
end
let x : int = let Eq = M.e in M.x
Of course, not all abstract types can be refined, as this would contradict the exhaustiveness check. Namely, builtin types (those defined by the compiler itself, such as int or array), and abstract types defined by the local module, are non-instantiable, and as such cause a type error rather than introduce an equation.
(Introduced in Objective Caml 3.00)
|
This extension provides syntactic sugar for getting and setting elements in the arrays provided by the Bigarray[Bigarray] library.
The short expressions are translated into calls to functions of the Bigarray module as described in the following table.
| expression | translation |
| expr0.{ expr1} | Bigarray.Array1.get expr0 expr1 |
| expr0.{ expr1} <- expr | Bigarray.Array1.set expr0 expr1 expr |
| expr0.{ expr1, expr2} | Bigarray.Array2.get expr0 expr1 expr2 |
| expr0.{ expr1, expr2} <- expr | Bigarray.Array2.set expr0 expr1 expr2 expr |
| expr0.{ expr1, expr2, expr3} | Bigarray.Array3.get expr0 expr1 expr2 expr3 |
| expr0.{ expr1, expr2, expr3} <- expr | Bigarray.Array3.set expr0 expr1 expr2 expr3 expr |
| expr0.{ expr1, …, exprn} | Bigarray.Genarray.get expr0 [| expr1, … , exprn |] |
| expr0.{ expr1, …, exprn} <- expr | Bigarray.Genarray.set expr0 [| expr1, … , exprn |] expr |
The last two entries are valid for any n > 3.
(Introduced in OCaml 4.02, infix notations for constructs other than expressions added in 4.03)
Attributes are “decorations” of the syntax tree which are mostly ignored by the type-checker but can be used by external tools. An attribute is made of an identifier and a payload, which can be a structure, a type expression (prefixed with :), a signature (prefixed with :) or a pattern (prefixed with ?) optionally followed by a when clause:
|
The first form of attributes is attached with a postfix notation on “algebraic” categories:
|
This form of attributes can also be inserted after the `tag-name in polymorphic variant type expressions (tag-spec-first, tag-spec, tag-spec-full) or after the method-name in method-type.
The same syntactic form is also used to attach attributes to labels and constructors in type declarations:
|
Note: when a label declaration is followed by a semi-colon, attributes can also be put after the semi-colon (in which case they are merged to those specified before).
The second form of attributes are attached to “blocks” such as type declarations, class fields, etc:
A third form of attributes appears as stand-alone structure or signature items in the module or class sub-languages. They are not attached to any specific node in the syntax tree:
|
(Note: contrary to what the grammar above describes, item-attributes cannot be attached to these floating attributes in class-field-spec and class-field.)
It is also possible to specify attributes using an infix syntax. For instance:
let[@foo] x = 2 in x + 1 === (let x = 2 [@@foo] in x + 1) begin[@foo][@bar x] ... end === (begin ... end)[@foo][@@bar x] module[@foo] M = ... === module M = ... [@@foo] type[@foo] t = T === type t = T [@@foo] method[@foo] m = ... === method m = ... [@@foo]
For let, the attributes are applied to each bindings:
let[@foo] x = 2 and y = 3 in x + y === (let x = 2 [@@foo] and y = 3 in x + y) let[@foo] x = 2 and[@bar] y = 3 in x + y === (let x = 2 [@@foo] and y = 3 [@bar] in x + y)
Some attributes are understood by the type-checker:
module X = struct [@@@warning "+9"] (* locally enable warning 9 in this structure *) ... end [@@deprecated "Please use module 'Y' instead."] let x = begin[@warning "+9"] ... end in .... type t = A | B [@@deprecated "Please use type 's' instead."] let f x = assert (x >= 0) [@ppwarning "TODO: remove this later"]; let rec no_op = function | [] -> () | _ :: q -> (no_op[@tailcall]) q;; let f x = x [@@inline] let () = (f[@inlined]) () type fragile = | Int of int [@warn_on_literal_pattern] | String of string [@warn_on_literal_pattern] let f = function | Int 0 | String "constant" -> () (* trigger warning 52 *) | _ -> () module Immediate: sig type t [@@immediate] val x: t ref end = struct type t = A | B let x = ref 0 end ....
(Introduced in OCaml 4.02, infix notations for constructs other than expressions added in 4.03, infix notation (e1 ;%ext e2) added in 4.04. )
Extension nodes are generic placeholders in the syntax tree. They are rejected by the type-checker and are intended to be “expanded” by external tools such as -ppx rewriters.
Extension nodes share the same notion of identifier and payload as attributes 7.18.
The first form of extension node is used for “algebraic” categories:
|
A second form of extension node can be used in structures and signatures, both in the module and object languages:
|
An infix form is available for extension nodes when the payload is of the same kind (expression with expression, pattern with pattern ...).
Examples:
let%foo x = 2 in x + 1 === [%foo let x = 2 in x + 1] begin%foo ... end === [%foo begin ... end] x ;%foo 2 === [%foo x; 2] module%foo M = .. === [%%foo module M = ... ] val%foo x : t === [%%foo: val x : t]
When this form is used together with the infix syntax for attributes, the attributes are considered to apply to the payload:
fun%foo[@bar] x -> x + 1 === [%foo (fun x -> x + 1)[@foo ] ];
(Introduced in OCaml 4.03)
Some extension nodes are understood by the compiler itself:
type t = .. type t += X of int | Y of string let x = [%extension_constructor X] let y = [%extension_constructor Y];;
x <> y;;- : bool = true
(Introduced in OCaml 4.02)
Quoted strings {foo|...|foo} provide a different lexical syntax to write string literals in OCaml code. They are useful to represent strings of arbitrary content without escaping – as long as the delimiter you chose (here |foo}) does not occur in the string itself.
|
The opening delimiter has the form {id| where id is a (possibly empty) sequence of lowercase letters and underscores. The corresponding closing delimiter is |id} (with the same identifier). Unlike regular OCaml string literals, quoted strings do not interpret any character in a special way.
Example:
String.length {|\"|} (* returns 2 *)
String.length {foo|\"|foo} (* returns 2 *)
Quoted strings are interesting in particular in conjunction to extension nodes [%foo ...] (see 7.19) to embed foreign syntax fragments to be interpreted by a preprocessor and turned into OCaml code: you can use [%sql {|...|}] for example to represent arbitrary SQL statements – assuming you have a ppx-rewriter that recognizes the %sql extension – without requiring escaping quotes.
Note that the non-extension form, for example {sql|...|sql}, should not be used for this purpose, as the user cannot see in the code that this string literal has a different semantics than they expect, and giving a semantics to a specific delimiter limits the freedom to change the delimiter to avoid escaping issues.
(Introduced in OCaml 4.02)
A new form of exception patterns is allowed, only as a toplevel pattern under a match...with pattern-matching (other occurrences are rejected by the type-checker).
|
Cases with such a toplevel pattern are called “exception cases”, as opposed to regular “value cases”. Exception cases are applied when the evaluation of the matched expression raises an exception. The exception value is then matched against all the exception cases and re-raised if none of them accept the exception (as for a try...with block). Since the bodies of all exception and value cases is outside the scope of the exception handler, they are all considered to be in tail-position: if the match...with block itself is in tail position in the current function, any function call in tail position in one of the case bodies results in an actual tail call.
It is an error if all cases are exception cases in a given pattern matching.
(Introduced in OCaml 4.02)
|
Extensible variant types are variant types which can be extended with new variant constructors. Extensible variant types are defined using ... New variant constructors are added using +=.
type attr = ..
type attr += Str of string
type attr +=
| Int of int
| Float of float
Pattern matching on an extensible variant type requires a default case to handle unknown variant constructors:
let to_string = function
| Str s -> s
| Int i -> string_of_int i
| Float f -> string_of_float f
| _ -> "?"
A preexisting example of an extensible variant type is the built-in exn type used for exceptions. Indeed, exception constructors can be declared using the type extension syntax:
type exn += Exc of int
Extensible variant constructors can be rebound to a different name. This allows exporting variants from another module.
type Expr.attr += Str = Expr.Str
Extensible variant constructors can be declared private. As with regular variants, this prevents them from being constructed directly by constructor application while still allowing them to be de-structured in pattern-matching.
(Introduced in OCaml 4.02)
|
A generative functor takes a unit () argument. In order to use it, one must necessarily apply it to this unit argument, ensuring that all type components in the result of the functor behave in a generative way, i.e. they are different from types obtained by other applications of the same functor. This is equivalent to taking an argument of signature sig end, and always applying to struct end, but not to some defined module (in the latter case, applying twice to the same module would return identical types).
As a side-effect of this generativity, one is allowed to unpack first-class modules in the body of generative functors.
(Introduced in OCaml 4.02.2, extended in 4.03)
Some syntactic constructions are accepted during parsing and rejected during type checking. These syntactic constructions can therefore not be used directly in vanilla OCaml. However, -ppx rewriters and other external tools can exploit this parser leniency to extend the language with these new syntactic constructions by rewriting them to vanilla constructions.
|
Operator names starting with a # character and containing more than one # character are reserved for extensions.
|
Int and float literals followed by an one-letter identifier in the range [g..z∣ G..Z] are extension-only literals.
|
The arguments of a sum-type constructors can now be defined using the same syntax as records. Mutable and polymorphic fields are allowed. GADT syntax is supported. Attributes can be specified on individual fields.
Syntactically, building or matching constructors with such an inline record argument is similar to working with a unary constructor whose unique argument is a declared record type. A pattern can bind the inline record as a pseudo-value, but the record cannot escape the scope of the binding and can only be used with the dot-notation to extract or modify fields or to build new constructor values.
type t =
| Point of {width: int; mutable x: float; mutable y: float}
| ...
let v = Point {width = 10; x = 0.; y = 0.}
let scale l = function
| Point p -> Point {p with x = l *. p.x; y = l *. p.y}
| ....
let print = function
| Point {x; y; _} -> Printf.printf "%f/%f" x y
| ....
let reset = function
| Point p -> p.x <- 0.; p.y <- 0.
| ...
let invalid = function
| Point p -> p (* INVALID *)
| ...
(Introduced in OCaml 4.04)
It is possible to define local exceptions in expressions:
|
The syntactic scope of the exception constructor is the inner expression, but nothing prevents exception values created with this constructor from escaping this scope. Two executions of the definition above result in two incompatible exception constructors (as for any exception definition).
(Introduced in OCaml 4.03)
Comments which start with ** are treated specially by the compiler. They are automatically converted during parsing into attributes (see 7.18) to allow tools to process them as documentation.
Such comments can take three forms: floating comments, item comments and label comments. Any comment starting with ** which does not match one of these forms will cause the compiler to emit warning 50.
Comments which start with ** are also used by the ocamldoc documentation generator (see 15). The three comment forms recognised by the compiler are a subset of the forms accepted by ocamldoc (see 15.2).
Comments surrounded by blank lines that appear within structures, signatures, classes or class types are converted into floating-attributes. For example:
type t = T (** Now some definitions for [t] *) let mkT = T
will be converted to:
type t = T [@@@ocaml.text " Now some definitions for [t] "] let mkT = T
Comments which appear immediately before or immediately after a structure item, signature item, class item or class type item are converted into item-attributes. Immediately before or immediately after means that there must be no blank lines, ;;, or other documentation comments between them. For example:
type t = T (** A description of [t] *)
or
(** A description of [t] *) type t = T
will be converted to:
type t = T [@@ocaml.doc " A description of [t] "]
Note that, if a comment appears immediately next to multiple items, as in:
type t = T (** An ambiguous comment *) type s = S
then it will be attached to both items:
type t = T [@@ocaml.doc " An ambiguous comment "] type s = S [@@ocaml.doc " An ambiguous comment "]
and the compiler will emit warning 50.
Comments which appear immediately after a labelled argument, record field, variant constructor, object method or polymorphic variant constructor are are converted into attributes. Immediately after means that there must be no blank lines or other documentation comments between them. For example:
type t1 = lbl:int (** Labelled argument *) -> unit
type t2 = {
fld: int; (** Record field *)
fld2: float;
}
type t3 =
| Cstr of string (** Variant constructor *)
| Cstr2 of string
type t4 = < meth: int * int; (** Object method *) >
type t5 = [
`PCstr (** Polymorphic variant constructor *)
]
will be converted to:
type t1 = lbl:(int [@ocaml.doc " Labelled argument "]) -> unit
type t2 = {
fld: int [@ocaml.doc " Record field "];
fld2: float;
}
type t3 =
| Cstr of string [@ocaml.doc " Variant constructor "]
| Cstr2 of string
type t4 = < meth : int * int [@ocaml.doc " Object method "] >
type t5 = [
`PCstr [@ocaml.doc " Polymorphic variant constructor "]
]
Note that label comments take precedence over item comments, so:
type t = T of string (** Attaches to T not t *)
will be converted to:
type t = T of string [@ocaml.doc " Attaches to T not t "]
whilst:
type t = T of string (** Attaches to T not t *) (** Attaches to t *)
will be converted to:
type t = T of string [@ocaml.doc " Attaches to T not t "] [@@ocaml.doc " Attaches to t "]
In the absence of meaningful comment on the last constructor of a type, an empty comment (**) can be used instead:
type t = T of string (**) (** Attaches to t *)
will be converted directly to
type t = T of string [@@ocaml.doc " Attaches to t "]
ocaml-doc-4.05/ocaml.html/manual001.html 0000644 0001750 0001750 00000112004 13131636457 016667 0 ustar mehdi mehdi
ocaml-doc-4.05/ocaml.html/modules.html 0000644 0001750 0001750 00000056713 13131636457 016657 0 ustar mehdi mehdi
Module expressions are the module-level equivalent of value expressions: they evaluate to modules, thus providing implementations for the specifications expressed in module types.
|
See also the following language extensions: recursive modules, first-class modules, overriding in open statements, attributes, extension nodes and generative functors.
The expression module-path evaluates to the module bound to the name module-path.
The expression ( module-expr ) evaluates to the same module as module-expr.
The expression ( module-expr : module-type ) checks that the type of module-expr is a subtype of module-type, that is, that all components specified in module-type are implemented in module-expr, and their implementation meets the requirements given in module-type. In other terms, it checks that the implementation module-expr meets the type specification module-type. The whole expression evaluates to the same module as module-expr, except that all components not specified in module-type are hidden and can no longer be accessed.
Structures struct … end are collections of definitions for value names, type names, exceptions, module names and module type names. The definitions are evaluated in the order in which they appear in the structure. The scopes of the bindings performed by the definitions extend to the end of the structure. As a consequence, a definition may refer to names bound by earlier definitions in the same structure.
For compatibility with toplevel phrases (chapter 9), optional ;; are allowed after and before each definition in a structure. These ;; have no semantic meanings. Similarly, an expr preceded by ;; is allowed as a component of a structure. It is equivalent to let _ = expr, i.e. expr is evaluated for its side-effects but is not bound to any identifier. If expr is the first component of a structure, the preceding ;; can be omitted.
A value definition let [rec] let-binding { and let-binding } bind value names in the same way as a let … in … expression (see section 6.7.1). The value names appearing in the left-hand sides of the bindings are bound to the corresponding values in the right-hand sides.
A value definition external value-name : typexpr = external-declaration implements value-name as the external function specified in external-declaration (see chapter 19).
A definition of one or several type components is written type typedef { and typedef } and consists of a sequence of mutually recursive definitions of type names.
Exceptions are defined with the syntax exception constr-decl or exception constr-name = constr.
A definition of one or several classes is written class class-binding { and class-binding } and consists of a sequence of mutually recursive definitions of class names. Class definitions are described more precisely in section 6.9.3.
A definition of one or several classes is written class type classtype-def { and classtype-def } and consists of a sequence of mutually recursive definitions of class type names. Class type definitions are described more precisely in section 6.9.5.
The basic form for defining a module component is module module-name = module-expr, which evaluates module-expr and binds the result to the name module-name.
One can write
instead of
Another derived form is
which is equivalent to
A definition for a module type is written module type modtype-name = module-type. It binds the name modtype-name to the module type denoted by the expression module-type.
The expression open module-path in a structure does not define any components nor perform any bindings. It simply affects the parsing of the following items of the structure, allowing components of the module denoted by module-path to be referred to by their simple names name instead of path accesses module-path . name. The scope of the open stops at the end of the structure expression.
The expression include module-expr in a structure re-exports in the current structure all definitions of the structure denoted by module-expr. For instance, if the identifier S is bound to the module
struct type t = int let x = 2 end
the module expression
struct include S let y = (x + 1 : t) end
is equivalent to the module expression
struct type t = S.t let x = S.x let y = (x + 1 : t) end
The difference between open and include is that open simply provides short names for the components of the opened structure, without defining any components of the current structure, while include also adds definitions for the components of the included structure.
The expression functor ( module-name : module-type ) -> module-expr evaluates to a functor that takes as argument modules of the type module-type1, binds module-name to these modules, evaluates module-expr in the extended environment, and returns the resulting modules as results. No restrictions are placed on the type of the functor argument; in particular, a functor may take another functor as argument (“higher-order” functor).
The expression module-expr1 ( module-expr2 ) evaluates module-expr1 to a functor and module-expr2 to a module, and applies the former to the latter. The type of module-expr2 must match the type expected for the arguments of the functor module-expr1.
ocaml-doc-4.05/ocaml.html/libnum.html 0000644 0001750 0001750 00000004631 13131636457 016465 0 ustar mehdi mehdi
The num library implements integer arithmetic and rational arithmetic in arbitrary precision.
More documentation on the functions provided in this library can be found in The CAML Numbers Reference Manual by Valérie Ménissier-Morain, technical report 141, INRIA, july 1992 (available electronically, http://hal.inria.fr/docs/00/07/00/27/PDF/RT-0141.pdf).
Programs that use the num library must be linked as follows:
ocamlc other options nums.cma other files
ocamlopt other options nums.cmxa other files
For interactive use of the nums library, do:
ocamlmktop -o mytop nums.cma
./mytop
or (if dynamic linking of C libraries is supported on your platform), start ocaml and type #load "nums.cma";;.
ocaml-doc-4.05/ocaml.html/lex.html 0000644 0001750 0001750 00000066206 13131636457 015775 0 ustar mehdi mehdi
The following characters are considered as blanks: space, horizontal tabulation, carriage return, line feed and form feed. Blanks are ignored, but they separate adjacent identifiers, literals and keywords that would otherwise be confused as one single identifier, literal or keyword.
Comments are introduced by the two characters (*, with no intervening blanks, and terminated by the characters *), with no intervening blanks. Comments are treated as blank characters. Comments do not occur inside string or character literals. Nested comments are handled correctly.
|
Identifiers are sequences of letters, digits, _ (the underscore character), and ' (the single quote), starting with a letter or an underscore. Letters contain at least the 52 lowercase and uppercase letters from the ASCII set. The current implementation also recognizes as letters some characters from the ISO 8859-1 set (characters 192–214 and 216–222 as uppercase letters; characters 223–246 and 248–255 as lowercase letters). This feature is deprecated and should be avoided for future compatibility.
All characters in an identifier are meaningful. The current implementation accepts identifiers up to 16000000 characters in length.
In many places, OCaml makes a distinction between capitalized identifiers and identifiers that begin with a lowercase letter. The underscore character is considered a lowercase letter for this purpose.
|
An integer literal is a sequence of one or more digits, optionally preceded by a minus sign. By default, integer literals are in decimal (radix 10). The following prefixes select a different radix:
| Prefix | Radix |
| 0x, 0X | hexadecimal (radix 16) |
| 0o, 0O | octal (radix 8) |
| 0b, 0B | binary (radix 2) |
(The initial 0 is the digit zero; the O for octal is the letter O.) The interpretation of integer literals that fall outside the range of representable integer values is undefined.
For convenience and readability, underscore characters (_) are accepted (and ignored) within integer literals.
|
Floating-point decimal literals consist in an integer part, a fractional part and an exponent part. The integer part is a sequence of one or more digits, optionally preceded by a minus sign. The fractional part is a decimal point followed by zero, one or more digits. The exponent part is the character e or E followed by an optional + or - sign, followed by one or more digits. It is interpreted as a power of 10. The fractional part or the exponent part can be omitted but not both, to avoid ambiguity with integer literals. The interpretation of floating-point literals that fall outside the range of representable floating-point values is undefined.
Floating-point hexadecimal literals are denoted with the 0x or 0X prefix. The syntax is similar to that of floating-point decimal literals, with the following differences. The integer part and the fractional part use hexadecimal digits. The exponent part starts with the character p or P. It is written in decimal and interpreted as a power of 2.
For convenience and readability, underscore characters (_) are accepted (and ignored) within floating-point literals.
|
Character literals are delimited by ' (single quote) characters. The two single quotes enclose either one character different from ' and \, or one of the escape sequences below:
| Sequence | Character denoted |
| \\ | backslash (\) |
| \" | double quote (") |
| \' | single quote (') |
| \n | linefeed (LF) |
| \r | carriage return (CR) |
| \t | horizontal tabulation (TAB) |
| \b | backspace (BS) |
| \space | space (SPC) |
| \ddd | the character with ASCII code ddd in decimal |
| \xhh | the character with ASCII code hh in hexadecimal |
| \oooo | the character with ASCII code ooo in octal |
|
String literals are delimited by " (double quote) characters. The two double quotes enclose a sequence of either characters different from " and \, or escape sequences from the table given above for character literals.
To allow splitting long string literals across lines, the sequence \newline spaces-or-tabs (a backslash at the end of a line followed by any number of spaces and horizontal tabulations at the beginning of the next line) is ignored inside string literals.
The current implementation places practically no restrictions on the length of string literals.
To avoid ambiguities, naming labels in expressions cannot just be defined syntactically as the sequence of the three tokens ~, ident and :, and have to be defined at the lexical level.
|
Naming labels come in two flavours: label for normal arguments and optlabel for optional ones. They are simply distinguished by their first character, either ~ or ?.
Despite label and optlabel being lexical entities in expressions, their expansions ~ label-name : and ? label-name : will be used in grammars, for the sake of readability. Note also that inside type expressions, this expansion can be taken literally, i.e. there are really 3 tokens, with optional blanks between them.
|
See also the following language extension: extension operators.
Sequences of “operator characters”, such as <=> or !!, are read as a single token from the infix-symbol or prefix-symbol class. These symbols are parsed as prefix and infix operators inside expressions, but otherwise behave like normal identifiers.
The identifiers below are reserved as keywords, and cannot be employed otherwise:
and as assert asr begin class
constraint do done downto else end
exception external false for fun function
functor if in include inherit initializer
land lazy let lor lsl lsr
lxor match method mod module mutable
new nonrec object of open or
private rec sig struct then to
true try type val virtual when
while with
The following character sequences are also keywords:
!= # & && ' ( ) * + , - -. -> . .. : :: := :> ; ;; < <- = > >] >} ? [ [< [> [| ] _ ` { {< | |] || } ~
Note that the following identifiers are keywords of the Camlp4 extensions and should be avoided for compatibility reasons.
parser value $ $$ $: <: << >> ??
Lexical ambiguities are resolved according to the “longest match” rule: when a character sequence can be decomposed into two tokens in several different ways, the decomposition retained is the one with the longest first token.
|
Preprocessors that generate OCaml source code can insert line number directives in their output so that error messages produced by the compiler contain line numbers and file names referring to the source file before preprocessing, instead of after preprocessing. A line number directive is composed of a # (sharp sign), followed by a positive integer (the source line number), optionally followed by a character string (the source file name). Line number directives are treated as blanks during lexical analysis.
ocaml-doc-4.05/ocaml.html/lexyacc.html 0000644 0001750 0001750 00000125557 13131636457 016642 0 ustar mehdi mehdi
This chapter describes two program generators: ocamllex, that produces a lexical analyzer from a set of regular expressions with associated semantic actions, and ocamlyacc, that produces a parser from a grammar with associated semantic actions.
These program generators are very close to the well-known lex and yacc commands that can be found in most C programming environments. This chapter assumes a working knowledge of lex and yacc: while it describes the input syntax for ocamllex and ocamlyacc and the main differences with lex and yacc, it does not explain the basics of writing a lexer or parser description in lex and yacc. Readers unfamiliar with lex and yacc are referred to “Compilers: principles, techniques, and tools” by Aho, Sethi and Ullman (Addison-Wesley, 1986), or “Lex & Yacc”, by Levine, Mason and Brown (O’Reilly, 1992).
The ocamllex command produces a lexical analyzer from a set of regular expressions with attached semantic actions, in the style of lex. Assuming the input file is lexer.mll, executing
ocamllex lexer.mll
produces OCaml code for a lexical analyzer in file lexer.ml. This file defines one lexing function per entry point in the lexer definition. These functions have the same names as the entry points. Lexing functions take as argument a lexer buffer, and return the semantic attribute of the corresponding entry point.
Lexer buffers are an abstract data type implemented in the standard library module Lexing. The functions Lexing.from_channel, Lexing.from_string and Lexing.from_function create lexer buffers that read from an input channel, a character string, or any reading function, respectively. (See the description of module Lexing in chapter 24.)
When used in conjunction with a parser generated by ocamlyacc, the semantic actions compute a value belonging to the type token defined by the generated parsing module. (See the description of ocamlyacc below.)
The following command-line options are recognized by ocamllex.
The format of lexer definitions is as follows:
{ header }
let ident = regexp …
[refill { refill-handler }]
rule entrypoint [arg1… argn] =
parse regexp { action }
| …
| regexp { action }
and entrypoint [arg1… argn] =
parse …
and …
{ trailer }
Comments are delimited by (* and *), as in OCaml. The parse keyword, can be replaced by the shortest keyword, with the semantic consequences explained below.
Refill handlers are a recent (optional) feature introduced in 4.02, documented below in subsection 12.2.7.
The header and trailer sections are arbitrary OCaml text enclosed in curly braces. Either or both can be omitted. If present, the header text is copied as is at the beginning of the output file and the trailer text at the end. Typically, the header section contains the open directives required by the actions, and possibly some auxiliary functions used in the actions.
Between the header and the entry points, one can give names to frequently-occurring regular expressions. This is written let ident = regexp. In regular expressions that follow this declaration, the identifier ident can be used as shorthand for regexp.
The names of the entry points must be valid identifiers for OCaml values (starting with a lowercase letter). Similarily, the arguments arg1… argn must be valid identifiers for OCaml. Each entry point becomes an OCaml function that takes n+1 arguments, the extra implicit last argument being of type Lexing.lexbuf. Characters are read from the Lexing.lexbuf argument and matched against the regular expressions provided in the rule, until a prefix of the input matches one of the rule. The corresponding action is then evaluated and returned as the result of the function.
If several regular expressions match a prefix of the input, the “longest match” rule applies: the regular expression that matches the longest prefix of the input is selected. In case of tie, the regular expression that occurs earlier in the rule is selected.
However, if lexer rules are introduced with the shortest keyword in place of the parse keyword, then the “shortest match” rule applies: the shortest prefix of the input is selected. In case of tie, the regular expression that occurs earlier in the rule is still selected. This feature is not intended for use in ordinary lexical analyzers, it may facilitate the use of ocamllex as a simple text processing tool.
The regular expressions are in the style of lex, with a more OCaml-like syntax.
|
Concerning the precedences of operators, # has the highest precedence, followed by *, + and ?, then concatenation, then | (alternation), then as.
The actions are arbitrary OCaml expressions. They are evaluated in a context where the identifiers defined by using the as construct are bound to subparts of the matched string. Additionally, lexbuf is bound to the current lexer buffer. Some typical uses for lexbuf, in conjunction with the operations on lexer buffers provided by the Lexing standard library module, are listed below.
The as construct is similar to “groups” as provided by numerous regular expression packages. The type of these variables can be string, char, string option or char option.
We first consider the case of linear patterns, that is the case when all as bound variables are distinct. In regexp as ident, the type of ident normally is string (or string option) except when regexp is a character constant, an underscore, a string constant of length one, a character set specification, or an alternation of those. Then, the type of ident is char (or char option). Option types are introduced when overall rule matching does not imply matching of the bound sub-pattern. This is in particular the case of ( regexp as ident ) ? and of regexp1 | ( regexp2 as ident ).
There is no linearity restriction over as bound variables. When a variable is bound more than once, the previous rules are to be extended as follows:
For instance, in ('a' as x) | ( 'a' (_ as x) ) the variable x is of type char, whereas in ("ab" as x) | ( 'a' (_ as x) ? ) the variable x is of type string option.
In some cases, a successful match may not yield a unique set of bindings.
For instance the matching of aba by the regular expression
(('a'|"ab") as x) (("ba"|'a') as y) may result in binding
either
x to "ab" and y to "a", or
x to "a" and y to "ba".
The automata produced ocamllex on such ambiguous regular
expressions will select one of the possible resulting sets of
bindings.
The selected set of bindings is purposely left unspecified.
By default, when ocamllex reaches the end of its lexing buffer, it will silently call the refill_buff function of lexbuf structure and continue lexing. It is sometimes useful to be able to take control of refilling action; typically, if you use a library for asynchronous computation, you may want to wrap the refilling action in a delaying function to avoid blocking synchronous operations.
Since OCaml 4.02, it is possible to specify a refill-handler, a function that will be called when refill happens. It is passed the continuation of the lexing, on which it has total control. The OCaml expression used as refill action should have a type that is an instance of
(Lexing.lexbuf -> 'a) -> Lexing.lexbuf -> 'a
where the first argument is the continuation which captures the processing ocamllex would usually perform (refilling the buffer, then calling the lexing function again), and the result type that instantiates [’a] should unify with the result type of all lexing rules.
As an example, consider the following lexer that is parametrized over an arbitrary monad:
{
type token = EOL | INT of int | PLUS
module Make (M : sig
type 'a t
val return: 'a -> 'a t
val bind: 'a t -> ('a -> 'b t) -> 'b t
val fail : string -> 'a t
(* Set up lexbuf *)
val on_refill : Lexing.lexbuf -> unit t
end)
= struct
let refill_handler k lexbuf =
M.bind (M.on_refill lexbuf) (fun () -> k lexbuf)
}
refill {refill_handler}
rule token = parse
| [' ' '\t']
{ token lexbuf }
| '\n'
{ M.return EOL }
| ['0'-'9']+ as i
{ M.return (INT (int_of_string i)) }
| '+'
{ M.return PLUS }
| _
{ M.fail "unexpected character" }
{
end
}
All identifiers starting with __ocaml_lex are reserved for use by ocamllex; do not use any such identifier in your programs.
The ocamlyacc command produces a parser from a context-free grammar specification with attached semantic actions, in the style of yacc. Assuming the input file is grammar.mly, executing
ocamlyacc options grammar.mly
produces OCaml code for a parser in the file grammar.ml, and its interface in file grammar.mli.
The generated module defines one parsing function per entry point in the grammar. These functions have the same names as the entry points. Parsing functions take as arguments a lexical analyzer (a function from lexer buffers to tokens) and a lexer buffer, and return the semantic attribute of the corresponding entry point. Lexical analyzer functions are usually generated from a lexer specification by the ocamllex program. Lexer buffers are an abstract data type implemented in the standard library module Lexing. Tokens are values from the concrete type token, defined in the interface file grammar.mli produced by ocamlyacc.
Grammar definitions have the following format:
%{
header
%}
declarations
%%
rules
%%
trailer
Comments are enclosed between /* and */ (as in C) in the
“declarations” and “rules” sections, and between (* and
*) (as in OCaml) in the “header” and “trailer” sections.
The header and the trailer sections are OCaml code that is copied as is into file grammar.ml. Both sections are optional. The header goes at the beginning of the output file; it usually contains open directives and auxiliary functions required by the semantic actions of the rules. The trailer goes at the end of the output file.
Declarations are given one per line. They all start with a % sign.
open directives (e.g. open Modname) were given in the
header section. That’s because the header is copied only to the .ml
output file, but not to the .mli output file, while the typexpr part
of a %token declaration is copied to both.%type directive below.-s option is in effect). The typexpr part is an arbitrary OCaml
type expression, except that all type constructor names must be
fully qualified, as explained above for %token.Associate precedences and associativities to the given symbols. All
symbols on the same line are given the same precedence. They have
higher precedence than symbols declared before in a %left,
%right or %nonassoc line. They have lower precedence
than symbols declared after in a %left, %right or
%nonassoc line. The symbols are declared to associate to the
left (%left), to the right (%right), or to be
non-associative (%nonassoc). The symbols are usually tokens.
They can also be dummy nonterminals, for use with the %prec
directive inside the rules.
The precedence declarations are used in the following way to resolve reduce/reduce and shift/reduce conflicts:
The syntax for rules is as usual:
nonterminal : symbol … symbol { semantic-action } | … | symbol … symbol { semantic-action } ;
Rules can also contain the %prec symbol directive in the
right-hand side part, to override the default precedence and
associativity of the rule with the precedence and associativity of the
given symbol.
Semantic actions are arbitrary OCaml expressions, that
are evaluated to produce the semantic attribute attached to
the defined nonterminal. The semantic actions can access the
semantic attributes of the symbols in the right-hand side of
the rule with the $ notation: $1 is the attribute for the
first (leftmost) symbol, $2 is the attribute for the second
symbol, etc.
The rules may contain the special symbol error to indicate resynchronization points, as in yacc.
Actions occurring in the middle of rules are not supported.
Nonterminal symbols are like regular OCaml symbols, except that they cannot end with ' (single quote).
Error recovery is supported as follows: when the parser reaches an error state (no grammar rules can apply), it calls a function named parse_error with the string "syntax error" as argument. The default parse_error function does nothing and returns, thus initiating error recovery (see below). The user can define a customized parse_error function in the header section of the grammar file.
The parser also enters error recovery mode if one of the grammar actions raises the Parsing.Parse_error exception.
In error recovery mode, the parser discards states from the stack until it reaches a place where the error token can be shifted. It then discards tokens from the input until it finds three successive tokens that can be accepted, and starts processing with the first of these. If no state can be uncovered where the error token can be shifted, then the parser aborts by raising the Parsing.Parse_error exception.
Refer to documentation on yacc for more details and guidance in how to use error recovery.
The ocamlyacc command recognizes the following options:
At run-time, the ocamlyacc-generated parser can be debugged by setting the p option in the OCAMLRUNPARAM environment variable (see section 10.2). This causes the pushdown automaton executing the parser to print a trace of its action (tokens shifted, rules reduced, etc). The trace mentions rule numbers and state numbers that can be interpreted by looking at the file grammar.output generated by ocamlyacc -v.
The all-time favorite: a desk calculator. This program reads arithmetic expressions on standard input, one per line, and prints their values. Here is the grammar definition:
/* File parser.mly */
%token <int> INT
%token PLUS MINUS TIMES DIV
%token LPAREN RPAREN
%token EOL
%left PLUS MINUS /* lowest precedence */
%left TIMES DIV /* medium precedence */
%nonassoc UMINUS /* highest precedence */
%start main /* the entry point */
%type <int> main
%%
main:
expr EOL { $1 }
;
expr:
INT { $1 }
| LPAREN expr RPAREN { $2 }
| expr PLUS expr { $1 + $3 }
| expr MINUS expr { $1 - $3 }
| expr TIMES expr { $1 * $3 }
| expr DIV expr { $1 / $3 }
| MINUS expr %prec UMINUS { - $2 }
;
Here is the definition for the corresponding lexer:
(* File lexer.mll *)
{
open Parser (* The type token is defined in parser.mli *)
exception Eof
}
rule token = parse
[' ' '\t'] { token lexbuf } (* skip blanks *)
| ['\n' ] { EOL }
| ['0'-'9']+ as lxm { INT(int_of_string lxm) }
| '+' { PLUS }
| '-' { MINUS }
| '*' { TIMES }
| '/' { DIV }
| '(' { LPAREN }
| ')' { RPAREN }
| eof { raise Eof }
Here is the main program, that combines the parser with the lexer:
(* File calc.ml *)
let _ =
try
let lexbuf = Lexing.from_channel stdin in
while true do
let result = Parser.main Lexer.token lexbuf in
print_int result; print_newline(); flush stdout
done
with Lexer.Eof ->
exit 0
To compile everything, execute:
ocamllex lexer.mll # generates lexer.ml
ocamlyacc parser.mly # generates parser.ml and parser.mli
ocamlc -c parser.mli
ocamlc -c lexer.ml
ocamlc -c parser.ml
ocamlc -c calc.ml
ocamlc -o calc lexer.cmo parser.cmo calc.cmo
The deterministic automata generated by ocamllex are limited to at most 32767 transitions. The message above indicates that your lexer definition is too complex and overflows this limit. This is commonly caused by lexer definitions that have separate rules for each of the alphabetic keywords of the language, as in the following example.
rule token = parse
"keyword1" { KWD1 }
| "keyword2" { KWD2 }
| ...
| "keyword100" { KWD100 }
| ['A'-'Z' 'a'-'z'] ['A'-'Z' 'a'-'z' '0'-'9' '_'] * as id
{ IDENT id}
To keep the generated automata small, rewrite those definitions with only one general “identifier” rule, followed by a hashtable lookup to separate keywords from identifiers:
{ let keyword_table = Hashtbl.create 53
let _ =
List.iter (fun (kwd, tok) -> Hashtbl.add keyword_table kwd tok)
[ "keyword1", KWD1;
"keyword2", KWD2; ...
"keyword100", KWD100 ]
}
rule token = parse
['A'-'Z' 'a'-'z'] ['A'-'Z' 'a'-'z' '0'-'9' '_'] * as id
{ try
Hashtbl.find keyword_table id
with Not_found ->
IDENT id }
ocaml-doc-4.05/ocaml.html/intfc.html 0000644 0001750 0001750 00000421734 13131636457 016311 0 ustar mehdi mehdi
This chapter describes how user-defined primitives, written in C, can be linked with OCaml code and called from OCaml functions, and how these C functions can call back to OCaml code.
|
User primitives are declared in an implementation file or struct…end module expression using the external keyword:
external name : type = C-function-name
This defines the value name name as a function with type type that executes by calling the given C function. For instance, here is how the input primitive is declared in the standard library module Pervasives:
external input : in_channel -> bytes -> int -> int -> int
= "input"
Primitives with several arguments are always curried. The C function does not necessarily have the same name as the ML function.
External functions thus defined can be specified in interface files or sig…end signatures either as regular values
val name : type
thus hiding their implementation as C functions, or explicitly as “manifest” external functions
external name : type = C-function-name
The latter is slightly more efficient, as it allows clients of the module to call directly the C function instead of going through the corresponding OCaml function. On the other hand, it should not be used in library modules if they have side-effects at toplevel, as this direct call interferes with the linker’s algorithm for removing unused modules from libraries at link-time.
The arity (number of arguments) of a primitive is automatically determined from its OCaml type in the external declaration, by counting the number of function arrows in the type. For instance, input above has arity 4, and the input C function is called with four arguments. Similarly,
external input2 : in_channel * bytes * int * int -> int = "input2"
has arity 1, and the input2 C function receives one argument (which is a quadruple of OCaml values).
Type abbreviations are not expanded when determining the arity of a primitive. For instance,
type int_endo = int -> int
external f : int_endo -> int_endo = "f"
external g : (int -> int) -> (int -> int) = "f"
f has arity 1, but g has arity 2. This allows a primitive to return a functional value (as in the f example above): just remember to name the functional return type in a type abbreviation.
The language accepts external declarations with one or two flag strings in addition to the C function’s name. These flags are reserved for the implementation of the standard library.
User primitives with arity n ≤ 5 are implemented by C functions that take n arguments of type value, and return a result of type value. The type value is the type of the representations for OCaml values. It encodes objects of several base types (integers, floating-point numbers, strings, …) as well as OCaml data structures. The type value and the associated conversion functions and macros are described in detail below. For instance, here is the declaration for the C function implementing the input primitive:
CAMLprim value input(value channel, value buffer, value offset, value length)
{
...
}
When the primitive function is applied in an OCaml program, the C function is called with the values of the expressions to which the primitive is applied as arguments. The value returned by the function is passed back to the OCaml program as the result of the function application.
User primitives with arity greater than 5 should be implemented by two C functions. The first function, to be used in conjunction with the bytecode compiler ocamlc, receives two arguments: a pointer to an array of OCaml values (the values for the arguments), and an integer which is the number of arguments provided. The other function, to be used in conjunction with the native-code compiler ocamlopt, takes its arguments directly. For instance, here are the two C functions for the 7-argument primitive Nat.add_nat:
CAMLprim value add_nat_native(value nat1, value ofs1, value len1,
value nat2, value ofs2, value len2,
value carry_in)
{
...
}
CAMLprim value add_nat_bytecode(value * argv, int argn)
{
return add_nat_native(argv[0], argv[1], argv[2], argv[3],
argv[4], argv[5], argv[6]);
}
The names of the two C functions must be given in the primitive declaration, as follows:
external name : type =
bytecode-C-function-name native-code-C-function-name
For instance, in the case of add_nat, the declaration is:
external add_nat: nat -> int -> int -> nat -> int -> int -> int -> int
= "add_nat_bytecode" "add_nat_native"
Implementing a user primitive is actually two separate tasks: on the one hand, decoding the arguments to extract C values from the given OCaml values, and encoding the return value as an OCaml value; on the other hand, actually computing the result from the arguments. Except for very simple primitives, it is often preferable to have two distinct C functions to implement these two tasks. The first function actually implements the primitive, taking native C values as arguments and returning a native C value. The second function, often called the “stub code”, is a simple wrapper around the first function that converts its arguments from OCaml values to C values, call the first function, and convert the returned C value to OCaml value. For instance, here is the stub code for the input primitive:
CAMLprim value input(value channel, value buffer, value offset, value length)
{
return Val_long(getblock((struct channel *) channel,
&Byte(buffer, Long_val(offset)),
Long_val(length)));
}
(Here, Val_long, Long_val and so on are conversion macros for the type value, that will be described later. The CAMLprim macro expands to the required compiler directives to ensure that the function is exported and accessible from OCaml.) The hard work is performed by the function getblock, which is declared as:
long getblock(struct channel * channel, char * p, long n)
{
...
}
To write C code that operates on OCaml values, the following include files are provided:
| Include file | Provides |
| caml/mlvalues.h | definition of the value type, and conversion macros |
| caml/alloc.h | allocation functions (to create structured OCaml objects) |
| caml/memory.h | miscellaneous memory-related functions and macros (for GC interface, in-place modification of structures, etc). |
| caml/fail.h | functions for raising exceptions (see section 19.4.5) |
| caml/callback.h | callback from C to OCaml (see section 19.7). |
| caml/custom.h | operations on custom blocks (see section 19.9). |
| caml/intext.h | operations for writing user-defined serialization and deserialization functions for custom blocks (see section 19.9). |
| caml/threads.h | operations for interfacing in the presence of multiple threads (see section 19.11). |
These files reside in the caml/ subdirectory of the OCaml standard library directory, which is returned by the command ocamlc -where (usually /usr/local/lib/ocaml or /usr/lib/ocaml).
By default, header files in the caml/ subdirectory give only access to the public interface of the OCaml runtime. It is possible to define the macro CAML_INTERNALS to get access to a lower-level interface, but this lower-level interface is more likely to change and break programs that use it.
Note: It is recommended to define the macro CAML_NAME_SPACE before including these header files. If you do not define it, the header files will also define short names (without the caml_ prefix) for most functions, which usually produce clashes with names defined by other C libraries that you might use. Including the header files without CAML_NAME_SPACE is only supported for backward compatibility.
The OCaml runtime system comprises three main parts: the bytecode interpreter, the memory manager, and a set of C functions that implement the primitive operations. Some bytecode instructions are provided to call these C functions, designated by their offset in a table of functions (the table of primitives).
In the default mode, the OCaml linker produces bytecode for the standard runtime system, with a standard set of primitives. References to primitives that are not in this standard set result in the “unavailable C primitive” error. (Unless dynamic loading of C libraries is supported – see section 19.1.4 below.)
In the “custom runtime” mode, the OCaml linker scans the object files and determines the set of required primitives. Then, it builds a suitable runtime system, by calling the native code linker with:
This builds a runtime system with the required primitives. The OCaml linker generates bytecode for this custom runtime system. The bytecode is appended to the end of the custom runtime system, so that it will be automatically executed when the output file (custom runtime + bytecode) is launched.
To link in “custom runtime” mode, execute the ocamlc command with:
If you are using the native-code compiler ocamlopt, the -custom flag is not needed, as the final linking phase of ocamlopt always builds a standalone executable. To build a mixed OCaml/C executable, execute the ocamlopt command with:
Starting with Objective Caml 3.00, it is possible to record the -custom option as well as the names of C libraries in an OCaml library file .cma or .cmxa. For instance, consider an OCaml library mylib.cma, built from the OCaml object files a.cmo and b.cmo, which reference C code in libmylib.a. If the library is built as follows:
ocamlc -a -o mylib.cma -custom a.cmo b.cmo -cclib -lmylib
users of the library can simply link with mylib.cma:
ocamlc -o myprog mylib.cma ...
and the system will automatically add the -custom and -cclib -lmylib options, achieving the same effect as
ocamlc -o myprog -custom a.cmo b.cmo ... -cclib -lmylib
The alternative is of course to build the library without extra options:
ocamlc -a -o mylib.cma a.cmo b.cmo
and then ask users to provide the -custom and -cclib -lmylib options themselves at link-time:
ocamlc -o myprog -custom mylib.cma ... -cclib -lmylib
The former alternative is more convenient for the final users of the library, however.
Starting with Objective Caml 3.03, an alternative to static linking of C code using the -custom code is provided. In this mode, the OCaml linker generates a pure bytecode executable (no embedded custom runtime system) that simply records the names of dynamically-loaded libraries containing the C code. The standard OCaml runtime system ocamlrun then loads dynamically these libraries, and resolves references to the required primitives, before executing the bytecode.
This facility is currently supported and known to work well under Linux, MacOS X, and Windows. It is supported, but not fully tested yet, under FreeBSD, Tru64, Solaris and Irix. It is not supported yet under other Unixes.
To dynamically link C code with OCaml code, the C code must first be compiled into a shared library (under Unix) or DLL (under Windows). This involves 1- compiling the C files with appropriate C compiler flags for producing position-independent code (when required by the operating system), and 2- building a shared library from the resulting object files. The resulting shared library or DLL file must be installed in a place where ocamlrun can find it later at program start-up time (see section 10.3). Finally (step 3), execute the ocamlc command with
Do not set the -custom flag, otherwise you’re back to static linking as described in section 19.1.3. The ocamlmklib tool (see section 19.12) automates steps 2 and 3.
As in the case of static linking, it is possible (and recommended) to record the names of C libraries in an OCaml .cma library archive. Consider again an OCaml library mylib.cma, built from the OCaml object files a.cmo and b.cmo, which reference C code in dllmylib.so. If the library is built as follows:
ocamlc -a -o mylib.cma a.cmo b.cmo -dllib -lmylib
users of the library can simply link with mylib.cma:
ocamlc -o myprog mylib.cma ...
and the system will automatically add the -dllib -lmylib option, achieving the same effect as
ocamlc -o myprog a.cmo b.cmo ... -dllib -lmylib
Using this mechanism, users of the library mylib.cma do not need to known that it references C code, nor whether this C code must be statically linked (using -custom) or dynamically linked.
After having described two different ways of linking C code with OCaml code, we now review the pros and cons of each, to help developers of mixed OCaml/C libraries decide.
The main advantage of dynamic linking is that it preserves the platform-independence of bytecode executables. That is, the bytecode executable contains no machine code, and can therefore be compiled on platform A and executed on other platforms B, C, …, as long as the required shared libraries are available on all these platforms. In contrast, executables generated by ocamlc -custom run only on the platform on which they were created, because they embark a custom-tailored runtime system specific to that platform. In addition, dynamic linking results in smaller executables.
Another advantage of dynamic linking is that the final users of the library do not need to have a C compiler, C linker, and C runtime libraries installed on their machines. This is no big deal under Unix and Cygwin, but many Windows users are reluctant to install Microsoft Visual C just to be able to do ocamlc -custom.
There are two drawbacks to dynamic linking. The first is that the resulting executable is not stand-alone: it requires the shared libraries, as well as ocamlrun, to be installed on the machine executing the code. If you wish to distribute a stand-alone executable, it is better to link it statically, using ocamlc -custom -ccopt -static or ocamlopt -ccopt -static. Dynamic linking also raises the “DLL hell” problem: some care must be taken to ensure that the right versions of the shared libraries are found at start-up time.
The second drawback of dynamic linking is that it complicates the construction of the library. The C compiler and linker flags to compile to position-independent code and build a shared library vary wildly between different Unix systems. Also, dynamic linking is not supported on all Unix systems, requiring a fall-back case to static linking in the Makefile for the library. The ocamlmklib command (see section 19.12) tries to hide some of these system dependencies.
In conclusion: dynamic linking is highly recommended under the native Windows port, because there are no portability problems and it is much more convenient for the end users. Under Unix, dynamic linking should be considered for mature, frequently used libraries because it enhances platform-independence of bytecode executables. For new or rarely-used libraries, static linking is much simpler to set up in a portable way.
It is sometimes inconvenient to build a custom runtime system each time OCaml code is linked with C libraries, like ocamlc -custom does. For one thing, the building of the runtime system is slow on some systems (that have bad linkers or slow remote file systems); for another thing, the platform-independence of bytecode files is lost, forcing to perform one ocamlc -custom link per platform of interest.
An alternative to ocamlc -custom is to build separately a custom runtime system integrating the desired C libraries, then generate “pure” bytecode executables (not containing their own runtime system) that can run on this custom runtime. This is achieved by the -make-runtime and -use-runtime flags to ocamlc. For example, to build a custom runtime system integrating the C parts of the “Unix” and “Threads” libraries, do:
ocamlc -make-runtime -o /home/me/ocamlunixrun unix.cma threads.cma
To generate a bytecode executable that runs on this runtime system, do:
ocamlc -use-runtime /home/me/ocamlunixrun -o myprog \
unix.cma threads.cma your .cmo and .cma files
The bytecode executable myprog can then be launched as usual: myprog args or /home/me/ocamlunixrun myprog args.
Notice that the bytecode libraries unix.cma and threads.cma must be given twice: when building the runtime system (so that ocamlc knows which C primitives are required) and also when building the bytecode executable (so that the bytecode from unix.cma and threads.cma is actually linked in).
All OCaml objects are represented by the C type value, defined in the include file caml/mlvalues.h, along with macros to manipulate values of that type. An object of type value is either:
caml_alloc_* functions below);
Integer values encode 63-bit signed integers (31-bit on 32-bit architectures). They are unboxed (unallocated).
Blocks in the heap are garbage-collected, and therefore have strict structure constraints. Each block includes a header containing the size of the block (in words), and the tag of the block. The tag governs how the contents of the blocks are structured. A tag lower than No_scan_tag indicates a structured block, containing well-formed values, which is recursively traversed by the garbage collector. A tag greater than or equal to No_scan_tag indicates a raw block, whose contents are not scanned by the garbage collector. For the benefit of ad-hoc polymorphic primitives such as equality and structured input-output, structured and raw blocks are further classified according to their tags as follows:
| Tag | Contents of the block |
| 0 to No_scan_tag−1 | A structured block (an array of OCaml objects). Each field is a value. |
| Closure_tag | A closure representing a functional value. The first word is a pointer to a piece of code, the remaining words are value containing the environment. |
| String_tag | A character string or a byte sequence. |
| Double_tag | A double-precision floating-point number. |
| Double_array_tag | An array or record of double-precision floating-point numbers. |
| Abstract_tag | A block representing an abstract datatype. |
| Custom_tag | A block representing an abstract datatype with user-defined finalization, comparison, hashing, serialization and deserialization functions atttached. |
Any word-aligned pointer to an address outside the heap can be safely
cast to and from the type value. This includes pointers returned by
malloc, and pointers to C variables (of size at least one word)
obtained with the & operator.
Caution: if a pointer returned by malloc is cast to the type value and returned to OCaml, explicit deallocation of the pointer using free is potentially dangerous, because the pointer may still be accessible from the OCaml world. Worse, the memory space deallocated by free can later be reallocated as part of the OCaml heap; the pointer, formerly pointing outside the OCaml heap, now points inside the OCaml heap, and this can crash the garbage collector. To avoid these problems, it is preferable to wrap the pointer in a OCaml block with tag Abstract_tag or Custom_tag.
This section describes how OCaml data types are encoded in the value type.
| OCaml type | Encoding |
| int | Unboxed integer values. |
| char | Unboxed integer values (ASCII code). |
| float | Blocks with tag Double_tag. |
| bytes | Blocks with tag String_tag. |
| string | Blocks with tag String_tag. |
| int32 | Blocks with tag Custom_tag. |
| int64 | Blocks with tag Custom_tag. |
| nativeint | Blocks with tag Custom_tag. |
Tuples are represented by pointers to blocks, with tag 0.
Records are also represented by zero-tagged blocks. The ordering of labels in the record type declaration determines the layout of the record fields: the value associated to the label declared first is stored in field 0 of the block, the value associated to the second label goes in field 1, and so on.
As an optimization, records whose fields all have static type float are represented as arrays of floating-point numbers, with tag Double_array_tag. (See the section below on arrays.)
As another optimization, unboxable record types are represented specially; unboxable record types are the immutable record types that have only one field. An unboxable type will be represented in one of two ways: boxed or unboxed. Boxed record types are represented as described above (by a block with tag 0 or Double_array_tag). An unboxed record type is represented directly by the value of its field (i.e. there is no block to represent the record itself).
The representation is chosen according to the following, in decreasing order of priority:
Arrays of integers and pointers are represented like tuples, that is, as pointers to blocks tagged 0. They are accessed with the Field macro for reading and the caml_modify function for writing.
Arrays of floating-point numbers (type float array) have a special, unboxed, more efficient representation. These arrays are represented by pointers to blocks with tag Double_array_tag. They should be accessed with the Double_field and Store_double_field macros.
Constructed terms are represented either by unboxed integers (for constant constructors) or by blocks whose tag encode the constructor (for non-constant constructors). The constant constructors and the non-constant constructors for a given concrete type are numbered separately, starting from 0, in the order in which they appear in the concrete type declaration. A constant constructor is represented by the unboxed integer equal to its constructor number. A non-constant constructor declared with n arguments is represented by a block of size n, tagged with the constructor number; the n fields contain its arguments. Example:
| Constructed term | Representation |
| () | Val_int(0) |
| false | Val_int(0) |
| true | Val_int(1) |
| [] | Val_int(0) |
| h::t | Block with size = 2 and tag = 0; first field contains h, second field t. |
As a convenience, caml/mlvalues.h defines the macros Val_unit, Val_false and Val_true to refer to (), false and true.
The following example illustrates the assignment of integers and block tags to constructors:
type t = | A (* First constant constructor -> integer "Val_int(0)" *) | B of string (* First non-constant constructor -> block with tag 0 *) | C (* Second constant constructor -> integer "Val_int(1)" *) | D of bool (* Second non-constant constructor -> block with tag 1 *) | E of t * t (* Third non-constant constructor -> block with tag 2 *)
As an optimization, unboxable concrete data types are represented specially; a concrete data type is unboxable if it has exactly one constructor and this constructor has exactly one argument. Unboxable concrete data types are represented in the same ways as unboxable record types: see the description in section 19.3.2.
Objects are represented as blocks with tag Object_tag. The first field of the block refers to the object’s class and associated method suite, in a format that cannot easily be exploited from C. The second field contains a unique object ID, used for comparisons. The remaining fields of the object contain the values of the instance variables of the object. It is unsafe to access directly instance variables, as the type system provides no guarantee about the instance variables contained by an object.
One may extract a public method from an object using the C function caml_get_public_method (declared in <caml/mlvalues.h>.) Since public method tags are hashed in the same way as variant tags, and methods are functions taking self as first argument, if you want to do the method call foo#bar from the C side, you should call:
callback(caml_get_public_method(foo, hash_variant("bar")), foo);
Like constructed terms, polymorphic variant values are represented either as integers (for polymorphic variants without argument), or as blocks (for polymorphic variants with an argument). Unlike constructed terms, variant constructors are not numbered starting from 0, but identified by a hash value (an OCaml integer), as computed by the C function hash_variant (declared in <caml/mlvalues.h>): the hash value for a variant constructor named, say, VConstr is hash_variant("VConstr").
The variant value `VConstr is represented by hash_variant("VConstr"). The variant value `VConstr(v) is represented by a block of size 2 and tag 0, with field number 0 containing hash_variant("VConstr") and field number 1 containing v.
Unlike constructed values, polymorphic variant values taking several arguments are not flattened. That is, `VConstr(v, w) is represented by a block of size 2, whose field number 1 contains the representation of the pair (v, w), rather than a block of size 3 containing v and w in fields 1 and 2.
The expressions Field(v, n), Byte(v, n) and Byte_u(v, n) are valid l-values. Hence, they can be assigned to, resulting in an in-place modification of value v. Assigning directly to Field(v, n) must be done with care to avoid confusing the garbage collector (see below).
The following functions are slightly more efficient than caml_alloc, but also much more difficult to use.
From the standpoint of the allocation functions, blocks are divided
according to their size as zero-sized blocks, small blocks (with size
less than or equal to Max_young_wosize), and large blocks (with
size greater than Max_young_wosize). The constant
Max_young_wosize is declared in the include file mlvalues.h. It
is guaranteed to be at least 64 (words), so that any block with
constant size less than or equal to 64 can be assumed to be small. For
blocks whose size is computed at run-time, the size must be compared
against Max_young_wosize to determine the correct allocation procedure.
Max_young_wosize. (It
can also be smaller, but in this case it is more efficient to call
caml_alloc_small instead of caml_alloc_shr.)
If this block is a structured block (i.e. if t < No_scan_tag), then
the fields of the block (initially containing garbage) must be initialized
with legal values (using the caml_initialize function described below)
before the next allocation.
Two functions are provided to raise two standard exceptions:
char *), raises exception Failure with argument s.
char *), raises exception Invalid_argument
with argument s.
Raising arbitrary exceptions from C is more delicate: the exception identifier is dynamically allocated by the OCaml program, and therefore must be communicated to the C function using the registration facility described below in section 19.7.3. Once the exception identifier is recovered in C, the following functions actually raise the exception:
Unused blocks in the heap are automatically reclaimed by the garbage collector. This requires some cooperation from C code that manipulates heap-allocated blocks.
All the macros described in this section are declared in the memory.h header file.
There are six CAMLparam macros: CAMLparam0 to CAMLparam5, which take zero to five arguments respectively. If your function has no more than 5 parameters of type value, use the corresponding macros with these parameters as arguments. If your function has more than 5 parameters of type value, use CAMLparam5 with five of these parameters, and use one or more calls to the CAMLxparam macros for the remaining parameters (CAMLxparam1 to CAMLxparam5).
The macros CAMLreturn, CAMLreturn0, and CAMLreturnT are used to replace the C keyword return. Every occurrence of return x must be replaced by CAMLreturn (x) if x has type value, or CAMLreturnT (t, x) (where t is the type of x); every occurrence of return without argument must be replaced by CAMLreturn0. If your C function is a procedure (i.e. if it returns void), you must insert CAMLreturn0 at the end (to replace C’s implicit return).
some C compilers give bogus warnings about unused variables caml__dummy_xxx at each use of CAMLparam and CAMLlocal. You should ignore them.
Example:
void foo (value v1, value v2, value v3)
{
CAMLparam3 (v1, v2, v3);
...
CAMLreturn0;
}
if your function is a primitive with more than 5 arguments for use with the byte-code runtime, its arguments are not values and must not be declared (they have types value * and int).
The macros CAMLlocal1 to CAMLlocal5 declare and initialize one to five local variables of type value. The variable names are given as arguments to the macros. CAMLlocalN(x, n) declares and initializes a local variable of type value [n]. You can use several calls to these macros if you have more than 5 local variables.
Example:
value bar (value v1, value v2, value v3)
{
CAMLparam3 (v1, v2, v3);
CAMLlocal1 (result);
result = caml_alloc (3, 0);
...
CAMLreturn (result);
}
Store_field (b, n, v) stores the value v in the field number n of value b, which must be a block (i.e. Is_block(b) must be true).
Example:
value bar (value v1, value v2, value v3)
{
CAMLparam3 (v1, v2, v3);
CAMLlocal1 (result);
result = caml_alloc (3, 0);
Store_field (result, 0, v1);
Store_field (result, 1, v2);
Store_field (result, 2, v3);
CAMLreturn (result);
}
The first argument of Store_field and Store_double_field must be a variable declared by CAMLparam* or a parameter declared by CAMLlocal* to ensure that a garbage collection triggered by the evaluation of the other arguments will not invalidate the first argument after it is computed.
Arrays of values declared using CAMLlocalN must not be written to using Store_field. Use the normal C array syntax instead.
Registration of a global variable v is achieved by calling caml_register_global_root(&v) just before or just after a valid value is stored in v for the first time. You must not call any of the OCaml runtime functions or macros between registering and storing the value.
A registered global variable v can be un-registered by calling caml_remove_global_root(&v).
If the contents of the global variable v are seldom modified after registration, better performance can be achieved by calling caml_register_generational_global_root(&v) to register v (after its initialization with a valid value, but before any allocation or call to the GC functions), and caml_remove_generational_global_root(&v) to un-register it. In this case, you must not modify the value of v directly, but you must use caml_modify_generational_global_root(&v,x) to set it to x. The garbage collector takes advantage of the guarantee that v is not modified between calls to caml_modify_generational_global_root to scan it less often. This improves performance if the modifications of v happen less often than minor collections.
The CAML macros use identifiers (local variables, type identifiers, structure tags) that start with caml__. Do not use any identifier starting with caml__ in your programs.
We now give the GC rules corresponding to the low-level allocation functions caml_alloc_small and caml_alloc_shr. You can ignore those rules if you stick to the simplified allocation function caml_alloc.
Field(v, n) = vn;
If the block has been allocated with caml_alloc_shr, filling is performed
through the caml_initialize function:
caml_initialize(&Field(v, n), vn);
The next allocation can trigger a garbage collection. The garbage collector assumes that all structured blocks contain well-formed values. Newly created blocks contain random data, which generally do not represent well-formed values.
If you really need to allocate before the fields can receive their final value, first initialize with a constant value (e.g. Val_unit), then allocate, then modify the fields with the correct value (see rule 6).
Field(v, n) = w;
is safe only if v is a block newly allocated by caml_alloc_small;
that is, if no allocation took place between the
allocation of v and the assignment to the field. In all other cases,
never assign directly. If the block has just been allocated by caml_alloc_shr,
use caml_initialize to assign a value to a field for the first time:
caml_initialize(&Field(v, n), w);
Otherwise, you are updating a field that previously contained a
well-formed value; then, call the caml_modify function:
caml_modify(&Field(v, n), w);
To illustrate the rules above, here is a C function that builds and returns a list containing the two integers given as parameters. First, we write it using the simplified allocation functions:
value alloc_list_int(int i1, int i2)
{
CAMLparam0 ();
CAMLlocal2 (result, r);
r = caml_alloc(2, 0); /* Allocate a cons cell */
Store_field(r, 0, Val_int(i2)); /* car = the integer i2 */
Store_field(r, 1, Val_int(0)); /* cdr = the empty list [] */
result = caml_alloc(2, 0); /* Allocate the other cons cell */
Store_field(result, 0, Val_int(i1)); /* car = the integer i1 */
Store_field(result, 1, r); /* cdr = the first cons cell */
CAMLreturn (result);
}
Here, the registering of result is not strictly needed, because no allocation takes place after it gets its value, but it’s easier and safer to simply register all the local variables that have type value.
Here is the same function written using the low-level allocation functions. We notice that the cons cells are small blocks and can be allocated with caml_alloc_small, and filled by direct assignments on their fields.
value alloc_list_int(int i1, int i2)
{
CAMLparam0 ();
CAMLlocal2 (result, r);
r = caml_alloc_small(2, 0); /* Allocate a cons cell */
Field(r, 0) = Val_int(i2); /* car = the integer i2 */
Field(r, 1) = Val_int(0); /* cdr = the empty list [] */
result = caml_alloc_small(2, 0); /* Allocate the other cons cell */
Field(result, 0) = Val_int(i1); /* car = the integer i1 */
Field(result, 1) = r; /* cdr = the first cons cell */
CAMLreturn (result);
}
In the two examples above, the list is built bottom-up. Here is an alternate way, that proceeds top-down. It is less efficient, but illustrates the use of caml_modify.
value alloc_list_int(int i1, int i2)
{
CAMLparam0 ();
CAMLlocal2 (tail, r);
r = caml_alloc_small(2, 0); /* Allocate a cons cell */
Field(r, 0) = Val_int(i1); /* car = the integer i1 */
Field(r, 1) = Val_int(0); /* A dummy value
tail = caml_alloc_small(2, 0); /* Allocate the other cons cell */
Field(tail, 0) = Val_int(i2); /* car = the integer i2 */
Field(tail, 1) = Val_int(0); /* cdr = the empty list [] */
caml_modify(&Field(r, 1), tail); /* cdr of the result = tail */
CAMLreturn (r);
}
It would be incorrect to perform Field(r, 1) = tail directly, because the allocation of tail has taken place since r was allocated.
This section outlines how the functions from the Unix curses library can be made available to OCaml programs. First of all, here is the interface curses.mli that declares the curses primitives and data types:
(* File curses.ml -- declaration of primitives and data types *)
type window (* The type "window" remains abstract *)
external initscr: unit -> window = "caml_curses_initscr"
external endwin: unit -> unit = "caml_curses_endwin"
external refresh: unit -> unit = "caml_curses_refresh"
external wrefresh : window -> unit = "caml_curses_wrefresh"
external newwin: int -> int -> int -> int -> window = "caml_curses_newwin"
external addch: char -> unit = "caml_curses_addch"
external mvwaddch: window -> int -> int -> char -> unit = "caml_curses_mvwaddch"
external addstr: string -> unit = "caml_curses_addstr"
external mvwaddstr: window -> int -> int -> string -> unit
= "caml_curses_mvwaddstr"
(* lots more omitted *)
To compile this interface:
ocamlc -c curses.ml
To implement these functions, we just have to provide the stub code; the core functions are already implemented in the curses library. The stub code file, curses_stubs.c, looks like this:
/* File curses_stubs.c -- stub code for curses */
#include <curses.h>
#include <caml/mlvalues.h>
#include <caml/memory.h>
#include <caml/alloc.h>
#include <caml/custom.h>
/* Encapsulation of opaque window handles (of type WINDOW *)
as OCaml custom blocks. */
static struct custom_operations curses_window_ops = {
"fr.inria.caml.curses_windows",
custom_finalize_default,
custom_compare_default,
custom_hash_default,
custom_serialize_default,
custom_deserialize_default,
custom_compare_ext_default
};
/* Accessing the WINDOW * part of an OCaml custom block */
#define Window_val(v) (*((WINDOW **) Data_custom_val(v)))
/* Allocating an OCaml custom block to hold the given WINDOW * */
static value alloc_window(WINDOW * w)
{
value v = alloc_custom(&curses_window_ops, sizeof(WINDOW *), 0, 1);
Window_val(v) = w;
return v;
}
value caml_curses_initscr(value unit)
{
CAMLparam1 (unit);
CAMLreturn (alloc_window(initscr()));
}
value caml_curses_endwin(value unit)
{
CAMLparam1 (unit);
endwin();
CAMLreturn (Val_unit);
}
value caml_curses_refresh(value unit)
{
CAMLparam1 (unit);
refresh();
CAMLreturn (Val_unit);
}
value caml_curses_wrefresh(value win)
{
CAMLparam1 (win);
wrefresh(Window_val(win));
CAMLreturn (Val_unit);
}
value caml_curses_newwin(value nlines, value ncols, value x0, value y0)
{
CAMLparam4 (nlines, ncols, x0, y0);
CAMLreturn (alloc_window(newwin(Int_val(nlines), Int_val(ncols),
Int_val(x0), Int_val(y0))));
}
value caml_curses_addch(value c)
{
CAMLparam1 (c);
addch(Int_val(c)); /* Characters are encoded like integers */
CAMLreturn (Val_unit);
}
value caml_curses_mvwaddch(value win, value x, value y, value c)
{
CAMLparam4 (win, x, y, c);
mvwaddch(Window_val(win), Int_val(x), Int_val(y), Int_val(c));
CAMLreturn (Val_unit);
}
value caml_curses_addstr(value s)
{
CAMLparam1 (s);
addstr(String_val(s));
CAMLreturn (Val_unit);
}
value caml_curses_mvwaddstr(value win, value x, value y, value s)
{
CAMLparam4 (win, x, y, s);
mvwaddstr(Window_val(win), Int_val(x), Int_val(y), String_val(s));
CAMLreturn (Val_unit);
}
/* This goes on for pages. */
The file curses_stubs.c can be compiled with:
cc -c -I`ocamlc -where` curses_stubs.c
or, even simpler,
ocamlc -c curses_stubs.c
(When passed a .c file, the ocamlc command simply calls the C compiler on that file, with the right -I option.)
Now, here is a sample OCaml program prog.ml that uses the curses module:
(* File prog.ml -- main program using curses *) open Curses;; let main_window = initscr () in let small_window = newwin 10 5 20 10 in mvwaddstr main_window 10 2 "Hello"; mvwaddstr small_window 4 3 "world"; refresh(); Unix.sleep 5; endwin()
To compile and link this program, run:
ocamlc -custom -o prog unix.cma curses.cmo prog.ml curses_stubs.o -cclib -lcurses
(On some machines, you may need to put -cclib -lcurses -cclib -ltermcap or -cclib -ltermcap instead of -cclib -lcurses.)
So far, we have described how to call C functions from OCaml. In this section, we show how C functions can call OCaml functions, either as callbacks (OCaml calls C which calls OCaml), or with the main program written in C.
C functions can apply OCaml function values (closures) to OCaml values. The following functions are provided to perform the applications:
If the function f does not return, but raises an exception that escapes the scope of the application, then this exception is propagated to the next enclosing OCaml code, skipping over the C code. That is, if an OCaml function f calls a C function g that calls back an OCaml function h that raises a stray exception, then the execution of g is interrupted and the exception is propagated back into f.
If the C code wishes to catch exceptions escaping the OCaml function, it can use the functions caml_callback_exn, caml_callback2_exn, caml_callback3_exn, caml_callbackN_exn. These functions take the same arguments as their non-_exn counterparts, but catch escaping exceptions and return them to the C code. The return value v of the caml_callback*_exn functions must be tested with the macro Is_exception_result(v). If the macro returns “false”, no exception occured, and v is the value returned by the OCaml function. If Is_exception_result(v) returns “true”, an exception escaped, and its value (the exception descriptor) can be recovered using Extract_exception(v).
If the OCaml function returned with an exception, Extract_exception should be applied to the exception result prior to calling a function that may trigger garbage collection. Otherwise, if v is reachable during garbage collection, the runtime can crash since v does not contain a valid value.
Example:
value call_caml_f_ex(value closure, value arg)
{
CAMLparam2(closure, arg);
CAMLlocal2(res, tmp);
res = caml_callback_exn(closure, arg);
if(Is_exception_result(res)) {
res = Extract_exception(res);
tmp = caml_alloc(3, 0); /* Safe to allocate: res contains valid value. */
...
}
CAMLreturn (res);
}
There are two ways to obtain OCaml function values (closures) to be passed to the callback functions described above. One way is to pass the OCaml function as an argument to a primitive function. For example, if the OCaml code contains the declaration
external apply : ('a -> 'b) -> 'a -> 'b = "caml_apply"
the corresponding C stub can be written as follows:
CAMLprim value caml_apply(value vf, value vx)
{
CAMLparam2(vf, vx);
CAMLlocal1(vy);
vy = caml_callback(vf, vx);
CAMLreturn(vy);
}
Another possibility is to use the registration mechanism provided by OCaml. This registration mechanism enables OCaml code to register OCaml functions under some global name, and C code to retrieve the corresponding closure by this global name.
On the OCaml side, registration is performed by evaluating Callback.register n v. Here, n is the global name (an arbitrary string) and v the OCaml value. For instance:
let f x = print_string "f is applied to "; print_int x; print_newline()
let _ = Callback.register "test function" f
On the C side, a pointer to the value registered under name n is obtained by calling caml_named_value(n). The returned pointer must then be dereferenced to recover the actual OCaml value. If no value is registered under the name n, the null pointer is returned. For example, here is a C wrapper that calls the OCaml function f above:
void call_caml_f(int arg)
{
caml_callback(*caml_named_value("test function"), Val_int(arg));
}
The pointer returned by caml_named_value is constant and can safely be cached in a C variable to avoid repeated name lookups. On the other hand, the value pointed to can change during garbage collection and must always be recomputed at the point of use. Here is a more efficient variant of call_caml_f above that calls caml_named_value only once:
void call_caml_f(int arg)
{
static value * closure_f = NULL;
if (closure_f == NULL) {
/* First time around, look up by name */
closure_f = caml_named_value("test function");
}
caml_callback(*closure_f, Val_int(arg));
}
The registration mechanism described above can also be used to communicate exception identifiers from OCaml to C. The OCaml code registers the exception by evaluating Callback.register_exception n exn, where n is an arbitrary name and exn is an exception value of the exception to register. For example:
exception Error of string
let _ = Callback.register_exception "test exception" (Error "any string")
The C code can then recover the exception identifier using caml_named_value and pass it as first argument to the functions raise_constant, raise_with_arg, and raise_with_string (described in section 19.4.5) to actually raise the exception. For example, here is a C function that raises the Error exception with the given argument:
void raise_error(char * msg)
{
caml_raise_with_string(*caml_named_value("test exception"), msg);
}
In normal operation, a mixed OCaml/C program starts by executing the OCaml initialization code, which then may proceed to call C functions. We say that the main program is the OCaml code. In some applications, it is desirable that the C code plays the role of the main program, calling OCaml functions when needed. This can be achieved as follows:
The bytecode compiler in custom runtime mode (ocamlc -custom) normally appends the bytecode to the executable file containing the custom runtime. This has two consequences. First, the final linking step must be performed by ocamlc. Second, the OCaml runtime library must be able to find the name of the executable file from the command-line arguments. When using caml_main(argv) as in section 19.7.4, this means that argv[0] or argv[1] must contain the executable file name.
An alternative is to embed the bytecode in the C code. The -output-obj option to ocamlc is provided for this purpose. It causes the ocamlc compiler to output a C object file (.o file, .obj under Windows) containing the bytecode for the OCaml part of the program, as well as a caml_startup function. The C object file produced by ocamlc -output-obj can then be linked with C code using the standard C compiler, or stored in a C library.
The caml_startup function must be called from the main C program in order to initialize the OCaml runtime and execute the OCaml initialization code. Just like caml_main, it takes one argv parameter containing the command-line parameters. Unlike caml_main, this argv parameter is used only to initialize Sys.argv, but not for finding the name of the executable file.
The caml_startup function calls the uncaught exception handler (or enters the debugger, if running under ocamldebug) if an exception escapes from a top-level module initialiser. Such exceptions may be caught in the C code by instead using the caml_startup_exn function and testing the result using Is_exception_result (followed by Extract_exception if appropriate).
The -output-obj option can also be used to obtain the C source file. More interestingly, the same option can also produce directly a shared library (.so file, .dll under Windows) that contains the OCaml code, the OCaml runtime system and any other static C code given to ocamlc (.o, .a, respectively, .obj, .lib). This use of -output-obj is very similar to a normal linking step, but instead of producing a main program that automatically runs the OCaml code, it produces a shared library that can run the OCaml code on demand. The three possible behaviors of -output-obj are selected according to the extension of the resulting file (given with -o).
The native-code compiler ocamlopt also supports the -output-obj option, causing it to output a C object file or a shared library containing the native code for all OCaml modules on the command-line, as well as the OCaml startup code. Initialization is performed by calling caml_startup (or caml_startup_exn) as in the case of the bytecode compiler.
For the final linking phase, in addition to the object file produced by -output-obj, you will have to provide the OCaml runtime library (libcamlrun.a for bytecode, libasmrun.a for native-code), as well as all C libraries that are required by the OCaml libraries used. For instance, assume the OCaml part of your program uses the Unix library. With ocamlc, you should do:
ocamlc -output-obj -o camlcode.o unix.cma other .cmo and .cma files
cc -o myprog C objects and libraries \
camlcode.o -L‘ocamlc -where‘ -lunix -lcamlrun
With ocamlopt, you should do:
ocamlopt -output-obj -o camlcode.o unix.cmxa other .cmx and .cmxa files
cc -o myprog C objects and libraries \
camlcode.o -L‘ocamlc -where‘ -lunix -lasmrun
On some ports, special options are required on the final linking phase that links together the object file produced by the -output-obj option and the remainder of the program. Those options are shown in the configuration file config/Makefile generated during compilation of OCaml, as the variables BYTECCLINKOPTS (for object files produced by ocamlc -output-obj) and NATIVECCLINKOPTS (for object files produced by ocamlopt -output-obj).
When OCaml bytecode produced by ocamlc -g is embedded in a C program, no debugging information is included, and therefore it is impossible to print stack backtraces on uncaught exceptions. This is not the case when native code produced by ocamlopt -g is embedded in a C program: stack backtrace information is available, but the backtrace mechanism needs to be turned on programmatically. This can be achieved from the OCaml side by calling Printexc.record_backtrace true in the initialization of one of the OCaml modules. This can also be achieved from the C side by calling caml_record_backtrace(Val_int(1)); in the OCaml-C glue code.
This section illustrates the callback facilities described in section 19.7. We are going to package some OCaml functions in such a way that they can be linked with C code and called from C just like any C functions. The OCaml functions are defined in the following mod.ml OCaml source:
(* File mod.ml -- some "useful" OCaml functions *) let rec fib n = if n < 2 then 1 else fib(n-1) + fib(n-2) let format_result n = Printf.sprintf "Result is: %d\n" n (* Export those two functions to C *) let _ = Callback.register "fib" fib let _ = Callback.register "format_result" format_result
Here is the C stub code for calling these functions from C:
/* File modwrap.c -- wrappers around the OCaml functions */
#include <stdio.h>
#include <string.h>
#include <caml/mlvalues.h>
#include <caml/callback.h>
int fib(int n)
{
static value * fib_closure = NULL;
if (fib_closure == NULL) fib_closure = caml_named_value("fib");
return Int_val(caml_callback(*fib_closure, Val_int(n)));
}
char * format_result(int n)
{
static value * format_result_closure = NULL;
if (format_result_closure == NULL)
format_result_closure = caml_named_value("format_result");
return strdup(String_val(caml_callback(*format_result_closure, Val_int(n))));
/* We copy the C string returned by String_val to the C heap
so that it remains valid after garbage collection. */
}
We now compile the OCaml code to a C object file and put it in a C library along with the stub code in modwrap.c and the OCaml runtime system:
ocamlc -custom -output-obj -o modcaml.o mod.ml
ocamlc -c modwrap.c
cp `ocamlc -where`/libcamlrun.a mod.a && chmod +w mod.a
ar r mod.a modcaml.o modwrap.o
(One can also use ocamlopt -output-obj instead of ocamlc -custom -output-obj. In this case, replace libcamlrun.a (the bytecode runtime library) by libasmrun.a (the native-code runtime library).)
Now, we can use the two functions fib and format_result in any C program, just like regular C functions. Just remember to call caml_startup (or caml_startup_exn) once before.
/* File main.c -- a sample client for the OCaml functions */
#include <stdio.h>
#include <caml/callback.h>
extern int fib(int n);
extern char * format_result(int n);
int main(int argc, char ** argv)
{
int result;
/* Initialize OCaml code */
caml_startup(argv);
/* Do some computation */
result = fib(10);
printf("fib(10) = %s\n", format_result(result));
return 0;
}
To build the whole program, just invoke the C compiler as follows:
cc -o prog -I `ocamlc -where` main.c mod.a -lcurses
(On some machines, you may need to put -ltermcap or -lcurses -ltermcap instead of -lcurses.)
Blocks with tag Custom_tag contain both arbitrary user data and a pointer to a C struct, with type struct custom_operations, that associates user-provided finalization, comparison, hashing, serialization and deserialization functions to this block.
The struct custom_operations is defined in <caml/custom.h> and contains the following fields:
The compare field can be set to custom_compare_default; this default comparison function simply raises Failure.
The compare_ext field can be set to custom_compare_ext_default; this default comparison function simply raises Failure.
The hash field can be set to custom_hash_default, in which case the custom block is ignored during hash computation.
The serialize field can be set to custom_serialize_default, in which case the Failure exception is raised when attempting to serialize the custom block.
The deserialize field can be set to custom_deserialize_default to indicate that deserialization is not supported. In this case, do not register the struct custom_operations with the deserializer using register_custom_operations (see below).
Note: the finalize, compare, hash, serialize and deserialize functions attached to custom block descriptors must never trigger a garbage collection. Within these functions, do not call any of the OCaml allocation functions, and do not perform a callback into OCaml code. Do not use CAMLparam to register the parameters to these functions, and do not use CAMLreturn to return the result.
Custom blocks must be allocated via the caml_alloc_custom function:
returns a fresh custom block, with room for size bytes of user data, and whose associated operations are given by ops (a pointer to a struct custom_operations, usually statically allocated as a C global variable).
The two parameters used and max are used to control the speed of garbage collection when the finalized object contains pointers to out-of-heap resources. Generally speaking, the OCaml incremental major collector adjusts its speed relative to the allocation rate of the program. The faster the program allocates, the harder the GC works in order to reclaim quickly unreachable blocks and avoid having large amount of “floating garbage” (unreferenced objects that the GC has not yet collected).
Normally, the allocation rate is measured by counting the in-heap size of allocated blocks. However, it often happens that finalized objects contain pointers to out-of-heap memory blocks and other resources (such as file descriptors, X Windows bitmaps, etc.). For those blocks, the in-heap size of blocks is not a good measure of the quantity of resources allocated by the program.
The two arguments used and max give the GC an idea of how much out-of-heap resources are consumed by the finalized block being allocated: you give the amount of resources allocated to this object as parameter used, and the maximum amount that you want to see in floating garbage as parameter max. The units are arbitrary: the GC cares only about the ratio used / max.
For instance, if you are allocating a finalized block holding an X Windows bitmap of w by h pixels, and you’d rather not have more than 1 mega-pixels of unreclaimed bitmaps, specify used = w * h and max = 1000000.
Another way to describe the effect of the used and max parameters is in terms of full GC cycles. If you allocate many custom blocks with used / max = 1 / N, the GC will then do one full cycle (examining every object in the heap and calling finalization functions on those that are unreachable) every N allocations. For instance, if used = 1 and max = 1000, the GC will do one full cycle at least every 1000 allocations of custom blocks.
If your finalized blocks contain no pointers to out-of-heap resources, or if the previous discussion made little sense to you, just take used = 0 and max = 1. But if you later find that the finalization functions are not called “often enough”, consider increasing the used / max ratio.
The data part of a custom block v can be accessed via the pointer Data_custom_val(v). This pointer has type void * and should be cast to the actual type of the data stored in the custom block.
The contents of custom blocks are not scanned by the garbage collector, and must therefore not contain any pointer inside the OCaml heap. In other terms, never store an OCaml value in a custom block, and do not use Field, Store_field nor caml_modify to access the data part of a custom block. Conversely, any C data structure (not containing heap pointers) can be stored in a custom block.
The following functions, defined in <caml/intext.h>, are provided to write and read back the contents of custom blocks in a portable way. Those functions handle endianness conversions when e.g. data is written on a little-endian machine and read back on a big-endian machine.
| Function | Action |
| caml_serialize_int_1 | Write a 1-byte integer |
| caml_serialize_int_2 | Write a 2-byte integer |
| caml_serialize_int_4 | Write a 4-byte integer |
| caml_serialize_int_8 | Write a 8-byte integer |
| caml_serialize_float_4 | Write a 4-byte float |
| caml_serialize_float_8 | Write a 8-byte float |
| caml_serialize_block_1 | Write an array of 1-byte quantities |
| caml_serialize_block_2 | Write an array of 2-byte quantities |
| caml_serialize_block_4 | Write an array of 4-byte quantities |
| caml_serialize_block_8 | Write an array of 8-byte quantities |
| caml_deserialize_uint_1 | Read an unsigned 1-byte integer |
| caml_deserialize_sint_1 | Read a signed 1-byte integer |
| caml_deserialize_uint_2 | Read an unsigned 2-byte integer |
| caml_deserialize_sint_2 | Read a signed 2-byte integer |
| caml_deserialize_uint_4 | Read an unsigned 4-byte integer |
| caml_deserialize_sint_4 | Read a signed 4-byte integer |
| caml_deserialize_uint_8 | Read an unsigned 8-byte integer |
| caml_deserialize_sint_8 | Read a signed 8-byte integer |
| caml_deserialize_float_4 | Read a 4-byte float |
| caml_deserialize_float_8 | Read an 8-byte float |
| caml_deserialize_block_1 | Read an array of 1-byte quantities |
| caml_deserialize_block_2 | Read an array of 2-byte quantities |
| caml_deserialize_block_4 | Read an array of 4-byte quantities |
| caml_deserialize_block_8 | Read an array of 8-byte quantities |
| caml_deserialize_error | Signal an error during deserialization; input_value or Marshal.from_... raise a Failure exception after cleaning up their internal data structures |
Serialization functions are attached to the custom blocks to which they apply. Obviously, deserialization functions cannot be attached this way, since the custom block does not exist yet when deserialization begins! Thus, the struct custom_operations that contain deserialization functions must be registered with the deserializer in advance, using the register_custom_operations function declared in <caml/custom.h>. Deserialization proceeds by reading the identifier off the input stream, allocating a custom block of the size specified in the input stream, searching the registered struct custom_operation blocks for one with the same identifier, and calling its deserialize function to fill the data part of the custom block.
Identifiers in struct custom_operations must be chosen carefully, since they must identify uniquely the data structure for serialization and deserialization operations. In particular, consider including a version number in the identifier; this way, the format of the data can be changed later, yet backward-compatible deserialisation functions can be provided.
Identifiers starting with _ (an underscore character) are reserved for the OCaml runtime system; do not use them for your custom data. We recommend to use a URL (http://mymachine.mydomain.com/mylibrary/version-number) or a Java-style package name (com.mydomain.mymachine.mylibrary.version-number) as identifiers, to minimize the risk of identifier collision.
Custom blocks generalize the finalized blocks that were present in OCaml prior to version 3.00. For backward compatibility, the format of custom blocks is compatible with that of finalized blocks, and the alloc_final function is still available to allocate a custom block with a given finalization function, but default comparison, hashing and serialization functions. caml_alloc_final(n, f, used, max) returns a fresh custom block of size n words, with finalization function f. The first word is reserved for storing the custom operations; the other n-1 words are available for your data. The two parameters used and max are used to control the speed of garbage collection, as described for caml_alloc_custom.
This section describe how to make calling C functions cheaper.
Note: this only applies to the native compiler. So whenever you use any of these methods, you have to provide an alternative byte-code stub that ignores all the special annotations.
We said earlier that all OCaml objects are represented by the C type value, and one has to use macros such as Int_val to decode data from the value type. It is however possible to tell OCaml to do this for us and pass arguments unboxed to the C function. Similarly it is possible to tell OCaml to expect the result unboxed and box it for us.
The motivation is that, by letting the OCaml compiler deal with boxing, it can often decide to suppress it entirely.
For instance let’s consider this example:
external foo : float -> float -> float = "foo"
let f a b =
let len = Array.length a in
assert (Array.length b = len);
let res = Array.make len 0. in
for i = 0 to len - 1 do
res.(i) <- foo a.(i) b.(i)
done
Float arrays are unboxed in OCaml, however the C function foo expect its arguments as boxed floats and returns a boxed float. Hence the OCaml compiler has no choice but to box a.(i) and b.(i) and unbox the result of foo. This results in the allocation of 3 * len temporary float values.
Now if we annotate the arguments and result with [@unboxed], the compiler will be able to avoid all these allocations:
external foo : (float [@unboxed]) -> (float [@unboxed]) -> (float [@unboxed]) = "foo_byte" "foo"
In this case the C functions must look like:
CAMLprim double foo(double a, double b)
{
...
}
CAMLprim value foo_byte(value a, value b)
{
return caml_copy_double(foo(Double_val(a), Double_val(b)))
}
For convenicence, when all arguments and the result are annotated with [@unboxed], it is possible to put the attribute only once on the declaration itself. So we can also write instead:
external foo : float -> float -> float = "foo_byte" "foo" [@@unboxed]
The following table summarize what OCaml types can be unboxed, and what C types should be used in correspondence:
| OCaml type | C type |
| float | double |
| int32 | int32_t |
| int64 | int64_t |
| nativeint | intnat |
Similarly, it is possible to pass untagged OCaml integers between OCaml and C. This is done by annotating the arguments and/or result with [@untagged]:
external f : string -> (int [@untagged]) = "f_byte" "f"
The corresponding C type must be intnat.
Note: do not use the C int type in correspondence with (int [@untagged]). This is because they often differ in size.
In order to be able to run the garbage collector in the middle of a C function, the OCaml compiler generates some bookkeeping code around C calls. Technically it wraps every C call with the C function caml_c_call which is part of the OCaml runtime.
For small functions that are called repeatedly, this indirection can have a big impact on performances. However this is not needed if we know that the C function doesn’t allocate and doesn’t raise exceptions. We can instruct the OCaml compiler of this fact by annotating the external declaration with the attribute [@@noalloc]:
external bar : int -> int -> int = "foo" [@@noalloc]
In this case calling bar from OCaml is as cheap as calling any other OCaml function, except for the fact that the OCaml compiler can’t inline C functions...
Using these attributes, it is possible to call C library functions with no indirection. For instance many math functions are defined this way in the OCaml standard library:
external sqrt : float -> float = "caml_sqrt_float" "sqrt" [@@unboxed] [@@noalloc] (** Square root. *) external exp : float -> float = "caml_exp_float" "exp" [@@unboxed] [@@noalloc] (** Exponential. *) external log : float -> float = "caml_log_float" "log" [@@unboxed] [@@noalloc] (** Natural logarithm. *)
Using multiple threads (shared-memory concurrency) in a mixed OCaml/C application requires special precautions, which are described in this section.
Callbacks from C to OCaml are possible only if the calling thread is known to the OCaml run-time system. Threads created from OCaml (through the Thread.create function of the system threads library) are automatically known to the run-time system. If the application creates additional threads from C and wishes to callback into OCaml code from these threads, it must first register them with the run-time system. The following functions are declared in the include file <caml/threads.h>.
The OCaml run-time system is not reentrant: at any time, at most one thread can be executing OCaml code or C code that uses the OCaml run-time system. Technically, this is enforced by a “master lock” that any thread must hold while executing such code.
When OCaml calls the C code implementing a primitive, the master lock is held, therefore the C code has full access to the facilities of the run-time system. However, no other thread can execute OCaml code concurrently with the C code of the primitive.
If a C primitive runs for a long time or performs potentially blocking input-output operations, it can explicitly release the master lock, enabling other OCaml threads to run concurrently with its operations. The C code must re-acquire the master lock before returning to OCaml. This is achieved with the following functions, declared in the include file <caml/threads.h>.
After caml_release_runtime_system() was called and until caml_acquire_runtime_system() is called, the C code must not access any OCaml data, nor call any function of the run-time system, nor call back into OCaml code. Consequently, arguments provided by OCaml to the C primitive must be copied into C data structures before calling caml_release_runtime_system(), and results to be returned to OCaml must be encoded as OCaml values after caml_acquire_runtime_system() returns.
Example: the following C primitive invokes gethostbyname to find the IP address of a host name. The gethostbyname function can block for a long time, so we choose to release the OCaml run-time system while it is running.
CAMLprim stub_gethostbyname(value vname)
{
CAMLparam1 (vname);
CAMLlocal1 (vres);
struct hostent * h;
char * name;
/* Copy the string argument to a C string, allocated outside the
OCaml heap. */
name = caml_stat_alloc(caml_string_length(vname) + 1);
name = caml_strdup(String_val(vname));
/* Release the OCaml run-time system */
caml_release_runtime_system();
/* Resolve the name */
h = gethostbyname(name);
/* Free the copy of the string, which we might as well do before
acquiring the runtime system to benefit from parallelism. */
caml_stat_free(name);
/* Re-acquire the OCaml run-time system */
caml_acquire_runtime_system();
/* Encode the relevant fields of h as the OCaml value vres */
... /* Omitted */
/* Return to OCaml */
CAMLreturn (vres);
}
Callbacks from C to OCaml must be performed while holding the master lock to the OCaml run-time system. This is naturally the case if the callback is performed by a C primitive that did not release the run-time system. If the C primitive released the run-time system previously, or the callback is performed from other C code that was not invoked from OCaml (e.g. an event loop in a GUI application), the run-time system must be acquired before the callback and released after:
caml_acquire_runtime_system(); /* Resolve OCaml function vfun to be invoked */ /* Build OCaml argument varg to the callback */ vres = callback(vfun, varg); /* Copy relevant parts of result vres to C data structures */ caml_release_runtime_system();
Note: the acquire and release functions described above were introduced in OCaml 3.12. Older code uses the following historical names, declared in <caml/signals.h>:
Intuition: a “blocking section” is a piece of C code that does not use the OCaml run-time system, typically a blocking input/output operation.
The ocamlmklib command facilitates the construction of libraries containing both OCaml code and C code, and usable both in static linking and dynamic linking modes. This command is available under Windows since Objective Caml 3.11 and under other operating systems since Objective Caml 3.03.
The ocamlmklib command takes three kinds of arguments:
It generates the following outputs:
In addition, the following options are recognized:
On native Windows, the following environment variable is also consulted:
Consider an OCaml interface to the standard libz C library for reading and writing compressed files. Assume this library resides in /usr/local/zlib. This interface is composed of an OCaml part zip.cmo/zip.cmx and a C part zipstubs.o containing the stub code around the libz entry points. The following command builds the OCaml libraries zip.cma and zip.cmxa, as well as the companion C libraries dllzip.so and libzip.a:
ocamlmklib -o zip zip.cmo zip.cmx zipstubs.o -lz -L/usr/local/zlib
If shared libraries are supported, this performs the following commands:
ocamlc -a -o zip.cma zip.cmo -dllib -lzip \
-cclib -lzip -cclib -lz -ccopt -L/usr/local/zlib
ocamlopt -a -o zip.cmxa zip.cmx -cclib -lzip \
-cclib -lzip -cclib -lz -ccopt -L/usr/local/zlib
gcc -shared -o dllzip.so zipstubs.o -lz -L/usr/local/zlib
ar rc libzip.a zipstubs.o
Note: This example is on a Unix system. The exact command lines may be different on other systems.
If shared libraries are not supported, the following commands are performed instead:
ocamlc -a -custom -o zip.cma zip.cmo -cclib -lzip \
-cclib -lz -ccopt -L/usr/local/zlib
ocamlopt -a -o zip.cmxa zip.cmx -lzip \
-cclib -lz -ccopt -L/usr/local/zlib
ar rc libzip.a zipstubs.o
Instead of building simultaneously the bytecode library, the native-code library and the C libraries, ocamlmklib can be called three times to build each separately. Thus,
ocamlmklib -o zip zip.cmo -lz -L/usr/local/zlib
builds the bytecode library zip.cma, and
ocamlmklib -o zip zip.cmx -lz -L/usr/local/zlib
builds the native-code library zip.cmxa, and
ocamlmklib -o zip zipstubs.o -lz -L/usr/local/zlib
builds the C libraries dllzip.so and libzip.a. Notice that the support libraries (-lz) and the corresponding options (-L/usr/local/zlib) must be given on all three invocations of ocamlmklib, because they are needed at different times depending on whether shared libraries are supported.
ocaml-doc-4.05/ocaml.html/foreword.html 0000644 0001750 0001750 00000007655 13131636457 017037 0 ustar mehdi mehdi
This manual documents the release 4.05 of the OCaml system. It is organized as follows.
OCaml runs on several operating systems. The parts of this manual that are specific to one operating system are presented as shown below:
Unix: This is material specific to the Unix family of operating systems, including Linux and MacOS X.
Windows: This is material specific to Microsoft Windows (XP, Vista, 7, 8, 10).
The OCaml system is copyright © 1996–2013 Institut National de Recherche en Informatique et en Automatique (INRIA). INRIA holds all ownership rights to the OCaml system.
The OCaml system is open source and can be freely redistributed. See the file LICENSE in the distribution for licensing information.
The present documentation is copyright © 2013 Institut National de Recherche en Informatique et en Automatique (INRIA). The OCaml documentation and user’s manual may be reproduced and distributed in whole or in part, subject to the following conditions:
The complete OCaml distribution can be accessed via the community Caml Web site and the older Caml Web site. The community Caml Web site contains a lot of additional information on OCaml.
ocaml-doc-4.05/ocaml.html/manual047.html 0000644 0001750 0001750 00000040643 13131636457 016712 0 ustar mehdi mehdi
|
|
ocaml-doc-4.05/ocaml.html/afl-fuzz.html 0000644 0001750 0001750 00000007665 13131636457 016747 0 ustar mehdi mehdi
American fuzzy lop (“afl-fuzz”) is a fuzzer, a tool for testing software by providing randomly-generated inputs, searching for those inputs which cause the program to crash.
Unlike most fuzzers, afl-fuzz observes the internal behaviour of the program being tested, and adjusts the test cases it generates to trigger unexplored execution paths. As a result, test cases generated by afl-fuzz cover more of the possible behaviours of the tested program than other fuzzers.
This requires that programs to be tested are instrumented to communicate with afl-fuzz. The native-code compiler “ocamlopt” can generate such instrumentation, allowing afl-fuzz to be used against programs written in OCaml.
For more information on afl-fuzz, see the website at http://lcamtuf.coredump.cx/afl/.
The instrumentation that afl-fuzz requires is not generated by default, and must be explicitly enabled, by passing the -afl-instrument option to ocamlopt.
To fuzz a large system without modifying build tools, OCaml’s configure script also accepts the afl-instrument option. If OCaml is configured with afl-instrument, then all programs compiled by ocamlopt will be instrumented.
In rare cases, it is useful to control the amount of instrumentation generated. By passing the -afl-inst-ratio N argument to ocamlopt with N less than 100, instrumentation can be generated for only N% of branches. (See the afl-fuzz documentation on the parameter AFL_INST_RATIO for the precise effect of this).
As an example, we fuzz-test the following program, readline.ml:
let _ =
let s = read_line () in
match Array.to_list (Array.init (String.length s) (String.get s)) with
['s'; 'e'; 'c'; 'r'; 'e'; 't'; ' '; 'c'; 'o'; 'd'; 'e'] -> failwith "uh oh"
| _ -> ()
There is a single input (the string “secret code”) which causes this program to crash, but finding it by blind random search is infeasible.
Instead, we compile with afl-fuzz instrumentation enabled:
ocamlopt -afl-instrument readline.ml -o readline
Next, we run the program under afl-fuzz:
mkdir input echo asdf > input/testcase mkdir output afl-fuzz -i input -o output ./readline
By inspecting instrumentation output, the fuzzer finds the crashing input quickly.
ocaml-doc-4.05/ocaml.html/libthreads.html 0000644 0001750 0001750 00000007661 13131636457 017326 0 ustar mehdi mehdi
The threads library allows concurrent programming in OCaml. It provides multiple threads of control (also called lightweight processes) that execute concurrently in the same memory space. Threads communicate by in-place modification of shared data structures, or by sending and receiving data on communication channels.
The threads library is implemented by time-sharing on a single processor. It will not take advantage of multi-processor machines. Using this library will therefore never make programs run faster. However, many programs are easier to write when structured as several communicating processes.
Two implementations of the threads library are available, depending on the capabilities of the operating system:
Programs that use system threads must be linked as follows:
ocamlc -thread other options unix.cma threads.cma other files
ocamlopt -thread other options unix.cmxa threads.cmxa other files
Compilation units that use the threads library must also be compiled with the -thread option (see chapter 8).
Programs that use VM-level threads must be compiled with the -vmthread option to ocamlc (see chapter 8), and be linked as follows:
ocamlc -vmthread other options threads.cma other files
Compilation units that use threads library must also be compiled with the -vmthread option (see chapter 8).
ocaml-doc-4.05/ocaml.html/expr.html 0000644 0001750 0001750 00000346461 13131636457 016167 0 ustar mehdi mehdi
|
|
See also the following language extensions: local opens, record and object notations, explicit polymorphic type annotations, first-class modules, overriding in open statements, syntax for Bigarray access, attributes, extension nodes and local exceptions.
The table below shows the relative precedences and associativity of operators and non-closed constructions. The constructions with higher precedence come first. For infix and prefix symbols, we write “*…” to mean “any symbol starting with *”.
| Construction or operator | Associativity |
| prefix-symbol | – |
| . .( .[ .{ (see section 7.17) | – |
| #… | – |
| function application, constructor application, tag application, assert, lazy | left |
| - -. (prefix) | – |
| **… lsl lsr asr | right |
| *… /… %… mod land lor lxor | left |
| +… -… | left |
| :: | right |
| @… ^… | right |
| =… <… >… |… &… $… != | left |
| & && | right |
| or || | right |
| , | – |
| <- := | right |
| if | – |
| ; | right |
| let match fun function try | – |
An expression consisting in a constant evaluates to this constant.
An expression consisting in an access path evaluates to the value bound to this path in the current evaluation environment. The path can be either a value name or an access path to a value component of a module.
The expressions ( expr ) and begin expr end have the same value as expr. The two constructs are semantically equivalent, but it is good style to use begin … end inside control structures:
if … then begin … ; … end else begin … ; … end
and ( … ) for the other grouping situations.
Parenthesized expressions can contain a type constraint, as in ( expr : typexpr ). This constraint forces the type of expr to be compatible with typexpr.
Parenthesized expressions can also contain coercions ( expr [: typexpr] :> typexpr) (see subsection 6.7.6 below).
Function application is denoted by juxtaposition of (possibly labeled) expressions. The expression expr argument1 … argumentn evaluates the expression expr and those appearing in argument1 to argumentn. The expression expr must evaluate to a functional value f, which is then applied to the values of argument1, …, argumentn.
The order in which the expressions expr, argument1, …, argumentn are evaluated is not specified.
Arguments and parameters are matched according to their respective labels. Argument order is irrelevant, except among arguments with the same label, or no label.
If a parameter is specified as optional (label prefixed by ?) in the type of expr, the corresponding argument will be automatically wrapped with the constructor Some, except if the argument itself is also prefixed by ?, in which case it is passed as is. If a non-labeled argument is passed, and its corresponding parameter is preceded by one or several optional parameters, then these parameters are defaulted, i.e. the value None will be passed for them. All other missing parameters (without corresponding argument), both optional and non-optional, will be kept, and the result of the function will still be a function of these missing parameters to the body of f.
As a special case, if the function has a known arity, all the arguments are unlabeled, and their number matches the number of non-optional parameters, then labels are ignored and non-optional parameters are matched in their definition order. Optional arguments are defaulted.
In all cases but exact match of order and labels, without optional parameters, the function type should be known at the application point. This can be ensured by adding a type constraint. Principality of the derivation can be checked in the -principal mode.
Two syntactic forms are provided to define functions. The first form is introduced by the keyword function:
|
This expression evaluates to a functional value with one argument. When this function is applied to a value v, this value is matched against each pattern pattern1 to patternn. If one of these matchings succeeds, that is, if the value v matches the pattern patterni for some i, then the expression expri associated to the selected pattern is evaluated, and its value becomes the value of the function application. The evaluation of expri takes place in an environment enriched by the bindings performed during the matching.
If several patterns match the argument v, the one that occurs first in the function definition is selected. If none of the patterns matches the argument, the exception Match_failure is raised.
The other form of function definition is introduced by the keyword fun:
This expression is equivalent to:
An optional type constraint typexpr can be added before -> to enforce the type of the result to be compatible with the constraint typexpr:
is equivalent to
Beware of the small syntactic difference between a type constraint on the last parameter
and one on the result
The parameter patterns ~lab and ~(lab [: typ]) are shorthands for respectively ~lab: lab and ~lab:( lab [: typ]), and similarly for their optional counterparts.
A function of the form fun ? lab :( pattern = expr0 ) -> expr is equivalent to
where ident is a fresh variable, except that it is unspecified when expr0 is evaluated.
After these two transformations, expressions are of the form
If we ignore labels, which will only be meaningful at function application, this is equivalent to
That is, the fun expression above evaluates to a curried function with n arguments: after applying this function n times to the values v1 … vn, the values will be matched in parallel against the patterns pattern1 … patternn. If the matching succeeds, the function returns the value of expr in an environment enriched by the bindings performed during the matchings. If the matching fails, the exception Match_failure is raised.
The cases of a pattern matching (in the function, match and try constructs) can include guard expressions, which are arbitrary boolean expressions that must evaluate to true for the match case to be selected. Guards occur just before the -> token and are introduced by the when keyword:
|
Matching proceeds as described before, except that if the value matches some pattern patterni which has a guard condi, then the expression condi is evaluated (in an environment enriched by the bindings performed during matching). If condi evaluates to true, then expri is evaluated and its value returned as the result of the matching, as usual. But if condi evaluates to false, the matching is resumed against the patterns following patterni.
The let and let rec constructs bind value names locally. The construct
evaluates expr1 … exprn in some unspecified order and matches their values against the patterns pattern1 … patternn. If the matchings succeed, expr is evaluated in the environment enriched by the bindings performed during matching, and the value of expr is returned as the value of the whole let expression. If one of the matchings fails, the exception Match_failure is raised.
An alternate syntax is provided to bind variables to functional values: instead of writing
in a let expression, one may instead write
Recursive definitions of names are introduced by let rec:
The only difference with the let construct described above is that the bindings of names to values performed by the pattern-matching are considered already performed when the expressions expr1 to exprn are evaluated. That is, the expressions expr1 to exprn can reference identifiers that are bound by one of the patterns pattern1, …, patternn, and expect them to have the same value as in expr, the body of the let rec construct.
The recursive definition is guaranteed to behave as described above if the expressions expr1 to exprn are function definitions (fun … or function …), and the patterns pattern1 … patternn are just value names, as in:
This defines name1 … namen as mutually recursive functions local to expr.
The behavior of other forms of let rec definitions is implementation-dependent. The current implementation also supports a certain class of recursive definitions of non-functional values, as explained in section 7.2.
The expression expr1 ; expr2 evaluates expr1 first, then expr2, and returns the value of expr2.
The expression if expr1 then expr2 else expr3 evaluates to the value of expr2 if expr1 evaluates to the boolean true, and to the value of expr3 if expr1 evaluates to the boolean false.
The else expr3 part can be omitted, in which case it defaults to else ().
The expression
|
matches the value of expr against the patterns pattern1 to patternn. If the matching against patterni succeeds, the associated expression expri is evaluated, and its value becomes the value of the whole match expression. The evaluation of expri takes place in an environment enriched by the bindings performed during matching. If several patterns match the value of expr, the one that occurs first in the match expression is selected. If none of the patterns match the value of expr, the exception Match_failure is raised.
The expression expr1 && expr2 evaluates to true if both expr1 and expr2 evaluate to true; otherwise, it evaluates to false. The first component, expr1, is evaluated first. The second component, expr2, is not evaluated if the first component evaluates to false. Hence, the expression expr1 && expr2 behaves exactly as
The expression expr1 || expr2 evaluates to true if one of the expressions expr1 and expr2 evaluates to true; otherwise, it evaluates to false. The first component, expr1, is evaluated first. The second component, expr2, is not evaluated if the first component evaluates to true. Hence, the expression expr1 || expr2 behaves exactly as
The boolean operators & and or are deprecated synonyms for (respectively) && and ||.
The expression while expr1 do expr2 done repeatedly evaluates expr2 while expr1 evaluates to true. The loop condition expr1 is evaluated and tested at the beginning of each iteration. The whole while … done expression evaluates to the unit value ().
The expression for name = expr1 to expr2 do expr3 done first evaluates the expressions expr1 and expr2 (the boundaries) into integer values n and p. Then, the loop body expr3 is repeatedly evaluated in an environment where name is successively bound to the values n, n+1, …, p−1, p. The loop body is never evaluated if n > p.
The expression for name = expr1 downto expr2 do expr3 done evaluates similarly, except that name is successively bound to the values n, n−1, …, p+1, p. The loop body is never evaluated if n < p.
In both cases, the whole for expression evaluates to the unit value ().
The expression
|
evaluates the expression expr and returns its value if the evaluation of expr does not raise any exception. If the evaluation of expr raises an exception, the exception value is matched against the patterns pattern1 to patternn. If the matching against patterni succeeds, the associated expression expri is evaluated, and its value becomes the value of the whole try expression. The evaluation of expri takes place in an environment enriched by the bindings performed during matching. If several patterns match the value of expr, the one that occurs first in the try expression is selected. If none of the patterns matches the value of expr, the exception value is raised again, thereby transparently “passing through” the try construct.
The expression expr1 , … , exprn evaluates to the n-tuple of the values of expressions expr1 to exprn. The evaluation order of the subexpressions is not specified.
The expression constr expr evaluates to the unary variant value whose constructor is constr, and whose argument is the value of expr. Similarly, the expression constr ( expr1 , … , exprn ) evaluates to the n-ary variant value whose constructor is constr and whose arguments are the values of expr1, …, exprn.
The expression constr ( expr1, …, exprn) evaluates to the variant value whose constructor is constr, and whose arguments are the values of expr1 … exprn.
For lists, some syntactic sugar is provided. The expression expr1 :: expr2 stands for the constructor ( :: ) applied to the arguments ( expr1 , expr2 ), and therefore evaluates to the list whose head is the value of expr1 and whose tail is the value of expr2. The expression [ expr1 ; … ; exprn ] is equivalent to expr1 :: … :: exprn :: [], and therefore evaluates to the list whose elements are the values of expr1 to exprn.
The expression `tag-name expr evaluates to the polymorphic variant value whose tag is tag-name, and whose argument is the value of expr.
The expression { field1 = expr1 ; … ; fieldn = exprn } evaluates to the record value { field1 = v1; …; fieldn = vn } where vi is the value of expri for i = 1,… , n. The fields field1 to fieldn must all belong to the same record type; each field of this record type must appear exactly once in the record expression, though they can appear in any order. The order in which expr1 to exprn are evaluated is not specified. Optional type constraints can be added after each field { field1 : typexpr1 = expr1 ;… ; fieldn : typexprn = exprn } to force the type of fieldk to be compatible with typexprk.
The expression { expr with field1 = expr1 ; … ; fieldn = exprn } builds a fresh record with fields field1 … fieldn equal to expr1 … exprn, and all other fields having the same value as in the record expr. In other terms, it returns a shallow copy of the record expr, except for the fields field1 … fieldn, which are initialized to expr1 … exprn. As previously, it is possible to add an optional type constraint on each field being updated with { expr with field1 : typexpr1 = expr1 ; … ; fieldn : typexprn = exprn }.
The expression expr1 . field evaluates expr1 to a record value, and returns the value associated to field in this record value.
The expression expr1 . field <- expr2 evaluates expr1 to a record value, which is then modified in-place by replacing the value associated to field in this record by the value of expr2. This operation is permitted only if field has been declared mutable in the definition of the record type. The whole expression expr1 . field <- expr2 evaluates to the unit value ().
The expression [| expr1 ; … ; exprn |] evaluates to a n-element array, whose elements are initialized with the values of expr1 to exprn respectively. The order in which these expressions are evaluated is unspecified.
The expression expr1 .( expr2 ) returns the value of element number expr2 in the array denoted by expr1. The first element has number 0; the last element has number n−1, where n is the size of the array. The exception Invalid_argument is raised if the access is out of bounds.
The expression expr1 .( expr2 ) <- expr3 modifies in-place the array denoted by expr1, replacing element number expr2 by the value of expr3. The exception Invalid_argument is raised if the access is out of bounds. The value of the whole expression is ().
The expression expr1 .[ expr2 ] returns the value of character number expr2 in the string denoted by expr1. The first character has number 0; the last character has number n−1, where n is the length of the string. The exception Invalid_argument is raised if the access is out of bounds.
The expression expr1 .[ expr2 ] <- expr3 modifies in-place the string denoted by expr1, replacing character number expr2 by the value of expr3. The exception Invalid_argument is raised if the access is out of bounds. The value of the whole expression is ().
Note: this possibility is offered only for backward compatibility with older versions of OCaml and will be removed in a future version. New code should use byte sequences and the Bytes.set function.
Symbols from the class infix-symbol, as well as the keywords *, +, -, -., =, !=, <, >, or, ||, &, &&, :=, mod, land, lor, lxor, lsl, lsr, and asr can appear in infix position (between two expressions). Symbols from the class prefix-symbol, as well as the keywords - and -. can appear in prefix position (in front of an expression).
Infix and prefix symbols do not have a fixed meaning: they are simply interpreted as applications of functions bound to the names corresponding to the symbols. The expression prefix-symbol expr is interpreted as the application ( prefix-symbol ) expr. Similarly, the expression expr1 infix-symbol expr2 is interpreted as the application ( infix-symbol ) expr1 expr2.
The table below lists the symbols defined in the initial environment and their initial meaning. (See the description of the core library module Pervasives in chapter 23 for more details). Their meaning may be changed at any time using let ( infix-op ) name1 name2 = …
Note: the operators &&, ||, and ~- are handled specially and it is not advisable to change their meaning.
The keywords - and -. can appear both as infix and prefix operators. When they appear as prefix operators, they are interpreted respectively as the functions (~-) and (~-.).
| Operator | Initial meaning |
| + | Integer addition. |
| - (infix) | Integer subtraction. |
| ~- - (prefix) | Integer negation. |
| * | Integer multiplication. |
| / | Integer division. Raise Division_by_zero if second argument is zero. |
| mod | Integer modulus. Raise Division_by_zero if second argument is zero. |
| land | Bitwise logical “and” on integers. |
| lor | Bitwise logical “or” on integers. |
| lxor | Bitwise logical “exclusive or” on integers. |
| lsl | Bitwise logical shift left on integers. |
| lsr | Bitwise logical shift right on integers. |
| asr | Bitwise arithmetic shift right on integers. |
| +. | Floating-point addition. |
| -. (infix) | Floating-point subtraction. |
| ~-. -. (prefix) | Floating-point negation. |
| *. | Floating-point multiplication. |
| /. | Floating-point division. |
| ** | Floating-point exponentiation. |
| @ | List concatenation. |
| ^ | String concatenation. |
| ! | Dereferencing (return the current contents of a reference). |
| := | Reference assignment (update the reference given as first argument with the value of the second argument). |
| = | Structural equality test. |
| <> | Structural inequality test. |
| == | Physical equality test. |
| != | Physical inequality test. |
| < | Test “less than”. |
| <= | Test “less than or equal”. |
| > | Test “greater than”. |
| >= | Test “greater than or equal”. |
| && & | Boolean conjunction. |
| || or | Boolean disjunction. |
When class-path evaluates to a class body, new class-path evaluates to a new object containing the instance variables and methods of this class.
When class-path evaluates to a class function, new class-path evaluates to a function expecting the same number of arguments and returning a new object of this class.
Creating directly an object through the object class-body end construct is operationally equivalent to defining locally a class class-name = object class-body end —see sections 6.9.2 and following for the syntax of class-body— and immediately creating a single object from it by new class-name.
The typing of immediate objects is slightly different from explicitly defining a class in two respects. First, the inferred object type may contain free type variables. Second, since the class body of an immediate object will never be extended, its self type can be unified with a closed object type.
The expression expr # method-name invokes the method method-name of the object denoted by expr.
If method-name is a polymorphic method, its type should be known at the invocation site. This is true for instance if expr is the name of a fresh object (let ident = new class-path … ) or if there is a type constraint. Principality of the derivation can be checked in the -principal mode.
The instance variables of a class are visible only in the body of the methods defined in the same class or a class that inherits from the class defining the instance variables. The expression inst-var-name evaluates to the value of the given instance variable. The expression inst-var-name <- expr assigns the value of expr to the instance variable inst-var-name, which must be mutable. The whole expression inst-var-name <- expr evaluates to ().
An object can be duplicated using the library function Oo.copy (see Module Oo). Inside a method, the expression {< inst-var-name = expr { ; inst-var-name = expr } >} returns a copy of self with the given instance variables replaced by the values of the associated expressions; other instance variables have the same value in the returned object as in self.
Expressions whose type contains object or polymorphic variant types can be explicitly coerced (weakened) to a supertype. The expression (expr :> typexpr) coerces the expression expr to type typexpr. The expression (expr : typexpr1 :> typexpr2) coerces the expression expr from type typexpr1 to type typexpr2.
The former operator will sometimes fail to coerce an expression expr from a type typ1 to a type typ2 even if type typ1 is a subtype of type typ2: in the current implementation it only expands two levels of type abbreviations containing objects and/or polymorphic variants, keeping only recursion when it is explicit in the class type (for objects). As an exception to the above algorithm, if both the inferred type of expr and typ are ground (i.e. do not contain type variables), the former operator behaves as the latter one, taking the inferred type of expr as typ1. In case of failure with the former operator, the latter one should be used.
It is only possible to coerce an expression expr from type typ1 to type typ2, if the type of expr is an instance of typ1 (like for a type annotation), and typ1 is a subtype of typ2. The type of the coerced expression is an instance of typ2. If the types contain variables, they may be instantiated by the subtyping algorithm, but this is only done after determining whether typ1 is a potential subtype of typ2. This means that typing may fail during this latter unification step, even if some instance of typ1 is a subtype of some instance of typ2. In the following paragraphs we describe the subtyping relation used.
A fixed object type admits as subtype any object type that includes all its methods. The types of the methods shall be subtypes of those in the supertype. Namely,
is a supertype of
which may contain an ellipsis .. if every typi is a supertype of the corresponding typ′i.
A monomorphic method type can be a supertype of a polymorphic method type. Namely, if typ is an instance of typ′, then 'a1 … 'an . typ′ is a subtype of typ.
Inside a class definition, newly defined types are not available for subtyping, as the type abbreviations are not yet completely defined. There is an exception for coercing self to the (exact) type of its class: this is allowed if the type of self does not appear in a contravariant position in the class type, i.e. if there are no binary methods.
A polymorphic variant type typ is a subtype of another polymorphic variant type typ′ if the upper bound of typ (i.e. the maximum set of constructors that may appear in an instance of typ) is included in the lower bound of typ′, and the types of arguments for the constructors of typ are subtypes of those in typ′. Namely,
which may be a shrinkable type, is a subtype of
which may be an extensible type, if every typi is a subtype of typ′i.
Other types do not introduce new subtyping, but they may propagate the subtyping of their arguments. For instance, typ1 * typ2 is a subtype of typ′1 * typ′2 when typ1 and typ2 are respectively subtypes of typ′1 and typ′2. For function types, the relation is more subtle: typ1 -> typ2 is a subtype of typ′1 -> typ′2 if typ1 is a supertype of typ′1 and typ2 is a subtype of typ′2. For this reason, function types are covariant in their second argument (like tuples), but contravariant in their first argument. Mutable types, like array or ref are neither covariant nor contravariant, they are nonvariant, that is they do not propagate subtyping.
For user-defined types, the variance is automatically inferred: a parameter is covariant if it has only covariant occurrences, contravariant if it has only contravariant occurrences, variance-free if it has no occurrences, and nonvariant otherwise. A variance-free parameter may change freely through subtyping, it does not have to be a subtype or a supertype. For abstract and private types, the variance must be given explicitly (see section 6.8.1), otherwise the default is nonvariant. This is also the case for constrained arguments in type definitions.
OCaml supports the assert construct to check debugging assertions. The expression assert expr evaluates the expression expr and returns () if expr evaluates to true. If it evaluates to false the exception Assert_failure is raised with the source file name and the location of expr as arguments. Assertion checking can be turned off with the -noassert compiler option. In this case, expr is not evaluated at all.
As a special case, assert false is reduced to raise (Assert_failure ...), which gives it a polymorphic type. This means that it can be used in place of any expression (for example as a branch of any pattern-matching). It also means that the assert false “assertions” cannot be turned off by the -noassert option.
The expression lazy expr returns a value v of type Lazy.t that encapsulates the computation of expr. The argument expr is not evaluated at this point in the program. Instead, its evaluation will be performed the first time the function Lazy.force is applied to the value v, returning the actual value of expr. Subsequent applications of Lazy.force to v do not evaluate expr again. Applications of Lazy.force may be implicit through pattern matching (see 7.3).
The expression let module module-name = module-expr in expr locally binds the module expression module-expr to the identifier module-name during the evaluation of the expression expr. It then returns the value of expr. For example:
let remove_duplicates comparison_fun string_list =
let module StringSet =
Set.Make(struct type t = string
let compare = comparison_fun end) in
StringSet.elements
(List.fold_right StringSet.add string_list StringSet.empty)
ocaml-doc-4.05/ocaml.html/types.html 0000644 0001750 0001750 00000064003 13131636457 016342 0 ustar mehdi mehdi
|
See also the following language extensions: first-class modules, attributes and extension nodes.
The table below shows the relative precedences and associativity of operators and non-closed type constructions. The constructions with higher precedences come first.
| Operator | Associativity |
| Type constructor application | – |
| # | – |
| * | – |
| -> | right |
| as | – |
Type expressions denote types in definitions of data types as well as in type constraints over patterns and expressions.
The type expression ' ident stands for the type variable named ident. The type expression _ stands for either an anonymous type variable or anonymous type parameters. In data type definitions, type variables are names for the data type parameters. In type constraints, they represent unspecified types that can be instantiated by any type to satisfy the type constraint. In general the scope of a named type variable is the whole top-level phrase where it appears, and it can only be generalized when leaving this scope. Anonymous variables have no such restriction. In the following cases, the scope of named type variables is restricted to the type expression where they appear: 1) for universal (explicitly polymorphic) type variables; 2) for type variables that only appear in public method specifications (as those variables will be made universal, as described in section 6.9.1); 3) for variables used as aliases, when the type they are aliased to would be invalid in the scope of the enclosing definition (i.e. when it contains free universal type variables, or locally defined types.)
The type expression ( typexpr ) denotes the same type as typexpr.
The type expression typexpr1 -> typexpr2 denotes the type of functions mapping arguments of type typexpr1 to results of type typexpr2.
label-name : typexpr1 -> typexpr2 denotes the same function type, but the argument is labeled label.
? label-name : typexpr1 -> typexpr2 denotes the type of functions mapping an optional labeled argument of type typexpr1 to results of type typexpr2. That is, the physical type of the function will be typexpr1 option -> typexpr2.
The type expression typexpr1 * … * typexprn denotes the type of tuples whose elements belong to types typexpr1, … typexprn respectively.
Type constructors with no parameter, as in typeconstr, are type expressions.
The type expression typexpr typeconstr, where typeconstr is a type constructor with one parameter, denotes the application of the unary type constructor typeconstr to the type typexpr.
The type expression (typexpr1,…, typexprn) typeconstr, where typeconstr is a type constructor with n parameters, denotes the application of the n-ary type constructor typeconstr to the types typexpr1 through typexprn.
In the type expression _ typeconstr , the anonymous type expression _ stands in for anonymous type parameters and is equivalent to (_, …,_) with as many repetitions of _ as the arity of typeconstr.
The type expression typexpr as ' ident denotes the same type as typexpr, and also binds the type variable ident to type typexpr both in typexpr and in other types. In general the scope of an alias is the same as for a named type variable, and covers the whole enclosing definition. If the type variable ident actually occurs in typexpr, a recursive type is created. Recursive types for which there exists a recursive path that does not contain an object or polymorphic variant type constructor are rejected, except when the -rectypes mode is selected.
If ' ident denotes an explicit polymorphic variable, and typexpr denotes either an object or polymorphic variant type, the row variable of typexpr is captured by ' ident, and quantified upon.
|
Polymorphic variant types describe the values a polymorphic variant may take.
The first case is an exact variant type: all possible tags are known, with their associated types, and they can all be present. Its structure is fully known.
The second case is an open variant type, describing a polymorphic variant value: it gives the list of all tags the value could take, with their associated types. This type is still compatible with a variant type containing more tags. A special case is the unknown type, which does not define any tag, and is compatible with any variant type.
The third case is a closed variant type. It gives information about all the possible tags and their associated types, and which tags are known to potentially appear in values. The exact variant type (first case) is just an abbreviation for a closed variant type where all possible tags are also potentially present.
In all three cases, tags may be either specified directly in the `tag-name [of typexpr] form, or indirectly through a type expression, which must expand to an exact variant type, whose tag specifications are inserted in its place.
Full specifications of variant tags are only used for non-exact closed types. They can be understood as a conjunctive type for the argument: it is intended to have all the types enumerated in the specification.
Such conjunctive constraints may be unsatisfiable. In such a case the corresponding tag may not be used in a value of this type. This does not mean that the whole type is not valid: one can still use other available tags. Conjunctive constraints are mainly intended as output from the type checker. When they are used in source programs, unsolvable constraints may cause early failures.
An object type < [method-type { ; method-type }] > is a record of method types.
Each method may have an explicit polymorphic type: { ' ident }+ . typexpr. Explicit polymorphic variables have a local scope, and an explicit polymorphic type can only be unified to an equivalent one, where only the order and names of polymorphic variables may change.
The type < {method-type ;} .. > is the type of an object whose method names and types are described by method-type1, …, method-typen, and possibly some other methods represented by the ellipsis. This ellipsis actually is a special kind of type variable (called row variable in the literature) that stands for any number of extra method types.
The type # class-path is a special kind of abbreviation. This abbreviation unifies with the type of any object belonging to a subclass of class class-path. It is handled in a special way as it usually hides a type variable (an ellipsis, representing the methods that may be added in a subclass). In particular, it vanishes when the ellipsis gets instantiated. Each type expression # class-path defines a new type variable, so type # class-path -> # class-path is usually not the same as type (# class-path as ' ident) -> ' ident.
Use of #-types to abbreviate polymorphic variant types is deprecated. If t is an exact variant type then #t translates to [< t], and #t[> `tag1 …` tagk] translates to [< t > `tag1 …` tagk]
There are no type expressions describing (defined) variant types nor record types, since those are always named, i.e. defined before use and referred to by name. Type definitions are described in section 6.8.1.
ocaml-doc-4.05/ocaml.html/manual032.html 0000644 0001750 0001750 00000002140 13131636457 016672 0 ustar mehdi mehdi
Since OCaml version 4.03, the ocamlbuild compilation manager is distributed separately from the OCaml compiler. The project is now hosted at https://github.com/ocaml/ocamlbuild/.
ocaml-doc-4.05/ocaml.html/parsing.html 0000644 0001750 0001750 00000007016 13131636457 016642 0 ustar mehdi mehdi
This chapter describes the OCaml front-end, which declares the abstract syntax tree used by the compiler, provides a way to parse, print and pretty-print OCaml code, and ultimately allows to write abstract syntax tree preprocessors invoked via the -ppx flag (see chapters 8 and 11).
It is important to note that the exported front-end interface follows the evolution of the OCaml language and implementation, and thus does not provide any backwards compatibility guarantees.
The front-end is a part of compiler-libs library. Programs that use the compiler-libs library should be built as follows:
ocamlfind ocamlc other options -package compiler-libs.common other files
ocamlfind ocamlopt other options -package compiler-libs.common other files
Use of the ocamlfind utility is recommended. However, if this is not possible, an alternative method may be used:
ocamlc other options -I +compiler-libs ocamlcommon.cma other files
ocamlopt other options -I +compiler-libs ocamlcommon.cmxa other files
For interactive use of the compiler-libs library, start ocaml and
type
#load "compiler-libs/ocamlcommon.cma";;.
ocaml-doc-4.05/ocaml.html/previous_motif.gif 0000644 0001750 0001750 00000000475 13131636457 020054 0 ustar mehdi mehdi GIF89a p p!# Imported from XPM image: prev.xpm ! , @63333# B 0 A0 0 0 0 `0 `0 A `0 `00000000000000000000000000000000000000 000000 000 0000000000000 000000000000000000`
; ocaml-doc-4.05/ocaml.info/ 0000755 0001750 0001750 00000000000 13142673356 014275 5 ustar mehdi mehdi ocaml-doc-4.05/ocaml.info/ocaml.info.body-12.gz 0000644 0001750 0001750 00000034310 13131636470 020033 0 ustar mehdi mehdi 8=gYocaml.info.body-12 }iFgO\~x45jBGeϰ#dy}Y +i((_$
c--{s߲USj9T 3Zp 1Vf:){9MYn짷#< n դgXXniF6*P emFRz&;@蕢u TERW(I\WTJ8Bib=ߢCBo++C%!zz9E{ˣ jnsuP
kU ^P)ˢls5[!4&QZ9+&L) CNϷ)/G(,zwӓa/k
U6p%hbSu@ %[Юa!U0-o:-@5W,TQ&irI8/L,=$B{
K.Tх=/4ho , W6D'3ReLϢ$^V%AP.p 5^p]xѽ!(+!1M(WZ)vӎd lmDQ0/;V@Z
SZѧ6!vAڐSFzvD2iG!f'_ӎVX|bOmikW7_(3ΪϱP+Dim(B+~StGFgw5 б *kM6Injhk/kӲL4wncJ a6Bu ,61![chn a3"E`C+'Mb&
pXԎn, -g%x3Z& ަIB-7|zi&>ڰb <hC/v Fiw M"H{h\Md]`
]vs
9 O q"a s[x '+|zE >JtQ"Y;/R.)&p^Jyua$ tl4qt;OWl꽏ddT$80ՊHtv`Ef'N%^^(3
V3ĔyT2FSB4f6~ڀz:H_ ls{DQW:KreDd,'6LEte
ܬB/#H Sj8iA$,R%r%:a-881:Kf5ꌳDDoDEE3zoO/G:櫠s62J.t|2,K6S)*d_x2S;{.ʥ,9MtjƷdhRW"y̴씨Qc^B3J
`dz;.Yp* g_Mc "Kjlsq{VϵM &#:F.3qD,Yh`ٯ k