/
batMonad.mli
54 lines (45 loc) · 2.07 KB
/
batMonad.mli
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
(*
* Monad -- Base monadic operations
* Copyright (C) 2008 David Teller
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version,
* with the special exception on linking described in file LICENSE.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*)
(** Definition of monads.
Monads are a design pattern which may be used to enforce strong
functional or non-functional constraints on the manipulation of
resources, while remaining in the world of functional programming.
For instance, monads may serve to implement approximations of a
types-and-effects type system, to enforce functional use of
arrays or other mutable data structures, or to enforce the
fact that only files opened for writing may be actually used
for writing.
For more information on monads, see {{:http://enfranchisedmind.com/blog/2007/08/06/a-monad-tutorial-for-ocaml/}
A Monad Tutorial for Ocaml}.
This definition is compatible with the standard syntax extension for monads.
For more information, see {{:http://www.cas.mcmaster.ca/~carette/pa_monad/} the documentation of pa_monad}.
@author David Teller
*)
(** Signature for monads *)
module type S = sig
type 'a m
(** The type of a monad producing values of type ['a].*)
val bind : 'a m -> ('a -> 'b m) -> 'b m
(** Monadic binding.
[bind m f] executes first [m] then [f], using the
result of [m]. *)
val return: 'a -> 'a m
(**Return a value, that is, put a value in the monad.*)
end