Index of values

!@ p dereferences the pointer p.

If p is a pointer to an array element then p +@ n computes the address of the nth next element.

If p is a pointer to an array element then p -@ n computes the address of the nth previous element.

p <-@ v writes the value v to the address p.

Construct a function type from a type and an existing function type.

s @. f computes the address of the field f in the structure or union value s.

p |-> f computes the address of the field f in the structure or union value pointed to by p.

abs f returns absolute value of f

Create an abstract type specification from the size and alignment requirements for the type.

Arc cosine

Inverse hyperbolic cosine

Addition

Addition

addr s returns the address of the structure or union s.

alignment t computes the alignment requirements of the type t.

allocate t v allocates a fresh value of type t, initialises it with v and returns its address.

allocate_n t ~count:n allocates a fresh array with element type t and length n, and returns its address.

Argument.

Construct a sized array type from a length and an existing type (called the element type).

The class of Bigarray.Array1.t values

The class of Bigarray.Array2.t values

The class of Bigarray.Array3.t values

array_of_bigarray c b converts the bigarray value b to a value of type Ctypes.CArray.t.

Arc sine

Inverse hyperbolic sine

Arc tangent

atan2 y x returns the arc tangent of y /. x.

Inverse hyperbolic tangent

Construct a sized C-layout bigarray type representation from a bigarray class, the dimensions, and the Bigarray_compat.kind.

bigarray_of_array c k a converts the Ctypes.CArray.t value a to a C-layout bigarray value.

bigarray_of_ptr c dims k p converts the C pointer p to a C-layout bigarray value.

Return the address of the first element of the given Bigarray value.

Value representing the C type bool.

size, in bytes, used for storing long doubles, and the actual number of bytes used by the value.

Value representing an integer type with the same storage requirements as an OCaml int.

Round above to an integer value.

Value representing the C type char.

Return the class of the given floating-point number: normal, subnormal, zero, infinite, or not a number.

coerce t1 t2 returns a coercion function between the types represented by t1 and t2.

coerce_fn f1 f2 returns a coercion function between the function types represented by f1 and f2.

Value representing the C99 single-precision float complex type.

Value representing the C99 double-precision double complex type.

Value representing the C99 long-double-precision long double complex type.

Conjugate: given the complex x + i.y, returns x - i.y.

constant name typ retrieves the value of the compile-time constant name of type typ.

copy a creates a fresh array with the same elements as a.

copysign x y returns a float whose absolute value is that of x and whose sign is that of y.

Cosine.

Hyperbolic cosine

create v allocates storage for the address of the OCaml value v, registers the storage as a root, and returns its address.

Division

Division

Close a dynamic library.

Open a dynamic library.

Look up a symbol in a dynamic library.

Value representing the C type double.

Define a type representation for passing OCaml functions to C with explicit lifetime management.

Retrieve the element type of an array.

enum name ?unexpected alist builds a type representation for the enum named name.

The difference between 1.0 and the smallest exactly representable floating-point number greater than 1.0.

Exponentiation.

Exponential

expm1 x computes exp x -. 1.0, giving numerically-accurate results even if x is close to 0.0.

