mirror of
https://github.com/c-cube/ocaml-containers.git
synced 2026-01-26 02:56:41 -05:00
40 lines
1 KiB
OCaml
40 lines
1 KiB
OCaml
|
|
(* This file is free software, part of containers. See file "license" for more details. *)
|
|
|
|
(** {1 Equality Combinators} *)
|
|
|
|
(** @since 1.2 *)
|
|
|
|
type 'a t = 'a -> 'a -> bool
|
|
(** Equality function. Must be transitive, symmetric, and reflexive. *)
|
|
|
|
val poly : 'a t
|
|
(** Standard polymorphic equality *)
|
|
|
|
val int : int t
|
|
val string : string t
|
|
val bool : bool t
|
|
val float : float t
|
|
val unit : unit t
|
|
|
|
val list : 'a t -> 'a list t
|
|
val array : 'a t -> 'a array t
|
|
|
|
val option : 'a t -> 'a option t
|
|
val pair : 'a t -> 'b t -> ('a * 'b) t
|
|
val triple : 'a t -> 'b t -> 'c t -> ('a * 'b * 'c) t
|
|
|
|
val map : ('a -> 'b) -> 'b t -> 'a t
|
|
(** [map f eq] is the equality function that, given objects [x] and [y],
|
|
projects [x] and [y] using [f] (e.g. using a record field) and then
|
|
compares those projections with [eq].
|
|
Example:
|
|
[map fst int] compares values of type [(int * 'a)] by their
|
|
first component. *)
|
|
|
|
val (>|=) : 'b t -> ('a -> 'b) -> 'a t
|
|
(** Infix equivalent of {!map} *)
|
|
|
|
module Infix : sig
|
|
val (>|=) : 'b t -> ('a -> 'b) -> 'a t
|
|
end
|