package higher_kinded

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Types
Signatures
Functors
Implementations

higher_kinded
- Higher_kinded
  - Array
  - Either
  - Hash_set
  - Hashtbl
  - Ident
  - Lazy
  - List
  - Make
    
    X
  - Make2
    
    X
  - Make3
    
    X
  - Make4
    
    X
  - Make5
    
    X
  - Make6
    
    X
  - Make7
    
    X
  - Make8
    
    X
  - Make_monad
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
  - Make_monad2
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
  - Make_monad3
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
  - Make_monad_using_witness
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
    
    X
  - Make_monad_using_witness2
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
    
    X
  - Make_monad_using_witness3
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    M
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
    
    Monad_infix
    
    X
  - Map
  - Monad
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Monad2
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Monad3
    
    Let_syntax
    
    Let_syntax
    
    Open_on_rhs
    
    Monad_infix
  - Option
  - Queue
  - Ref
  - Result
  - S
  - S2
  - S3
  - S4
  - S5
  - S6
  - S7
  - S8
  - Sequence
  - Set
  - Type_equal

Legend:
Library
Module
Module type
Parameter
Class
Class type

This library allows you to use higher-kinded types in OCaml. See the README for a short tutorial on what that means and how to use it.

Types

type 'a t

If A implements the signature S, (a, A.witness1) t is equivalent to a A.t.

