travesty

Traversable containers, monad extensions, and more
IN THIS PACKAGE

Parameters

module M : Base.Monad.S

Signature

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

All applicative operators are available through lowering the monad to an applicative functor.

include Traversable_types.Generic_on_applicative with module M := Monad_exts.App(M) with type 'a t := 'a t with type 'a elt := 'a
include Traversable_types.Basic_generic_on_applicative with module M := Monad_exts.App(M) with type 'a t := 'a t with type 'a elt := 'a

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 Generic_types.Generic with type 'a t := 'a t with type 'a elt := 'a
val map_m : 'a t -> f:( 'a -> 'b Monad_exts.App(M).t ) -> 'b t Monad_exts.App(M).t

map_m c ~f maps f over every t in c, threading through an applicative functor.

Example:

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

let f x =
  Or_error.(if 0 < x then error_string "negative!" else ok x)
in
List.With_errors.map_m integers ~f
val 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 applicatively over every t in c, threading through an accumulator with initial value init.

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

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

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

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

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

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

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

sequence_m x lifts a container of applicatives x to an applicative containing a container, by sequencing the applicative effects from left to right.