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