If A implements the signature S, ('a, A.higher_kinded) t1 is equivalent to 'a A.t.

type ('a, 'witness) t1 = ('a -> 'witness) t

If A implements the signature S2, ('a, 'b, A.higher_kinded) t2 is equivalent to ('a, 'b) A.t.

type ('a, 'b, 'witness) t2 = ('a, 'b -> 'witness) t1

If A implements the signature S3, ('a, 'b, 'c, A.higher_kinded) t3 is equivalent to ('a, 'b, 'c) A.t.

type ('a, 'b, 'c, 'witness) t3 = ('a, 'b, 'c -> 'witness) t2

If A implements the signature S4, ('a, 'b, 'c, 'd, A.higher_kinded) t4 is equivalent to ('a, 'b, 'c, 'd) A.t.

type ('a, 'b, 'c, 'd, 'witness) t4 = ('a, 'b, 'c, 'd -> 'witness) t3

If A implements the signature S5, ('a, 'b, 'c, 'd, 'e, A.higher_kinded) t5 is equivalent to ('a, 'b, 'c, 'd, 'e) A.t.

type ('a, 'b, 'c, 'd, 'e, 'witness) t5 = ('a, 'b, 'c, 'd, 'e -> 'witness) t4

If A implements the signature S6, ('a, 'b, 'c, 'd, 'e, 'f, A.higher_kinded) t6 is equivalent to ('a, 'b, 'c, 'd, 'e, 'f) A.t.

type ('a, 'b, 'c, 'd, 'e, 'f, 'witness) t6 =
  ('a, 'b, 'c, 'd, 'e, 'f -> 'witness) t5

If A implements the signature S7, ('a, 'b, 'c, 'd, 'e, 'f, 'g, A.higher_kinded) t7 is equivalent to ('a, 'b, 'c, 'd, 'e, 'f, 'g) A.t.

type ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'witness) t7 =
  ('a, 'b, 'c, 'd, 'e, 'f, 'g -> 'witness) t6

If A implements the signature S8, ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, A.higher_kinded) t8 is equivalent to ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h) A.t.

type ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h, 'witness) t8 =
  ('a, 'b, 'c, 'd, 'e, 'f, 'g, 'h -> 'witness) t7

Signatures

include sig ... end

module type S = sig ... end

module type S2 = sig ... end

module type S3 = sig ... end

module type S4 = sig ... end

module type S5 = sig ... end

module type S6 = sig ... end

module type S7 = sig ... end

module type S8 = sig ... end

module type Monad = sig ... end

module type Monad2 = sig ... end

module type Monad3 = sig ... end

Functors

This is the meat of the library. Use these functors to implement the higher_kinded interface.

module Make (X : sig ... end) : S with type 'a t := 'a X.t

module Make2 (X : sig ... end) : S2 with type ('a, 'z) t := ('a, 'z) X.t

module Make3
  (X : sig ... end) : 
  S3 with type ('a, 'y, 'z) t := ('a, 'y, 'z) X.t

module Make4
  (X : sig ... end) : 
  S4 with type ('a, 'x, 'y, 'z) t := ('a, 'x, 'y, 'z) X.t

module Make5
  (X : sig ... end) : 
  S5 with type ('a, 'w, 'x, 'y, 'z) t := ('a, 'w, 'x, 'y, 'z) X.t

module Make6
  (X : sig ... end) : 
  S6 with type ('a, 'v, 'w, 'x, 'y, 'z) t := ('a, 'v, 'w, 'x, 'y, 'z) X.t

module Make7
  (X : sig ... end) : 
  S7
    with type ('a, 'u, 'v, 'w, 'x, 'y, 'z) t :=
           ('a, 'u, 'v, 'w, 'x, 'y, 'z) X.t

module Make8
  (X : sig ... end) : 
  S8
    with type ('a, 't, 'u, 'v, 'w, 'x, 'y, 'z) t :=
           ('a, 't, 'u, 'v, 'w, 'x, 'y, 'z) X.t

module Make_monad (M : Base.Monad.S) : Monad with type 'a t := 'a M.t

module Make_monad2
  (M : Base.Monad.S2) : 
  Monad2 with type ('a, 'b) t := ('a, 'b) M.t

module Make_monad3
  (M : Base.Monad.S3) : 
  Monad3 with type ('a, 'b, 'c) t := ('a, 'b, 'c) M.t

module Make_monad_using_witness
  (M : Base.Monad.S)
  (X : S with type 'a t := 'a M.t) : 
  Monad with type 'a t := 'a M.t with type higher_kinded := X.higher_kinded

module Make_monad_using_witness2
  (M : Base.Monad.S2)
  (X : S2 with type ('a, 'b) t := ('a, 'b) M.t) : 
  Monad2
    with type ('a, 'b) t := ('a, 'b) M.t
    with type higher_kinded := X.higher_kinded

module Make_monad_using_witness3
  (M : Base.Monad.S3)
  (X : S3 with type ('a, 'b, 'c) t := ('a, 'b, 'c) M.t) : 
  Monad3
    with type ('a, 'b, 'c) t := ('a, 'b, 'c) M.t
    with type higher_kinded := X.higher_kinded

Implementations

Base, Core, and Async don't depend on Higher_kinded, so we put these implementations here instead of in the respective modules where they might have been a nicer fit.

module Ident : S with type 'a t := 'a

module Array : S with type 'a t := 'a Base.Array.t

module Either : S2 with type ('a, 'b) t := ('a, 'b) Base.Either.t

module Hash_set : S with type 'a t := 'a Base.Hash_set.t

module Hashtbl : S2 with type ('a, 'b) t := ('a, 'b) Base.Hashtbl.t

module Lazy : S with type 'a t := 'a Base.Lazy.t

module List : S with type 'a t := 'a Base.List.t

module Map : S3 with type ('a, 'b, 'c) t := ('a, 'b, 'c) Base.Map.t

module Option : S with type 'a t := 'a Base.Option.t

module Queue : S with type 'a t := 'a Base.Queue.t

module Ref : S with type 'a t := 'a Base.Ref.t

module Result : S2 with type ('a, 'e) t := ('a, 'e) Base.Result.t

module Set : S2 with type ('a, 'b) t := ('a, 'b) Base.Set.t

module Sequence : S with type 'a t := 'a Base.Sequence.t

module Type_equal : S2 with type ('a, 'b) t := ('a, 'b) Base.Type_equal.t

t itself has one type parameter, so we might as well implement S right here.

include S with type 'a t := 'a t

type higher_kinded

val inject : 'a t -> ('a -> higher_kinded) t

val project : ('a -> higher_kinded) t -> 'a t