Index of values




A

B
  • backwards [Array]
    Returns an enumeration of the elements of an array, from last to first.
  • backwards [Array.Cap]
    Returns an enumeration of the elements of an array, from end to start.
  • backwards [Ref_list]
    Returns an enumeration of current elements in the ref list, going from last to first
  • backwards [Vect.RANDOMACCESS]
  • backwards [Vect]
    Returns an enumeration of the elements of a vector, from last to first.
  • backwards [List]
    Returns an enumeration of the elements of a list.
  • backwards [Set.S]
    Return an enumeration of all elements of the given set.
  • backwards [Extlib.ExtSet.Set.S]
    Return an enumeration of all elements of the given set.
  • backwards [UTF8]
  • backwards [Rope]
    Returns an enumeration of the characters of a rope, from last to first.
  • backwards [String]
    Returns an enumeration of the characters of a string, from last to first.
  • backwards [String.Cap]
    Returns an enumeration of the characters of a string, from last to first.
  • balance [Vect]
    balance r returns a balanced copy of the r vect.
  • balance [Vect.Make]
    balance r returns a balanced copy of the r vect.
  • balance [Rope]
    balance r returns a balanced copy of the r rope.
  • basename [Path]
    Split a file name into directory name / base file name.
  • beginning_of_input [Scanf.Scanning]
    Scanning.beginning_of_input ib tests the beginning of input condition of the given scanning buffer.
  • belongs [Future.PathGen.PathType]
    belongs base sub is true when sub descends from base, i.e.
  • belongs [Extlib.PathGen.PathType]
    belongs base sub is true when sub descends from base, i.e.
  • big_int_of_int [Big_int]
    Convert a small integer to a big integer.
  • big_int_of_num [Num]
  • big_int_of_sexp [SExpr]
    big_int_of_sexp sexp converts S-expression sexp to a value of type Big_int.big_int.
  • big_int_of_string [Big_int]
    Convert a string to a big integer, in decimal.
  • bind [Monad.S]
    Monadic binding.
  • bind [Option]
    bind f (Some x) returns f x and bind f None returns None.
  • bind [Unix]
    Bind a socket to an address.
  • bind [Future.Parser_co]
    Monadic-style combination:
  • bind [Future.Result]
    Monadic composition.
  • bits [Random]
    Return 30 random bits in a nonnegative integer.
  • bits [Random.State]
  • bits_of [IO]
    Read an enumeration of bits
  • bits_of_float [Int32]
    Return the internal representation of the given float according to the IEEE 754 floating-point ``single format'' bit layout.
  • bits_of_float [Int64]
    Return the internal representation of the given float according to the IEEE 754 floating-point ``double format'' bit layout.
  • 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 [Array.Cap]
    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.Cap.Labels]
  • blit [Array.Labels]
  • blit [Big_array.Genarray]
    Copy all elements of a big array in another big array.
  • blit [Big_array.Array1]
    Copy the first big array to the second big array.
  • blit [Big_array.Array2]
    Copy the first big array to the second big array.
  • blit [Big_array.Array3]
    Copy the first big array to the second big array.
  • blit [Dyn_array]
    blit src srcidx dst dstidx len copies len elements from src starting with index srcidx to dst starting at dstidx.
  • blit [Buffer]
    Buffer.blit b srcoff dst dstoff len copies len characters from the current contents of the buffer b starting at offset off, starting at character number srcoff, to string dst, starting at character number dstoff.
  • blit [Rope]
    blit src srcoff dst dstoff len returns a copy of dst in which len characters have been copied from rope src, starting at character number srcoff, to rope dst, starting at character number dstoff.
  • blit [String]
    String.blit src srcoff dst dstoff len copies len characters from string src, starting at character number srcoff, to string dst, starting at character number dstoff.
  • blit [String.Cap]
    String.blit src srcoff dst dstoff len copies len characters from string src, starting at character number srcoff, to string dst, starting at character number dstoff.
  • blit [Weak]
    Weak.blit ar1 off1 ar2 off2 len copies len weak pointers from ar1 (starting at off1) to ar2 (starting at off2).
  • bool [Random]
    Random.bool () returns true or false with probability 0.5 each.
  • bool [Random.State]
  • bool_of_sexp [SExpr]
    bool_of_sexp sexp converts S-expression sexp to a value of type bool.
  • bool_of_string [Standard]
    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]
    Same as Str.split, but splits into at most n substrings, where n is the extra integer parameter.
  • 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 [Format]
    Same as sprintf above, but instead of printing on a string, writes into the given extensible buffer.
  • bprintf [Printf]
    As Printf.fprintf, but with buffers instead of outputs.
  • bprintf [Print]
    This function behaves as Print.fprintf but prints into a buffer rather than into an output.
  • bprintf2 [Printf]
    As Printf.printf but writes to a buffer instead of printing to the output.
  • break [Enum]
    Negated span.
  • broadcast [Condition]
    broadcast c restarts all processes waiting on the condition variable c.
  • broadcast [Threads.Condition]
    broadcast c restarts all processes waiting on the condition variable c.
  • browse [Batteries_config]
  • bscanf [Scanf]
    bscanf ib fmt r1 ... rN f reads arguments for the function f, from the scanning buffer ib, according to the format string fmt, and applies f to these values.
  • bscanf_format [Scanf]
    bscanf_format ib fmt f reads a format string token from the scannning buffer ib, according to the given format string fmt, and applies f to the resulting format string value.
  • bulk_enum [Rope]
    Returns an enumeration of the UTF-8 encoded strings of a rope.
  • bulk_filter_map [Rope]
    bulk_filter_map f l calls (f a0) (f a1).... (f an) where a0..an are the UTF-encoded strings of l.
  • bulk_fold [Rope]
    As Rope.fold but over larger chunks of data.
  • bulk_iter [Rope]
    as iter but over larger chunks of data
  • bulk_iteri [Rope]
    as iteri but over larger chunks of data.
  • bulk_map [Rope]
    map f s returns a rope where all ropes c in s have been replaced by f c.
  • bytes_of [IO]
    Read an enumeration of unsigned 8-bit integers.

