package travesty

  1. Overview
  2. Docs
Monadically traversable containers

Install 

dune-project
 Dependency

mattwindsor91.github.io Readme Changelog Edit opam file Versions (8)

Authors

  1. M
    Matt Windsor <m.windsor@imperial.ac.uk>

Maintainers

  1. M
    Matt Windsor <m.windsor@imperial.ac.uk>

Sources

travesty-v0.6.2.tbz
sha256=be89ec1c96fedcc47362568b359aa6b8d3fefb8b86f70133dd1a75ca72476807
sha512=19616b0a5fddd5725fdf7ab160e9f89d243f0dbaaaf53ba455bfbac2790cb07811862ecc5ada81be35a06869a987dcc149f24a7e84f461222216d45fe0036ca2

doc/travesty.containers/Travesty_containers/Singleton/On_monad/index.html

Module Singleton.On_monad

On_monad implements monadic folding and mapping operators for a given monad M, including arity-1 specific operators.

Parameters

module M : Base.Monad.S

Signature

include Travesty.Traversable_types.Generic_on_monad with type 'a t := 'a t and type 'a elt := 'a with module M := M
include Travesty.Traversable_types.Basic_generic_on_monad with type 'a t := 'a t with type 'a elt := 'a with module M := M

Generic refers to the container type as 'a t, and the element type as 'a elt; substitute t/elt (arity-0) or 'a t/'a (arity-1) accordingly below.

include Travesty.Generic_types.Generic with type 'a t := 'a t with type 'a elt := 'a
Sourceval map_m : 'a t -> f:('a -> 'b M.t) -> 'b t M.t

map_m c ~f maps f over every t in c, threading through monadic state.

Example:

  (* Travesty_base_exts.List adds monadic traversals to a list;
     With_errors (in S1_container) implements them on the On_error
     monad. *)

  let f x =
    Or_error.(if 0 < x then error_string "negative!" else ok x)
  in
  List.With_errors.map_m integers ~f
Sourceval fold_map_m : 'a t -> f:('acc -> 'a -> ('acc * 'b) M.t) -> init:'acc -> ('acc * 'b t) M.t

fold_map_m c ~f ~init folds f monadically over every t in c, threading through an accumulator with initial value init.

Sourceval fold_m : 'a t -> init:'acc -> f:('acc -> 'a -> 'acc M.t) -> 'acc M.t

fold_m x ~init ~f folds the monadic computation f over x, starting with initial value init, and returning the final value inside the monadic effect.

Sourceval iter_m : 'a t -> f:('a -> Base.unit M.t) -> Base.unit M.t

iter_m x ~f iterates the monadic computation f over x, returning the final monadic effect.

Sourceval mapi_m : f:(Base.int -> 'a -> 'b M.t) -> 'a t -> 'b t M.t

mapi_m ~f x behaves as mapM, but also supplies f with the index of the element. This index should match the actual position of the element in the container x.

Sourceval sequence_m : 'a M.t t -> 'a t M.t

sequence_m x lifts a container of monads x to a monad containing a container, by sequencing the monadic effects from left to right.