package travesty

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

With_elt (Elt) demotes this S1_container to a S0_container by fixing the element type to that mentioned in Elt.

Parameters

module Elt : Base.Equal.S

Signature

include Types_intf.S0 with type t := Elt.t I.t with type elt := Elt.t
include Generic_container with type 'a t := Elt.t I.t and type 'a elt := Elt.t
include Types_intf.Generic with type 'a t := Elt.t I.t with type 'a elt := Elt.t
module On_monad (M : Base.Monad.S) : Generic_on_monad with type 'a t := Elt.t I.t and type 'a elt := Elt.t and module M := M

On_monad implements monadic traversal operators for a given monad M.

We can do generic container operations.

include Base.Container.Generic with type 'a t := Elt.t I.t and type 'a elt := Elt.t

We can do non-monadic mapping operations.

include Mappable.Generic with type 'a t := Elt.t I.t and type 'a elt := Elt.t

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 Types_intf.Generic with type 'a t := Elt.t I.t with type 'a elt := Elt.t
val fold_map : Elt.t I.t -> f:('acc -> Elt.t -> 'acc * Elt.t) -> init:'acc -> 'acc * Elt.t I.t

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

val mapi : f:(Base.int -> Elt.t -> Elt.t) -> Elt.t I.t -> Elt.t I.t

mapi ~f t maps f across t, passing in an increasing position counter.

module With_errors : Generic_on_monad with type 'a t := Elt.t I.t and type 'a elt := Elt.t and module M := Base.Or_error

With_errors specialises On_monad to the error monad.

include Mappable.S0_container with type t := Elt.t I.t and type elt := Elt.t
include Mappable.S0 with type t := Elt.t I.t with type elt := Elt.t
include Types_intf.S0 with type t := Elt.t I.t with type elt := Elt.t
include Mappable.Generic with type 'a t := Elt.t I.t and type 'a elt := Elt.t

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 Types_intf.Generic with type 'a t := Elt.t I.t with type 'a elt := Elt.t
val map : Elt.t I.t -> f:(Elt.t -> Elt.t) -> Elt.t I.t

map c ~f maps f over every t in c.

include Base.Container.S0 with type t := Elt.t I.t and type elt := Elt.t
val mem : Elt.t I.t -> Elt.t -> bool
val length : Elt.t I.t -> int
val is_empty : Elt.t I.t -> bool
val iter : Elt.t I.t -> f:(Elt.t -> unit) -> unit
val fold : Elt.t I.t -> init:'accum -> f:('accum -> Elt.t -> 'accum) -> 'accum
val fold_result : Elt.t I.t -> init:'accum -> f:('accum -> Elt.t -> ('accum, 'e) Base__.Result.t) -> ('accum, 'e) Base__.Result.t
val fold_until : Elt.t I.t -> init:'accum -> f: ('accum -> Elt.t -> ('accum, 'final) Base__.Container_intf.Continue_or_stop.t) -> finish:('accum -> 'final) -> 'final
val exists : Elt.t I.t -> f:(Elt.t -> bool) -> bool
val for_all : Elt.t I.t -> f:(Elt.t -> bool) -> bool
val count : Elt.t I.t -> f:(Elt.t -> bool) -> int
val sum : (module Base__.Commutative_group.S with type t = 'sum) -> Elt.t I.t -> f:(Elt.t -> 'sum) -> 'sum
val find : Elt.t I.t -> f:(Elt.t -> bool) -> Elt.t option
val find_map : Elt.t I.t -> f:(Elt.t -> 'a option) -> 'a option
val to_list : Elt.t I.t -> Elt.t list
val to_array : Elt.t I.t -> Elt.t array
val min_elt : Elt.t I.t -> compare:(Elt.t -> Elt.t -> int) -> Elt.t option
val max_elt : Elt.t I.t -> compare:(Elt.t -> Elt.t -> int) -> Elt.t option
OCaml

Innovation. Community. Security.