diff options
author | Emilio Jesus Gallego Arias <e+git@x80.org> | 2017-12-15 18:51:45 +0100 |
---|---|---|
committer | Emilio Jesus Gallego Arias <e+git@x80.org> | 2017-12-23 19:20:30 +0100 |
commit | 5ffa147bd2fe548df3ac9053fe497d0871a5f6df (patch) | |
tree | cc62882184c34e33e2995a5a4ff4ebfcbd0defe0 /clib/predicate.mli | |
parent | dea75d74c222c25f6aa6c38506ac7a51b339e9c6 (diff) |
[lib] Split auxiliary libraries into Coq-specific and general.
Up to this point the `lib` directory contained two different library
archives, `clib.cma` and `lib.cma`, which a rough splitting between
Coq-specific libraries and general-purpose ones.
We know split the directory in two, as to make the distinction clear:
- `clib`: contains libraries that are not Coq specific and implement
common data structures and programming patterns. These libraries
could be eventually replace with external dependencies and the rest
of the code base wouldn't notice much.
- `lib`: contains Coq-specific common libraries in widespread use
along the codebase, but that are not considered part of other
components. Examples are printing, error handling, or flags.
In some cases we have coupling due to utility files depending on Coq
specific flags, however this commit doesn't modify any files, but only
moves them around, further cleanup is welcome, as indeed a few files
in `lib` should likely be placed in `clib`.
Also note that `Deque` is not used ATM.
Diffstat (limited to 'clib/predicate.mli')
-rw-r--r-- | clib/predicate.mli | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/clib/predicate.mli b/clib/predicate.mli new file mode 100644 index 000000000..cee3b0bd3 --- /dev/null +++ b/clib/predicate.mli @@ -0,0 +1,84 @@ +(** Infinite sets over a chosen [OrderedType]. + + All operations over sets are purely applicative (no side-effects). + *) + +(** Input signature of the functor [Make]. *) +module type OrderedType = + sig + type t + (** The type of the elements in the set. + + The chosen [t] {b must be infinite}. *) + + val compare : t -> t -> int + (** A total ordering function over the set elements. + This is a two-argument function [f] such that: + - [f e1 e2] is zero if the elements [e1] and [e2] are equal, + - [f e1 e2] is strictly negative if [e1] is smaller than [e2], + - and [f e1 e2] is strictly positive if [e1] is greater than [e2]. + *) + end + +module type S = + sig + type elt + (** The type of the elements in the set. *) + + type t + (** The type of sets. *) + + val empty: t + (** The empty set. *) + + val full: t + (** The set of all elements (of type [elm]). *) + + val is_empty: t -> bool + (** Test whether a set is empty or not. *) + + val is_full: t -> bool + (** Test whether a set contains the whole type or not. *) + + val mem: elt -> t -> bool + (** [mem x s] tests whether [x] belongs to the set [s]. *) + + val singleton: elt -> t + (** [singleton x] returns the one-element set containing only [x]. *) + + val add: elt -> t -> t + (** [add x s] returns a set containing all elements of [s], + plus [x]. If [x] was already in [s], then [s] is returned unchanged. *) + + val remove: elt -> t -> t + (** [remove x s] returns a set containing all elements of [s], + except [x]. If [x] was not in [s], then [s] is returned unchanged. *) + + val union: t -> t -> t + (** Set union. *) + + val inter: t -> t -> t + (** Set intersection. *) + + val diff: t -> t -> t + (** Set difference. *) + + val complement: t -> t + (** Set complement. *) + + val equal: t -> t -> bool + (** [equal s1 s2] tests whether the sets [s1] and [s2] are + equal, that is, contain equal elements. *) + + val subset: t -> t -> bool + (** [subset s1 s2] tests whether the set [s1] is a subset of + the set [s2]. *) + + val elements: t -> bool * elt list + (** Gives a finite representation of the predicate: if the + boolean is false, then the predicate is given in extension. + if it is true, then the complement is given *) + end + +(** The [Make] functor constructs an implementation for any [OrderedType]. *) +module Make (Ord : OrderedType) : (S with type elt = Ord.t) |