base v0.11.0 · OCaml Package

base

type 'a array = 'a Array.t

val compare_array : 'a. ('a -> 'a -> int) -> 'a array -> 'a array -> int

val array_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a array

val sexp_of_array : 'a. ('a -> Sexp.t) -> 'a array -> Sexp.t

type bool = Bool.t

val compare_bool : bool -> bool -> int

val hash_fold_bool : Hash.state -> bool -> Hash.state

val hash_bool : bool -> Hash.hash_value

val bool_of_sexp : Sexp.t -> bool

val sexp_of_bool : bool -> Sexp.t

type char = Char.t

val compare_char : char -> char -> int

val hash_fold_char : Hash.state -> char -> Hash.state

val hash_char : char -> Hash.hash_value

val char_of_sexp : Sexp.t -> char

val sexp_of_char : char -> Sexp.t

type exn = Exn.t

val sexp_of_exn : exn -> Sexp.t

type float = Float.t

val compare_float : float -> float -> int

val hash_fold_float : Hash.state -> float -> Hash.state

val hash_float : float -> Hash.hash_value

val float_of_sexp : Sexp.t -> float

val sexp_of_float : float -> Sexp.t

type int = Int.t

val compare_int : int -> int -> int

val hash_fold_int : Hash.state -> int -> Hash.state

val hash_int : int -> Hash.hash_value

val int_of_sexp : Sexp.t -> int

val sexp_of_int : int -> Sexp.t

type int32 = Int32.t

val compare_int32 : int32 -> int32 -> int

val hash_fold_int32 : Hash.state -> int32 -> Hash.state

val hash_int32 : int32 -> Hash.hash_value

val int32_of_sexp : Sexp.t -> int32

val sexp_of_int32 : int32 -> Sexp.t

type int64 = Int64.t

val compare_int64 : int64 -> int64 -> int

val hash_fold_int64 : Hash.state -> int64 -> Hash.state

val hash_int64 : int64 -> Hash.hash_value

val int64_of_sexp : Sexp.t -> int64

val sexp_of_int64 : int64 -> Sexp.t

type 'a list = 'a List.t

val compare_list : 'a. ('a -> 'a -> int) -> 'a list -> 'a list -> int

val hash_fold_list : 
  'a. (Hash.state -> 'a -> Hash.state) ->
  Hash.state ->
  'a list ->
  Hash.state

val list_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a list

val sexp_of_list : 'a. ('a -> Sexp.t) -> 'a list -> Sexp.t

type nativeint = Nativeint.t

val compare_nativeint : nativeint -> nativeint -> int

val hash_fold_nativeint : Hash.state -> nativeint -> Hash.state

val hash_nativeint : nativeint -> Hash.hash_value

val nativeint_of_sexp : Sexp.t -> nativeint

val sexp_of_nativeint : nativeint -> Sexp.t

type 'a option = 'a Option.t

val compare_option : 'a. ('a -> 'a -> int) -> 'a option -> 'a option -> int

val hash_fold_option : 
  'a. (Hash.state -> 'a -> Hash.state) ->
  Hash.state ->
  'a option ->
  Hash.state

val option_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a option

val sexp_of_option : 'a. ('a -> Sexp.t) -> 'a option -> Sexp.t

type 'a ref = 'a Ref.t

val compare_ref : 'a. ('a -> 'a -> int) -> 'a ref -> 'a ref -> int

val ref_of_sexp : 'a. (Sexp.t -> 'a) -> Sexp.t -> 'a ref

val sexp_of_ref : 'a. ('a -> Sexp.t) -> 'a ref -> Sexp.t

type string = String.t

val compare_string : string -> string -> int

val hash_fold_string : Hash.state -> string -> Hash.state

val hash_string : string -> Hash.hash_value

val string_of_sexp : Sexp.t -> string

val sexp_of_string : string -> Sexp.t

type bytes = Bytes.t

val compare_bytes : bytes -> bytes -> int

val bytes_of_sexp : Sexp.t -> bytes

val sexp_of_bytes : bytes -> Sexp.t

type unit = Unit.t

val compare_unit : unit -> unit -> int

val hash_fold_unit : Hash.state -> unit -> Hash.state

val hash_unit : unit -> Hash.hash_value

