Module Spotlib.BaseSource

Basic functionns. They are accessible via open Spotlib.Spot

Common types
Sourcetype ('a, 'b) poly_result = [
  1. | `Ok of 'a
  2. | `Error of 'b
]

Result/Either monad using polymorphic variant. Obsolete. Use the primitive type result instead.

Function compositions and other operators
Sourceval (**) : ('b -> 'c) -> ('a -> 'b) -> 'a -> 'c

Functional composition. Haskell's (.) Use power if you want to use the original ( ** ).

Sourceval (*<) : ('b -> 'c) -> ('a -> 'b) -> 'a -> 'c

Same as ( ** ).

Sourceval (*>) : ('a -> 'b) -> ('b -> 'c) -> 'a -> 'c

Functional composition in swapped order. Same as Haskell's (>>>)

Sourceval power : float -> float -> float

Replacement of ( ** )

Sourceval (&) : ('a -> 'b) -> 'a -> 'b

Haskell's ($).

Sourceval (&~) : (f:'a -> 'b) -> 'a -> 'b

Haskell's ($), with label 'f'.

Sourceval id : 'a -> 'a
Sourceval (|-) : 'a -> ('a -> unit) -> 'a

"tee". v |-- f is v but f v is run before v is returned

Sourceval flip : ('a -> 'b -> 'c) -> 'b -> 'a -> 'c

flip of Haskell

Sourceval (~~) : ('a -> 'b) -> f:'a -> 'b

Super flip of Haskell. The first argument is labeled and becomes commutative.

Sourceval flipf : ('a -> 'b) -> f:'a -> 'b

Super flip of Haskell. The first argument is labeled and becomes commutative.

Sourceval flip2 : ('a -> 'b -> 'c -> 'd) -> 'b -> 'c -> 'a -> 'd

flip f x2 x3 x1 = f x1 x2 x3

Imperative operations
Sourceval with_ref : 'a -> ('a ref -> 'b) -> 'a * 'b
Sourceval with_ref_ : 'a -> ('a ref -> unit) -> 'a

with_ref and with_ref_ runs a function with a reference with the specified initial value.

I/O
Sourceval with_oc : out_channel -> (out_channel -> 'a) -> 'a
Sourceval with_ic : in_channel -> (in_channel -> 'a) -> 'a
Misc things
Sourceval sprintf : ('a, unit, string) format -> 'a

Printf.sprintf is available without tying Printf.

Sourceval ksprintf : (string -> 'a) -> ('b, unit, string, 'a) format4 -> 'b

Printf.ksprintf is available without tying Printf.

Sourceval (!%) : ('a, unit, string) format -> 'a

Printf.sprintf, prefix style. Bought from ITPL.

Sourceval (!!%) : ('a, Format.formatter, unit) format -> 'a

Format.eprintf, prefix style.

Sourceval memoize_gen : (('a -> 'b) -> 'a -> 'b) -> ('a -> 'b) * ('a, 'b) Hashtbl.t

Generic memozation by hash with fixed point. You can call memoized self inside:

memoize_gen (fun self -> .... self v ....) f

Sourceval memoize : ('c -> 'd) -> 'c -> 'd

Memozation by hash

Sourceval memoize_rec : (('a -> 'b) -> 'a -> 'b) -> 'a -> 'b

Memozation by hash with fixed point. You can call memoized self inside:

memoize_rec (fun self -> .... self v ....) f

Sourceval time : ('a -> 'b) -> 'a -> 'b * float

Simple profiling. Returns seconds. If f a raises an exception e, then time f a raises e too.

Sourceval (+=) : int ref -> int -> unit
Sourceval (-=) : int ref -> int -> unit
Sourceval find_by_iter : (('a -> unit) -> 'collection -> unit) -> ('a -> bool) -> 'collection -> 'a option

find the first element where predicate holds by iteration find_by_iter iterator predicate colleciton

Sourceval find_in_tree : ('a -> 'a list) -> ('a -> 'res option) -> 'a -> 'res option

find_in_tree get_subs p a visits a and finds the first sub node in which p holds. get_subs returns the sub nodes of a node.

Sourceval loop : ('a -> [< `Continue of 'a | `Break of 'b ]) -> 'a -> 'b

Keep repeating a function until a final result is producted.

Comparison
Sourceval compare_on : ('a -> 'b) -> 'a -> 'a -> int

compare_on f a b compares a and b not by themselves but by f a and f b.

Sourceval rev_compare_on : ('a -> 'b) -> 'a -> 'a -> int

rev_compare_on f a b = - (compare_on f a b)

Sourceval add_if_not_mem : 'a -> 'a list ref -> [> `AlreadyIn | `NewlyAdded ]

add_if_not_mem adds a to asref if not (List.mem a !asref) then return `NewlyAdded. Otherwise it returns `AlreadIn and asref is not modified.

String <-> bytes conversions

Sourceval (!<$) : string -> bytes
Sourceval (!>$) : bytes -> string