package batteries
Install
Dune Dependency
Authors
Maintainers
Sources
md5=ea26b5c72e6731e59d856626049cca4d
sha512=55975b62c26f6db77433a3ac31f97af609fc6789bb62ac38b267249c78fd44ff37fe81901f1cf560857b9493a6046dd37b0d1c0234c66bd59e52843aac3ce6cb
doc/batteries.unthreaded/BatSet/PSet/index.html
Module BatSet.PSetSource
Polymorphic sets
The definitions below describe the polymorphic set interface.
They are similar in functionality to the functorized BatSet.Make module, but the compiler cannot ensure that sets using different element ordering have different types: the responsibility of not mixing non-sensical comparison functions together is to the programmer. If you ever need a custom comparison function, it is recommended to use the BatSet.Make functor for additional safety.
The type of sets.
include BatEnum.Enumerable with type 'a enumerable = 'a t
include BatInterfaces.Mappable with type 'a mappable = 'a t
Creates a new empty set, using the provided function for key comparison.
Creates a new set with the single given element in it.
find x s returns the element in s that tests equal to x under its comparison function.
find_opt x s returns Some k for the element k in s that tests equal to x under its comparison function. If no element is equal, return None
find_first f m returns the first element e for which f e is true or raises Not_found if there is no such element. f must be monotonically increasing, i.e. if k1 < k2 && f k1 is true then f k2 must also be true.
find_first_opt f m returns Some e for the first element e for which f e is true or returns None if there is no such element. f must be monotonically increasing, i.e. if k1 < k2 && f k1 is true then f k2 must also be true.
find_last f m returns the last element e for which f e is true or raises Not_found if there is no such element. f must be monotonically decreasing, i.e. if k1 < k2 && f k2 is true then f k1 must also be true.
find_last_opt f m returns Some e for the last element e for which f e is true or returns None if there is no such element. f must be monotonically decreasing, i.e. if k1 < k2 && f k2 is true then f k1 must also be true.
add x s returns a set containing all elements of s, plus x. If x was already in s, s is returned unchanged.
remove x s returns a set containing all elements of s, except x. If x was not in s, s is returned unchanged.
remove_exn x s behaves like remove x s except that it raises an exception if x is not in s.
update x y s replace x by y in s. update is faster when x compares equal to y according to the comparison function used by your set. When x and y are physically equal, m is returned unchanged.
union s t returns the union of s and t - the set containing all elements in either s and t. The returned set uses t's comparison function. The current implementation works better for small s.
intersect s t returns a new set of those elements that are in both s and t. The returned set uses s's comparison function.
diff s t returns the set of all elements in s but not in t. The returned set uses s's comparison function.
sym_diff s t returns the set of all elements in s or t but not both. This is the same as diff (union s t) (inter s t). The returned set uses s's comparison function.
Total ordering between sets. Can be used as the ordering function for doing sets of sets.
equal s1 s2 tests whether the sets s1 and s2 are equal, that is, contain equal elements.
disjoint s1 s2 tests whether the sets s1 and s2 contain no shared elements. (i.e. inter s1 s2 is empty.)
iter f s applies f in turn to all elements of s. The elements of s are presented to f in increasing order with respect to the ordering over the type of the elements.
at_rank_exn i s returns element at rank i in s, that is the i-th element in increasing order (the 0-th element being the smallest element of s).
map f x creates a new set with elements f a0, f a1... f aN, where a0, a1, ..., aN are the values contained in x
The resulting map uses the polymorphic compare function to order elements.
map f x creates a new set with elements f a0, f a1... f aN, where a0, a1, ..., aN are the values contained in x
The resulting map uses the same compare function to order elements as m does.
If f returns physically equal values for all elements in m then the resulting map will be physically equal to m.
filter p s returns the set of all elements in s that satisfy predicate p.
if p returns true for all elements then s is returned unmodified.
filter_map f m combines the features of filter and map. It calls calls f a0, f a1, f aN where a0,a1..an are the elements of m and returns the set of pairs bi such as f ai = Some bi (when f returns None, the corresponding element of m is discarded).
The resulting map uses the polymorphic compare function to order elements.
filter_map_endo f m combines the features of filter and map. It calls calls f a0, f a1, f aN where a0,a1..an are the elements of m and returns the set of pairs bi such as f ai = Some bi (when f returns None, the corresponding element of m is discarded).
The resulting map uses the same compare function to order elements as used for m.
if the filter function f returns true for all elements in m, the resulting map is physically equal to m.
fold f s a computes (f xN ... (f x1 (f x0 a))...), where x0,x1..xN are the elements of s, in increasing order.
exists p s checks if at least one element of the set satisfies the predicate p.
Returns whether the given predicate applies to all elements in the set
returns two disjoint subsets, those that satisfy the given predicate and those that don't
split x s returns a triple (l, present, r), where l is the set of elements of s that are strictly less than x; r is the set of elements of s that are strictly greater than x; present is false if s contains no element equal to x, or true if s contains an element equal to x.
split_opt x s returns a triple (l, maybe_v, r), where l is the set of elements of s that are strictly less than x; r is the set of elements of s that are strictly greater than x; maybe_v is None if s contains no element equal to x, or Some v if s contains an element v that compares equal to x.
split_lt x s returns a pair of sets (l, r), such that l is the subset of s with elements < x; r is the subset of s with elements >= x.
split_le x s returns a pair of sets (l, r), such that l is the subset of s with elements <= x; r is the subset of s with elements > x.
Return the list of all elements of the given set. The returned list is sorted in increasing order with respect to the ordering of the given set.
Return Some e for the smallest element e of the given set (with respect to the Ord.compare ordering). Return None if the set is empty.
Returns the smallest element of the given set along with the rest of the set. Semantically equivalent and faster than
let mini = min_elt s in (mini, remove mini s)
Returns the biggest element of the given set along with the rest of the set. Semantically equivalent and faster than
let maxi = max_elt s in (maxi, remove maxi s)
Same as Set.S.min_elt_opt, but for the largest element of the given set.
Return Some e for one element e of the given set. Which element is chosen is unspecified, but equal elements will be chosen for equal sets. Return None if the set is empty.
Return one element of the given set. The difference with choose is that there is no guarantee that equals elements will be picked for equal sets. This merely returns the quickest element to get (O(1)).
Return an enumeration of all elements of the given set. The returned enumeration is sorted in increasing order with respect to the ordering of this set.
builds a set from the given list, using the default comparison function
builds a set from the given array and comparison function
to_seq_from x s iterates on a subset of the elements in s, namely those greater or equal to x, in ascending order.
Boilerplate code
Printing
val print :
?first:string ->
?last:string ->
?sep:string ->
('a BatInnerIO.output -> 'c -> unit) ->
'a BatInnerIO.output ->
'c t ->
unit