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 StringSet : Set.S with type elt = string
  27
  28   (** @return <main, constants>
  29   * main: constant in main position and, for polymorphic constants, type
  30   * instantitation
  31   * constants: constants appearing in term *)
  32 type term_signature = (string * string list) option * StringSet.t
  33
  34 (** {2 Candidates filtering} *)
  35
  36   (** @return sorted list of theorem URIs, first URIs in the least have higher
  37   * relevance *)
  38 val cmatch: dbd:Mysql.dbd -> ?facts:bool -> Cic.term -> string list
  39
  40   (** as cmatch, but returned list is not sorted but rather tagged with
  41   * relevance information: higher the tag, higher the relevance *)
  42 val cmatch': dbd:Mysql.dbd -> ?facts:bool -> Cic.term -> (int * string) list
  43
  44 type where = [ `Conclusion | `Statement ] (** signature matching extent *)
  45
  46   (** @param where defaults to `Conclusion *)
  47 val sigmatch:
  48   dbd:Mysql.dbd ->
  49   ?facts:bool ->
  50   ?where:where ->
  51   term_signature ->
  52     (int * string) list
  53
  54 (** {2 Constraint engine} *)
  55
  56   (** constraing on the number of distinct constants *)
  57 type cardinality_condition =
  58   | Eq of int
  59   | Gt of int
  60   | Lt of int
  61
  62 type rating_criterion =
  63   [ `Hits   (** order by number of hits, most used objects first *)
  64   ]
  65
  66 val add_constraint:
  67   ?start:int ->
  68   ?tables:string * string * string * string ->
  69   int * string list * string list ->
  70   MetadataTypes.constr ->
  71   int * string list * string list
  72
  73   (** @param concl_card cardinality condition on conclusion only
  74   * @param full_card cardinality condition on the whole statement
  75   * @param diff required difference between the number of different constants in
  76   * hypothesis and the number of different constants in body
  77   * @return list of URI satisfying given constraints *)
  78
  79 val at_least:
  80   dbd:Mysql.dbd ->
  81   ?concl_card:cardinality_condition ->
  82   ?full_card:cardinality_condition ->
  83   ?diff:cardinality_condition ->
  84   ?rating:rating_criterion ->
  85   MetadataTypes.constr list ->
  86     string list
  87
  88   (** @param where defaults to `Conclusion *)
  89 val at_most:
  90   dbd:Mysql.dbd ->
  91   ?where:where -> StringSet.t ->
  92     (string -> bool)
  93
  94 val add_all_constr:
  95   ?tbl:string ->
  96    int * string list * string list ->
  97   cardinality_condition option ->
  98   cardinality_condition option ->
  99   cardinality_condition option ->
 100   int * string list * string list
 101
 102 val exec:
 103   dbd:Mysql.dbd ->
 104   ?rating:[ `Hits ] ->
 105   int * string list * string list ->
 106   string list
 107
 108 val signature_of: Cic.term -> term_signature
 109 val constants_of: Cic.term -> StringSet.t
 110