snapshot, still work in progress

[helm.git] / helm / ocaml / metadata / metadataConstraints.mli

diff --git a/helm/ocaml/metadata/metadataConstraints.mli b/helm/ocaml/metadata/metadataConstraints.mli
new file mode 100644 (file)
index 0000000..59cb042
--- /dev/null
+++ b/helm/ocaml/metadata/metadataConstraints.mli
@@ -0,0 +1,65 @@
+(* Copyright (C) 2004, HELM Team.
+ * 
+ * This file is part of HELM, an Hypertextual, Electronic
+ * Library of Mathematics, developed at the Computer Science
+ * Department, University of Bologna, Italy.
+ * 
+ * HELM is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * HELM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HELM; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA  02111-1307, USA.
+ * 
+ * For details, see the HELM World-Wide-Web page,
+ * http://helm.cs.unibo.it/
+ *)
+
+module StringSet : Set.S with type elt = string
+
+  (** @return <main, constants>
+  * main: constant in main position and, for polymorphic constants, type
+  * instantitation
+  * constants: constants appearing in term *)
+type term_signature = (string * string list) option * StringSet.t
+
+(** {2 Candidates filtering} *)
+
+  (** @return sorted list of theorem URIs, first URIs in the least have higher
+  * relevance *)
+val cmatch: dbh:Dbi.connection -> Cic.term -> string list
+
+  (** as cmatch, but returned list is not sorted but rather tagged with
+  * relevance information: higher the tag, higher the relevance *)
+val cmatch': dbh:Dbi.connection -> Cic.term -> (int * string) list
+
+val sigmatch: dbh:Dbi.connection -> term_signature -> (int * string) list
+
+(** {2 Constraint engine} *)
+
+  (** constraing on the number of distinct constants *)
+type cardinality_condition =
+  | Eq of int
+  | Gt of int
+
+  (** @param concl_card cardinality condition on conclusion only
+  * @param full_card cardinality condition on the whole statement
+  * @return list of URI satisfying given constraints *)
+val at_least:
+  dbh:Dbi.connection ->
+  ?concl_card:cardinality_condition ->
+  ?full_card:cardinality_condition ->
+  MetadataTypes.metadata list ->
+    string list
+
+val signature_of: Cic.term -> term_signature
+val constants_of: Cic.term -> StringSet.t
+