Source file monoid_intf.ml

(** A type of values with an associative operation and an identity element, for
    example, integers with addition and zero. *)
module type Basic = sig
  type t

  (** Must be the identity of [combine]:

      - combine empty t = t
      - combine t empty = t *)
  val empty : t

  (** Must be associative:

      - combine a (combine b c) = combine (combine a b) c *)
  val combine : t -> t -> t
end

(** This module type extends the basic definition of a monoid by adding a
    convenient operator synonym [( @ ) = combine], as well as derived functions
    [reduce] and [map_reduce]. *)
module type S = sig
  include Basic

  module O : sig
    (** An operator alias for [combine]. *)
    val ( @ ) : t -> t -> t
  end

  val reduce : t list -> t
  val map_reduce : f:('a -> t) -> 'a list -> t
end

module Commutative = struct
  (** Like [Basic] but requires [combine] to be commutative.

      The [combine_is_commutative] type is a "proof" of commutativity, so that
      one can't simply pass any monoid where a commutative monoid is expected. *)
  module type Basic = sig
    include Basic

    type combine_is_commutative = unit
  end

  (** Like [S] but requires [combine] to be commutative. *)
  module type S = sig
    include S

    type combine_is_commutative = unit
  end
end