package core

  1. Overview
  2. Docs
package core
Legend:
Library
Module
Module type
Parameter
Class
Class type
include Set.Creators_generic
type ('a, 'cmp) t
type ('a, 'cmp) set
type ('a, 'cmp) tree
type 'a elt
type ('a, 'cmp, 'z) create_options
type 'cmp cmp
val empty : ('a, 'cmp, ('a, 'cmp) t) create_options
val singleton : ('a, 'cmp, 'a elt -> ('a, 'cmp) t) create_options
val union_list : ('a, 'cmp, ('a, 'cmp) t list -> ('a, 'cmp) t) create_options
val of_list : ('a, 'cmp, 'a elt list -> ('a, 'cmp) t) create_options
val of_sequence : ('a, 'cmp, 'a elt Base.Sequence.t -> ('a, 'cmp) t) create_options
val of_array : ('a, 'cmp, 'a elt array -> ('a, 'cmp) t) create_options
val of_sorted_array : ('a, 'cmp, 'a elt array -> ('a, 'cmp) t Base.Or_error.t) create_options
val of_sorted_array_unchecked : ('a, 'cmp, 'a elt array -> ('a, 'cmp) t) create_options
val of_increasing_iterator_unchecked : ('a, 'cmp, len:int -> f:(int -> 'a elt) -> ('a, 'cmp) t) create_options
val stable_dedup_list : ('a, _, 'a elt list -> 'a elt list) create_options
val map : ('b, 'cmp, ('a, _) set -> f:('a -> 'b elt) -> ('b, 'cmp) t) create_options

The types of map and filter_map are subtle. The input set, ('a, _) set, reflects the fact that these functions take a set of *any* type, with any comparator, while the output set, ('b, 'cmp) t, reflects that the output set has the particular 'cmp of the creation function. The comparator can come in one of three ways, depending on which set module is used

  • Set.map -- comparator comes as an argument
  • Set.Poly.map -- comparator is polymorphic comparison
  • Foo.Set.map -- comparator is Foo.comparator
val filter_map : ('b, 'cmp, ('a, _) set -> f:('a -> 'b elt option) -> ('b, 'cmp) t) create_options
val of_tree : ('a, 'cmp, ('a elt, 'cmp cmp) tree -> ('a, 'cmp) t) create_options
val of_hash_set : ('a, 'cmp, 'a elt Hash_set.t -> ('a, 'cmp) t) create_options
val of_hashtbl_keys : ('a, 'cmp, ('a elt, _) Hashtbl.t -> ('a, 'cmp) t) create_options
val of_map_keys : ('a elt, _, 'cmp cmp) Base.Map.t -> ('a, 'cmp) t

Never requires a comparator because it can get one from the input Map.t.

val quickcheck_generator : ('a, 'cmp, 'a elt Quickcheck.Generator.t -> ('a, 'cmp) t Quickcheck.Generator.t) create_options