C

D

E

F

G
  • ge_big_int [Big_int]
  • ge_num [Num]
  • genarray_of_array1 [Big_array]
    Return the generic big array corresponding to the given one-dimensional big array.
  • genarray_of_array2 [Big_array]
    Return the generic big array corresponding to the given two-dimensional big array.
  • genarray_of_array3 [Big_array]
    Return the generic big array corresponding to the given three-dimensional big array.
  • get [Standard]
    get e returns None if e is empty or Some x where x is the next element of e, in which case the element is removed from the enumeration.
  • get [Array]
    Array.get a n returns the element number n of array a.
  • get [Array.Cap]
    Array.get a n returns the element number n of array a.
  • get [Big_array.Genarray]
    Read an element of a generic big array.
  • get [Big_array.Array1]
    Array1.get a x, or alternatively a.{x}, returns the element of a at index x.
  • get [Big_array.Array2]
    Array2.get a x y, also written a.{x,y}, returns the element of a at coordinates (x, y).
  • get [Big_array.Array3]
    Array3.get a x y z, also written a.{x,y,z}, returns the element of a at coordinates (x, y, z).
  • get [Dllist]
    Given a node, get the data associated with that node.
  • get [Dyn_array]
    get darr idx gets the element in darr at index idx.
  • get [Enum]
    get e returns None if e is empty or Some x where x is the next element of e, in which case the element is removed from the enumeration.
  • get [Global]
    Get the global value contents - raise Global_not_initialized if not defined.
  • get [Ref]
    As !
  • get [Vect.RANDOMACCESS]
  • get [Vect]
    get v n returns the (n+1)th element from the vect v; i.e.
  • get [Vect.Make]
    get n r returns the (n+1)th element from the vect r; i.e.
  • get [Lazy_list]
    get l returns the head and tail of l, if l is not empty.
  • get [Option]
    get (Some x) returns x and get None raises No_value.
  • get [UTF8]
    get s n returns the n-th Unicode character of s.
  • get [Rope]
    get r n returns the (n+1)th character from the rope r; i.e.
  • get [String]
    String.get s n returns character number n in string s.
  • get [String.Cap]
    String.get s n returns character number n in string s.
  • get [Gc]
    Return the current values of the GC parameters in a control record.
  • 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 [Opt_parse.Opt]
    Get the value of an option.
  • get [Future.PathGen.StringType]
    Usual get function.
  • get_all_formatter_output_functions [Format]
    Return the current output functions of the pretty-printer, including line breaking and indentation functions.
  • 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_ellipsis_text [Format]
    Return the text of the ellipsis.
  • get_exn [Option]
    get_exn (Some x) e returns x and get_exn None e raises e.
  • 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_margin [Format]
    Returns the position of the right margin.
  • get_mark_tags [Format]
    Return the current status of tags printing and tags marking.
  • get_max_boxes [Format]
    Returns the maximum number of boxes allowed before ellipsis.
  • get_max_indent [Format]
    Return the value of the maximum indentation limit (in characters).
  • get_method [Oo.Internal]
  • get_method_label [Oo.Internal]
  • get_method_labels [Oo.Internal]
  • get_print_tags [Format]
  • get_public_method [Oo.Internal]
  • get_resizer [Dyn_array]
    Get the current resizer function for a given array
  • get_state [Random]
    Return the current state of the generator used by the basic functions.
  • get_state [Future.Parser_co.Source]
  • get_variable [Oo.Internal]
  • get_variables [Oo.Internal]
  • 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 [Shell]
    Return the current working directory of the process.
  • getcwd [Unix]
    Return the name of the current working directory.
  • getegid [Unix]
    Return the effective group id under which the process runs.
  • getenv [Shell]
    Return the value associated to a variable in the process environment.
  • getenv [Unix]
    Return the value associated to a variable in the process environment.
  • geteuid [Unix]
    Return the effective user id under which the process runs.
  • getgid [Unix]
    Return the group id of the user executing the process.
  • getgrgid [Unix]
    Find an entry in group with the given group id, or raise Not_found.
  • getgrnam [Unix]
    Find an entry in group with the given name, or raise Not_found.
  • getgroups [Unix]
    Return the list of groups to which the user executing the process belongs.
  • gethostbyaddr [Unix]
    Find an entry in hosts with the given address, or raise Not_found.
  • gethostbyname [Unix]
    Find an entry in hosts with the given name, or raise Not_found.
  • gethostname [Unix]
    Return the name of the local host.
  • getitimer [Unix]
    Return the current status of the given interval timer.
  • getlogin [Unix]
    Return the login name of the user executing the process.
  • getnameinfo [Unix]
    getnameinfo addr opts returns the host name and service name corresponding to the socket address addr.
  • getpeername [Unix]
    Return the address of the host connected to the given socket.
  • getpid [Unix]
    Return the pid of the process.
  • getppid [Unix]
    Return the pid of the parent process.
  • getprotobyname [Unix]
    Find an entry in protocols with the given name, or raise Not_found.
  • getprotobynumber [Unix]
    Find an entry in protocols with the given protocol number, or raise Not_found.
  • getpwnam [Unix]
    Find an entry in passwd with the given name, or raise Not_found.
  • getpwuid [Unix]
    Find an entry in passwd with the given user id, or raise Not_found.
  • getservbyname [Unix]
    Find an entry in services with the given name, or raise Not_found.
  • getservbyport [Unix]
    Find an entry in services with the given service number, or raise Not_found.
  • getsockname [Unix]
    Return the address of the given socket.
  • getsockopt [Unix]
    Return the current status of a boolean-valued option in the given socket.
  • getsockopt_float [Unix]
    Same as Unix.getsockopt for a socket option whose value is a floating-point number.
  • getsockopt_int [Unix]
    Same as Unix.getsockopt for an integer-valued socket option.
  • getsockopt_optint [Unix]
    Same as Unix.getsockopt for a socket option whose value is an int option.
  • gettimeofday [Unix]
    Same as Unix.time, but with resolution better than 1 second.
  • 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 [Unix]
    Convert a time in seconds, as returned by Unix.time, into a date and a time.
  • group [Enum]
    group test e devides e into an enumeration of enumerations, where each sub-enumeration is the longest continuous enumeration of elements whose test results are the same.
  • group [List]
    group cmp l returns list of groups and each group consists of elements judged equal by comparison function cmp.
  • 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.
  • 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.
  • group_exec [File]
    Give the permission to execute the file to the group containing the user.
  • group_read [File]
    Give the permission to read the file to the group containing the user.
  • group_write [File]
    Give the permission to write the file to the group containing the user.
  • 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.
  • guard [Threads.Event]
    guard fn returns the event that, when synchronized, computes fn() and behaves as the resulting event.
  • gzip_compress [GZip]
    gzip-specific compression function, same as GZip.compress, but enable to specifiy gzip-specific compression parameters

