src/HOL/Tools/Sledgehammer/sledgehammer_fact_filter.ML
author blanchet
Tue Jun 22 16:40:36 2010 +0200 (2010-06-22 ago)
changeset 37501 b5440c78ed3f
parent 37500 7587b6e63454
child 37502 a8f7b25d5478
permissions -rw-r--r--
leverage new data structure for handling "add:" and "del:"
blanchet@35826
     1
(*  Title:      HOL/Tools/Sledgehammer/sledgehammer_fact_filter.ML
wenzelm@33309
     2
    Author:     Jia Meng, Cambridge University Computer Laboratory, NICTA
blanchet@36393
     3
    Author:     Jasmin Blanchette, TU Muenchen
wenzelm@33309
     4
*)
paulson@15452
     5
blanchet@35826
     6
signature SLEDGEHAMMER_FACT_FILTER =
wenzelm@16802
     7
sig
blanchet@37500
     8
  type cnf_thm = Sledgehammer_Fact_Preprocessor.cnf_thm
blanchet@35865
     9
  type classrel_clause = Sledgehammer_FOL_Clause.classrel_clause
blanchet@35865
    10
  type arity_clause = Sledgehammer_FOL_Clause.arity_clause
blanchet@35865
    11
  type hol_clause = Sledgehammer_HOL_Clause.hol_clause
blanchet@36473
    12
blanchet@35966
    13
  type relevance_override =
blanchet@35966
    14
    {add: Facts.ref list,
blanchet@35966
    15
     del: Facts.ref list,
blanchet@35966
    16
     only: bool}
blanchet@35966
    17
blanchet@37344
    18
  val name_thms_pair_from_ref :
blanchet@37344
    19
    Proof.context -> thm list -> Facts.ref -> string * thm list
paulson@22989
    20
  val tvar_classes_of_terms : term list -> string list
paulson@22989
    21
  val tfree_classes_of_terms : term list -> string list
paulson@22989
    22
  val type_consts_of_terms : theory -> term list -> string list
blanchet@37399
    23
  val is_quasi_fol_term : theory -> term -> bool
blanchet@37347
    24
  val relevant_facts :
blanchet@37347
    25
    bool -> bool -> real -> real -> bool -> int -> bool -> relevance_override
