Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
BitMaskSet.S
SourceSignature for Bitmask Sets.
All functions and types from the Standard Library's Set
implementation are available.
include Set.S
The type of the set elements.
The type of sets.
add x s
returns a set containing all elements of s
, plus x
. If x
was already in s
, s
is returned unchanged (the result of the function is then physically equal to s
).
remove x s
returns a set containing all elements of s
, except x
. If x
was not in s
, s
is returned unchanged (the result of the function is then physically equal to s
).
Set difference: diff s1 s2
contains the elements of s1
that are not in s2
.
Return the list of all elements of the given set. The returned list is sorted in increasing order with respect to the ordering Ord.compare
, where Ord
is the argument given to Set.Make
.
Return the smallest element of the given set (with respect to the Ord.compare
ordering), or raise Not_found
if the set is empty.
Return one element of the given set, or raise Not_found
if the set is empty. Which element is chosen is unspecified, but equal elements will be chosen for equal sets.
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.
fold f s init
computes (f xN ... (f x2 (f x1 init))...)
, where x1 ... xN
are the elements of s
, in increasing order.
filter f s
returns the set of all elements in s
that satisfy predicate f
. If f
satisfies every element in s
, s
is returned unchanged (the result of the function is then physically equal to s
).
partition f s
returns a pair of sets (s1, s2)
, where s1
is the set of all the elements of s
that satisfy the predicate f
, and s2
is the set of all the elements of s
that do not satisfy f
.
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
.
equal s1 s2
tests whether the sets s1
and s2
are equal, that is, contain equal elements.
Total ordering between sets. Can be used as the ordering function for doing sets of sets.
for_all f s
checks if all elements of the set satisfy the predicate f
.
exists f s
checks if at least one element of the set satisfies the predicate f
.
The underlying storage type for the bitmask.