H
  • handle [Arg]
    Arg.handle commands parses the command-line and applies the specifications of commands and returns the list of anonymous arguments.
  • handle_unix_error [Unix]
    handle_unix_error f x applies f to x and returns the result.
  • hard_count [Enum]
    hard_count returns the number of remaining in elements in e, consuming the whole enumeration somewhere along the way.
  • hash [Hashtbl.HashedType]
    A hashing function on keys.
  • hash [Hashtbl]
    Hashtbl.hash x associates a positive integer to any value of any type.
  • hash_param [Hashtbl]
    Hashtbl.hash_param n m x computes a hash value for x, with the same properties as for hash.
  • hashtbl_of_sexp [SExpr]
    hashtbl_of_sexp conv_key conv_value sexp converts S-expression sexp to a value of type ('a, 'b) Hashtbl.t using conversion function conv_key, which converts an S-expression to hashtable key of type 'a, and function conv_value, which converts an S-expression to hashtable value of type 'b.
  • hd [Seq]
    Returns the first element of the sequence or raise Invalid_argument if the sequence is empty.
  • hd [Seq.Exceptionless]
  • hd [Ref_list]
    same as first
  • hd [Lazy_list]
    Return the first element of the given list.
  • hd [List]
    Returns the first element of the list or raise Empty_list if the list is empty.
  • head [Rope]
  • head [String]
  • head [String.Cap]
  • 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.
  • height [Vect]
    Returns the height (depth) of the vect.
  • height [Vect.Make]
    Returns the height (depth) of the vect.
  • height [Rope]
    Returns the height (depth) of the rope.
  • help_option [Opt_parse.StdOpt]
    help_option () returns the standard help option which displays a usage message and exits the program when encountered on the command line.
  • hex [Future.Char_parser]
    Recognizes one hexadecimal digit (case-insensitive)
  • hex [Future.UChar_parser]
    Recognizes one hexadecimal digit (case-insensitive)

