package core

  1. Overview
  2. Docs
package core
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module String.SetSource

Sourcemodule Elt : sig ... end
include Set_intf.S with module Elt := Elt
include Set_intf.S_plain with module Elt := Elt
include Ppx_compare_lib.Comparable.S with type t := t
Sourceval compare : t -> t -> int
include Set_intf.Creators_and_accessors0 with type ('a, 'b) set := ('a, 'b) Base.Set.t with type t := t with type tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type elt := Elt.t with type named := named with type comparator_witness := Elt.comparator_witness
include Set_intf.Accessors0 with type t := t with type tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type elt := Elt.t with type named := named with type comparator_witness := Elt.comparator_witness
include Base.Set.Accessors0 with type t := t with type tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type elt := Elt.t with type named := named with type comparator_witness := Elt.comparator_witness
include Base.Container.S0 with type t := t with type elt := Elt.t
Sourceval length : t -> int
Sourceval is_empty : t -> bool
Sourceval iter : t -> f:(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.

Sourceval fold : t -> init:'accum -> f:('accum -> Elt.t -> 'accum) -> 'accum

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

Sourceval fold_result : t -> init:'accum -> f:('accum -> Elt.t -> ('accum, 'e) Base.Result.t) -> ('accum, 'e) Base.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.

Sourceval exists : t -> f:(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.

Sourceval for_all : t -> f:(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.

Sourceval count : t -> f:(Elt.t -> bool) -> int

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

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

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

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

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

Sourceval find_map : t -> f:(Elt.t -> 'a option) -> 'a option

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

Sourceval to_list : t -> Elt.t list
Sourceval to_array : t -> Elt.t array
Sourceval invariants : t -> bool
Sourceval mem : t -> Elt.t -> bool
Sourceval add : t -> Elt.t -> t
Sourceval remove : t -> Elt.t -> t
Sourceval union : t -> t -> t
Sourceval inter : t -> t -> t
Sourceval diff : t -> t -> t
Sourceval symmetric_diff : t -> t -> (Elt.t, Elt.t) Base.Either.t Base.Sequence.t
Sourceval compare_direct : t -> t -> int
Sourceval equal : t -> t -> bool
Sourceval is_subset : t -> of_:t -> bool
Sourceval are_disjoint : t -> t -> bool
Sourcemodule Named : sig ... end
Sourceval fold_until : t -> init:'b -> f:('b -> Elt.t -> ('b, 'final) Base.Container.Continue_or_stop.t) -> finish:('b -> 'final) -> 'final
Sourceval fold_right : t -> init:'b -> f:(Elt.t -> 'b -> 'b) -> 'b
Sourceval iter2 : t -> t -> f:([ `Left of Elt.t | `Right of Elt.t | `Both of Elt.t * Elt.t ] -> unit) -> unit
Sourceval filter : t -> f:(Elt.t -> bool) -> t
Sourceval partition_tf : t -> f:(Elt.t -> bool) -> t * t
Sourceval elements : t -> Elt.t list
Sourceval min_elt : t -> Elt.t option
Sourceval min_elt_exn : t -> Elt.t
Sourceval max_elt : t -> Elt.t option
Sourceval max_elt_exn : t -> Elt.t
Sourceval choose : t -> Elt.t option
Sourceval choose_exn : t -> Elt.t
Sourceval split : t -> Elt.t -> t * Elt.t option * t
Sourceval group_by : t -> equiv:(Elt.t -> Elt.t -> bool) -> t list
Sourceval find_exn : t -> f:(Elt.t -> bool) -> Elt.t
Sourceval nth : t -> int -> Elt.t option
Sourceval remove_index : t -> int -> t
Sourceval to_sequence : ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:Elt.t -> ?less_or_equal_to:Elt.t -> t -> Elt.t Base.Sequence.t
Sourceval binary_search_segmented : t -> segment_of:(Elt.t -> [ `Left | `Right ]) -> Base.Binary_searchable.Which_target_by_segment.t -> Elt.t option
Sourceval merge_to_sequence : ?order:[ `Increasing | `Decreasing ] -> ?greater_or_equal_to:Elt.t -> ?less_or_equal_to:Elt.t -> t -> t -> (Elt.t, Elt.t) Base.Sequence.Merge_with_duplicates_element.t Base.Sequence.t
Sourceval to_map : t -> f:(Elt.t -> 'data) -> (Elt.t, 'data, Elt.comparator_witness) Base.Map.t
include Set_intf.Creators0 with type t := t with type tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type elt := Elt.t with type comparator_witness := Elt.comparator_witness with type ('a, 'b) set := ('a, 'b) Base.Set.t
include Base.Set.Creators0 with type t := t with type tree := (Elt.t, Elt.comparator_witness) Base.Set.Using_comparator.Tree.t with type elt := Elt.t with type comparator_witness := Elt.comparator_witness with type ('a, 'b) set := ('a, 'b) Base.Set.t
Sourceval empty : t
Sourceval singleton : Elt.t -> t
Sourceval union_list : t list -> t
Sourceval of_list : Elt.t list -> t
Sourceval of_sequence : Elt.t Base.Sequence.t -> t
Sourceval of_array : Elt.t array -> t
Sourceval of_sorted_array : Elt.t array -> t Base.Or_error.t
Sourceval of_sorted_array_unchecked : Elt.t array -> t
Sourceval of_increasing_iterator_unchecked : len:int -> f:(int -> Elt.t) -> t
Sourceval stable_dedup_list : Elt.t list -> Elt.t list
Sourceval map : ('a, _) Base.Set.t -> f:('a -> Elt.t) -> t
Sourceval filter_map : ('a, _) Base.Set.t -> f:('a -> Elt.t option) -> t
Sourceval of_hash_set : Elt.t Hash_set.t -> t
Sourceval of_hashtbl_keys : (Elt.t, _) Hashtbl.t -> t
Sourceval of_map_keys : (Elt.t, _, Elt.comparator_witness) Base.Map.t -> t
Sourcemodule Provide_of_sexp (Elt : sig ... end) : sig ... end
Sourcemodule Provide_bin_io (Elt : sig ... end) : Set_intf.Binable.S with type t := t
Sourcemodule Provide_hash (Elt : Base.Hasher.S with type t := Elt.t) : sig ... end
include Sexpable.S with type t := t
Sourceval t_of_sexp : Sexplib0.Sexp.t -> t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
include Set_intf.Binable.S with type t := t
include Bin_prot.Binable.S_only_functions with type t := t
Sourceval bin_size_t : t Bin_prot.Size.sizer
Sourceval bin_write_t : t Bin_prot.Write.writer
Sourceval bin_read_t : t Bin_prot.Read.reader
Sourceval __bin_read_t__ : (int -> t) Bin_prot.Read.reader

This function only needs implementation if t exposed to be a polymorphic variant. Despite what the type reads, this does *not* produce a function after reading; instead it takes the constructor tag (int) before reading and reads the rest of the variant t afterwards.

Sourceval bin_shape_t : Bin_prot.Shape.t