Module type `Container.Generic__''value''`

type ('a, _, _) t

type 'a elt

include sig ... end

val length : 'a 'p1 'p2. ('a, 'p1, 'p2) t -> int

val is_empty : 'a 'p1 'p2. ('a, 'p1, 'p2) t -> bool

val iter : 'a 'p1 'p2. ('a, 'p1, 'p2) t -> f:('a elt -> unit) @ local -> 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 exists : 'a 'p1 'p2. ('a, 'p1, 'p2) t -> f:('a elt -> bool) @ local -> 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 : 
  'a 'p1 'p2. ('a, 'p1, 'p2) t ->
  f:('a elt -> bool) @ local ->
  bool

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

val count : 'a 'p1 'p2. ('a, 'p1, 'p2) t -> f:('a elt -> bool) @ local -> int

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

val find : 
  'a 'p1 'p2. ('a, 'p1, 'p2) t ->
  f:('a elt -> bool) @ local ->
  'a elt option

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

val to_list : 'a 'p1 'p2. ('a, 'p1, 'p2) t -> 'a elt list

val min_elt : 
  'a 'p1 'p2. ('a, 'p1, 'p2) t ->
  compare:('a elt -> 'a elt -> int) @ local ->
  'a elt option

Returns a min (resp. max) element from the collection using the provided compare function. In case of a tie, the first element encountered while traversing the collection is returned. The implementation uses fold so it has the same complexity as fold. Returns None iff the collection is empty.

val max_elt : 
  'a 'p1 'p2. ('a, 'p1, 'p2) t ->
  compare:('a elt -> 'a elt -> int) @ local ->
  'a elt option

include sig ... end

val sum : 
  'a 'sum 'p1 'p2. (module Base__.Container_intf.Definitions.Summable__value_or_null
                     with type t = 'sum) ->
  ('a, 'p1, 'p2) t ->
  f:('a elt -> 'sum) @ local ->
  'sum

Returns the sum of f i for all i in the container. The order in which the elements will be summed is unspecified.

val iter_until : 
  'a 'p1 'p2 'final. ('a, 'p1, 'p2) t ->
  f:('a elt -> (unit, 'final) Base.Container.Continue_or_stop.t) @ local ->
  finish:(unit -> 'final) @ local ->
  'final

iter_until t ~f ~finish is a short-circuiting version of iter. If f returns Stop x the computation ceases and returns x. If f always returns Continue () the final result is computed by finish.

val fold : 
  'a 'p1 'p2 'acc. ('a, 'p1, 'p2) t ->
  init:'acc ->
  f:('acc -> 'a elt -> 'acc) @ local ->
  'acc

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 : 
  'a 'p1 'p2 'acc 'e. ('a, 'p1, 'p2) t ->
  init:'acc ->
  f:('acc -> 'a elt -> ('acc, 'e) Stdlib.result) @ local ->
  ('acc, 'e) Stdlib.result

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 find_map : 
  'a 'p1 'p2 'b. ('a, 'p1, 'p2) t ->
  f:('a elt -> 'b option) @ local ->
  'b option

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

include sig ... end

val fold_until : 
  'a 'p1 'p2 'acc 'final. ('a, 'p1, 'p2) t ->
  init:'acc ->
  f:
    ('acc -> 'a elt -> ('acc, 'final) Base.Container.Continue_or_stop.t) @ local ->
  finish:('acc -> 'final) @ local ->
  'final

fold_until t ~init ~f ~finish is a short-circuiting version of fold. If f returns Stop _ the computation ceases and results in that value. If f returns Continue _, the fold will proceed. If f never returns Stop _, the final result is computed by finish.

Example:

  type maybe_negative =
    | Found_negative of int
    | All_nonnegative of { sum : int }

  (** [first_neg_or_sum list] returns the first negative number in [list], if any,
      otherwise returns the sum of the list. *)
  let first_neg_or_sum =
    List.fold_until ~init:0
      ~f:(fun sum x ->
        if x < 0
        then Stop (Found_negative x)
        else Continue (sum + x))
      ~finish:(fun sum -> All_nonnegative { sum })
  ;;

  let x = first_neg_or_sum [1; 2; 3; 4; 5]
  val x : maybe_negative = All_nonnegative {sum = 15}

  let y = first_neg_or_sum [1; 2; -3; 4; 5]
  val y : maybe_negative = Found_negative -3

include sig ... end

val mem : 
  'a 'p1 'p2. ('a, 'p1, 'p2) t ->
  'a elt ->
  equal:('a elt -> 'a elt -> bool) @ local ->
  bool

Checks whether the provided element is there, using equal.

Module type Container.Generic__''value''

Module type `Container.Generic__''value''`