I

J

K
  • kbprintf [Printf]
    Same as bprintf, but instead of returning immediately, passes the buffer to its first argument at the end of printing.
  • kbprintf [Print]
    bprintf k buf fmt prints into the buffer buf, then call k with buf as argument.
  • kbprintf2 [Printf]
    Same as bprintf2, but instead of returning immediately, passes the buffer to its first argument at the end of printing.
  • keep [Dyn_array]
    keep p darr removes in place all the element x of darr such that p x = false
  • keys [Hashtbl.S]
  • keys [Hashtbl]
    Return an enumeration of all the keys of a hashtable.
  • keys [Extlib.ExtHashtbl.Hashtbl.S]
  • keys [Hashtbl.Cap]
    Return an enumeration of all the keys of a hashtable.
  • keys [Map.S]
    Return an enumeration of all the keys of a map.
  • keys [Extlib.ExtMap.Map.S]
    Return an enumeration of all the keys of a map.
  • keyword [Future.Genlex.Languages.Make]
  • kfprintf [Format]
    Same as fprintf above, but instead of returning immediately, passes the formatter to its first argument at the end of printing.
  • kfprintf [Printf]
    Same as fprintf, but instead of returning immediately, passes the output to its first argument at the end of printing.
  • kfprintf [Print]
    kfprintf k oc fmt prints on oc then call k with oc as argument
  • kill [Thread]
    Terminate prematurely the thread whose handle is given.
  • kill [Threads.Thread]
    Terminate prematurely the thread whose handle is given.
  • kill [Unix]
    kill pid sig sends signal number sig to the process with id pid.
  • kind [Big_array.Genarray]
    Return the kind of the given big array.
  • kind [Big_array.Array1]
    Return the kind of the given big array.
  • kind [Big_array.Array2]
    Return the kind of the given big array.
  • kind [Big_array.Array3]
    Return the kind of the given big array.
  • kprintf [Format]
    A deprecated synonym for ksprintf.
  • kprintf [Printf]
  • krprintf [Print]
    krprintf k fmt creates a rope from the format and other arguments and pass it to k
  • 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 scanning buffer and the exception that aborted the scanning process.
  • ksprintf [Format]
    Same as sprintf above, but instead of returning the string, passes it to the first argument.
  • ksprintf [Printf]
    Same as sprintf above, but instead of returning the string, passes it to the first argument.
  • ksprintf [Print]
    ksprintf k fmt creates a string from the format and other arguments and pass it to k
  • ksprintf2 [Printf]
    Same as sprintf2 above, but instead of returning the string, passes it to the first argument.
  • kwd [Future.Genlex.Languages.Make]
    Accepts any identifier.

L

M

N

O

P

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]
    Additional operations
  • quomod_big_int [Big_int]
    Euclidean division of two big integers.
  • quote [String]
    Add quotes around a string and escape any quote appearing in that string.
  • quote [String.Cap]
    Add quotes around a string and escape any quote appearing in that string.
  • quote [Str]
    Str.quote s returns a regexp string that matches exactly s and nothing else.
  • quote [Path]
    Return a quoted version of a file name, suitable for use as one argument in a command line, escaping all meta-characters.

R

S

T

U

V

W

Y

Z