val unit_of_sexp : Sexp.t -> unit

val sexp_of_unit : unit -> Sexp.t

Format stuff

type nonrec ('a, 'b, 'c) format = ('a, 'b, 'c) Pervasives.format

type nonrec ('a, 'b, 'c, 'd) format4 = ('a, 'b, 'c, 'd) Pervasives.format4

type nonrec ('a, 'b, 'c, 'd, 'e, 'f) format6 =
  ('a, 'b, 'c, 'd, 'e, 'f) Pervasives.format6

Sexp

Exporting the ad-hoc types that are recognized by ppx_sexp_* converters. sexp_array, sexp_list, and sexp_option allow a record field to be absent when converting from a sexp, and if absent, the field will take a default value of the appropriate type:

        sexp_array   [||]
        sexp_bool    false
        sexp_list    []
        sexp_option  None

sexp_opaque causes the conversion to sexp to produce the atom <opaque>.

For more documentation, see sexplib/README.md.

type 'a sexp_array = 'a array

type 'a sexp_list = 'a list

type 'a sexp_opaque = 'a

type 'a sexp_option = 'a option

List operators

include module type of struct include List.Infix end

val (@) : 'a List.t -> 'a List.t -> 'a List.t

Int operators and comparisons

include module type of struct include Int.O end

A sub-module designed to be opened to make working with ints more convenient.

val (+) : Int.t -> Int.t -> Int.t

val (-) : Int.t -> Int.t -> Int.t

val (*) : Int.t -> Int.t -> Int.t

val (/) : Int.t -> Int.t -> Int.t

val (~-) : Int.t -> Int.t

val (**) : Int.t -> Int.t -> Int.t

include Comparisons.Infix with type t := Int.t

val abs : Int.t -> Int.t

val neg : Int.t -> Int.t

val zero : Int.t

val (%) : Int.t -> Int.t -> Int.t

val (/%) : Int.t -> Int.t -> Int.t

val (//) : Int.t -> Int.t -> float

val (land) : Int.t -> Int.t -> Int.t

val (lor) : Int.t -> Int.t -> Int.t

val (lxor) : Int.t -> Int.t -> Int.t

val lnot : Int.t -> Int.t

val (lsl) : Int.t -> int -> Int.t

val (asr) : Int.t -> int -> Int.t

val (lsr) : Int.t -> int -> Int.t

val (<) : int -> int -> bool

val (<=) : int -> int -> bool

val (<>) : int -> int -> bool

val (=) : int -> int -> bool

val (>) : int -> int -> bool

val (>=) : int -> int -> bool

val ascending : int -> int -> int

val descending : int -> int -> int

val compare : int -> int -> int

val equal : int -> int -> bool

val max : int -> int -> int

val min : int -> int -> int

Float operators

include module type of struct include Float.O_dot end

Similar to O, except that operators are suffixed with a dot, allowing one to have both int and float operators in scope simultaneously.

val (+.) : Float.t -> Float.t -> Float.t

val (-.) : Float.t -> Float.t -> Float.t

val (*.) : Float.t -> Float.t -> Float.t

val (/.) : Float.t -> Float.t -> Float.t

val (**.) : Float.t -> Float.t -> Float.t

val (~-.) : Float.t -> Float.t

val (|>) : 'a -> ('a -> 'b) -> 'b

Reverse application operator. x |> g |> f is equivalent to f (g (x)).

val (@@) : ('a -> 'b) -> 'a -> 'b

Application operator. g @@ f @@ x is equivalent to g (f (x)).

Boolean operations

val (&&) : bool -> bool -> bool

val (||) : bool -> bool -> bool

val not : bool -> bool

val ignore : _ -> unit

val (^) : String.t -> String.t -> String.t

Common string operations

Reference operations

val (!) : 'a ref -> 'a

val ref : 'a -> 'a ref

val (:=) : 'a ref -> 'a -> unit

Pair operations

val fst : ('a * 'b) -> 'a

val snd : ('a * 'b) -> 'b

Exceptions stuff

val failwith : string -> 'a

val invalid_arg : string -> 'a

val raise : exn -> 'a

val raise_s : Sexp.t -> 'a

Misc

val phys_equal : 'a -> 'a -> bool

val force : 'a Lazy.t -> 'a

package base

Sexp