Index of values

mod and div operators that have the right behavior on negative numbers, that is, x % y always returns a value between 0 and y-1.

(name %: typ) specifies a required anonymous argument of type typ.

Basic operations on spans

command-line spec composition

add a leftmost parameter onto the type of main

add a rightmost parameter onto the type of main

float division of integers

t >>= f returns a computation that sequences the computations represented by two monad elements.

t >>| f is t >>= (fun a -> return (f a)).

same as Filename.concat

A 'pipe' operator.

Functions from function.ml

abbreviation zone t returns t abbreviation name such as EDT, EST, JST of given zone at the time t.

Abnormal termination

absolute value

abs_diff t1 t2 returns the absolute span of time t1 minus time t2.

Accept connections on the given socket.

Check that the process has the given permissions over the named file.

add t s adds the span s to time t and returns the resulting time.

add timer handler ?randomize ?interval span

add t s shifts the time of day t by the span s.

add t i add i to the set

add ru1 ru2 adds two rusage structures (e.g.

returns a new map with the specified new binding; if the key was already bound, its previous binding disappears.

add t v adds v to the bag t, returning an element that can later be removed from the bag.

adds the specified key and data to the tree destructively (previous t's are no longer valid) using the specified comparison function.

add_abs timer handler ?randomize ?interval time same as Timer.add, but takes an absolute time time for scheduling the event rather than a span.

add_buffer b1 b2 appends the current contents of buffer b2 at the end of buffer b1.

add_business_days t ~is_holiday n returns a business day even when n=0.

add_channel b ic n reads exactly n character from the input channel ic and stores them at the end of buffer b.

add_char b c appends the character c at the end of the buffer b.

add_months t n returns date with max days for the month if the date would be invalid.

if key is not present then add a singleton list, otherwise, cons data on the head of the existing list.

add_multi t ~key ~data if key is present in the table then cons data on the list, otherwise add key with a single element list.

add_range t i j add all the numbers between i and j (inclusive) to the set.

add_string b s appends the string s at the end of the buffer b.

add_substitute b f s appends the string pattern s at the end of the buffer b with substitution.

add_substring b s ofs len takes len characters from offset ofs in string s and appends them at the end of the buffer b.

add_weekdays t 0 returns the next weekday if t is a weekend and t otherwise.

Address information returned by Unix.getaddrinfo.

Schedule a SIGALRM signal after the given number of seconds.

Align the documentation strings by inserting spaces at the first space, according to the length of the keyword.

Return the total number of bytes allocated since the program was started.

Timeout

generator that always returns given value

anon spec specifies a command that, among other things, takes the anonymous arguments specified by spec.

E.g.

Array.append v1 v2 returns a fresh array containing the concatenation of the arrays v1 and v2.

apply x f run optional function on argument and return an option

Returns true iff a given set of intervals are disjoint

Returns true iff a given set of intervals would be disjoint if considered as open intervals.

the arguments passed to the command

The command line arguments given to the process.

A comparator that returns results in ascending order.

Printexc.get_backtrace

Respects the posix semantic.

basic ~summary ?readme spec main is a basic command that executes a function main which is passed parameters parsed from the command line according to spec.

Return a copy of the current contents of the buffer as a bigstring.

The type of socket addresses.

The type of socket domains.

The type of socket kinds, specifying the semantics of communications.

bind t f = t >>= f

Bind a socket to an address.

A special address, for use only with bind, representing all the Internet addresses that the host machine possesses.

These functions are the same as the basic functions, except that they use (and update) the given PRNG state instead of the default one.

Return 30 random bits in a nonnegative integer.

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.

block_forever () will block the calling thread forever.

blocking_create ?message path like create, but sleeps for 1 second between lock attempts and does not return until it succeeds

blocking_create t tries to create the lock.

Random.bool () returns true or false with probability 0.5 each.

like bot_exn, but returns result optionally, without exception.

returns the bottom (most-recently enqueued element).

bound i x bounds the value x to the interval i.

call x f run optional function on argument

Warning: this function clobbers the Signal.int (SIGINT) handler.

character generator

change map key f updates the given map by changing the value stored under key according to f.

change t key f updates the given table by changing the value stored under key according to f, just like Map.change (see that for example).

Change the process working directory.

Change the current working directory of the process.

check_args ~loc ~pos ~len bstr checks the position and length arguments pos and len for bigstrings bstr.

check_heap_property h asserts that h has the heap property: that all nodes are less than their children by h's comparison function.

check_suffix name suff returns true if the filename name ends with the suffix suff.

Child process terminated

Change the permissions of the named file.

choose t returns some element in the bag.

Return the given file name without its extension.

chop_prefix s ~pref returns a copy s without the leading pref

chop_suffix name suff removes the suffix suff from the filename name.

chop_suffix s ~suf returns a copy s without the trailing suff

Change the owner uid and owner gid of the named file.

Change the process root directory.

clears the queue

clear the queue

clear t removes all elements from the list in constant time.

clear t removes all elements from t.

clear t discards all elements from t.

clear t discards all elements from t.

Empty the buffer.

clear t removes all elements from the bag.

Clear the ``close-on-exec'' flag on the given descriptor.

Clear the ``non-blocking'' flag on the given descriptor.

Close a file descriptor.

we have our own version of these two, the INRIA version doesn't release the runtime lock.

Close channels opened by UnixLabels.open_process, wait for the associated command to terminate, and return its termination status.

Close channels opened by UnixLabels.open_process_full, wait for the associated command to terminate, and return its termination status.

Close channels opened by UnixLabels.open_process_in, wait for the associated command to terminate, and return its termination status.

Close channels opened by UnixLabels.open_process_out, wait for the associated command to terminate, and return its termination status.

Close a directory descriptor.

combine ar combines two arrays to an array of pairs.

Execute the given shell command and return its exit code.

Perform a full major collection and compact the heap.

lexicographic

Total ordering between maps.

Handy types for marking things read-only and read-write.

compose f g x is f (g x)

concatanate all strings in the list using separator sep (default sep "")

Concatenate a list of lists.

concat p1 p2 returns a path equivalent to p1 ^ "/" ^ p2.

Same as Array.append, but concatenates a list of arrays.

concat_array sep ar like String.concat, but operates on arrays

Like map, but allows replacement of a single character with zero or two or more characters.

concat_map t ~f is concat (map t ~f), except that there is no guarantee about the order in which f is applied to the elements of t.

concat_mapi t ~f is like concat_map, but passes the index as an argument

Same as concat but faster and without preserving any ordering (ie for lists that are essentially viewed as multi-sets.

cond_pop heap cond

cond_pop_heap_el heap cond

Connect a socket to an address.

produces a function that just returns its first argument

a hard-coded parameter

Continue

contains_dup True if there are any two elements in the list which are the same.

Return a copy of the current contents of the buffer.

copy heap

copy t returns a copy of t.

copy t returns a copy of t.

copy t returns a copy of t.

Array.copy a returns a copy of a, that is, a fresh array containing the same elements as a.

cores ()

count f l is the number of elements in l that satisfy the predicate f.

Return (minor_words, promoted_words, major_words).

Compute the 32-bit crc

String version of the crc, encoded in hex.

create name to_sexp if the type 'a doesn't support sexp conversion, then a good practice is to use sexp_of_opaque as the converter.

create var arg creates a new t from a constr and the argument to the constr.

create v returns a new object in its own equivalence class that has value v.

create ?min_size () creates a new timer.

create maxsize returns a synchronized queue bounded to have no more than maxsize elements.

create () returns a new, unlocked mutex.

create ?pos ?len base creates a substring of the base sequence of * length len starting at position pos, i.e.

lock ?message path tries to create and lock the file at path by creating a hard link to path.nfs_lock.

create ?close_on_exec ?message path tries to create a file at path containing the text message, which defaults to the pid of the locking process.

create ~num_file_descrs creates a new epoll set able to watch file descriptors in [0, num_file_descrs).

For create msg z sexp_of_z, be careful to use only immutable values for z, or be aware that z will be lazily converted to a sexp at a later point in time, which will pick up the then-current state of z.

create ?min_size cmp

create () returns an empty queue.

create f creates a new force_once

creating doubly-linked lists

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 () returns an empty stack.

create () returns an empty queue.

create ~len x creates an array of length len with the value x populated in each element

an argument type includes information about how to parse values of that type from the command line, and (optionally) how to auto-complete partial arguments of that type via bash's programmable TAB-completion.

create ~num_keys ~key_to_int returns a table where the keys can map to 0 ..

create length

create n returns a fresh buffer, initially empty.

create () returns an empty bag.

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_bin_prot reader returns an unpacker that reads the "size-prefixed" bin_prot encoding, in which a value is encoded by first writing the length of the bin_prot data as a 64-bit int, and then writing the data itself.

create_bin_prot reader returns an unpack buffer that unpacks the "size-prefixed" bin_prot encoding, in which a value is encoded by first writing the length of the bin_prot data as a 64-bit int, and then writing the bin_prot data itself.

create_ending_after ?zone (od1, od2) ~now returns the smallest interval (t1 t2) with minimum t2 such that t2 >= now, to_ofday t1 = od1, and to_ofday t2 = od2.

create_ending_before ?zone (od1, od2) ~ubound returns the smallest interval (t1 t2) with maximum t2 such that t2 <= ubound, to_ofday t1 = od1, and to_ofday t2 = od2.

create_exn ?message path like create, but throws an exception when it fails to obtain the lock

create_exn ?message path is like create except that it throws an exception on failure instead of returning a boolean value

create_exn ~y ~m ~d creates the date specified in the arguments.

create_process ~prog ~args forks a new process that executes the program prog with arguments args.

create_process_env ~prog ~args ~env as create process, but takes an additional parameter that extends, or replaces the current environment.

critical_section ?message path ~f wrap function f (including exceptions escaping it) by first locking (using Lock_file.Nfs.create_exn) and then unlocking the given lock file.

Position (in Sys.argv) of the argument being processed.

The conventional name for the current directory (e.g.

current_thread_has_lock t returns true iff the current thread has t locked.

daemonize makes the executing process a daemon.

daemonize_wait makes the executing process a daemon, but delays full detachment from the calling shell/process until the returned "release" closure is called.

returns list of data in map

filter_inplace t ~f removes all the elements from t that don't satisfy f.

Standard hashtbl functions.

deactivate timer deactives a timer.

debug controls whether invariants are checked at each call.

set debug := true to turn on debugging, including potentially slow invariant checking.

dedup (de-duplicate).

default_sys_behavior t Query the default system behavior for a signal.

delay d suspends the execution of the calling thread for d seconds.

delete_alarm a will stop the calls to the function associated to a.

dequeue t returns the front element of the queue.

Like dequeue_exn, but returns result optionally, without exception.

dequeue t returns None if t is empty, otherwise it removes and returns the front of t

dequeue_all t ~f dequeues every element of the queue and applies f to each one.

dequeue_exn t removes and returns the front of t, raising Empty if t is empty.

dequeue_with_key t returns the front element of the queue and its key

Return the descriptor corresponding to an input channel.

Return the descriptor corresponding to an output channel.

diff t1 t2 returns time t1 minus time t2.

diff t1 t2 returns the difference in time between two ofdays, as if they occurred on the same day

diff t1 t2 returns date t1 minus date t2 in days.

digest t return the MD5 digest of the file the t was created from (if any)

The directory separator (e.g.

See Filename.basename.

Returns version of queue with top element removed.

The handling of sets of bit flags here is indeed a departure from the typical convention of lists of variants, but has some advantages and is likely to be used in the future.

Return the socket domain adequate for the given socket address.

drop iovec n drops n characters from iovec.

drop_prefix s n drops the longest prefix of s of length less than or equal to n

drop_suffix s n drops the longest suffix of s of length less than or equal to n

drop_while l ~f drops the longest prefix of l for which f is true.

Return a new file descriptor referencing the same file as the given descriptor.

dup2 fd1 fd2 duplicates fd1 to fd2, closing fd2 if already opened.

The empty queue

empty the empty I/O-vector.

the empty map

empty () creates an empty array

the empty command-line spec

enqueue t k v adds the key-value pair (k, v) to the end of the queue, returning `Ok if the pair was added, or `Key_already_present if there is already a (k, v') in the queue.

enqueue t x returns a queue with adds x to the end of t.

enqueue t x adds x to the end of t.

enqueue a single element on the *top* of the queue.

Return the process environment, as an array of strings with the format ``variable=value''.

equal is phys_equal

predicates

fast equality function on strings, doesn't use compare_val

subset t1 t2 returns true iff t1 is a subset of t2.

equal cmp m1 m2 tests whether the maps m1 and m2 are equal, that is, contain equal keys and associate them with equal data.

toplevel binding for polymorphic equality (=).