package bitmasks

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

Module type BitMaskSet.SSource

Signature for Bitmask Sets.

All functions and types from the Standard Library's Set implementation are available.

include Set.S

Sets

Sourcetype elt

The type of the set elements.

Sourcetype t

The type of sets.

Sourceval empty : t

The empty set.

Sourceval add : elt -> t -> t

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).

  • before 4.03

    Physical equality was not ensured.

Sourceval singleton : elt -> t

singleton x returns the one-element set containing only x.

Sourceval remove : elt -> t -> t

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).

  • before 4.03

    Physical equality was not ensured.

Sourceval union : t -> t -> t

Set union.

Sourceval inter : t -> t -> t

Set intersection.

Sourceval diff : t -> t -> t

Set difference: diff s1 s2 contains the elements of s1 that are not in s2.

Sourceval cardinal : t -> int

Return the number of elements of a set.

Elements

Sourceval elements : t -> elt list

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.

Sourceval min_elt : t -> elt

Return the smallest element of the given set (with respect to the Ord.compare ordering), or raise Not_found if the set is empty.

Sourceval max_elt : t -> elt

Same as min_elt, but returns the largest element of the given set.

Sourceval choose : t -> elt

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.

Searching

Traversing

Sourceval iter : (elt -> unit) -> t -> unit

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.

Sourceval fold : (elt -> 'acc -> 'acc) -> t -> 'acc -> 'acc

fold f s init computes (f xN ... (f x2 (f x1 init))...), where x1 ... xN are the elements of s, in increasing order.

Transforming

Sourceval filter : (elt -> bool) -> t -> t

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).

  • before 4.03

    Physical equality was not ensured.

Sourceval partition : (elt -> bool) -> t -> t * t

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.

Sourceval split : elt -> t -> t * bool * 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.

Predicates and comparisons

Sourceval is_empty : t -> bool

Test whether a set is empty or not.

Sourceval mem : elt -> t -> bool

mem x s tests whether x belongs to the set s.

Sourceval equal : t -> t -> bool

equal s1 s2 tests whether the sets s1 and s2 are equal, that is, contain equal elements.

Sourceval compare : t -> t -> int

Total ordering between sets. Can be used as the ordering function for doing sets of sets.

Sourceval subset : t -> t -> bool

subset s1 s2 tests whether the set s1 is a subset of the set s2.

Sourceval for_all : (elt -> bool) -> t -> bool

for_all f s checks if all elements of the set satisfy the predicate f.

Sourceval exists : (elt -> bool) -> t -> bool

exists f s checks if at least one element of the set satisfies the predicate f.

Converting

Sourcetype storage

The underlying storage type for the bitmask.

Sourceval invalid : t -> t

Returns an empty bitmask where the underlying storage only has any invalid bits remaining.