package octez-proto-libs
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c
sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a
doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V1/Make/Protocol_hash/Set/index.html
Module Protocol_hash.Set
include S.SET with type elt = t
type elt = tThe type of the set elements.
val empty : tThe empty set.
val is_empty : t -> boolTest whether a set is empty or not.
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).
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.
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.
map f s is the set whose elements are f a0,f a1... f aN, where a0,a1...aN are the elements of s.
The elements are passed to f in increasing order with respect to the ordering over the type of the elements.
If no element of s is changed by f, s is returned unchanged. (If each output of f is physically equal to its input, the returned set is physically equal to s.)
fold f s a computes (f xN ... (f x2 (f x1 a))...), where x1 ... xN are the elements of s, in increasing order.
for_all p s checks if all elements of the set satisfy the predicate p.
exists p s checks if at least one element of the set satisfies the predicate p.
filter p s returns the set of all elements in s that satisfy predicate p. If p satisfies every element in s, s is returned unchanged (the result of the function is then physically equal to s).
partition p s returns a pair of sets (s1, s2), where s1 is the set of all the elements of s that satisfy the predicate p, and s2 is the set of all the elements of s that do not satisfy p.
val cardinal : t -> intReturn the number of elements of a set.
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 None if the set is empty.
Same as Set.S.min_elt_opt, but returns the largest element of the given set.
Return one element of the given set, or None if the set is empty. Which element is chosen is unspecified, but equal elements will be chosen for equal sets.
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.
find_opt x s returns the element of s equal to x (according to Ord.compare), or None if no such element exists.
find_first_opt f s, where f is a monotonically increasing function, returns an option containing the lowest element e of s such that f e, or None if no such element exists.
find_last_opt f s, where f is a monotonically decreasing function, returns an option containing the highest element e of s such that f e, or None if no such element exists.
val encoding : t Data_encoding.t