blanchet@37500
    26
    -> Proof.context * (thm list * 'a) -> thm list -> cnf_thm list
blanchet@36473
    27
  val prepare_clauses :
blanchet@37500
    28
    bool -> thm list -> cnf_thm list -> cnf_thm list -> theory
blanchet@37500
    29
    -> string vector
blanchet@37500
    30
       * (hol_clause list * hol_clause list * hol_clause list
blanchet@37500
    31
          * hol_clause list * classrel_clause list * arity_clause list)
paulson@15347
    32
end;
paulson@15347
    33
blanchet@35826
    34
structure Sledgehammer_Fact_Filter : SLEDGEHAMMER_FACT_FILTER =
paulson@15347
    35
struct
paulson@15347
    36
blanchet@35865
    37
open Sledgehammer_FOL_Clause
blanchet@35865
    38
open Sledgehammer_Fact_Preprocessor
blanchet@35865
    39
open Sledgehammer_HOL_Clause
blanchet@35826
    40
blanchet@35966
    41
type relevance_override =
blanchet@35966
    42
  {add: Facts.ref list,
blanchet@35966
    43
   del: Facts.ref list,
blanchet@35966
    44
   only: bool}
paulson@21070
    45
wenzelm@28477
    46
(***************************************************************)
wenzelm@28477
    47
(* Relevance Filtering                                         *)
wenzelm@28477
    48
(***************************************************************)
mengj@19194
    49
blanchet@35865
    50
fun strip_Trueprop (@{const Trueprop} $ t) = t
paulson@24958
    51
  | strip_Trueprop t = t;
mengj@19194
    52
paulson@24287
    53
(*A surprising number of theorems contain only a few significant constants.
paulson@24287
    54
  These include all induction rules, and other general theorems. Filtering
paulson@24287
    55
  theorems in clause form reveals these complexities in the form of Skolem 
paulson@24287
    56
  functions. If we were instead to filter theorems in their natural form,
paulson@24287
    57
  some other method of measuring theorem complexity would become necessary.*)
paulson@24287
    58
paulson@24287
    59
fun log_weight2 (x:real) = 1.0 + 2.0/Math.ln (x+1.0);
paulson@24287
    60
paulson@24287
    61
(*The default seems best in practice. A constant function of one ignores
paulson@24287
    62
  the constant frequencies.*)
wenzelm@28477
    63
val weight_fn = log_weight2;
paulson@24287
    64
paulson@24287
    65
paulson@24287
    66
(*Including equality in this list might be expected to stop rules like subset_antisym from
paulson@24287
    67
  being chosen, but for some reason filtering works better with them listed. The
paulson@24287
    68
  logical signs All, Ex, &, and --> are omitted because any remaining occurrrences
paulson@24287
    69
  must be within comprehensions.*)
blanchet@35865
    70
val standard_consts =
blanchet@35865
    71
  [@{const_name Trueprop}, @{const_name "==>"}, @{const_name all},
blanchet@35865
    72
   @{const_name "=="}, @{const_name "op |"}, @{const_name Not},
blanchet@35865
    73
   @{const_name "op ="}];
paulson@24287
    74
paulson@24287
    75
paulson@24287
    76
(*** constants with types ***)
paulson@24287
    77
paulson@24287
    78
(*An abstraction of Isabelle types*)
paulson@24287
    79
datatype const_typ =  CTVar | CType of string * const_typ list
paulson@24287
    80
paulson@24287
    81
(*Is the second type an instance of the first one?*)
paulson@24287
    82
fun match_type (CType(con1,args1)) (CType(con2,args2)) = 
paulson@24287
    83
      con1=con2 andalso match_types args1 args2
paulson@24287
    84
  | match_type CTVar _ = true
paulson@24287
    85
  | match_type _ CTVar = false
paulson@24287
    86
and match_types [] [] = true
paulson@24287
    87
  | match_types (a1::as1) (a2::as2) = match_type a1 a2 andalso match_types as1 as2;
paulson@24287
    88
paulson@24287
    89
(*Is there a unifiable constant?*)
paulson@24287
    90
fun uni_mem gctab (c,c_typ) =
paulson@24287
    91
  case Symtab.lookup gctab c of
paulson@24287
    92
      NONE => false
paulson@24287
    93
    | SOME ctyps_list => exists (match_types c_typ) ctyps_list;
paulson@24287
    94
  
paulson@24287
    95
(*Maps a "real" type to a const_typ*)
paulson@24287
    96
fun const_typ_of (Type (c,typs)) = CType (c, map const_typ_of typs) 
paulson@24287
    97
  | const_typ_of (TFree _) = CTVar
paulson@24287
    98
  | const_typ_of (TVar _) = CTVar
paulson@24287
    99
paulson@24287
   100
(*Pairs a constant with the list of its type instantiations (using const_typ)*)
paulson@24287
   101
fun const_with_typ thy (c,typ) = 
paulson@24287
   102
    let val tvars = Sign.const_typargs thy (c,typ)
paulson@24287
   103
    in (c, map const_typ_of tvars) end
paulson@24287
   104
    handle TYPE _ => (c,[]);   (*Variable (locale constant): monomorphic*)   
paulson@24287
   105
paulson@24287
   106
(*Add a const/type pair to the table, but a [] entry means a standard connective,
paulson@24287
   107
  which we ignore.*)
paulson@24287
   108
fun add_const_typ_table ((c,ctyps), tab) =
paulson@24287
   109
  Symtab.map_default (c, [ctyps]) (fn [] => [] | ctyps_list => insert (op =) ctyps ctyps_list) 
paulson@24287
   110
    tab;
paulson@24287
   111
paulson@24287
   112
(*Free variables are included, as well as constants, to handle locales*)
paulson@24287
   113
fun add_term_consts_typs_rm thy (Const(c, typ), tab) =
paulson@24287
   114
      add_const_typ_table (const_with_typ thy (c,typ), tab) 
paulson@24287
   115
  | add_term_consts_typs_rm thy (Free(c, typ), tab) =
paulson@24287
   116
      add_const_typ_table (const_with_typ thy (c,typ), tab) 
blanchet@37410
   117
  | add_term_consts_typs_rm _ (Const (@{const_name skolem_id}, _) $ _, tab) =
blanchet@37399
   118
      tab
paulson@24287
   119
  | add_term_consts_typs_rm thy (t $ u, tab) =
paulson@24287
   120
      add_term_consts_typs_rm thy (t, add_term_consts_typs_rm thy (u, tab))
paulson@24287
   121
  | add_term_consts_typs_rm thy (Abs(_,_,t), tab) = add_term_consts_typs_rm thy (t, tab)
wenzelm@32994
   122
  | add_term_consts_typs_rm _ (_, tab) = tab;
paulson@24287
   123
paulson@24287
   124
(*The empty list here indicates that the constant is being ignored*)
paulson@24287
   125
fun add_standard_const (s,tab) = Symtab.update (s,[]) tab;
paulson@24287
   126
paulson@24287
   127
val null_const_tab : const_typ list list Symtab.table = 
wenzelm@30190
   128
    List.foldl add_standard_const Symtab.empty standard_consts;
paulson@24287
   129
wenzelm@30190
   130
fun get_goal_consts_typs thy = List.foldl (add_term_consts_typs_rm thy) null_const_tab;
paulson@24287
   131
paulson@24287
   132
(*Inserts a dummy "constant" referring to the theory name, so that relevance
paulson@24287
   133
  takes the given theory into account.*)
blanchet@36220
   134
fun const_prop_of theory_relevant th =
blanchet@36220
   135
 if theory_relevant then
paulson@24287
   136
  let val name = Context.theory_name (theory_of_thm th)
paulson@24287
   137
      val t = Const (name ^ ". 1", HOLogic.boolT)
paulson@24287
   138
  in  t $ prop_of th  end
paulson@24287
   139
 else prop_of th;
paulson@24287
   140
paulson@24287
   141
(**** Constant / Type Frequencies ****)
paulson@24287
   142
paulson@24287
   143
(*A two-dimensional symbol table counts frequencies of constants. It's keyed first by
paulson@24287
   144
  constant name and second by its list of type instantiations. For the latter, we need
paulson@24287
   145
  a linear ordering on type const_typ list.*)
paulson@24287
   146
  
paulson@24287
   147
local
paulson@24287
   148
paulson@24287
   149
fun cons_nr CTVar = 0
paulson@24287
   150
  | cons_nr (CType _) = 1;
paulson@24287
   151
paulson@24287
   152
in
paulson@24287
   153
paulson@24287
   154
fun const_typ_ord TU =
paulson@24287
   155
  case TU of
paulson@24287
   156
    (CType (a, Ts), CType (b, Us)) =>
paulson@24287
   157
      (case fast_string_ord(a,b) of EQUAL => dict_ord const_typ_ord (Ts,Us) | ord => ord)
paulson@24287
   158
  | (T, U) => int_ord (cons_nr T, cons_nr U);
paulson@24287
   159
paulson@24287
   160
end;
paulson@24287
   161
wenzelm@31971
   162
structure CTtab = Table(type key = const_typ list val ord = dict_ord const_typ_ord);
paulson@24287
   163
blanchet@36220
   164
fun count_axiom_consts theory_relevant thy ((thm,_), tab) = 
paulson@24287
   165
  let fun count_const (a, T, tab) =
wenzelm@32960
   166
        let val (c, cts) = const_with_typ thy (a,T)
wenzelm@32960
   167
        in  (*Two-dimensional table update. Constant maps to types maps to count.*)
wenzelm@32960
   168
            Symtab.map_default (c, CTtab.empty) 
wenzelm@32960
   169
                               (CTtab.map_default (cts,0) (fn n => n+1)) tab
wenzelm@32960
   170
        end
paulson@24287
   171
      fun count_term_consts (Const(a,T), tab) = count_const(a,T,tab)
wenzelm@32960
   172
        | count_term_consts (Free(a,T), tab) = count_const(a,T,tab)
wenzelm@32960
   173
        | count_term_consts (t $ u, tab) =
wenzelm@32960
   174
            count_term_consts (t, count_term_consts (u, tab))
wenzelm@32960
   175
        | count_term_consts (Abs(_,_,t), tab) = count_term_consts (t, tab)
wenzelm@32960
   176
        | count_term_consts (_, tab) = tab
blanchet@36220
   177
  in  count_term_consts (const_prop_of theory_relevant thm, tab)  end;
paulson@24287
   178
paulson@24287
   179
paulson@24287
   180
(**** Actual Filtering Code ****)
paulson@24287
   181
paulson@24287
   182
(*The frequency of a constant is the sum of those of all instances of its type.*)
paulson@24287
   183
fun const_frequency ctab (c, cts) =
blanchet@36185
   184
  CTtab.fold (fn (cts', m) => match_types cts cts' ? Integer.add m)
blanchet@36185
   185
             (the (Symtab.lookup ctab c)) 0
paulson@24287
   186
paulson@24287
   187
(*Add in a constant's weight, as determined by its frequency.*)
paulson@24287
   188
fun add_ct_weight ctab ((c,T), w) =
wenzelm@28477
   189
  w + weight_fn (real (const_frequency ctab (c,T)));
paulson@24287
   190
paulson@24287
   191
(*Relevant constants are weighted according to frequency, 
paulson@24287
   192
  but irrelevant constants are simply counted. Otherwise, Skolem functions,
paulson@24287
   193
  which are rare, would harm a clause's chances of being picked.*)
paulson@24287
   194
fun clause_weight ctab gctyps consts_typs =
paulson@24287
   195
    let val rel = filter (uni_mem gctyps) consts_typs
paulson@24287
   196
        val rel_weight = List.foldl (add_ct_weight ctab) 0.0 rel
paulson@24287
   197
    in
wenzelm@32960
   198
        rel_weight / (rel_weight + real (length consts_typs - length rel))
paulson@24287
   199
    end;
paulson@24287
   200
    
paulson@24287
   201
(*Multiplies out to a list of pairs: 'a * 'b list -> ('a * 'b) list -> ('a * 'b) list*)
wenzelm@30190
   202
fun add_expand_pairs (x,ys) xys = List.foldl (fn (y,acc) => (x,y)::acc) xys ys;
paulson@24287
   203
paulson@24287
   204
fun consts_typs_of_term thy t = 
paulson@24287
   205
  let val tab = add_term_consts_typs_rm thy (t, null_const_tab)
paulson@24287
   206
  in  Symtab.fold add_expand_pairs tab []  end;
paulson@24287
   207
blanchet@36220
   208
fun pair_consts_typs_axiom theory_relevant thy (p as (thm, _)) =
blanchet@36220
   209
  (p, (consts_typs_of_term thy (const_prop_of theory_relevant thm)));
paulson@24287
   210
paulson@24287
   211
exception ConstFree;
paulson@24287
   212
fun dest_ConstFree (Const aT) = aT
paulson@24287
   213
  | dest_ConstFree (Free aT) = aT
paulson@24287
   214
  | dest_ConstFree _ = raise ConstFree;
paulson@24287
   215
paulson@24287
   216
(*Look for definitions of the form f ?x1 ... ?xn = t, but not reversed.*)
wenzelm@32994
   217
fun defines thy thm gctypes =
paulson@24287
   218
    let val tm = prop_of thm
wenzelm@32960
   219
        fun defs lhs rhs =
paulson@24287
   220
            let val (rator,args) = strip_comb lhs
wenzelm@32960
   221
                val ct = const_with_typ thy (dest_ConstFree rator)
haftmann@33037
   222
            in
haftmann@33037
   223
              forall is_Var args andalso uni_mem gctypes ct andalso
haftmann@33038
   224
                subset (op =) (Term.add_vars rhs [], Term.add_vars lhs [])
paulson@24287
   225
            end
wenzelm@32960
   226
            handle ConstFree => false
paulson@24287
   227
    in    
blanchet@35963
   228
        case tm of
blanchet@35963
   229
          @{const Trueprop} $ (Const (@{const_name "op ="}, _) $ lhs $ rhs) => 
blanchet@35963
   230
            defs lhs rhs 
blanchet@35963
   231
        | _ => false
paulson@24287
   232
    end;
paulson@24287
   233
blanchet@37500
   234
type annotated_clause = cnf_thm * ((string * const_typ list) list)
paulson@24287
   235
       
paulson@24287
   236
(*For a reverse sort, putting the largest values first.*)
blanchet@37500
   237
fun compare_pairs ((_, w1), (_, w2)) = Real.compare (w2, w1)
paulson@24287
   238
paulson@24287
   239
(*Limit the number of new clauses, to prevent runaway acceptance.*)
blanchet@37500
   240
fun take_best max_new (newpairs : (annotated_clause * real) list) =
paulson@24287
   241
  let val nnew = length newpairs
paulson@24287
   242
  in
wenzelm@28477
   243
    if nnew <= max_new then (map #1 newpairs, [])
paulson@24287
   244
    else 
paulson@24287
   245
      let val cls = sort compare_pairs newpairs
wenzelm@28477
   246
          val accepted = List.take (cls, max_new)
paulson@24287
   247
      in
blanchet@35865
   248
        trace_msg (fn () => ("Number of candidates, " ^ Int.toString nnew ^ 
wenzelm@32960
   249
                       ", exceeds the limit of " ^ Int.toString (max_new)));
blanchet@35865
   250
        trace_msg (fn () => ("Effective pass mark: " ^ Real.toString (#2 (List.last accepted))));
blanchet@35865
   251
        trace_msg (fn () => "Actually passed: " ^
blanchet@37500
   252
          space_implode ", " (map (fn (((_,((name,_), _)),_),_) => name) accepted));
paulson@24287
   253
wenzelm@32960
   254
        (map #1 accepted, map #1 (List.drop (cls, max_new)))
paulson@24287
   255
      end
paulson@24287
   256
  end;
paulson@24287
   257
blanchet@36922
   258
fun relevant_clauses ctxt relevance_convergence defs_relevant max_new
blanchet@37498
   259
                     ({add, del, ...} : relevance_override) ctab =
blanchet@36182
   260
  let
blanchet@37344
   261
    val thy = ProofContext.theory_of ctxt
blanchet@37501
   262
    val add_thms = maps (ProofContext.get_fact ctxt) add
blanchet@37501
   263
    val del_thms = maps (ProofContext.get_fact ctxt) del
blanchet@37344
   264
    fun iter threshold rel_consts =
blanchet@36182
   265
      let
blanchet@36182
   266
        fun relevant ([], _) [] = []  (* Nothing added this iteration *)
blanchet@37344
   267
          | relevant (newpairs, rejects) [] =
blanchet@36182
   268
            let
blanchet@36182
   269
              val (newrels, more_rejects) = take_best max_new newpairs
blanchet@36182
   270
              val new_consts = maps #2 newrels
blanchet@36182
   271
              val rel_consts' = List.foldl add_const_typ_table rel_consts new_consts
blanchet@37344
   272
              val threshold =
blanchet@37344
   273
                threshold + (1.0 - threshold) / relevance_convergence
wenzelm@32960
   274
            in
blanchet@36182
   275
              trace_msg (fn () => "relevant this iteration: " ^
blanchet@36182
   276
                                  Int.toString (length newrels));
blanchet@37344
   277
              map #1 newrels @ iter threshold rel_consts'
blanchet@37344
   278
                  (more_rejects @ rejects)
wenzelm@32960
   279
            end
blanchet@36182
   280
          | relevant (newrels, rejects)
blanchet@37501
   281
                     ((ax as (clsthm as (thm, ((name, n), orig_th)),
blanchet@37501
   282
                              consts_typs)) :: axs) =
blanchet@35966
   283
            let
blanchet@37501
   284
              val weight = if member Thm.eq_thm add_thms orig_th then 1.0
blanchet@37501
   285
                           else if member Thm.eq_thm del_thms orig_th then 0.0
blanchet@35966
   286
                           else clause_weight ctab rel_consts consts_typs
wenzelm@32960
   287
            in
blanchet@37344
   288
              if weight >= threshold orelse
blanchet@36922
   289
                 (defs_relevant andalso defines thy (#1 clsthm) rel_consts) then
blanchet@36182
   290
                (trace_msg (fn () => name ^ " clause " ^ Int.toString n ^ 
blanchet@36182
   291
                                     " passes: " ^ Real.toString weight);
blanchet@36182
   292
                relevant ((ax, weight) :: newrels, rejects) axs)
blanchet@36182
   293
              else
blanchet@36182
   294
                relevant (newrels, ax :: rejects) axs
wenzelm@32960
   295
            end
blanchet@36182
   296
        in
blanchet@37344
   297
          trace_msg (fn () => "relevant_clauses, current threshold: " ^
blanchet@37344
   298
                              Real.toString threshold);
blanchet@36182
   299
          relevant ([], [])
blanchet@36182
   300
        end
blanchet@36182
   301
  in iter end
wenzelm@32960
   302
        
blanchet@36922
   303
fun relevance_filter ctxt relevance_threshold relevance_convergence
blanchet@36922
   304
                     defs_relevant max_new theory_relevant relevance_override
blanchet@37500
   305
                     thy (axioms : cnf_thm list) goals = 
blanchet@35966
   306
  if relevance_threshold > 0.0 then
blanchet@35963
   307
    let
blanchet@36220
   308
      val const_tab = List.foldl (count_axiom_consts theory_relevant thy)
blanchet@35963
   309
                                 Symtab.empty axioms
paulson@24287
   310
      val goal_const_tab = get_goal_consts_typs thy goals
blanchet@35963
   311
      val _ =
blanchet@35963
   312
        trace_msg (fn () => "Initial constants: " ^
blanchet@35963
   313
                            commas (Symtab.keys goal_const_tab))
blanchet@35963
   314
      val relevant =
blanchet@36922
   315
        relevant_clauses ctxt relevance_convergence defs_relevant max_new
blanchet@37344
   316
                         relevance_override const_tab relevance_threshold
blanchet@36922
   317
                         goal_const_tab
blanchet@36220
   318
                         (map (pair_consts_typs_axiom theory_relevant thy)
blanchet@36220
   319
                              axioms)
blanchet@35963
   320
    in
blanchet@35963
   321
      trace_msg (fn () => "Total relevant: " ^ Int.toString (length relevant));
blanchet@35963
   322
      relevant
blanchet@35963
   323
    end
blanchet@35963
   324
  else
blanchet@35963
   325
    axioms;
paulson@24287
   326
paulson@24287
   327
(***************************************************************)
mengj@19768
   328
(* Retrieving and filtering lemmas                             *)
mengj@19768
   329
(***************************************************************)
mengj@19768
   330
paulson@33022
   331
(*** retrieve lemmas and filter them ***)
mengj@19768
   332
mengj@19768
   333
(*Hashing to detect duplicate and variant clauses, e.g. from the [iff] attribute*)
mengj@19768
   334
paulson@22382
   335
fun setinsert (x,s) = Symtab.update (x,()) s;
mengj@19768
   336
paulson@20757
   337
(*Reject theorems with names like "List.filter.filter_list_def" or
paulson@21690
   338
  "Accessible_Part.acc.defs", as these are definitions arising from packages.*)
paulson@20757
   339
fun is_package_def a =
wenzelm@30364
   340
  let val names = Long_Name.explode a
paulson@21690
   341
  in
paulson@21690
   342
     length names > 2 andalso
paulson@21690
   343
     not (hd names = "local") andalso
paulson@21690
   344
     String.isSuffix "_def" a  orelse  String.isSuffix "_defs" a
paulson@21690
   345
  end;
paulson@20757
   346
blanchet@36061
   347
fun mk_clause_table xs =
blanchet@36061
   348
  fold (Termtab.update o `(prop_of o fst)) xs Termtab.empty
paulson@22382
   349
blanchet@36061
   350
fun make_unique xs =
blanchet@36061
   351
  Termtab.fold (cons o snd) (mk_clause_table xs) []
mengj@19768
   352
blanchet@36061
   353
(* Remove existing axiom clauses from the conjecture clauses, as this can
blanchet@36061
   354
   dramatically boost an ATP's performance (for some reason). *)
blanchet@36061
   355
fun subtract_cls ax_clauses =
blanchet@36061
   356
  filter_out (Termtab.defined (mk_clause_table ax_clauses) o prop_of)
mengj@19768
   357
blanchet@37345
   358
fun all_name_thms_pairs respect_no_atp ctxt chained_ths =
paulson@22382
   359
  let
wenzelm@26675
   360
    val global_facts = PureThy.facts_of (ProofContext.theory_of ctxt);
wenzelm@26278
   361
    val local_facts = ProofContext.facts_of ctxt;
wenzelm@33641
   362
    val full_space =
wenzelm@33641
   363
      Name_Space.merge (Facts.space_of global_facts, Facts.space_of local_facts);
wenzelm@33641
   364
wenzelm@33641
   365
    fun valid_facts facts =
wenzelm@33641
   366
      (facts, []) |-> Facts.fold_static (fn (name, ths0) =>
blanchet@37399
   367
        if Facts.is_concealed facts name orelse
blanchet@37399
   368
           (respect_no_atp andalso is_package_def name) orelse
blanchet@37399
   369
           member (op =) multi_base_blacklist (Long_Name.base_name name) then
blanchet@37399
   370
          I
blanchet@37399
   371
        else
blanchet@37399
   372
          let
blanchet@37399
   373
            fun check_thms a =
blanchet@37399
   374
              (case try (ProofContext.get_thms ctxt) a of
blanchet@37399
   375
                NONE => false
blanchet@37399
   376
              | SOME ths1 => Thm.eq_thms (ths0, ths1));
wenzelm@33641
   377
blanchet@37399
   378
            val name1 = Facts.extern facts name;
blanchet@37399
   379
            val name2 = Name_Space.extern full_space name;
blanchet@37399
   380
            val ths = filter_out is_theorem_bad_for_atps ths0;
blanchet@37399
   381
          in
blanchet@37399
   382
            case find_first check_thms [name1, name2, name] of
blanchet@37399
   383
              NONE => I
blanchet@37399
   384
            | SOME name' =>
blanchet@37399
   385
              cons (name' |> forall (member Thm.eq_thm chained_ths) ths
blanchet@37399
   386
                             ? prefix chained_prefix, ths)
blanchet@37399
   387
          end)
wenzelm@26675
   388
  in valid_facts global_facts @ valid_facts local_facts end;
paulson@21224
   389
wenzelm@33309
   390
fun multi_name a th (n, pairs) =
wenzelm@33309
   391
  (n + 1, (a ^ "(" ^ Int.toString n ^ ")", th) :: pairs);
paulson@21224
   392
blanchet@37498
   393
fun add_names (_, []) pairs = pairs
blanchet@37399
   394
  | add_names (a, [th]) pairs = (a, th) :: pairs
blanchet@37399
   395
  | add_names (a, ths) pairs = #2 (fold (multi_name a) ths (1, pairs))
paulson@21224
   396
paulson@21290
   397
fun is_multi (a, ths) = length ths > 1 orelse String.isSuffix ".axioms" a;
paulson@21290
   398
blanchet@36550
   399
(* The single-name theorems go after the multiple-name ones, so that single
blanchet@36550
   400
   names are preferred when both are available. *)
blanchet@37344
   401
fun name_thm_pairs respect_no_atp ctxt name_thms_pairs =
wenzelm@33309
   402
  let
blanchet@37344
   403
    val (mults, singles) = List.partition is_multi name_thms_pairs
blanchet@37399
   404
    val ps = [] |> fold add_names singles |> fold add_names mults
blanchet@36060
   405
  in ps |> respect_no_atp ? filter_out (No_ATPs.member ctxt o snd) end;
paulson@21224
   406
blanchet@37344
   407
fun is_named ("", th) =
blanchet@37344
   408
    (warning ("No name for theorem " ^
blanchet@37344
   409
              Display.string_of_thm_without_context th); false)
blanchet@37344
   410
  | is_named _ = true
blanchet@37344
   411
fun checked_name_thm_pairs respect_no_atp ctxt =
blanchet@37344
   412
  name_thm_pairs respect_no_atp ctxt
blanchet@37344
   413
  #> tap (fn ps => trace_msg
blanchet@37344
   414
                        (fn () => ("Considering " ^ Int.toString (length ps) ^
blanchet@37344
   415
                                   " theorems")))
blanchet@37344
   416
  #> filter is_named
paulson@19894
   417
blanchet@37344
   418
fun name_thms_pair_from_ref ctxt chained_ths xref =
blanchet@37344
   419
  let
blanchet@37344
   420
    val ths = ProofContext.get_fact ctxt xref
blanchet@37344
   421
    val name = Facts.string_of_ref xref
blanchet@37344
   422
               |> forall (member Thm.eq_thm chained_ths) ths
blanchet@37344
   423
                  ? prefix chained_prefix
blanchet@37344
   424
  in (name, ths) end
blanchet@37344
   425
mengj@19768
   426
paulson@21290
   427
(***************************************************************)
paulson@21290
   428
(* Type Classes Present in the Axiom or Conjecture Clauses     *)
paulson@21290
   429
(***************************************************************)
paulson@21290
   430
wenzelm@32952
   431
fun add_classes (sorts, cset) = List.foldl setinsert cset (flat sorts);
paulson@21290
   432
paulson@21290
   433
(*Remove this trivial type class*)
blanchet@35865
   434
fun delete_type cset = Symtab.delete_safe (the_single @{sort HOL.type}) cset;
paulson@21290
   435
paulson@21290
   436
fun tvar_classes_of_terms ts =
wenzelm@29270
   437
  let val sorts_list = map (map #2 o OldTerm.term_tvars) ts
wenzelm@30190
   438
  in  Symtab.keys (delete_type (List.foldl add_classes Symtab.empty sorts_list))  end;
paulson@21290
   439
paulson@21290
   440
fun tfree_classes_of_terms ts =
wenzelm@29270
   441
  let val sorts_list = map (map #2 o OldTerm.term_tfrees) ts
wenzelm@30190
   442
  in  Symtab.keys (delete_type (List.foldl add_classes Symtab.empty sorts_list))  end;
paulson@20526
   443
paulson@21373
   444
(*fold type constructors*)
paulson@21373
   445
fun fold_type_consts f (Type (a, Ts)) x = fold (fold_type_consts f) Ts (f (a,x))
wenzelm@32994
   446
  | fold_type_consts _ _ x = x;
paulson@21373
   447
paulson@21373
   448
val add_type_consts_in_type = fold_type_consts setinsert;
paulson@21373
   449
paulson@21397
   450
(*Type constructors used to instantiate overloaded constants are the only ones needed.*)
paulson@21397
   451
fun add_type_consts_in_term thy =
paulson@21397
   452
  let val const_typargs = Sign.const_typargs thy
paulson@21397
   453
      fun add_tcs (Const cT) x = fold add_type_consts_in_type (const_typargs cT) x
wenzelm@32994
   454
        | add_tcs (Abs (_, _, u)) x = add_tcs u x
paulson@21397
   455
        | add_tcs (t $ u) x = add_tcs t (add_tcs u x)
paulson@21397
   456
        | add_tcs _ x = x
paulson@21397
   457
  in  add_tcs  end
paulson@21373
   458
paulson@21397
   459
fun type_consts_of_terms thy ts =
paulson@21397
   460
  Symtab.keys (fold (add_type_consts_in_term thy) ts Symtab.empty);
paulson@21373
   461
paulson@21373
   462
mengj@19194
   463
(***************************************************************)
mengj@19194
   464
(* ATP invocation methods setup                                *)
mengj@19194
   465
(***************************************************************)
mengj@19194
   466
blanchet@37410
   467
fun is_quasi_fol_term thy =
blanchet@37410
   468
  Meson.is_fol_term thy o snd o conceal_skolem_somes ~1 []
blanchet@37399
   469
paulson@20526
   470
(*Ensures that no higher-order theorems "leak out"*)
blanchet@37399
   471
fun restrict_to_logic thy true cls =
blanchet@37399
   472
    filter (is_quasi_fol_term thy o prop_of o fst) cls
blanchet@37498
   473
  | restrict_to_logic _ false cls = cls
paulson@20526
   474
blanchet@37347
   475
(**** Predicates to detect unwanted clauses (prolific or likely to cause
blanchet@37347
   476
      unsoundness) ****)
paulson@21470
   477
paulson@21470
   478
(** Too general means, positive equality literal with a variable X as one operand,
paulson@21470
   479
  when X does not occur properly in the other operand. This rules out clearly
paulson@21470
   480
  inconsistent clauses such as V=a|V=b, though it by no means guarantees soundness. **)
wenzelm@21588
   481
blanchet@37348
   482
fun var_occurs_in_term ix =
blanchet@37348
   483
  let
blanchet@37348
   484
    fun aux (Var (jx, _)) = (ix = jx)
blanchet@37348
   485
      | aux (t1 $ t2) = aux t1 orelse aux t2
blanchet@37348
   486
      | aux (Abs (_, _, t)) = aux t
blanchet@37348
   487
      | aux _ = false
blanchet@37348
   488
  in aux end
paulson@21470
   489
blanchet@37348
   490
fun is_record_type T = not (null (Record.dest_recTs T))
paulson@21470
   491
paulson@21470
   492
(*Unwanted equalities include
paulson@21470
   493
  (1) those between a variable that does not properly occur in the second operand,
paulson@21470
   494
  (2) those between a variable and a record, since these seem to be prolific "cases" thms
wenzelm@21588
   495
*)
blanchet@37348
   496
fun too_general_eqterms (Var (ix,T), t) =
blanchet@37348
   497
    not (var_occurs_in_term ix t) orelse is_record_type T
paulson@21470
   498
  | too_general_eqterms _ = false;
paulson@21470
   499
blanchet@35865
   500
fun too_general_equality (Const (@{const_name "op ="}, _) $ x $ y) =
paulson@21470
   501
      too_general_eqterms (x,y) orelse too_general_eqterms(y,x)
paulson@21470
   502
  | too_general_equality _ = false;
paulson@21470
   503
wenzelm@29267
   504
fun has_typed_var tycons = exists_subterm
wenzelm@29267
   505
  (fn Var (_, Type (a, _)) => member (op =) tycons a | _ => false);
paulson@21431
   506
blanchet@37347
   507
(* Clauses are forbidden to contain variables of these types. The typical reason
blanchet@37347
   508
   is that they lead to unsoundness. Note that "unit" satisfies numerous
blanchet@37347
   509
   equations like "?x = ()". The resulting clause will have no type constraint,
blanchet@37347
   510
   yielding false proofs. Even "bool" leads to many unsound proofs, though only
blanchet@37347
   511
   for higher-order problems. *)
blanchet@37347
   512
val dangerous_types = [@{type_name unit}, @{type_name bool}];
paulson@22217
   513
blanchet@37347
   514
(* Clauses containing variables of type "unit" or "bool" or of the form
blanchet@37347
   515
   "?x = A | ?x = B | ?x = C" are likely to lead to unsound proofs if types are
blanchet@37347
   516
   omitted. *)
blanchet@37347
   517
fun is_dangerous_term _ @{prop True} = true
blanchet@37347
   518
  | is_dangerous_term full_types t =
blanchet@37347
   519
    not full_types andalso 
blanchet@37347
   520
    (has_typed_var dangerous_types t orelse
blanchet@37347
   521
     forall too_general_equality (HOLogic.disjuncts (strip_Trueprop t)))
paulson@21470
   522
blanchet@37347
   523
fun remove_dangerous_clauses full_types add_thms =
blanchet@37501
   524
  filter_out (fn (cnf_th, (_, orig_th)) =>
blanchet@37501
   525
                 not (member Thm.eq_thm add_thms orig_th) andalso
blanchet@37501
   526
                 is_dangerous_term full_types (prop_of cnf_th))
paulson@21431
   527
blanchet@37399
   528
fun is_fol_goal thy = forall (Meson.is_fol_term thy) o map prop_of
immler@30536
   529
blanchet@37347
   530
fun relevant_facts full_types respect_no_atp relevance_threshold
blanchet@37347
   531
                   relevance_convergence defs_relevant max_new theory_relevant
blanchet@37347
   532
                   (relevance_override as {add, del, only})
blanchet@37347
   533
                   (ctxt, (chained_ths, _)) goal_cls =
blanchet@36185
   534
  if (only andalso null add) orelse relevance_threshold > 1.0 then
blanchet@36185
   535
    []
blanchet@36185
   536
  else
blanchet@36185
   537
    let
blanchet@36185
   538
      val thy = ProofContext.theory_of ctxt
blanchet@37345
   539
      val has_override = not (null add) orelse not (null del)
blanchet@37399
   540
      val is_FO = is_fol_goal thy goal_cls
blanchet@37345
   541
      val axioms =
blanchet@37399
   542
        checked_name_thm_pairs (respect_no_atp andalso not only) ctxt
blanchet@37344
   543
            (if only then map (name_thms_pair_from_ref ctxt chained_ths) add
blanchet@37345
   544
             else all_name_thms_pairs respect_no_atp ctxt chained_ths)
blanchet@37345
   545
        |> cnf_rules_pairs thy
blanchet@37345
   546
        |> not has_override ? make_unique
blanchet@37399
   547
        |> not only ? restrict_to_logic thy is_FO
blanchet@37501
   548
        |> (if only then
blanchet@37501
   549
              I
blanchet@37501
   550
            else
blanchet@37501
   551
              remove_dangerous_clauses full_types
blanchet@37501
   552
                                       (maps (ProofContext.get_fact ctxt) add))
blanchet@36185
   553
    in
blanchet@36922
   554
      relevance_filter ctxt relevance_threshold relevance_convergence
blanchet@36922
   555
                       defs_relevant max_new theory_relevant relevance_override
blanchet@37345
   556
                       thy axioms (map prop_of goal_cls)
blanchet@37345
   557
      |> has_override ? make_unique
blanchet@36185
   558
    end
immler@30536
   559
immler@31752
   560
(* prepare for passing to writer,
immler@31752
   561
   create additional clauses based on the information from extra_cls *)
blanchet@37498
   562
fun prepare_clauses full_types goal_cls axcls extra_cls thy =
immler@31409
   563
  let
blanchet@37399
   564
    val is_FO = is_fol_goal thy goal_cls
blanchet@36061
   565
    val ccls = subtract_cls extra_cls goal_cls
blanchet@35865
   566
    val _ = app (fn th => trace_msg (fn _ => Display.string_of_thm_global thy th)) ccls
immler@30536
   567
    val ccltms = map prop_of ccls
immler@31752
   568
    and axtms = map (prop_of o #1) extra_cls
immler@30536
   569
    val subs = tfree_classes_of_terms ccltms
immler@30536
   570
    and supers = tvar_classes_of_terms axtms
blanchet@35865
   571
    and tycons = type_consts_of_terms thy (ccltms @ axtms)
immler@30536
   572
    (*TFrees in conjecture clauses; TVars in axiom clauses*)
blanchet@37498
   573
    val conjectures = make_conjecture_clauses thy ccls
blanchet@37498
   574
    val (_, extra_clauses) = ListPair.unzip (make_axiom_clauses thy extra_cls)
blanchet@37498
   575
    val (clnames, axiom_clauses) = ListPair.unzip (make_axiom_clauses thy axcls)
blanchet@37479
   576
    val helper_clauses =
blanchet@37498
   577
      get_helper_clauses thy is_FO full_types conjectures extra_cls
blanchet@37498
   578
    val (supers', arity_clauses) = make_arity_clauses thy tycons supers
blanchet@35865
   579
    val classrel_clauses = make_classrel_clauses thy subs supers'
immler@30536
   580
  in
immler@31752
   581
    (Vector.fromList clnames,
immler@31865
   582
      (conjectures, axiom_clauses, extra_clauses, helper_clauses, classrel_clauses, arity_clauses))
immler@31409
   583
  end
quigley@15644
   584
paulson@15347
   585
end;