Module `Monad.Of_monad_indexed`

Converts between monadic types with index type parameters.

Parameters

module Monad : sig ... end

module M : sig ... end

Signature

include Base.Monad.S_indexed with type ('a, 'i, 'j) t := ('a, 'i, 'j) M.t

val return : 'a 'i 'p 'q. 'a -> ('a, 'i, 'i) M.t

Convert a value to a t.

val map : 
  'a 'b 'i 'j 'p 'q. ('a, 'i, 'j) M.t ->
  f:('a -> 'b) ->
  ('b, 'i, 'j) M.t

Transforms the contents of a t.

val bind : 
  'a 'b 'i 'j 'k 'p 'q. ('a, 'i, 'j) M.t ->
  f:('a -> ('b, 'j, 'k) M.t) ->
  ('b, 'i, 'k) M.t

Sequences computations. bind t ~f computes f v for value(s) v in t. Well-behaved monads satisfy these "laws" (where ( >>= ) is the infix bind operator):

map t ~f is equivalent to bind t ~f:(fun x -> return (f x))
return x >>= f is equivalent to f x
t >>= return is equivalent to t
(t >>= f) >>= g is equivalent to t >>= fun x -> f x >>= g

val join : 
  'a 'i 'j 'k 'p 'q. (('a, 'j, 'k) M.t, 'i, 'j) M.t ->
  ('a, 'i, 'k) M.t

Combines nested t into just one layer. Equivalent to bind t ~f:Fn.id.

val ignore_m : 'a 'i 'j 'p 'q. ('a, 'i, 'j) M.t -> (unit, 'i, 'j) M.t

Ignores contained values of t. Equivalent to map t ~f:ignore.

val all : 'a 'i 'p 'q. ('a, 'i, 'i) M.t list -> ('a list, 'i, 'i) M.t

Combines a list of t.

val all_unit : 'i 'p 'q. (unit, 'i, 'i) M.t list -> (unit, 'i, 'i) M.t

Combines a list of t whose contents are unimportant.

val (>>=) : 
  'a 'b 'i 'j 'k 'p 'q. ('a, 'i, 'j) M.t ->
  ('a -> ('b, 'j, 'k) M.t) ->
  ('b, 'i, 'k) M.t

Infix bind.

val (>>|) : 
  'a 'b 'i 'j 'p 'q. ('a, 'i, 'j) M.t ->
  ('a -> 'b) ->
  ('b, 'i, 'j) M.t

Infix map.

module Monad_infix : sig ... end

module Let_syntax : sig ... end

Module Monad.Of_monad_indexed

Parameters

Signature

Module `Monad.Of_monad_indexed`