field ty label ty' adds a field of type ty' with label label to the structure or union type ty and returns a field value that can be used to read and write the field in structure or union instances (e.g.

field_name f returns the name of the field f.

field_type f returns the type of the field f.

Value representing the C single-precision float type.

Round below to an integer value.

CArray.fold_left (@) x a computes (((x @ a.(0)) @ a.(1)) ...) @ a.(n-1) where n is the length of the array a.

CArray.fold_right f a x computes a.(0) @ (a.(1) @ ( ... (a.(n-1) @ x) ...)) where n is the length of the array a.

foreign name typ exposes the C function of type typ named by name as an OCaml value.

foreign_value name typ exposes the C value of type typ named by name as an OCaml value.

Pretty-print a representation of the C value to the specified formatter.

Pretty-print a C representation of the function type to the specified formatter.

Pretty-print a C representation of the type to the specified formatter.

Construct a sized Fortran-layout bigarray type representation from a bigarray class, the dimensions, and the Bigarray_compat.kind.

fortran_bigarray_of_ptr c dims k p converts the C pointer p to a Fortran-layout bigarray value.

Indicate that the fptr is no longer needed.

frexp f returns the pair of the significant and the exponent of f.

from_ptr p n creates an n-length array reference to the memory at address p.

Conversion from void *.

Construct a function pointer type from a function type.

Convert the numeric representation of an address to a function pointer

Construct a function pointer type from a function type.

The class of Bigarray.Genarray.t values

get p retrieves the OCaml value whose address is stored at p.

get a n returns the nth element of the zero-indexed array a.

getf s f retrieves the value of the field f in the structure or union s.

0 + i

Generate code with no special support for errno.

return the imaginary part of the long double complex

Positive infinity

Value representing the C type (signed) int.

Value representing a 16-bit signed integer C type.

Value representing a 32-bit signed integer C type.

Value representing a 64-bit signed integer C type.

Value representing an 8-bit signed integer C type.

Value representing the C type intptr_t.

Multiplicative inverse (1/z).

is_null p is true when p is a null pointer.

iter f a is analogous to Array.iter f a: it applies f in turn to all the elements of a.

ldexp x n returns x *. 2 ** n.

Value representing the C type long double.

Return the number of elements of the given array.

lift_typ t turns a concrete type representation into an abstract type representation.

Value representing the C type (signed) long long.

Natural logarithm (in base e).

Natural logarithm

Base 10 logarithm

log1p x computes log(1.0 +. x) (natural logarithm), giving numerically-accurate results even if x is close to 0.0.

Value representing the C type (signed) long.

Generate code which implements C function calls as Lwt jobs:

Generate code which runs C function calls with the Lwt_preemptive module:

make t n creates an n-length array of type t.

Allocate a fresh, uninitialised structure or union value.

make x y creates the long double complex value x + y * i

size of mantissa

map t f a is analogous to Array.map f a: it creates a new array with element type t whose elements are obtained by applying f to the elements of a.

mapi behaves like Array.mapi, except that it also passes the index of each element as the first argument to f and the element itself as the second argument.

The largest positive finite value

The smallest positive, non-zero, non-denormalized value

return (fractional,integer) parts of number.

Multiplication

Multiplication

A special floating-point value denoting the result of an undefined operation such as 0.0 /. 0.0.

Value representing the C type (signed) int.

Unary negation

Negation

Negative infinity

Norm: given x + i.y, returns sqrt(x^2 + y^2).

Norm squared: given x + i.y, returns x^2 + y^2.

A null pointer.

Value representing the directly mapped storage of an OCaml byte array.

ocaml_bytes_start s allows to pass a pointer to the contents of an OCaml byte array directly to a C function.

Value representing the directly mapped storage of an OCaml string.

ocaml_string_start s allows to pass a pointer to the contents of an OCaml string directly to a C function.

create a long double complex from a Complex.t

Create a long double from a float

Turn an OCaml closure into a function pointer that can be passed to C.

Create a long double from an int

of_list t l builds an array of type t of the same length as l, and writes the elements of l to the corresponding elements of the array.

of_string s builds an array of the same length as s, and writes the elements of s to the corresponding elements of the array.

Create a long double from a string

offsetof f returns the offset, in bytes, of the field f from the beginning of the associated struct type.

1 + i0

1.0

polar norm arg returns the complex having norm norm and argument arg.

Power function.

Exponentiation

Construct a pointer type from an existing type (called the reference type).

If p and q are pointers to elements i and j of the same array then ptr_compare p q compares the indexes of the elements.

ptr_diff p q computes q - p.

Convert the numeric representation of an address to a pointer

Construct a pointer type from an existing type (called the reference type).

Value representing the C type ptrdiff_t.

raw_address_of_ptr p returns the numeric representation of p.

return the real part of the long double complex

Retrieve the reference type of a pointer.

release p unregsiters the root p.

rem x y is the remainder of dividing x by y

Hook called on collection of closures associated with Foreign.dynamic_funptr values that have not been deallocated with free.

Generate code that returns errno in addition to the return value of each function.

Give the return type of a C function.

Value representing the C type signed char.

seal t completes the struct or union type t so that no further fields can be added.

Generate code with no special support for concurrency.

set p v updates the OCaml value stored as a root at p.

set a n v overwrites the nth element of the zero-indexed array a with v.

setf s f v overwrites the value of the field f in the structure or union s with v.

Value representing the C type (signed) short.

Sine.

Hyperbolic sine

Value representing the C type int.

Value representing the C type size_t, an alias for one of the unsigned integer types.

sizeof t computes the size in bytes of the type t.

Square root.

Square root

Return the address of the first element of the given array.

Construct a function pointer type from an existing function type (called the reference type).

A high-level representation of the string type.

string_from_ptr p ~length creates a string initialized with the length characters at address p.

Return a string representation of the C value.

Return a C representation of the function type.

Return a C representation of the type.

A high-level representation of the string type.

Construct a new structure type.

sub a ~pos ~length creates a fresh array of length length containing the elements a.(pos) to a.(pos + length - 1) of a.

Subtraction

Subtraction

A type representation for a function pointer type with explicit lifetime management.

This behaves like Foreign.Funptr.t, except that null pointers appear in OCaml as None.

Tangent.

Hyperbolic tangent

Convert a long double complex to a Complex.t.

Convert a long double to a float.

Convert a long double to an int.

to_list a builds a list of the same length as a such that each element of the list is the result of reading the corresponding element of a.

Convert a long double to a string.

Conversion to void *.

typ_of_bigarray_kind k is the type corresponding to the Bigarray kind k.

typedef t name creates a C type representation t' which is equivalent to t except its name is printed as name.

Value representing the C type unsigned char.

Value representing the C type unsigned int.

Value representing a 16-bit unsigned integer C type.

Value representing a 32-bit unsigned integer C type.

Value representing a 64-bit unsigned integer C type.

Value representing an 8-bit unsigned integer C type.

Value representing the C type uintptr_t.

Value representing the C type unsigned long long.

Value representing the C type unsigned long.

Construct a new union type.

Generate code that releases the runtime lock during C calls.

unsafe_get a n behaves like get a n except that the check that n between 0 and (CArray.length a - 1) is not performed.

unsafe_set a n v behaves like set a n v except that the check that n between 0 and (CArray.length a - 1) is not performed.

Value representing the C type unsigned short.

view ~read:r ~write:w t creates a C type representation t' which behaves like t except that values read using t' are subsequently transformed using the function r and values written using t' are first transformed using the function w.

Value representing the C void type.

with_fun fn (fun fptr -> e) - Turn an OCaml closure into a function pointer and perform simple life cycle management.

write_c fmt ~prefix bindings generates C stubs for the functions bound with internal in bindings.

write_c fmt ~prefix bindings generates C stubs for the functions bound with foreign in bindings.

write_c_header fmt ~prefix bindings generates a C header file for the functions bound with internal in bindings.

write_ml fmt ~prefix bindings generates ML bindings for the functions bound with internal in bindings.

write_ml fmt ~prefix bindings generates ML bindings for the functions bound with foreign in bindings.

0 + i0

0.0