helm/ocaml/metadata/metadataConstraints.mli

   1 (* Copyright (C) 2004, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 module UriManagerSet : Set.S with type elt = UriManager.uri
  27
  28
  29   (** @return <main, constants>
  30   * main: constant in main position and, for polymorphic constants, type
  31   * instantitation
  32   * constants: constants appearing in term *)
  33 type term_signature = (UriManager.uri * UriManager.uri list) option * UriManagerSet.t
  34
  35 (** {2 Candidates filtering} *)
  36
  37   (** @return sorted list of theorem URIs, first URIs in the least have higher
  38   * relevance *)
  39 val cmatch: dbd:HMysql.dbd -> ?facts:bool -> Cic.term -> UriManager.uri list
  40
  41   (** as cmatch, but returned list is not sorted but rather tagged with
  42   * relevance information: higher the tag, higher the relevance *)
  43 val cmatch': dbd:HMysql.dbd -> ?facts:bool -> Cic.term -> (int * UriManager.uri) list
  44
  45 type where = [ `Conclusion | `Statement ] (** signature matching extent *)
  46
  47   (** @param where defaults to `Conclusion *)
  48 val sigmatch:
  49   dbd:HMysql.dbd ->
  50   ?facts:bool ->
  51   ?where:where ->
  52   term_signature ->
  53     (int * UriManager.uri) list
  54
  55 (** {2 Constraint engine} *)
  56
  57   (** constraing on the number of distinct constants *)
  58 type cardinality_condition =
  59   | Eq of int
  60   | Gt of int
  61   | Lt of int
  62
  63 type rating_criterion =
  64   [ `Hits   (** order by number of hits, most used objects first *)
  65   ]
  66
  67 val add_constraint:
  68   ?start:int ->
  69   ?tables:string * string * string * string ->
  70   int * string list * string list ->
  71   MetadataTypes.constr ->
  72   int * string list * string list
  73
  74   (** @param concl_card cardinality condition on conclusion only
  75   * @param full_card cardinality condition on the whole statement
  76   * @param diff required difference between the number of different constants in
  77   * hypothesis and the number of different constants in body
  78   * @return list of URI satisfying given constraints *)
  79
  80 val at_least:
  81   dbd:HMysql.dbd ->
  82   ?concl_card:cardinality_condition ->
  83   ?full_card:cardinality_condition ->
  84   ?diff:cardinality_condition ->
  85   ?rating:rating_criterion ->
  86   MetadataTypes.constr list ->
  87     UriManager.uri list
  88
  89   (** @param where defaults to `Conclusion *)
  90 val at_most:
  91   dbd:HMysql.dbd ->
  92   ?where:where -> UriManagerSet.t ->
  93     (UriManager.uri -> bool)
  94
  95 val add_all_constr:
  96   ?tbl:string ->
  97    int * string list * string list ->
  98   cardinality_condition option ->
  99   cardinality_condition option ->
 100   cardinality_condition option ->
 101   int * string list * string list
 102
 103 val exec:
 104   dbd:HMysql.dbd ->
 105   ?rating:[ `Hits ] ->
 106   int * string list * string list ->
 107   UriManager.uri list
 108
 109 val signature_of: Cic.term -> term_signature
 110 val constants_of: Cic.term -> UriManagerSet.t
 111