package base

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

Parameters

module T : sig ... end

Signature

include Container.S0_with_creators with type t := T.t with type elt := T.Elt.t
val of_list : T.Elt.t list -> T.t
val of_array : T.Elt.t array -> T.t
val append : T.t -> T.t -> T.t

E.g., append (of_list [a; b]) (of_list [c; d; e]) is of_list [a; b; c; d; e]

val concat : T.t list -> T.t

Concatenates a nested container. The elements of the inner containers are concatenated together in order to give the result.

val map : T.t -> f:(T.Elt.t -> T.Elt.t) -> T.t

map f (of_list [a1; ...; an]) applies f to a1, a2, ..., an, in order, and builds a result equivalent to of_list [f a1; ...; f an].

val filter : T.t -> f:(T.Elt.t -> bool) -> T.t

filter t ~f returns all the elements of t that satisfy the predicate f.

val filter_map : T.t -> f:(T.Elt.t -> T.Elt.t option) -> T.t

filter_map t ~f applies f to every x in t. The result contains every y for which f x returns Some y.

val concat_map : T.t -> f:(T.Elt.t -> T.t) -> T.t

concat_map t ~f is equivalent to concat (map t ~f).

val partition_tf : T.t -> f:(T.Elt.t -> bool) -> T.t * T.t

partition_tf t ~f returns a pair t1, t2, where t1 is all elements of t that satisfy f, and t2 is all elements of t that do not satisfy f. The "tf" suffix is mnemonic to remind readers that the result is (trues, falses).

val partition_map : T.t -> f:(T.Elt.t -> (T.Elt.t, T.Elt.t) Base__.Either0.t) -> T.t * T.t

partition_map t ~f partitions t according to f.

include Container.S0 with type t := T.t with type elt := T.Elt.t
val mem : T.t -> T.Elt.t -> bool

Checks whether the provided element is there, using equality on elts.

val length : T.t -> int
val is_empty : T.t -> bool
val iter : T.t -> f:(T.Elt.t -> 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.t -> init:'acc -> f:('acc -> T.Elt.t -> 'acc) -> '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 : T.t -> init:'acc -> f:('acc -> T.Elt.t -> ('acc, 'e) Result.t) -> ('acc, '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 fold_until : T.t -> init:'acc -> f:('acc -> T.Elt.t -> ('acc, 'final) Container.Continue_or_stop.t) -> finish:('acc -> 'final) -> '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
val exists : T.t -> f:(T.Elt.t -> 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.t -> f:(T.Elt.t -> 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.t -> f:(T.Elt.t -> bool) -> int

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

val sum : (module Container.Summable with type t = 'sum) -> T.t -> f:(T.Elt.t -> 'sum) -> 'sum

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

val find : T.t -> f:(T.Elt.t -> bool) -> T.Elt.t option

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

val find_map : T.t -> f:(T.Elt.t -> '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.t -> T.Elt.t list
val to_array : T.t -> T.Elt.t array
val min_elt : T.t -> compare:(T.Elt.t -> T.Elt.t -> int) -> T.Elt.t 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 : T.t -> compare:(T.Elt.t -> T.Elt.t -> int) -> T.Elt.t option

These are all like their equivalents in Container except that an index starting at 0 is added as the first argument to f.

val foldi : T.t -> init:_ -> f:(int -> _ -> T.Elt.t -> _) -> _
val iteri : T.t -> f:(int -> T.Elt.t -> unit) -> unit
val existsi : T.t -> f:(int -> T.Elt.t -> bool) -> bool
val for_alli : T.t -> f:(int -> T.Elt.t -> bool) -> bool
val counti : T.t -> f:(int -> T.Elt.t -> bool) -> int
val findi : T.t -> f:(int -> T.Elt.t -> bool) -> (int * T.Elt.t) option
val find_mapi : T.t -> f:(int -> T.Elt.t -> 'a option) -> 'a option
val init : int -> f:(int -> T.Elt.t) -> T.t

init n ~f is equivalent to of_list [f 0; f 1; ...; f (n-1)]. It raises an exception if n < 0.

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

mapi is like map. Additionally, it passes in the index of each element as the first argument to the mapped function.

val filteri : T.t -> f:(int -> T.Elt.t -> bool) -> T.t
val filter_mapi : T.t -> f:(int -> T.Elt.t -> T.Elt.t option) -> T.t

filter_mapi is like filter_map. Additionally, it passes in the index of each element as the first argument to the mapped function.

val concat_mapi : T.t -> f:(int -> T.Elt.t -> T.t) -> T.t

concat_mapi t ~f is like concat_map. Additionally, it passes the index as an argument.

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