doc-src/Sledgehammer/sledgehammer.tex
author blanchet
Mon, 06 Jun 2011 20:36:35 +0200
changeset 43204 ac02112a208e
parent 43203 6c8170f8849e
child 43216 7b89836fd607
permissions -rw-r--r--
remove more occurrences of "metisX", preparing for the D Day when it will silently hijack "metis" and "metisFT"
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     1
\documentclass[a4paper,12pt]{article}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     2
\usepackage[T1]{fontenc}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     3
\usepackage{amsmath}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     4
\usepackage{amssymb}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     5
\usepackage[english,french]{babel}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     6
\usepackage{color}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     7
\usepackage{footmisc}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     8
\usepackage{graphicx}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
     9
%\usepackage{mathpazo}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    10
\usepackage{multicol}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    11
\usepackage{stmaryrd}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    12
%\usepackage[scaled=.85]{beramono}
42511
bf89455ccf9d eliminated copies of isabelle style files;
wenzelm
parents: 42446
diff changeset
    13
\usepackage{../../lib/texinputs/isabelle,../iman,../pdfsetup}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    14
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    15
%\oddsidemargin=4.6mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    16
%\evensidemargin=4.6mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    17
%\textwidth=150mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    18
%\topmargin=4.6mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    19
%\headheight=0mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    20
%\headsep=0mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    21
%\textheight=234mm
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    22
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    23
\def\Colon{\mathord{:\mkern-1.5mu:}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    24
%\def\lbrakk{\mathopen{\lbrack\mkern-3.25mu\lbrack}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    25
%\def\rbrakk{\mathclose{\rbrack\mkern-3.255mu\rbrack}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    26
\def\lparr{\mathopen{(\mkern-4mu\mid}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    27
\def\rparr{\mathclose{\mid\mkern-4mu)}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    28
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    29
\def\unk{{?}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    30
\def\undef{(\lambda x.\; \unk)}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    31
%\def\unr{\textit{others}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    32
\def\unr{\ldots}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    33
\def\Abs#1{\hbox{\rm{\flqq}}{\,#1\,}\hbox{\rm{\frqq}}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    34
\def\Q{{\smash{\lower.2ex\hbox{$\scriptstyle?$}}}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    35
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    36
\urlstyle{tt}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    37
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    38
\begin{document}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    39
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    40
\selectlanguage{english}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    41
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    42
\title{\includegraphics[scale=0.5]{isabelle_sledgehammer} \\[4ex]
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    43
Hammering Away \\[\smallskipamount]
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    44
\Large A User's Guide to Sledgehammer for Isabelle/HOL}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    45
\author{\hbox{} \\
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    46
Jasmin Christian Blanchette \\
43002
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
    47
{\normalsize Institut f\"ur Informatik, Technische Universit\"at M\"unchen} \\[4\smallskipamount]
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
    48
{\normalsize with contributions from} \\[4\smallskipamount]
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
    49
Lawrence C. Paulson \\
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
    50
{\normalsize Computer Laboratory, University of Cambridge} \\
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    51
\hbox{}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    52
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    53
\maketitle
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    54
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    55
\tableofcontents
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    56
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    57
\setlength{\parskip}{.7em plus .2em minus .1em}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    58
\setlength{\parindent}{0pt}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    59
\setlength{\abovedisplayskip}{\parskip}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    60
\setlength{\abovedisplayshortskip}{.9\parskip}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    61
\setlength{\belowdisplayskip}{\parskip}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    62
\setlength{\belowdisplayshortskip}{.9\parskip}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    63
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    64
% General-purpose enum environment with correct spacing
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    65
\newenvironment{enum}%
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    66
    {\begin{list}{}{%
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    67
        \setlength{\topsep}{.1\parskip}%
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    68
        \setlength{\partopsep}{.1\parskip}%
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    69
        \setlength{\itemsep}{\parskip}%
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    70
        \advance\itemsep by-\parsep}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    71
    {\end{list}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    72
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    73
\def\pre{\begingroup\vskip0pt plus1ex\advance\leftskip by\leftmargin
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    74
\advance\rightskip by\leftmargin}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    75
\def\post{\vskip0pt plus1ex\endgroup}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    76
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    77
\def\prew{\pre\advance\rightskip by-\leftmargin}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    78
\def\postw{\post}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    79
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    80
\section{Introduction}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    81
\label{introduction}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    82
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
    83
Sledgehammer is a tool that applies automatic theorem provers (ATPs)
40942
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
    84
and satisfiability-modulo-theories (SMT) solvers on the current goal. The
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
    85
supported ATPs are E \cite{schulz-2002}, LEO-II \cite{leo2}, Satallax
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
    86
\cite{satallax}, SInE-E \cite{sine}, SNARK \cite{snark}, SPASS
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
    87
\cite{weidenbach-et-al-2009}, ToFoF-E \cite{tofof}, Vampire
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
    88
\cite{riazanov-voronkov-2002}, and Waldmeister \cite{waldmeister}. The ATPs are
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
    89
run either locally or remotely via the System\-On\-TPTP web service
42940
f838586ebec2 document Waldmeister
blanchet
parents: 42888
diff changeset
    90
\cite{sutcliffe-2000}. In addition to the ATPs, the SMT solvers Z3 \cite{z3} is
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
    91
used by default, and you can tell Sledgehammer to try CVC3 \cite{cvc3} and Yices
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
    92
\cite{yices} as well; these are run either locally or on a server at the TU
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
    93
M\"unchen.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
    94
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
    95
The problem passed to the automatic provers consists of your current goal
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
    96
together with a heuristic selection of hundreds of facts (theorems) from the
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
    97
current theory context, filtered by relevance. Because jobs are run in the
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
    98
background, you can continue to work on your proof by other means. Provers can
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
    99
be run in parallel. Any reply (which may arrive half a minute later) will appear
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   100
in the Proof General response buffer.
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   101
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   102
The result of a successful proof search is some source text that usually (but
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   103
not always) reconstructs the proof within Isabelle. For ATPs, the reconstructed
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   104
proof relies on the general-purpose Metis prover, which is fully integrated into
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   105
Isabelle/HOL, with explicit inferences going through the kernel. Thus its
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   106
results are correct by construction.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   107
39320
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   108
In this manual, we will explicitly invoke the \textbf{sledgehammer} command.
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   109
Sledgehammer also provides an automatic mode that can be enabled via the
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   110
``Auto Sledgehammer'' option from the ``Isabelle'' menu in Proof General. In
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   111
this mode, Sledgehammer is run on every newly entered theorem. The time limit
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   112
for Auto Sledgehammer and other automatic tools can be set using the ``Auto
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   113
Tools Time Limit'' option.
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   114
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   115
\newbox\boxA
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   116
\setbox\boxA=\hbox{\texttt{nospam}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   117
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   118
\newcommand\authoremail{\texttt{blan{\color{white}nospam}\kern-\wd\boxA{}chette@\allowbreak
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   119
in.\allowbreak tum.\allowbreak de}}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   120
40689
3a10ce7cd436 document requirement on theory import
blanchet
parents: 40343
diff changeset
   121
To run Sledgehammer, you must make sure that the theory \textit{Sledgehammer} is
3a10ce7cd436 document requirement on theory import
blanchet
parents: 40343
diff changeset
   122
imported---this is rarely a problem in practice since it is part of
3a10ce7cd436 document requirement on theory import
blanchet
parents: 40343
diff changeset
   123
\textit{Main}. Examples of Sledgehammer use can be found in Isabelle's
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   124
\texttt{src/HOL/Metis\_Examples} directory.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   125
Comments and bug reports concerning Sledgehammer or this manual should be
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   126
directed to the author at \authoremail.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   127
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   128
\vskip2.5\smallskipamount
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   129
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   130
%\textbf{Acknowledgment.} The author would like to thank Mark Summerfield for
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   131
%suggesting several textual improvements.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   132
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   133
\section{Installation}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   134
\label{installation}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   135
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   136
Sledgehammer is part of Isabelle, so you don't need to install it. However, it
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   137
relies on third-party automatic theorem provers (ATPs) and SMT solvers.
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   138
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   139
\subsection{Installing ATPs}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   140
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   141
Currently, E, SPASS, and Vampire can be run locally; in addition, E, Vampire,
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   142
LEO-II, Satallax, SInE-E, SNARK, ToFoF-E, and Waldmeister are available remotely
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   143
via System\-On\-TPTP \cite{sutcliffe-2000}. If you want better performance, you
42940
f838586ebec2 document Waldmeister
blanchet
parents: 42888
diff changeset
   144
should at least install E and SPASS locally.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   145
38043
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   146
There are three main ways to install ATPs on your machine:
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   147
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   148
\begin{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   149
\item[$\bullet$] If you installed an official Isabelle package with everything
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   150
inside, it should already include properly setup executables for E and SPASS,
38043
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   151
ready to use.%
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   152
\footnote{Vampire's license prevents us from doing the same for this otherwise
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   153
wonderful tool.}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   154
38043
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   155
\item[$\bullet$] Alternatively, you can download the Isabelle-aware E and SPASS
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   156
binary packages from Isabelle's download page. Extract the archives, then add a
41747
f58d4d202924 fix path to etc/settings and etc/components in doc
blanchet
parents: 41740
diff changeset
   157
line to your \texttt{\$ISABELLE\_HOME\_USER/etc/components}%
f58d4d202924 fix path to etc/settings and etc/components in doc
blanchet
parents: 41740
diff changeset
   158
\footnote{The variable \texttt{\$ISABELLE\_HOME\_USER} is set by Isabelle at
f58d4d202924 fix path to etc/settings and etc/components in doc
blanchet
parents: 41740
diff changeset
   159
startup. Its value can be retrieved by invoking \texttt{isabelle}
f58d4d202924 fix path to etc/settings and etc/components in doc
blanchet
parents: 41740
diff changeset
   160
\texttt{getenv} \texttt{ISABELLE\_HOME\_USER} on the command line.}
f58d4d202924 fix path to etc/settings and etc/components in doc
blanchet
parents: 41740
diff changeset
   161
file with the absolute
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   162
path to E or SPASS. For example, if the \texttt{components} does not exist yet
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   163
and you extracted SPASS to \texttt{/usr/local/spass-3.7}, create the
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   164
\texttt{components} file with the single line
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   165
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   166
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   167
\texttt{/usr/local/spass-3.7}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   168
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   169
38043
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   170
in it.
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   171
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   172
\item[$\bullet$] If you prefer to build E or SPASS yourself, or obtained a
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   173
Vampire executable from somewhere (e.g., \url{http://www.vprover.org/}),
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   174
set the environment variable \texttt{E\_HOME}, \texttt{SPASS\_HOME}, or
f31ddd5da4e3 updated Sledgehammer docs
blanchet
parents: 37582
diff changeset
   175
\texttt{VAMPIRE\_HOME} to the directory that contains the \texttt{eproof},
38063
458c4578761f mention version numbers
blanchet
parents: 38043
diff changeset
   176
\texttt{SPASS}, or \texttt{vampire} executable. Sledgehammer has been tested
42845
94c69e441440 mention version 0.6 of Vampire, since that's what's currently available for download
blanchet
parents: 42763
diff changeset
   177
with E 1.0 and 1.2, SPASS 3.5 and 3.7, and Vampire 0.6 and 1.0%
38063
458c4578761f mention version numbers
blanchet
parents: 38043
diff changeset
   178
\footnote{Following the rewrite of Vampire, the counter for version numbers was
42845
94c69e441440 mention version 0.6 of Vampire, since that's what's currently available for download
blanchet
parents: 42763
diff changeset
   179
reset to 0; hence the (new) Vampire versions 0.6 and 1.0 are more recent than,
94c69e441440 mention version 0.6 of Vampire, since that's what's currently available for download
blanchet
parents: 42763
diff changeset
   180
say, Vampire 11.5.}%
38063
458c4578761f mention version numbers
blanchet
parents: 38043
diff changeset
   181
. Since the ATPs' output formats are neither documented nor stable, other
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   182
versions of the ATPs might or might not work well with Sledgehammer. Ideally,
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   183
also set \texttt{E\_VERSION}, \texttt{SPASS\_VERSION}, or
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   184
\texttt{VAMPIRE\_VERSION} to the ATP's version number (e.g., ``1.2'').
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   185
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   186
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   187
To check whether E and SPASS are successfully installed, follow the example in
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   188
\S\ref{first-steps}. If the remote versions of E and SPASS are used (identified
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   189
by the prefix ``\emph{remote\_}''), or if the local versions fail to solve the
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   190
easy goal presented there, this is a sign that something is wrong with your
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   191
installation.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   192
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   193
Remote ATP invocation via the SystemOnTPTP web service requires Perl with the
39152
f09b378cb252 make remote ATP invocation work for those people who need to go through a proxy;
blanchet
parents: 38997
diff changeset
   194
World Wide Web Library (\texttt{libwww-perl}) installed. If you must use a proxy
f09b378cb252 make remote ATP invocation work for those people who need to go through a proxy;
blanchet
parents: 38997
diff changeset
   195
server to access the Internet, set the \texttt{http\_proxy} environment variable
39153
b1c2c03fd9d7 mention ~/.isabelle/etc/settings file
blanchet
parents: 39152
diff changeset
   196
to the proxy, either in the environment in which Isabelle is launched or in your
41747
f58d4d202924 fix path to etc/settings and etc/components in doc
blanchet
parents: 41740
diff changeset
   197
\texttt{\char`\~/\$ISABELLE\_HOME\_USER/etc/settings} file. Here are a few examples:
39152
f09b378cb252 make remote ATP invocation work for those people who need to go through a proxy;
blanchet
parents: 38997
diff changeset
   198
f09b378cb252 make remote ATP invocation work for those people who need to go through a proxy;
blanchet
parents: 38997
diff changeset
   199
\prew
39153
b1c2c03fd9d7 mention ~/.isabelle/etc/settings file
blanchet
parents: 39152
diff changeset
   200
\texttt{http\_proxy=http://proxy.example.org} \\
b1c2c03fd9d7 mention ~/.isabelle/etc/settings file
blanchet
parents: 39152
diff changeset
   201
\texttt{http\_proxy=http://proxy.example.org:8080} \\
b1c2c03fd9d7 mention ~/.isabelle/etc/settings file
blanchet
parents: 39152
diff changeset
   202
\texttt{http\_proxy=http://joeblow:pAsSwRd@proxy.example.org}
39152
f09b378cb252 make remote ATP invocation work for those people who need to go through a proxy;
blanchet
parents: 38997
diff changeset
   203
\postw
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   204
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   205
\subsection{Installing SMT Solvers}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   206
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   207
CVC3, Yices, and Z3 can be run locally or (for CVC3 and Z3) remotely on a TU
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   208
M\"unchen server. If you want better performance and get the ability to replay
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   209
proofs that rely on the \emph{smt} proof method, you should at least install Z3
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   210
locally.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   211
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   212
There are two main ways of installing SMT solvers locally.
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   213
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   214
\begin{enum}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   215
\item[$\bullet$] If you installed an official Isabelle package with everything
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   216
inside, it should already include properly setup executables for CVC3 and Z3,
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   217
ready to use.%
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   218
\footnote{Yices's license prevents us from doing the same for this otherwise
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   219
wonderful tool.}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   220
For Z3, you additionally need to set the environment variable
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   221
\texttt{Z3\_NON\_COMMERCIAL} to ``yes'' to confirm that you are a noncommercial
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   222
user.
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   223
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   224
\item[$\bullet$] Otherwise, follow the instructions documented in the \emph{SMT}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   225
theory (\texttt{\$ISABELLE\_HOME/src/HOL/SMT.thy}).
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   226
\end{enum}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   227
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   228
\section{First Steps}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   229
\label{first-steps}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   230
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   231
To illustrate Sledgehammer in context, let us start a theory file and
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   232
attempt to prove a simple lemma:
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   233
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   234
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   235
\textbf{theory}~\textit{Scratch} \\
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   236
\textbf{imports}~\textit{Main} \\
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   237
\textbf{begin} \\[2\smallskipamount]
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   238
%
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   239
\textbf{lemma} ``$[a] = [b] \,\Longrightarrow\, a = b$'' \\
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   240
\textbf{sledgehammer}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   241
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   242
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   243
Instead of issuing the \textbf{sledgehammer} command, you can also find
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   244
Sledgehammer in the ``Commands'' submenu of the ``Isabelle'' menu in Proof
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   245
General or press the Emacs key sequence C-c C-a C-s.
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   246
Either way, Sledgehammer produces the following output after a few seconds:
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   247
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   248
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   249
\slshape
43035
31182f0ec04d minor update
blanchet
parents: 43031
diff changeset
   250
Sledgehammer: ``\textit{e}'' on goal \\
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   251
$[a] = [b] \,\Longrightarrow\, a = b$ \\
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   252
Try this: \textbf{by} (\textit{metis last\_ConsL}) (64 ms). \\[3\smallskipamount]
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   253
%
43035
31182f0ec04d minor update
blanchet
parents: 43031
diff changeset
   254
Sledgehammer: ``\textit{vampire}'' on goal \\
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   255
$[a] = [b] \,\Longrightarrow\, a = b$ \\
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   256
Try this: \textbf{by} (\textit{metis hd.simps}) (14 ms). \\[3\smallskipamount]
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   257
%
43035
31182f0ec04d minor update
blanchet
parents: 43031
diff changeset
   258
Sledgehammer: ``\textit{spass}'' on goal \\
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   259
$[a] = [b] \,\Longrightarrow\, a = b$ \\
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   260
Try this: \textbf{by} (\textit{metis list.inject}) (17 ms). \\[3\smallskipamount]
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   261
%
43035
31182f0ec04d minor update
blanchet
parents: 43031
diff changeset
   262
Sledgehammer: ``\textit{remote\_waldmeister}'' on goal \\
43010
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   263
$[a] = [b] \,\Longrightarrow\, a = b$ \\
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   264
Try this: \textbf{by} (\textit{metis hd.simps}) (15 ms). \\[3\smallskipamount]
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   265
%
43035
31182f0ec04d minor update
blanchet
parents: 43031
diff changeset
   266
Sledgehammer: ``\textit{remote\_sine\_e}'' on goal \\
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   267
$[a] = [b] \,\Longrightarrow\, a = b$ \\
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   268
Try this: \textbf{by} (\textit{metis hd.simps}) (18 ms). \\[3\smallskipamount]
40942
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
   269
%
43035
31182f0ec04d minor update
blanchet
parents: 43031
diff changeset
   270
Sledgehammer: ``\textit{remote\_z3}'' on goal \\
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   271
$[a] = [b] \,\Longrightarrow\, a = b$ \\
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   272
Try this: \textbf{by} (\textit{metis list.inject}) (20 ms).
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   273
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   274
43010
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   275
Sledgehammer ran E, SInE-E, SPASS, Vampire, Waldmeister, and Z3 in parallel.
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   276
Depending on which provers are installed and how many processor cores are
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   277
available, some of the provers might be missing or present with a
43010
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   278
\textit{remote\_} prefix. Waldmeister is run only for unit equational problems,
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   279
where the goal's conclusion is a (universally quantified) equation.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   280
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   281
For each successful prover, Sledgehammer gives a one-liner proof that uses Metis
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   282
or the \textit{smt} proof method. For Metis, approximate timings are shown in
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   283
parentheses, indicating how fast the call is. You can click the proof to insert
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   284
it into the theory text.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   285
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   286
In addition, you can ask Sledgehammer for an Isar text proof by passing the
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   287
\textit{isar\_proof} option (\S\ref{output-format}):
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   288
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   289
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   290
\textbf{sledgehammer} [\textit{isar\_proof}]
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   291
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   292
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   293
When Isar proof construction is successful, it can yield proofs that are more
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   294
readable and also faster than the Metis one-liners. This feature is experimental
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   295
and is only available for ATPs.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   296
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   297
\section{Hints}
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   298
\label{hints}
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   299
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   300
This section presents a few hints that should help you get the most out of
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   301
Sledgehammer and Metis. Frequently (and infrequently) asked questions are
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   302
answered in \S\ref{frequently-asked-questions}.
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   303
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   304
\newcommand\point[1]{\medskip\par{\sl\bfseries#1}\par\nopagebreak}
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   305
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   306
\point{Presimplify the goal}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   307
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   308
For best results, first simplify your problem by calling \textit{auto} or at
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   309
least \textit{safe} followed by \textit{simp\_all}. The SMT solvers provide
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   310
arithmetic decision procedures, but the ATPs typically do not (or if they do,
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   311
Sledgehammer does not use it yet). Apart from Waldmeister, they are not
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   312
especially good at heavy rewriting, but because they regard equations as
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   313
undirected, they often prove theorems that require the reverse orientation of a
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   314
\textit{simp} rule. Higher-order problems can be tackled, but the success rate
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   315
is better for first-order problems. Hence, you may get better results if you
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   316
first simplify the problem to remove higher-order features.
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   317
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   318
\point{Make sure at least E, SPASS, Vampire, and Z3 are installed}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   319
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   320
Locally installed provers are faster and more reliable than those running on
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   321
servers. See \S\ref{installation} for details on how to install them.
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   322
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   323
\point{Familiarize yourself with the most important options}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   324
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   325
Sledgehammer's options are fully documented in \S\ref{command-syntax}. Many of
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   326
the options are very specialized, but serious users of the tool should at least
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   327
familiarize themselves with the following options:
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   328
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   329
\begin{enum}
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   330
\item[$\bullet$] \textbf{\textit{provers}} (\S\ref{mode-of-operation}) specifies
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   331
the automatic provers (ATPs and SMT solvers) that should be run whenever
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   332
Sledgehammer is invoked (e.g., ``\textit{provers}~= \textit{e spass
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   333
remote\_vampire}''). For convenience, you can omit ``\textit{provers}~=''
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   334
and simply write the prover names as a space-separated list (e.g., ``\textit{e
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   335
spass remote\_vampire}'').
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   336
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   337
\item[$\bullet$] \textbf{\textit{full\_types}} (\S\ref{problem-encoding})
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   338
specifies whether type-sound encodings should be used. By default, Sledgehammer
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   339
employs a mixture of type-sound and type-unsound encodings, occasionally
43007
b48aa3492f0b minor doc adjustments
blanchet
parents: 43005
diff changeset
   340
yielding unsound ATP proofs. In contrast, SMT solver proofs should always be
b48aa3492f0b minor doc adjustments
blanchet
parents: 43005
diff changeset
   341
sound.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   342
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   343
\item[$\bullet$] \textbf{\textit{max\_relevant}} (\S\ref{relevance-filter})
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   344
specifies the maximum number of facts that should be passed to the provers. By
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   345
default, the value is prover-dependent but varies between about 150 and 1000. If
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   346
the provers time out, you can try lowering this value to, say, 100 or 50 and see
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   347
if that helps.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   348
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   349
\item[$\bullet$] \textbf{\textit{isar\_proof}} (\S\ref{output-format}) specifies
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   350
that Isar proofs should be generated, instead of one-liner Metis proofs. The
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   351
length of the Isar proofs can be controlled by setting
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   352
\textit{isar\_shrink\_factor} (\S\ref{output-format}).
43038
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   353
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   354
\item[$\bullet$] \textbf{\textit{timeout}} (\S\ref{timeouts}) controls the
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   355
provers' time limit. It is set to 30 seconds, but since Sledgehammer runs
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   356
asynchronously you should not hesitate to raise this limit to 60 or 120 seconds
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   357
if you are the kind of user who can think clearly while ATPs are active.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   358
\end{enum}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   359
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   360
Options can be set globally using \textbf{sledgehammer\_params}
43010
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   361
(\S\ref{command-syntax}). The command also prints the list of all available
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   362
options with their current value. Fact selection can be influenced by specifying
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   363
``$(\textit{add}{:}~\textit{my\_facts})$'' after the \textbf{sledgehammer} call
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   364
to ensure that certain facts are included, or simply ``$(\textit{my\_facts})$''
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   365
to force Sledgehammer to run only with $\textit{my\_facts}$.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   366
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   367
\section{Frequently Asked Questions}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   368
\label{frequently-asked-questions}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   369
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   370
This sections answers frequently (and infrequently) asked questions about
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   371
Sledgehammer. It is a good idea to skim over it now even if you don't have any
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   372
questions at this stage. And if you have any further questions not listed here,
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   373
send them to the author at \authoremail.
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   374
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   375
\point{Why does Metis fail to reconstruct the proof?}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   376
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   377
There are many reasons. If Metis runs seemingly forever, that is a sign that the
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   378
proof is too difficult for it. Metis's search is complete, so it should
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   379
eventually find it, but that's little consolation. There are several possible
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   380
solutions:
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   381
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   382
\begin{enum}
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   383
\item[$\bullet$] Try the \textit{isar\_proof} option (\S\ref{output-format}) to
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   384
obtain a step-by-step Isar proof where each step is justified by Metis. Since
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   385
the steps are fairly small, Metis is more likely to be able to replay them.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   386
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   387
\item[$\bullet$] Try the \textit{smt} proof method instead of Metis. It is
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   388
usually stronger, but you need to have Z3 available to replay the proofs, trust
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   389
the SMT solver, or use certificates. See the documentation in the \emph{SMT}
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   390
theory (\texttt{\$ISABELLE\_HOME/src/HOL/SMT.thy}) for details.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   391
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   392
\item[$\bullet$] Try the \textit{blast} or \textit{auto} proof methods, passing
43010
a14cf580a5a5 readded Waldmeister as default to the documentation and other minor changes
blanchet
parents: 43008
diff changeset
   393
the necessary facts via \textbf{unfolding}, \textbf{using}, \textit{intro}{:},
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   394
\textit{elim}{:}, \textit{dest}{:}, or \textit{simp}{:}, as appropriate.
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   395
\end{enum}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   396
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   397
In some rare cases, Metis fails fairly quickly, and you get the error message
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   398
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   399
\prew
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   400
\slshape
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   401
Proof reconstruction failed.
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   402
\postw
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   403
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   404
This usually indicates that Sledgehammer found a type-incorrect proof.
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   405
Sledgehammer erases some type information to speed up the search. Try
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   406
Sledgehammer again with full type information: \textit{full\_types}
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   407
(\S\ref{problem-encoding}), or choose a specific type encoding with
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   408
\textit{type\_sys} (\S\ref{problem-encoding}). Older versions of Sledgehammer
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   409
were frequent victims of this problem. Now this should very seldom be an issue,
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   410
but if you notice many unsound proofs, contact the author at \authoremail.
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   411
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   412
\point{How can I tell whether a generated proof is sound?}
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   413
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   414
First, if Metis can reconstruct it, the proof is sound (modulo soundness of
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   415
Isabelle's inference kernel). If it fails or runs seemingly forever, you can try
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   416
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   417
\prew
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   418
\textbf{apply}~\textbf{--} \\
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   419
\textbf{sledgehammer} [\textit{type\_sys} = \textit{poly\_tags}] (\textit{metis\_facts})
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   420
\postw
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   421
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   422
where \textit{metis\_facts} is the list of facts appearing in the suggested
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   423
Metis call. The automatic provers should be able to re-find the proof very
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   424
quickly if it is sound, and the \textit{type\_sys} $=$ \textit{poly\_tags}
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   425
option (\S\ref{problem-encoding}) ensures that no unsound proofs are found.
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   426
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   427
The \textit{full\_types} option (\S\ref{problem-encoding}) can also be used
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   428
here, but it is unsound in extremely rare degenerate cases such as the
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   429
following:
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   430
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   431
\prew
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   432
\textbf{lemma} ``$\forall x\> y\Colon{'}\!a.\ x = y \,\Longrightarrow \exists f\> g\Colon\mathit{nat} \Rightarrow {'}\!a.\ f \not= g$'' \\
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   433
\textbf{sledgehammer} [\textit{full\_types}] (\textit{nat.distinct\/}(1))
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   434
\postw
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   435
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   436
\point{Which facts are passed to the automatic provers?}
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   437
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   438
The relevance filter assigns a score to every available fact (lemma, theorem,
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   439
definition, or axiom)\ based upon how many constants that fact shares with the
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   440
conjecture. This process iterates to include facts relevant to those just
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   441
accepted, but with a decay factor to ensure termination. The constants are
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   442
weighted to give unusual ones greater significance. The relevance filter copes
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   443
best when the conjecture contains some unusual constants; if all the constants
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   444
are common, it is unable to discriminate among the hundreds of facts that are
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   445
picked up. The relevance filter is also memoryless: It has no information about
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   446
how many times a particular fact has been used in a proof, and it cannot learn.
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   447
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   448
The number of facts included in a problem varies from prover to prover, since
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   449
some provers get overwhelmed more easily than others. You can show the number of
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   450
facts given using the \textit{verbose} option (\S\ref{output-format}) and the
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   451
actual facts using \textit{debug} (\S\ref{output-format}).
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   452
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   453
Sledgehammer is good at finding short proofs combining a handful of existing
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   454
lemmas. If you are looking for longer proofs, you must typically restrict the
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   455
number of facts, by setting the \textit{max\_relevant} option
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   456
(\S\ref{relevance-filter}) to, say, 50 or 100.
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   457
42996
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   458
You can also influence which facts are actually selected in a number of ways. If
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   459
you simply want to ensure that a fact is included, you can specify it using the
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   460
``$(\textit{add}{:}~\textit{my\_facts})$'' syntax. For example:
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   461
%
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   462
\prew
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   463
\textbf{sledgehammer} (\textit{add}: \textit{hd.simps} \textit{tl.simps})
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   464
\postw
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   465
%
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   466
The specified facts then replace the least relevant facts that would otherwise be
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   467
included; the other selected facts remain the same.
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   468
If you want to direct the selection in a particular direction, you can specify
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   469
the facts via \textbf{using}:
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   470
%
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   471
\prew
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   472
\textbf{using} \textit{hd.simps} \textit{tl.simps} \\
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   473
\textbf{sledgehammer}
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   474
\postw
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   475
%
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   476
The facts are then more likely to be selected than otherwise, and if they are
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   477
selected at iteration $j$ they also influence which facts are selected at
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   478
iterations $j + 1$, $j + 2$, etc. To give them even more weight, try
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   479
%
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   480
\prew
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   481
\textbf{using} \textit{hd.simps} \textit{tl.simps} \\
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   482
\textbf{apply}~\textbf{--} \\
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   483
\textbf{sledgehammer}
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   484
\postw
29be053ec75b document relevance filter a bit more
blanchet
parents: 42995
diff changeset
   485
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   486
\point{Why are the generated Isar proofs so ugly/detailed/broken?}
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   487
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   488
The current implementation is experimental and explodes exponentially in the
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   489
worst case. Work on a new implementation has begun. There is a large body of
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   490
research into transforming resolution proofs into natural deduction proofs (such
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   491
as Isar proofs), which we hope to leverage. In the meantime, a workaround is to
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   492
set the \textit{isar\_shrink\_factor} option (\S\ref{output-format}) to a larger
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   493
value or to try several provers and keep the nicest-looking proof.
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   494
43203
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   495
\point{What is metisFT?}
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   496
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   497
The \textit{metisFT} proof method is the fully-typed version of Metis. It is
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   498
much slower than \textit{metis}, but the proof search is fully typed, and it
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   499
also includes more powerful rules such as the axiom ``$x = \mathit{True}
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   500
\mathrel{\lor} x = \mathit{False}$'' for reasoning in higher-order places (e.g.,
43203
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   501
in set comprehensions). The method kicks in automatically as a fallback when
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   502
\textit{metis} fails, and it is sometimes generated by Sledgehammer instead of
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   503
\textit{metis} if the proof obviously requires type information or if
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   504
\textit{metis} failed when Sledgehammer preplayed the proof. (By default,
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   505
Sledgehammer tries to run \textit{metis} and/or \textit{metisFT} for 4 seconds
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   506
to ensure that the generated one-line proofs actually work and to display timing
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   507
information. This can be configured using the \textit{preplay\_timeout} option
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   508
(\S\ref{timeouts}).)
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   509
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   510
If you see the warning
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   511
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   512
\prew
43007
b48aa3492f0b minor doc adjustments
blanchet
parents: 43005
diff changeset
   513
\slshape
43203
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   514
Metis: Falling back on ``\textit{metisFT\/}''.
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   515
\postw
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   516
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   517
in a successful Metis proof, you can advantageously replace the \textit{metis}
43203
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   518
call with \textit{metisFT}.
42850
c8709be8a40f distinguish between a soft timeout (30 s by defalt) and a hard timeout (60 s), to let minimization-based provers (such as CVC3, Yices, and occasionally the other provers) do their job
blanchet
parents: 42846
diff changeset
   519
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   520
\point{Are generated proofs minimal?}
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   521
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   522
Automatic provers frequently use many more facts than are necessary.
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   523
Sledgehammer inclues a minimization tool that takes a set of facts returned by a
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   524
given prover and repeatedly calls the same prover or Metis with subsets of those
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   525
axioms in order to find a minimal set. Reducing the number of axioms typically
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   526
improves Metis's speed and success rate, while also removing superfluous clutter
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   527
from the proof scripts.
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   528
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   529
In earlier versions of Sledgehammer, generated proofs were accompanied by a
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   530
suggestion to invoke the minimization tool. This step is now performed
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   531
implicitly if it can be done in a reasonable amount of time (something that can
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   532
be guessed from the number of facts in the original proof and the time it took
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   533
to find it or replay it).
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   534
43054
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   535
In addition, some provers (notably CVC3, Satallax, and Yices) do not provide
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   536
proofs or sometimes provide incomplete proofs. The minimizer is then invoked to
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   537
find out which facts are actually needed from the (large) set of facts that was
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   538
initinally given to the prover. Finally, if a prover returns a proof with lots
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   539
of facts, the minimizer is invoked automatically since Metis would be unlikely
f1864c0bd165 update minimization documentation
blanchet
parents: 43053
diff changeset
   540
to re-find the proof.
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   541
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   542
\point{A strange error occurred---what should I do?}
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   543
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   544
Sledgehammer tries to give informative error messages. Please report any strange
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   545
error to the author at \authoremail. This applies double if you get the message
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   546
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   547
\prew
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   548
\slshape
42877
d7447b8c4265 updated FAQ
blanchet
parents: 42856
diff changeset
   549
The prover found a type-unsound proof involving ``\textit{foo}'',
43005
c96f06bffd90 merge timeout messages from several ATPs into one message to avoid clutter
blanchet
parents: 43002
diff changeset
   550
``\textit{bar}'', and ``\textit{baz}'' even though a supposedly type-sound
c96f06bffd90 merge timeout messages from several ATPs into one message to avoid clutter
blanchet
parents: 43002
diff changeset
   551
encoding was used (or, less likely, your axioms are inconsistent). You might
c96f06bffd90 merge timeout messages from several ATPs into one message to avoid clutter
blanchet
parents: 43002
diff changeset
   552
want to report this to the Isabelle developers.
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   553
\postw
42763
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   554
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   555
\point{Auto can solve it---why not Sledgehammer?}
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   556
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   557
Problems can be easy for \textit{auto} and difficult for automatic provers, but
e588d3e8ad91 added hints and FAQs
blanchet
parents: 42753
diff changeset
   558
the reverse is also true, so don't be discouraged if your first attempts fail.
39320
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   559
Because the system refers to all theorems known to Isabelle, it is particularly
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   560
suitable when your goal has a short proof from lemmas that you don't know about.
37517
19ba7ec5f1e3 steal some of http://isabelle.in.tum.de/sledgehammer.html and add it to the docs
blanchet
parents: 37498
diff changeset
   561
42883
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   562
\point{Why are there so many options?}
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   563
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   564
Sledgehammer's philosophy should work out of the box, without user guidance.
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   565
Many of the options are meant to be used mostly by the Sledgehammer developers
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   566
for experimentation purposes. Of course, feel free to experiment with them if
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   567
you are so inclined.
ec1ea24d49bc more FAQs
blanchet
parents: 42877
diff changeset
   568
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   569
\section{Command Syntax}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   570
\label{command-syntax}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   571
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   572
Sledgehammer can be invoked at any point when there is an open goal by entering
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   573
the \textbf{sledgehammer} command in the theory file. Its general syntax is as
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   574
follows:
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   575
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   576
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   577
\textbf{sledgehammer} \textit{subcommand\/$^?$ options\/$^?$ facts\_override\/$^?$ num\/$^?$}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   578
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   579
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   580
For convenience, Sledgehammer is also available in the ``Commands'' submenu of
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   581
the ``Isabelle'' menu in Proof General or by pressing the Emacs key sequence C-c
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   582
C-a C-s. This is equivalent to entering the \textbf{sledgehammer} command with
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   583
no arguments in the theory text.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   584
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   585
In the general syntax, the \textit{subcommand} may be any of the following:
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   586
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   587
\begin{enum}
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   588
\item[$\bullet$] \textbf{\textit{run} (the default):} Runs Sledgehammer on
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   589
subgoal number \textit{num} (1 by default), with the given options and facts.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   590
43008
bb212c2ad238 renamed "minimize" to "min" to make Sledgehammer output a little bit more concise
blanchet
parents: 43007
diff changeset
   591
\item[$\bullet$] \textbf{\textit{min}:} Attempts to minimize the provided facts
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   592
(specified in the \textit{facts\_override} argument) to obtain a simpler proof
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   593
involving fewer facts. The options and goal number are as for \textit{run}.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   594
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   595
\item[$\bullet$] \textbf{\textit{messages}:} Redisplays recent messages issued
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   596
by Sledgehammer. This allows you to examine results that might have been lost
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   597
due to Sledgehammer's asynchronous nature. The \textit{num} argument specifies a
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   598
limit on the number of messages to display (5 by default).
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   599
41727
ab3f6d76fb23 available_provers ~> supported_provers (for clarity)
blanchet
parents: 41724
diff changeset
   600
\item[$\bullet$] \textbf{\textit{supported\_provers}:} Prints the list of
41724
14d135c09bec transformed lie into truth
blanchet
parents: 41208
diff changeset
   601
automatic provers supported by Sledgehammer. See \S\ref{installation} and
14d135c09bec transformed lie into truth
blanchet
parents: 41208
diff changeset
   602
\S\ref{mode-of-operation} for more information on how to install automatic
14d135c09bec transformed lie into truth
blanchet
parents: 41208
diff changeset
   603
provers.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   604
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   605
\item[$\bullet$] \textbf{\textit{running\_provers}:} Prints information about
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   606
currently running automatic provers, including elapsed runtime and remaining
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   607
time until timeout.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   608
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   609
\item[$\bullet$] \textbf{\textit{kill\_provers}:} Terminates all running
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   610
automatic provers.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   611
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   612
\item[$\bullet$] \textbf{\textit{refresh\_tptp}:} Refreshes the list of remote
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   613
ATPs available at System\-On\-TPTP \cite{sutcliffe-2000}.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   614
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   615
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   616
Sledgehammer's behavior can be influenced by various \textit{options}, which can
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   617
be specified in brackets after the \textbf{sledgehammer} command. The
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   618
\textit{options} are a list of key--value pairs of the form ``[$k_1 = v_1,
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   619
\ldots, k_n = v_n$]''. For Boolean options, ``= \textit{true}'' is optional. For
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   620
example:
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   621
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   622
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   623
\textbf{sledgehammer} [\textit{isar\_proof}, \,\textit{timeout} = 120$\,s$]
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   624
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   625
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   626
Default values can be set using \textbf{sledgehammer\_\allowbreak params}:
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   627
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   628
\prew
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   629
\textbf{sledgehammer\_params} \textit{options}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   630
\postw
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   631
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   632
The supported options are described in \S\ref{option-reference}.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   633
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   634
The \textit{facts\_override} argument lets you alter the set of facts that go
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   635
through the relevance filter. It may be of the form ``(\textit{facts})'', where
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   636
\textit{facts} is a space-separated list of Isabelle facts (theorems, local
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   637
assumptions, etc.), in which case the relevance filter is bypassed and the given
39320
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   638
facts are used. It may also be of the form ``(\textit{add}:\ \textit{facts}$_1$)'',
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   639
``(\textit{del}:\ \textit{facts}$_2$)'', or ``(\textit{add}:\ \textit{facts}$_1$\
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   640
\textit{del}:\ \textit{facts}$_2$)'', where the relevance filter is instructed to
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   641
proceed as usual except that it should consider \textit{facts}$_1$
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   642
highly-relevant and \textit{facts}$_2$ fully irrelevant.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   643
39320
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   644
You can instruct Sledgehammer to run automatically on newly entered theorems by
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   645
enabling the ``Auto Sledgehammer'' option from the ``Isabelle'' menu in Proof
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   646
General. For automatic runs, only the first prover set using \textit{provers}
42736
8005fc9b65ec ensure that Auto Sledgehammer is run with full type information
blanchet
parents: 42724
diff changeset
   647
(\S\ref{mode-of-operation}) is considered, fewer facts are passed to the prover,
43038
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   648
\textit{slicing} (\S\ref{mode-of-operation}) is disabled, \textit{full\_types}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   649
(\S\ref{problem-encoding}) is enabled, \textit{verbose} (\S\ref{output-format})
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   650
and \textit{debug} (\S\ref{output-format}) are disabled, and \textit{timeout}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   651
(\S\ref{timeouts}) is superseded by the ``Auto Tools Time Limit'' in Proof
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   652
General's ``Isabelle'' menu. Sledgehammer's output is also more concise.
39320
5d578004be23 added Auto Sledgehammer docs
blanchet
parents: 39153
diff changeset
   653
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   654
\section{Option Reference}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   655
\label{option-reference}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   656
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   657
\def\defl{\{}
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   658
\def\defr{\}}
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   659
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   660
\def\flushitem#1{\item[]\noindent\kern-\leftmargin \textbf{#1}}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   661
\def\qty#1{$\left<\textit{#1}\right>$}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   662
\def\qtybf#1{$\mathbf{\left<\textbf{\textit{#1}}\right>}$}
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   663
\def\optrue#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{bool}$\bigr]$\enskip \defl\textit{true}\defr\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   664
\def\opfalse#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{bool}$\bigr]$\enskip \defl\textit{false}\defr\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   665
\def\opsmart#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{smart\_bool}$\bigr]$\enskip \defl\textit{smart}\defr\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   666
\def\opnodefault#1#2{\flushitem{\textit{#1} = \qtybf{#2}} \nopagebreak\\[\parskip]}
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   667
\def\opnodefaultbrk#1#2{\flushitem{$\bigl[$\textit{#1} =$\bigr]$ \qtybf{#2}} \nopagebreak\\[\parskip]}
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   668
\def\opdefault#1#2#3{\flushitem{\textit{#1} = \qtybf{#2}\enskip \defl\textit{#3}\defr} \nopagebreak\\[\parskip]}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   669
\def\oparg#1#2#3{\flushitem{\textit{#1} \qtybf{#2} = \qtybf{#3}} \nopagebreak\\[\parskip]}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   670
\def\opargbool#1#2#3{\flushitem{\textit{#1} \qtybf{#2} $\bigl[$= \qtybf{bool}$\bigr]$\hfill (neg.: \textit{#3})}\nopagebreak\\[\parskip]}
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   671
\def\opargboolorsmart#1#2#3{\flushitem{\textit{#1} \qtybf{#2} $\bigl[$= \qtybf{smart\_bool}$\bigr]$\hfill (neg.: \textit{#3})}\nopagebreak\\[\parskip]}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   672
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   673
Sledgehammer's options are categorized as follows:\ mode of operation
38984
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
   674
(\S\ref{mode-of-operation}), problem encoding (\S\ref{problem-encoding}),
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
   675
relevance filter (\S\ref{relevance-filter}), output format
43038
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   676
(\S\ref{output-format}), authentication (\S\ref{authentication}), and timeouts
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
   677
(\S\ref{timeouts}).
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   678
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   679
The descriptions below refer to the following syntactic quantities:
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   680
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   681
\begin{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   682
\item[$\bullet$] \qtybf{string}: A string.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   683
\item[$\bullet$] \qtybf{bool\/}: \textit{true} or \textit{false}.
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   684
\item[$\bullet$] \qtybf{smart\_bool\/}: \textit{true}, \textit{false}, or
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
   685
\textit{smart}.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   686
\item[$\bullet$] \qtybf{int\/}: An integer.
42724
4d6bcf846759 added "max_mono_instances" option to Sledgehammer and renamed old "monomorphize_limit" option
blanchet
parents: 42722
diff changeset
   687
%\item[$\bullet$] \qtybf{float\/}: A floating-point number (e.g., 2.5).
40343
4521d56aef63 use floating-point numbers for Sledgehammer's "thresholds" option rather than percentages;
blanchet
parents: 40341
diff changeset
   688
\item[$\bullet$] \qtybf{float\_pair\/}: A pair of floating-point numbers
4521d56aef63 use floating-point numbers for Sledgehammer's "thresholds" option rather than percentages;
blanchet
parents: 40341
diff changeset
   689
(e.g., 0.6 0.95).
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   690
\item[$\bullet$] \qtybf{smart\_int\/}: An integer or \textit{smart}.
43036
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   691
\item[$\bullet$] \qtybf{float\_or\_none\/}: A floating-point number (e.g., 60 or
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   692
0.5) expressing a number of seconds, or the keyword \textit{none} ($\infty$
0ef380310863 more Sledgehammer documentation updates
blanchet
parents: 43035
diff changeset
   693
seconds).
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   694
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   695
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   696
Default values are indicated in braces. Boolean options have a negated
38984
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
   697
counterpart (e.g., \textit{blocking} vs.\ \textit{non\_blocking}). When setting
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   698
Boolean options, ``= \textit{true}'' may be omitted.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   699
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   700
\subsection{Mode of Operation}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   701
\label{mode-of-operation}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   702
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   703
\begin{enum}
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   704
\opnodefaultbrk{provers}{string}
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   705
Specifies the automatic provers to use as a space-separated list (e.g.,
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   706
``\textit{e}~\textit{spass}~\textit{remote\_vampire}''). The following local
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
   707
provers are supported:
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   708
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   709
\begin{enum}
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   710
\item[$\bullet$] \textbf{\textit{cvc3}:} CVC3 is an SMT solver developed by
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   711
Clark Barrett, Cesare Tinelli, and their colleagues \cite{cvc3}. To use CVC3,
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   712
set the environment variable \texttt{CVC3\_SOLVER} to the complete path of the
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   713
executable, including the file name. Sledgehammer has been tested with version
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   714
2.2.
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   715
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   716
\item[$\bullet$] \textbf{\textit{e}:} E is a first-order resolution prover
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   717
developed by Stephan Schulz \cite{schulz-2002}. To use E, set the environment
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   718
variable \texttt{E\_HOME} to the directory that contains the \texttt{eproof}
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   719
executable, or install the prebuilt E package from Isabelle's download page. See
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   720
\S\ref{installation} for details.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   721
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   722
\item[$\bullet$] \textbf{\textit{spass}:} SPASS is a first-order resolution
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   723
prover developed by Christoph Weidenbach et al.\ \cite{weidenbach-et-al-2009}.
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   724
To use SPASS, set the environment variable \texttt{SPASS\_HOME} to the directory
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   725
that contains the \texttt{SPASS} executable, or install the prebuilt SPASS
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   726
package from Isabelle's download page. Sledgehammer requires version 3.5 or
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   727
above. See \S\ref{installation} for details.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   728
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   729
\item[$\bullet$] \textbf{\textit{yices}:} Yices is an SMT solver developed at
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   730
SRI \cite{yices}. To use Yices, set the environment variable
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   731
\texttt{YICES\_SOLVER} to the complete path of the executable, including the
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   732
file name. Sledgehammer has been tested with version 1.0.
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   733
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   734
\item[$\bullet$] \textbf{\textit{vampire}:} Vampire is a first-order resolution
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   735
prover developed by Andrei Voronkov and his colleagues
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   736
\cite{riazanov-voronkov-2002}. To use Vampire, set the environment variable
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   737
\texttt{VAMPIRE\_HOME} to the directory that contains the \texttt{vampire}
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   738
executable. Sledgehammer has been tested with versions 11, 0.6, and 1.0.
40942
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
   739
41740
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   740
\item[$\bullet$] \textbf{\textit{z3}:} Z3 is an SMT solver developed at
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   741
Microsoft Research \cite{z3}. To use Z3, set the environment variable
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   742
\texttt{Z3\_SOLVER} to the complete path of the executable, including the file
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   743
name, and set \texttt{Z3\_NON\_COMMERCIAL=yes} to confirm that you are a
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   744
noncommercial user. Sledgehammer has been tested with versions 2.7 to 2.18.
41740
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   745
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   746
\item[$\bullet$] \textbf{\textit{z3\_atp}:} This version of Z3 pretends to be an
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   747
ATP, exploiting Z3's undocumented support for the TPTP format. It is included
42442
036142bd0302 fixed typo in documentation
blanchet
parents: 42237
diff changeset
   748
for experimental purposes. It requires version 2.18 or above.
43053
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   749
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   750
\item[$\bullet$] \textbf{\textit{metis}:} Although it is much less powerful than
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   751
the external provers, Metis itself can be used for proof search.
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   752
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   753
\item[$\bullet$] \textbf{\textit{metisFT}:} Fully typed version of Metis.
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   754
\end{enum}
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   755
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   756
In addition, the following remote provers are supported:
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   757
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   758
\begin{enum}
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   759
\item[$\bullet$] \textbf{\textit{remote\_cvc3}:} The remote version of CVC3 runs
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   760
on servers at the TU M\"unchen (or wherever \texttt{REMOTE\_SMT\_URL} is set to
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   761
point).
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   762
38601
0da6db609c1f update docs
blanchet
parents: 38591
diff changeset
   763
\item[$\bullet$] \textbf{\textit{remote\_e}:} The remote version of E runs
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   764
on Geoff Sutcliffe's Miami servers \cite{sutcliffe-2000}.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   765
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   766
\item[$\bullet$] \textbf{\textit{remote\_leo2}:} LEO-II is an automatic
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   767
higher-order prover developed by Christoph Benzm\"uller et al. \cite{leo2}. The
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   768
remote version of LEO-II runs on Geoff Sutcliffe's Miami servers. In the current
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   769
setup, the problems given to LEO-II are only mildly higher-order.
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   770
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   771
\item[$\bullet$] \textbf{\textit{remote\_satallax}:} Satallax is an automatic
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   772
higher-order prover developed by Chad Brown et al. \cite{satallax}. The remote
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   773
version of Satallax runs on Geoff Sutcliffe's Miami servers. In the current
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   774
setup, the problems given to Satallax are only mildly higher-order.
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   775
38601
0da6db609c1f update docs
blanchet
parents: 38591
diff changeset
   776
\item[$\bullet$] \textbf{\textit{remote\_sine\_e}:} SInE-E is a metaprover
0da6db609c1f update docs
blanchet
parents: 38591
diff changeset
   777
developed by Kry\v stof Hoder \cite{sine} based on E. The remote version of
0da6db609c1f update docs
blanchet
parents: 38591
diff changeset
   778
SInE runs on Geoff Sutcliffe's Miami servers.
0da6db609c1f update docs
blanchet
parents: 38591
diff changeset
   779
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   780
\item[$\bullet$] \textbf{\textit{remote\_snark}:} SNARK is a first-order
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   781
resolution prover developed by Stickel et al.\ \cite{snark}. The remote version
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   782
of SNARK runs on Geoff Sutcliffe's Miami servers.
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   783
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   784
\item[$\bullet$] \textbf{\textit{remote\_tofof\_e}:} ToFoF-E is a metaprover
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   785
developed by Geoff Sutcliffe \cite{tofof} based on E running on his Miami
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   786
servers. This ATP supports a fragment of the TPTP many-typed first-order format
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   787
(TFF). It is supported primarily for experimenting with the
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   788
\textit{type\_sys} $=$ \textit{simple} option (\S\ref{problem-encoding}).
42940
f838586ebec2 document Waldmeister
blanchet
parents: 42888
diff changeset
   789
42945
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   790
\item[$\bullet$] \textbf{\textit{remote\_vampire}:} The remote version of
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   791
Vampire runs on Geoff Sutcliffe's Miami servers. Version 9 is used.
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   792
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   793
\item[$\bullet$] \textbf{\textit{remote\_waldmeister}:} Waldmeister is a unit
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   794
equality prover developed by Hillenbrand et al.\ \cite{waldmeister}. It can be
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   795
used to prove universally quantified equations using unconditional equations.
cb28abfde010 slightly improved documentation
blanchet
parents: 42940
diff changeset
   796
The remote version of Waldmeister runs on Geoff Sutcliffe's Miami servers.
41738
eb98c60a6cf0 added experimental "remote_z3_atp", Sutcliffe's TPTP-syntax-aware wrapper for Z3 -- allows to do head-to-head comparison of Sledgehammer's ATP translation and of Sascha's SMT translation
blanchet
parents: 41727
diff changeset
   797
40942
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
   798
\item[$\bullet$] \textbf{\textit{remote\_z3}:} The remote version of Z3 runs on
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
   799
servers at the TU M\"unchen (or wherever \texttt{REMOTE\_SMT\_URL} is set to
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
   800
point).
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   801
41740
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   802
\item[$\bullet$] \textbf{\textit{remote\_z3\_atp}:} The remote version of ``Z3
4b09f8b9e012 added "Z3 as an ATP" support to Sledgehammer locally
blanchet
parents: 41738
diff changeset
   803
as an ATP'' runs on Geoff Sutcliffe's Miami servers.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   804
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   805
40942
e08fa125c268 update documentation
blanchet
parents: 40689
diff changeset
   806
By default, Sledgehammer will run E, SPASS, Vampire, SInE-E, and Z3 (or whatever
42228
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   807
the SMT module's \textit{smt\_solver} configuration option is set to) in
40073
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   808
parallel---either locally or remotely, depending on the number of processor
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   809
cores available. For historical reasons, the default value of this option can be
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   810
overridden using the option ``Sledgehammer: Provers'' from the ``Isabelle'' menu
f167beebb527 added SMT solver to Sledgehammer docs
blanchet
parents: 40060
diff changeset
   811
in Proof General.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   812
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   813
It is a good idea to run several provers in parallel, although it could slow
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   814
down your machine. Running E, SPASS, and Vampire for 5~seconds yields a similar
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   815
success rate to running the most effective of these for 120~seconds
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   816
\cite{boehme-nipkow-2010}.
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   817
43053
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   818
For the \textit{min} subcommand, the default prover is \textit{metis}. If
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   819
several provers are set, the first one is used.
da6f459a7021 imported patch sledge_doc_metis_as_prover
blanchet
parents: 43038
diff changeset
   820
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   821
\opnodefault{prover}{string}
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   822
Alias for \textit{provers}.
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   823
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   824
%\opnodefault{atps}{string}
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   825
%Legacy alias for \textit{provers}.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   826
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   827
%\opnodefault{atp}{string}
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   828
%Legacy alias for \textit{provers}.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   829
38983
5261cf6b57ca update docs
blanchet
parents: 38940
diff changeset
   830
\opfalse{blocking}{non\_blocking}
5261cf6b57ca update docs
blanchet
parents: 38940
diff changeset
   831
Specifies whether the \textbf{sledgehammer} command should operate
5261cf6b57ca update docs
blanchet
parents: 38940
diff changeset
   832
synchronously. The asynchronous (non-blocking) mode lets the user start proving
5261cf6b57ca update docs
blanchet
parents: 38940
diff changeset
   833
the putative theorem manually while Sledgehammer looks for a proof, but it can
42995
e23f61546cf0 always run Sledgehammer synchronously in the jEdit interface (until the multithreading support for Proof General is ported)
blanchet
parents: 42964
diff changeset
   834
also be more confusing. Irrespective of the value of this option, Sledgehammer
e23f61546cf0 always run Sledgehammer synchronously in the jEdit interface (until the multithreading support for Proof General is ported)
blanchet
parents: 42964
diff changeset
   835
is always run synchronously for the new jEdit-based user interface or if
e23f61546cf0 always run Sledgehammer synchronously in the jEdit interface (until the multithreading support for Proof General is ported)
blanchet
parents: 42964
diff changeset
   836
\textit{debug} (\S\ref{output-format}) is enabled.
38983
5261cf6b57ca update docs
blanchet
parents: 38940
diff changeset
   837
42443
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   838
\optrue{slicing}{no\_slicing}
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   839
Specifies whether the time allocated to a prover should be sliced into several
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   840
segments, each of which has its own set of possibly prover-dependent options.
42446
d105b1309a8d rewording
blanchet
parents: 42443
diff changeset
   841
For SPASS and Vampire, the first slice tries the fast but incomplete
42443
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   842
set-of-support (SOS) strategy, whereas the second slice runs without it. For E,
42446
d105b1309a8d rewording
blanchet
parents: 42443
diff changeset
   843
up to three slices are tried, with different weighted search strategies and
42443
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   844
number of facts. For SMT solvers, several slices are tried with the same options
42446
d105b1309a8d rewording
blanchet
parents: 42443
diff changeset
   845
each time but fewer and fewer facts. According to benchmarks with a timeout of
d105b1309a8d rewording
blanchet
parents: 42443
diff changeset
   846
30 seconds, slicing is a valuable optimization, and you should probably leave it
d105b1309a8d rewording
blanchet
parents: 42443
diff changeset
   847
enabled unless you are conducting experiments. This option is implicitly
42443
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   848
disabled for (short) automatic runs.
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   849
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   850
\nopagebreak
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   851
{\small See also \textit{verbose} (\S\ref{output-format}).}
724e612ba248 implemented general slicing for ATPs, especially E 1.2w and above
blanchet
parents: 42442
diff changeset
   852
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   853
\opfalse{overlord}{no\_overlord}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   854
Specifies whether Sledgehammer should put its temporary files in
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   855
\texttt{\$ISA\-BELLE\_\allowbreak HOME\_\allowbreak USER}, which is useful for
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   856
debugging Sledgehammer but also unsafe if several instances of the tool are run
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   857
simultaneously. The files are identified by the prefix \texttt{prob\_}; you may
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   858
safely remove them after Sledgehammer has run.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   859
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   860
\nopagebreak
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   861
{\small See also \textit{debug} (\S\ref{output-format}).}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   862
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   863
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   864
\subsection{Problem Encoding}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   865
\label{problem-encoding}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   866
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   867
\begin{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   868
\opfalse{full\_types}{partial\_types}
42681
281cc069282c document monotonic type systems
blanchet
parents: 42591
diff changeset
   869
Specifies whether full type information is encoded in ATP problems. Enabling
42736
8005fc9b65ec ensure that Auto Sledgehammer is run with full type information
blanchet
parents: 42724
diff changeset
   870
this option prevents the discovery of type-incorrect proofs, but it can slow
8005fc9b65ec ensure that Auto Sledgehammer is run with full type information
blanchet
parents: 42724
diff changeset
   871
down the ATP slightly. This option is implicitly enabled for automatic runs. For
8005fc9b65ec ensure that Auto Sledgehammer is run with full type information
blanchet
parents: 42724
diff changeset
   872
historical reasons, the default value of this option can be overridden using the
8005fc9b65ec ensure that Auto Sledgehammer is run with full type information
blanchet
parents: 42724
diff changeset
   873
option ``Sledgehammer: Full Types'' from the ``Isabelle'' menu in Proof General.
42228
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   874
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   875
\opdefault{type\_sys}{string}{smart}
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   876
Specifies the type system to use in ATP problems. Some of the type systems are
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   877
unsound, meaning that they can give rise to spurious proofs (unreconstructible
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   878
using Metis). The supported type systems are listed below, with an indication of
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   879
their soundness in parentheses:
42228
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   880
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   881
\begin{enum}
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   882
\item[$\bullet$] \textbf{\textit{erased} (very unsound):} No type information is
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   883
supplied to the ATP. Types are simply erased.
42582
6321d0dc3d72 document new type system syntax
blanchet
parents: 42535
diff changeset
   884
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   885
\item[$\bullet$] \textbf{\textit{poly\_preds} (sound):} Types are encoded using
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   886
a predicate \textit{has\_\allowbreak type\/}$(\tau, t)$ that restricts the range
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   887
of bound variables. Constants are annotated with their types, supplied as extra
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   888
arguments, to resolve overloading.
42685
7a5116bd63b7 documentation tuning
blanchet
parents: 42683
diff changeset
   889
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   890
\item[$\bullet$] \textbf{\textit{poly\_tags} (sound):} Each term and subterm is
43002
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
   891
tagged with its type using a function $\mathit{type\_info\/}(\tau, t)$. This
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
   892
coincides with the encoding used by the \textit{metisFT} command.
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   893
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   894
\item[$\bullet$] \textbf{\textit{poly\_args} (unsound):}
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   895
Like for \textit{poly\_preds} constants are annotated with their types to
43002
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
   896
resolve overloading, but otherwise no type information is encoded. This
e88fde86e4c2 mention contributions from LCP and explain metis and metisFT encodings
blanchet
parents: 42996
diff changeset
   897
coincides with the encoding used by the \textit{metis} command (before it falls
43203
6c8170f8849e don't mention "metisX" so much in the docs -- it will go away soon
blanchet
parents: 43170
diff changeset
   898
back on \textit{metisFT}).
42685
7a5116bd63b7 documentation tuning
blanchet
parents: 42683
diff changeset
   899
42722
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   900
\item[$\bullet$]
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   901
\textbf{%
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   902
\textit{mono\_preds}, \textit{mono\_tags} (sound);
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   903
\textit{mono\_args} (unsound):} \\
42722
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   904
Similar to \textit{poly\_preds}, \textit{poly\_tags}, and \textit{poly\_args},
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   905
respectively, but the problem is additionally monomorphized, meaning that type
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   906
variables are instantiated with heuristically chosen ground types.
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   907
Monomorphization can simplify reasoning but also leads to larger fact bases,
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   908
which can slow down the ATPs.
42582
6321d0dc3d72 document new type system syntax
blanchet
parents: 42535
diff changeset
   909
42722
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   910
\item[$\bullet$]
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   911
\textbf{%
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   912
\textit{mangled\_preds},
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   913
\textit{mangled\_tags} (sound); \\
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   914
\textit{mangled\_args} (unsound):} \\
42722
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   915
Similar to
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   916
\textit{mono\_preds}, \textit{mono\_tags}, and \textit{mono\_args},
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   917
respectively but types are mangled in constant names instead of being supplied
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   918
as ground term arguments. The binary predicate $\mathit{has\_type\/}(\tau, t)$
626e292d22a7 renamed type systems for more consistency
blanchet
parents: 42685
diff changeset
   919
becomes a unary predicate $\mathit{has\_type\_}\tau(t)$, and the binary function
42589
9f7c48463645 restructured type systems some more -- the old naming schemes had "argshg diff |less" and "tagshg diff |less" as equivalent and didn't support a monomorphic version of "tags"
blanchet
parents: 42582
diff changeset
   920
$\mathit{type\_info\/}(\tau, t)$ becomes a unary function
9f7c48463645 restructured type systems some more -- the old naming schemes had "argshg diff |less" and "tagshg diff |less" as equivalent and didn't support a monomorphic version of "tags"
blanchet
parents: 42582
diff changeset
   921
$\mathit{type\_info\_}\tau(t)$.
9f7c48463645 restructured type systems some more -- the old naming schemes had "argshg diff |less" and "tagshg diff |less" as equivalent and didn't support a monomorphic version of "tags"
blanchet
parents: 42582
diff changeset
   922
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   923
\item[$\bullet$] \textbf{\textit{simple} (sound):} Use the prover's support for
42964
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   924
simple types if available; otherwise, fall back on \textit{mangled\_preds}. The
bf45fd2488a2 document primitive support for LEO-II and Satallax
blanchet
parents: 42945
diff changeset
   925
problem is monomorphized.
42681
281cc069282c document monotonic type systems
blanchet
parents: 42591
diff changeset
   926
281cc069282c document monotonic type systems
blanchet
parents: 42591
diff changeset
   927
\item[$\bullet$]
281cc069282c document monotonic type systems
blanchet
parents: 42591
diff changeset
   928
\textbf{%
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   929
\textit{poly\_preds}?, \textit{poly\_tags}?, \textit{mono\_preds}?, \textit{mono\_tags}?, \\
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   930
\textit{mangled\_preds}?, \textit{mangled\_tags}?, \textit{simple}? (quasi-sound):} \\
42743
b81127eb79f3 reflect option renaming in doc + do not document the type systems poly_preds? and poly_tags?, since they are virtually identical to the non-? versions
blanchet
parents: 42736
diff changeset
   931
The type systems \textit{poly\_preds}, \textit{poly\_tags},
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   932
\textit{mono\_preds}, \textit{mono\_tags}, \textit{mangled\_preds},
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   933
\textit{mangled\_tags}, and \textit{simple} are fully typed and sound. For each
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   934
of these, Sledgehammer also provides a lighter, virtually sound variant
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   935
identified by a question mark (`{?}')\ that detects and erases monotonic types,
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   936
notably infinite types. (For \textit{simple}, the types are not actually erased
42856
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   937
but rather replaced by a shared uniform type of individuals.)
42582
6321d0dc3d72 document new type system syntax
blanchet
parents: 42535
diff changeset
   938
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   939
\item[$\bullet$]
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   940
\textbf{%
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   941
\textit{poly\_preds}!, \textit{poly\_tags}!, \textit{mono\_preds}!, \textit{mono\_tags}!, \\
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   942
\textit{mangled\_preds}!, \textit{mangled\_tags}!, \textit{simple}! \\
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   943
(mildly unsound):} \\
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   944
The type systems \textit{poly\_preds}, \textit{poly\_tags},
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   945
\textit{mono\_preds}, \textit{mono\_tags}, \textit{mangled\_preds},
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   946
\textit{mangled\_tags}, and \textit{simple} also admit a mildly unsound (but
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   947
very efficient) variant identified by an exclamation mark (`{!}') that detects
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   948
and erases erases all types except those that are clearly finite (e.g.,
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   949
\textit{bool}). (For \textit{simple}, the types are not actually erased but
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   950
rather replaced by a shared uniform type of individuals.)
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   951
42237
e645d7255bd4 renamed "const_args" option value to "args"
blanchet
parents: 42234
diff changeset
   952
\item[$\bullet$] \textbf{\textit{smart}:} If \textit{full\_types} is enabled,
42887
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   953
uses a sound or virtually sound encoding; otherwise, uses any encoding. The actual
771be1dcfef6 document new type system and soundness properties of the different systems
blanchet
parents: 42884
diff changeset
   954
encoding used depends on the ATP and should be the most efficient for that ATP.
42228
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   955
\end{enum}
3bf2eea43dac document "type_sys" option
blanchet
parents: 42180
diff changeset
   956
42856
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   957
In addition, all the \textit{preds} and \textit{tags} type systems are available
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   958
in two variants, a lightweight and a heavyweight variant. The lightweight
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   959
variants are generally more efficient and are the default; the heavyweight
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   960
variants are identified by a \textit{\_heavy} suffix (e.g.,
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   961
\textit{mangled\_preds\_heavy}{?}).
42523
08346ea46a59 added (without implementation yet) new type encodings for Sledgehammer/ATP
blanchet
parents: 42511
diff changeset
   962
42856
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   963
For SMT solvers and ToFoF-E, the type system is always \textit{simple},
9eef1dc200a8 updated option documentation
blanchet
parents: 42850
diff changeset
   964
irrespective of the value of this option.
42888
4da581400b69 added see also
blanchet
parents: 42887
diff changeset
   965
4da581400b69 added see also
blanchet
parents: 42887
diff changeset
   966
\nopagebreak
4da581400b69 added see also
blanchet
parents: 42887
diff changeset
   967
{\small See also \textit{max\_new\_mono\_instances} (\S\ref{relevance-filter})
4da581400b69 added see also
blanchet
parents: 42887
diff changeset
   968
and \textit{max\_mono\_iters} (\S\ref{relevance-filter}).}
43065
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   969
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   970
\opsmart{explicit\_apply}{implicit\_apply}
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   971
Specifies whether function application should be encoded as an explicit
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   972
``apply'' operator in ATP problems. If the option is set to \textit{false}, each
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   973
function will be directly applied to as many arguments as possible. Disabling
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   974
this option can sometimes prevent the discovery of higher-order proofs.
38591
7400530ab1d0 update docs
blanchet
parents: 38063
diff changeset
   975
\end{enum}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   976
38591
7400530ab1d0 update docs
blanchet
parents: 38063
diff changeset
   977
\subsection{Relevance Filter}
7400530ab1d0 update docs
blanchet
parents: 38063
diff changeset
   978
\label{relevance-filter}
7400530ab1d0 update docs
blanchet
parents: 38063
diff changeset
   979
7400530ab1d0 update docs
blanchet
parents: 38063
diff changeset
   980
\begin{enum}
40343
4521d56aef63 use floating-point numbers for Sledgehammer's "thresholds" option rather than percentages;
blanchet
parents: 40341
diff changeset
   981
\opdefault{relevance\_thresholds}{float\_pair}{\upshape 0.45~0.85}
38746
9b465a288c62 update docs
blanchet
parents: 38741
diff changeset
   982
Specifies the thresholds above which facts are considered relevant by the
9b465a288c62 update docs
blanchet
parents: 38741
diff changeset
   983
relevance filter. The first threshold is used for the first iteration of the
9b465a288c62 update docs
blanchet
parents: 38741
diff changeset
   984
relevance filter and the second threshold is used for the last iteration (if it
9b465a288c62 update docs
blanchet
parents: 38741
diff changeset
   985
is reached). The effective threshold is quadratically interpolated for the other
40343
4521d56aef63 use floating-point numbers for Sledgehammer's "thresholds" option rather than percentages;
blanchet
parents: 40341
diff changeset
   986
iterations. Each threshold ranges from 0 to 1, where 0 means that all theorems
4521d56aef63 use floating-point numbers for Sledgehammer's "thresholds" option rather than percentages;
blanchet
parents: 40341
diff changeset
   987
are relevant and 1 only theorems that refer to previously seen constants.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
   988
43065
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   989
\opdefault{max\_relevant}{smart\_int}{smart}
38746
9b465a288c62 update docs
blanchet
parents: 38741
diff changeset
   990
Specifies the maximum number of facts that may be returned by the relevance
9b465a288c62 update docs
blanchet
parents: 38741
diff changeset
   991
filter. If the option is set to \textit{smart}, it is set to a value that was
40059
6ad9081665db use consistent terminology in Sledgehammer: "prover = ATP or SMT solver or ..."
blanchet
parents: 39335
diff changeset
   992
empirically found to be appropriate for the prover. A typical value would be
43065
d1e547e25be2 document new explicit apply
blanchet
parents: 43054
diff changeset
   993
250.
42180
a6c141925a8a added monomorphization option to Sledgehammer ATPs -- this looks promising but is still off by default
blanchet
parents: 41747
diff changeset
   994
42884
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   995
\opdefault{max\_new\_mono\_instances}{int}{\upshape 400}
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   996
Specifies the maximum number of monomorphic instances to generate beyond
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   997
\textit{max\_relevant}. The higher this limit is, the more monomorphic instances
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   998
are potentially generated. Whether monomorphization takes place depends on the
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
   999
type system used.
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1000
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1001
\nopagebreak
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1002
{\small See also \textit{type\_sys} (\S\ref{problem-encoding}).}
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1003
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1004
\opdefault{max\_mono\_iters}{int}{\upshape 3}
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1005
Specifies the maximum number of iterations for the monomorphization fixpoint
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1006
construction. The higher this limit is, the more monomorphic instances are
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1007
potentially generated. Whether monomorphization takes place depends on the
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1008
type system used.
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1009
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1010
\nopagebreak
75c94e3319ae more doc fiddling
blanchet
parents: 42883
diff changeset
  1011
{\small See also \textit{type\_sys} (\S\ref{problem-encoding}).}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1012
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1013
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1014
\subsection{Output Format}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1015
\label{output-format}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1016
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1017
\begin{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1018
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1019
\opfalse{verbose}{quiet}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1020
Specifies whether the \textbf{sledgehammer} command should explain what it does.
41208
1b28c43a7074 make "debug" imply "blocking", since in blocking mode the exceptions flow through and are more instructive
blanchet
parents: 40942
diff changeset
  1021
This option is implicitly disabled for automatic runs.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1022
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1023
\opfalse{debug}{no\_debug}
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
  1024
Specifies whether Sledgehammer should display additional debugging information
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
  1025
beyond what \textit{verbose} already displays. Enabling \textit{debug} also
41208
1b28c43a7074 make "debug" imply "blocking", since in blocking mode the exceptions flow through and are more instructive
blanchet
parents: 40942
diff changeset
  1026
enables \textit{verbose} and \textit{blocking} (\S\ref{mode-of-operation})
1b28c43a7074 make "debug" imply "blocking", since in blocking mode the exceptions flow through and are more instructive
blanchet
parents: 40942
diff changeset
  1027
behind the scenes. The \textit{debug} option is implicitly disabled for
1b28c43a7074 make "debug" imply "blocking", since in blocking mode the exceptions flow through and are more instructive
blanchet
parents: 40942
diff changeset
  1028
automatic runs.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1029
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1030
\nopagebreak
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1031
{\small See also \textit{overlord} (\S\ref{mode-of-operation}).}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1032
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1033
\opfalse{isar\_proof}{no\_isar\_proof}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1034
Specifies whether Isar proofs should be output in addition to one-liner
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1035
\textit{metis} proofs. Isar proof construction is still experimental and often
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1036
fails; however, they are usually faster and sometimes more robust than
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1037
\textit{metis} proofs.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1038
40343
4521d56aef63 use floating-point numbers for Sledgehammer's "thresholds" option rather than percentages;
blanchet
parents: 40341
diff changeset
  1039
\opdefault{isar\_shrink\_factor}{int}{\upshape 1}
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1040
Specifies the granularity of the Isar proof. A value of $n$ indicates that each
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1041
Isar proof step should correspond to a group of up to $n$ consecutive proof
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1042
steps in the ATP proof.
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1043
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1044
38984
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1045
\subsection{Authentication}
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1046
\label{authentication}
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1047
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1048
\begin{enum}
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1049
\opnodefault{expect}{string}
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1050
Specifies the expected outcome, which must be one of the following:
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1051
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1052
\begin{enum}
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
  1053
\item[$\bullet$] \textbf{\textit{some}:} Sledgehammer found a (potentially
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
  1054
unsound) proof.
38984
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1055
\item[$\bullet$] \textbf{\textit{none}:} Sledgehammer found no proof.
43014
0dca147765f4 minor fixes to Sledgehammer docs
blanchet
parents: 43010
diff changeset
  1056
\item[$\bullet$] \textbf{\textit{timeout}:} Sledgehammer timed out.
40203
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
  1057
\item[$\bullet$] \textbf{\textit{unknown}:} Sledgehammer encountered some
aff7d1471b62 "Nitpick" -> "Sledgehammer";
blanchet
parents: 40073
diff changeset
  1058
problem.
38984
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1059
\end{enum}
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1060
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1061
Sledgehammer emits an error (if \textit{blocking} is enabled) or a warning
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1062
(otherwise) if the actual outcome differs from the expected outcome. This option
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1063
is useful for regression testing.
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1064
ca7ac998bb36 update docs
blanchet
parents: 38983
diff changeset
  1065
\nopagebreak
43038
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1066
{\small See also \textit{blocking} (\S\ref{mode-of-operation}) and
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1067
\textit{timeout} (\S\ref{timeouts}).}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1068
\end{enum}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1069
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1070
\subsection{Timeouts}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1071
\label{timeouts}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1072
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1073
\begin{enum}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1074
\opdefault{timeout}{float\_or\_none}{\upshape 30}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1075
Specifies the maximum number of seconds that the automatic provers should spend
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1076
searching for a proof. This excludes problem preparation and is a soft limit.
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1077
For historical reasons, the default value of this option can be overridden using
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1078
the option ``Sledgehammer: Time Limit'' from the ``Isabelle'' menu in Proof
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1079
General.
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1080
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1081
\opdefault{preplay\_timeout}{float\_or\_none}{\upshape 4}
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1082
Specifies the maximum number of seconds that Metis should be spent trying to
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1083
``preplay'' the found proof. If this option is set to 0, no preplaying takes
07ebc2398731 new timeout section (cf. Nitpick manual)
blanchet
parents: 43036
diff changeset
  1084
place, and no timing information is displayed next to the suggested Metis calls.
36926
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1085
\end{enum}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1086
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1087
\let\em=\sl
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1088
\bibliography{../manual}{}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1089
\bibliographystyle{abbrv}
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1090
90bb12cf8e36 added Sledgehammer manual;
blanchet
parents:
diff changeset
  1091
\end{document}