package base

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Container.S0
type t
type elt
val length : t -> int
val is_empty : t -> bool
val iter : t -> f:(elt -> unit) -> unit

iter must allow exceptions raised in f to escape, terminating the iteration cleanly. The same holds for all functions below taking an f.

val fold : t -> init:'accum -> f:('accum -> elt -> 'accum) -> 'accum

fold t ~init ~f returns f (... f (f (f init e1) e2) e3 ...) en, where e1..en are the elements of t.

val fold_result : t -> init:'accum -> f:('accum -> elt -> ('accum, 'e) Result.t) -> ('accum, 'e) Result.t

fold_result t ~init ~f is a short-circuiting version of fold that runs in the Result monad. If f returns an Error _, that value is returned without any additional invocations of f.

val exists : t -> f:(elt -> bool) -> bool

Returns true if and only if there exists an element for which the provided function evaluates to true. This is a short-circuiting operation.

val for_all : t -> f:(elt -> bool) -> bool

Returns true if and only if the provided function evaluates to true for all elements. This is a short-circuiting operation.

val count : t -> f:(elt -> bool) -> int

Returns the number of elements for which the provided function evaluates to true.

val sum : (module Commutative_group.S with type t = 'sum) -> t -> f:(elt -> 'sum) -> 'sum

Returns the sum of f i for all i in the container.

val find : t -> f:(elt -> bool) -> elt option

Returns as an option the first element for which f evaluates to true.

val find_map : t -> f:(elt -> 'a option) -> 'a option

Returns the first evaluation of f that returns Some, and returns None if there is no such element.

val to_list : t -> elt list
val to_array : t -> elt array
type tree
type comparator_witness
val invariants : t -> bool
val mem : t -> elt -> bool
val add : t -> elt -> t
val remove : t -> elt -> t
val union : t -> t -> t
val inter : t -> t -> t
val diff : t -> t -> t
val symmetric_diff : t -> t -> (elt, elt) Either.t Sequence.t
val compare_direct : t -> t -> int
val equal : t -> t -> bool
val is_subset : t -> of_:t -> bool
val subset : t -> t -> bool
  • deprecated [since 2016-09] Replace [Set.subset t1 t2] with [Set.is_subset t1 ~of_:t2]
val fold_until : t -> init:'b -> f:('b -> elt -> ('b, 'stop) Continue_or_stop.t) -> ('b, 'stop) Finished_or_stopped_early.t
val fold_right : t -> init:'b -> f:(elt -> 'b -> 'b) -> 'b
val iter2 : t -> t -> f:([ `Left of elt | `Right of elt | `Both of elt * elt ] -> unit) -> unit
val filter : t -> f:(elt -> bool) -> t
val partition_tf : t -> f:(elt -> bool) -> t * t
val elements : t -> elt list
val min_elt : t -> elt option
val min_elt_exn : t -> elt
val max_elt : t -> elt option
val max_elt_exn : t -> elt
val choose : t -> elt option
val choose_exn : t -> elt
val split : t -> elt -> t * elt option * t
val group_by : t -> equiv:(elt -> elt -> bool) -> t list
val find_exn : t -> f:(elt -> bool) -> elt
val find_index : t -> int -> elt option
  • deprecated [since 2016-10] Use [nth]
val nth : t -> int -> elt option
val remove_index : t -> int -> t
val to_tree : t -> tree
val to_sequence : ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:elt -> ?less_or_equal_to:elt -> t -> elt Sequence.t
val merge_to_sequence : ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:elt -> ?less_or_equal_to:elt -> t -> t -> (elt, elt) Merge_to_sequence_element.t Sequence.t
OCaml

Innovation. Community. Security.