package containers

A 'pipe' operator. x |> f is the same as f x.

Composition. compose f g x is g (f x).

compose_binop f g is fun x y -> g (f x) (f y). Example (partial order): List.sort (compose_binop fst CCInt.compare) [1, true; 2, false; 1, false].

• since 0.6

Alias to compose.

f @@ x is the same as f x, but right-associative.

• since 0.5

Identity function.

Produce a function that just returns its first argument. const x y = x for any y.

Reverse the order of arguments for a binary function.

Convert a function which accepts a pair of arguments into a function which accepts two arguments. curry f x y is f (x,y).

Convert a function which accepts a two arguments into a function which accepts a pair of arguments. uncurry f (x,y) is f x y.

tap f x evaluates f x, discards it, then returns x. Useful in a pipeline, for instance:

CCArray.(1 -- 10)
|> tap CCArray.shuffle
|> tap @@ CCArray.sort Pervasives.compare

Mathematical composition. (%) f g x is f (g x).

Lexicographic combination of comparison functions.

finally h f calls f () and returns its result. If it raises, the same exception is raised; in any case, h () is called after f () terminates.

finally1 ~h f x is the same as f x, but after the computation, h () is called whether f x rose an exception or not.

• since 0.16

finally2 ~h f x y is the same as f x y, but after the computation, h () is called whether f x y rose an exception or not.

• since 0.16

opaque_identity x is like x, but prevents Flambda from using x's definition for optimizing it. (flambda is an optimization/inlining pass in OCaml >= 4.03).

• since 0.18

iterate n f is f iterated n times. That is to say, iterate 0 f x is x, iterate 1 f x is f x, iterate 2 f x is f (f x), etc.

• since 2.1