package travesty

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

List extensions.

This module contains various extensions for Core's List module, including adding monadic traversal.

type 'a t = 'a Base.list

t is just list, re-exported to make this module satisfy various container interfaces.

Lists are traversable containers.

include Traversable.S1_container with type 'a t := 'a t
module On_monad (M : Base.Monad.S) : Traversable.On_monad1 with type 'a t := 'a t and module M := M

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

module With_errors : Traversable.On_monad1 with type 'a t := 'a t and module M := Base.Or_error

With_errors is shorthand for On_monad (Or_error).

include Traversable.Generic_container with type 'a t := 'a t and type 'a elt := 'a and module On_monad := On_monad and module With_errors := With_errors
include Types_intf.Generic with type 'a t := 'a t with type 'a elt := 'a

We can do generic container operations.

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

We can do non-monadic mapping operations.

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

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

include Mappable.S1_container with type 'a t := 'a t
include Mappable.S1 with type 'a t := 'a t
include Mappable.Generic with type 'a t := 'a t and 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 Types_intf.Generic with type 'a t := 'a t with type 'a elt := 'a
val map : 'a t -> f:('a -> 'b) -> 'b t

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

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

Extensions1 includes the container extensions from T_container, as they work with any arity-1 container.

include T_container.Extensions1 with type 'a t := 'a t
val max_measure : measure:('a -> int) -> ?default:int -> 'a t -> int

max_measure ~measure ~default xs measures each item in xs according to measure, and returns the highest measure reported. If xs is empty, return default if given, and 0 otherwise.

val any : predicates:('a -> bool) t -> 'a -> bool

any ~predicates x tests x against predicates until one returns true, or all return false.

val right_pad : padding:'a -> 'a Base.list t -> 'a Base.list t

right_pad ~padding xs pads every list in xs with padding, ensuring all lists have equal length.

module With_elt (Elt : Base.Equal.S) : Traversable.S0_container with type t := Elt.t t and type elt := Elt.t

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

Miscellaneous extension functions

val exclude : f:('a -> Base.bool) -> 'a t -> 'a t

exclude ~f xs is the inverse of filter ~f xs.

val prefixes : 'a t -> 'a t t

prefixes xs returns all non-empty prefixes of xs.

val one : 'a Base.list -> 'a Base.Or_error.t

one xs returns Ok x if xs is a list containing only x, and an error otherwise.

val two : 'a Base.list -> ('a * 'a) Base.Or_error.t

two xs returns Ok (x, y) if xs is a list containing only x and y in that order, and an error otherwise.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct