package base

  1. Overview
  2. Docs
Full standard library replacement for OCaml

Install 

dune-project
 Dependency

github.com Changelog MIT License Edit opam file Versions (20)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.16.5.tar.gz
md5=109456ad2350671ad3159cbbca993e3e
sha512=445d08b965e0d559e4046b874f611c8f36de47fa5c23a047146f48ee638588c1b73789a7adb5ead235c0ad2f44b56fd513a6d60bcb8b6c9f11566d32fd7760f2

doc/base/Base/Monad/index.html

Module Base.MonadSource

A monad is an abstraction of the concept of sequencing of computations. A value of type 'a monad represents a computation that returns a value of type 'a.

Sourcemodule type Basic = sig ... end
Sourcemodule type Basic2 = sig ... end

Multi parameter monad. The second parameter gets unified across all the computation. This is used to encode monads working on a multi parameter data structure like (('a,'b) result).

Sourcemodule type Basic3 = sig ... end

Multi parameter monad. The second and third parameters get unified across all the computation.

Sourcemodule type Basic_indexed = sig ... end

Indexed monad, in the style of Atkey. The second and third parameters are composed across all computation. To see this more clearly, you can look at the type of bind:

Sourcemodule type Basic_local = sig ... end
Sourcemodule type Basic2_local = sig ... end

Multi parameter monad. The second parameter gets unified across all the computation. This is used to encode monads working on a multi parameter data structure like (('a,'b) result).

Sourcemodule type Infix = sig ... end
Sourcemodule type Infix2 = sig ... end

Same as Infix, except the monad type has two arguments. The second is always just passed through.

Sourcemodule type Infix3 = sig ... end

Same as Infix, except the monad type has three arguments. The second and third are always just passed through.

Sourcemodule type Infix_indexed = sig ... end

Same as Infix, except the monad type has three arguments. The second and third are composed across all computation.

Sourcemodule type Infix_local = sig ... end
Sourcemodule type Infix2_local = sig ... end

Same as Infix, except the monad type has two arguments. The second is always just passed through.

Sourcemodule type Syntax = sig ... end

Opening a module of this type allows one to use the %bind and %map syntax extensions defined by ppx_let, and brings return into scope.

Sourcemodule type Syntax2 = sig ... end
Sourcemodule type Syntax3 = sig ... end
Sourcemodule type Syntax_indexed = sig ... end
Sourcemodule type Syntax_local = sig ... end

Opening a module of this type allows one to use the %bind and %map syntax extensions defined by ppx_let, and brings return into scope.

Sourcemodule type Syntax2_local = sig ... end
Sourcemodule type S_without_syntax = sig ... end
Sourcemodule type S_without_syntax_local = sig ... end
Sourcemodule type S = sig ... end
Sourcemodule type S2 = sig ... end

The same as S except the monad type has two arguments. The second is always just passed through.

Sourcemodule type S3 = sig ... end

The same as S except the monad type has three arguments. The second and third are always just passed through.

Sourcemodule type S_indexed = sig ... end

The same as S except the monad type has three arguments. The second and third are composed across all computation.

Sourcemodule type S_local = sig ... end
Sourcemodule type S2_local = sig ... end

The same as S except the monad type has two arguments. The second is always just passed through.

Sourcemodule Make (X : Basic) : S with type 'a t := 'a X.t
Sourcemodule Make2 (X : Basic2) : S2 with type ('a, 'e) t := ('a, 'e) X.t

The same as S except the monad type has two arguments. The second is always just passed through.

Sourcemodule Make3 (X : Basic3) : S3 with type ('a, 'd, 'e) t := ('a, 'd, 'e) X.t

The same as S except the monad type has three arguments. The second and third are always just passed through.

Sourcemodule Make_indexed (X : Basic_indexed) : S_indexed with type ('a, 'd, 'e) t := ('a, 'd, 'e) X.t

The same as S except the monad type has three arguments. The second and third are composed across all computation.

Sourcemodule Make_local (X : Basic_local) : S_local with type 'a t := 'a X.t
Sourcemodule Make2_local (X : Basic2_local) : S2_local with type ('a, 'e) t := ('a, 'e) X.t

The same as S except the monad type has two arguments. The second is always just passed through.

Sourcemodule Of_monad (Monad : S) (M : sig ... end) : S with type 'a t := 'a M.t

Define a monad through an isomorphism with an existing monad. For example:

Sourcemodule Of_monad2 (Monad : S2) (M : sig ... end) : S2 with type ('a, 'b) t := ('a, 'b) M.t

The same as S except the monad type has two arguments. The second is always just passed through.

Sourcemodule Of_monad3 (Monad : S3) (M : sig ... end) : S3 with type ('a, 'b, 'c) t := ('a, 'b, 'c) M.t

The same as S except the monad type has three arguments. The second and third are always just passed through.

Sourcemodule Of_monad_indexed (Monad : S_indexed) (M : sig ... end) : S_indexed with type ('a, 'i, 'j) t := ('a, 'i, 'j) M.t

The same as S except the monad type has three arguments. The second and third are composed across all computation.

Sourcemodule Ident : S_local with type 'a t = 'a

An eager identity monad with functions heavily annotated with @inlined or @inline hint.