doc-src/Sledgehammer/sledgehammer.tex
author blanchet
Tue, 08 Feb 2011 16:10:10 +0100
changeset 42591 ab3f6d76fb23
parent 42588 14d135c09bec
child 42609 eb98c60a6cf0
permissions -rw-r--r--
available_provers ~> supported_provers (for clarity)
blanchet@36918
     1
\documentclass[a4paper,12pt]{article}
blanchet@36918
     2
\usepackage[T1]{fontenc}
blanchet@36918
     3
\usepackage{amsmath}
blanchet@36918
     4
\usepackage{amssymb}
blanchet@36918
     5
\usepackage[english,french]{babel}
blanchet@36918
     6
\usepackage{color}
blanchet@36918
     7
\usepackage{footmisc}
blanchet@36918
     8
\usepackage{graphicx}
blanchet@36918
     9
%\usepackage{mathpazo}
blanchet@36918
    10
\usepackage{multicol}
blanchet@36918
    11
\usepackage{stmaryrd}
blanchet@36918
    12
%\usepackage[scaled=.85]{beramono}
blanchet@40937
    13
\usepackage{../isabelle,../iman,../pdfsetup}
blanchet@36918
    14
blanchet@36918
    15
%\oddsidemargin=4.6mm
blanchet@36918
    16
%\evensidemargin=4.6mm
blanchet@36918
    17
%\textwidth=150mm
blanchet@36918
    18
%\topmargin=4.6mm
blanchet@36918
    19
%\headheight=0mm
blanchet@36918
    20
%\headsep=0mm
blanchet@36918
    21
%\textheight=234mm
blanchet@36918
    22
blanchet@36918
    23
\def\Colon{\mathord{:\mkern-1.5mu:}}
blanchet@36918
    24
%\def\lbrakk{\mathopen{\lbrack\mkern-3.25mu\lbrack}}
blanchet@36918
    25
%\def\rbrakk{\mathclose{\rbrack\mkern-3.255mu\rbrack}}
blanchet@36918
    26
\def\lparr{\mathopen{(\mkern-4mu\mid}}
blanchet@36918
    27
\def\rparr{\mathclose{\mid\mkern-4mu)}}
blanchet@36918
    28
blanchet@36918
    29
\def\unk{{?}}
blanchet@36918
    30
\def\undef{(\lambda x.\; \unk)}
blanchet@36918
    31
%\def\unr{\textit{others}}
blanchet@36918
    32
\def\unr{\ldots}
blanchet@36918
    33
\def\Abs#1{\hbox{\rm{\flqq}}{\,#1\,}\hbox{\rm{\frqq}}}
blanchet@36918
    34
\def\Q{{\smash{\lower.2ex\hbox{$\scriptstyle?$}}}}
blanchet@36918
    35
blanchet@36918
    36
\urlstyle{tt}
blanchet@36918
    37
blanchet@36918
    38
\begin{document}
blanchet@36918
    39
blanchet@36918
    40
\selectlanguage{english}
blanchet@36918
    41
blanchet@36918
    42
\title{\includegraphics[scale=0.5]{isabelle_sledgehammer} \\[4ex]
blanchet@36918
    43
Hammering Away \\[\smallskipamount]
blanchet@36918
    44
\Large A User's Guide to Sledgehammer for Isabelle/HOL}
blanchet@36918
    45
\author{\hbox{} \\
blanchet@36918
    46
Jasmin Christian Blanchette \\
blanchet@36918
    47
{\normalsize Institut f\"ur Informatik, Technische Universit\"at M\"unchen} \\
blanchet@36918
    48
\hbox{}}
blanchet@36918
    49
blanchet@36918
    50
\maketitle
blanchet@36918
    51
blanchet@36918
    52
\tableofcontents
blanchet@36918
    53
blanchet@36918
    54
\setlength{\parskip}{.7em plus .2em minus .1em}
blanchet@36918
    55
\setlength{\parindent}{0pt}
blanchet@36918
    56
\setlength{\abovedisplayskip}{\parskip}
blanchet@36918
    57
\setlength{\abovedisplayshortskip}{.9\parskip}
blanchet@36918
    58
\setlength{\belowdisplayskip}{\parskip}
blanchet@36918
    59
\setlength{\belowdisplayshortskip}{.9\parskip}
blanchet@36918
    60
blanchet@36918
    61
% General-purpose enum environment with correct spacing
blanchet@36918
    62
\newenvironment{enum}%
blanchet@36918
    63
    {\begin{list}{}{%
blanchet@36918
    64
        \setlength{\topsep}{.1\parskip}%
blanchet@36918
    65
        \setlength{\partopsep}{.1\parskip}%
blanchet@36918
    66
        \setlength{\itemsep}{\parskip}%
blanchet@36918
    67
        \advance\itemsep by-\parsep}}
blanchet@36918
    68
    {\end{list}}
blanchet@36918
    69
blanchet@36918
    70
\def\pre{\begingroup\vskip0pt plus1ex\advance\leftskip by\leftmargin
blanchet@36918
    71
\advance\rightskip by\leftmargin}
blanchet@36918
    72
\def\post{\vskip0pt plus1ex\endgroup}
blanchet@36918
    73
blanchet@36918
    74
\def\prew{\pre\advance\rightskip by-\leftmargin}
blanchet@36918
    75
\def\postw{\post}
blanchet@36918
    76
blanchet@36918
    77
\section{Introduction}
blanchet@36918
    78
\label{introduction}
blanchet@36918
    79
blanchet@36918
    80
Sledgehammer is a tool that applies first-order automatic theorem provers (ATPs)
blanchet@41190
    81
and satisfiability-modulo-theories (SMT) solvers on the current goal. The
blanchet@40254
    82
supported ATPs are E \cite{schulz-2002}, SPASS \cite{weidenbach-et-al-2009},
blanchet@40254
    83
Vampire \cite{riazanov-voronkov-2002}, SInE-E \cite{sine}, and SNARK
blanchet@40254
    84
\cite{snark}. The ATPs are run either locally or remotely via the
blanchet@40254
    85
System\-On\-TPTP web service \cite{sutcliffe-2000}. In addition to the ATPs, the
blanchet@41190
    86
SMT solvers Z3 \cite{z3} is used, and you can tell Sledgehammer to try Yices
blanchet@41190
    87
\cite{yices} and CVC3 \cite{cvc3} as well.
blanchet@36918
    88
blanchet@40254
    89
The problem passed to the automatic provers consists of your current goal
blanchet@40254
    90
together with a heuristic selection of hundreds of facts (theorems) from the
blanchet@40254
    91
current theory context, filtered by relevance. Because jobs are run in the
blanchet@40254
    92
background, you can continue to work on your proof by other means. Provers can
blanchet@40254
    93
be run in parallel. Any reply (which may arrive half a minute later) will appear
blanchet@40254
    94
in the Proof General response buffer.
blanchet@37517
    95
blanchet@40254
    96
The result of a successful proof search is some source text that usually (but
blanchet@40254
    97
not always) reconstructs the proof within Isabelle. For ATPs, the reconstructed
blanchet@40254
    98
proof relies on the general-purpose Metis prover \cite{metis}, which is fully
blanchet@40254
    99
integrated into Isabelle/HOL, with explicit inferences going through the kernel.
blanchet@40254
   100
Thus its results are correct by construction.
blanchet@36918
   101
blanchet@39566
   102
In this manual, we will explicitly invoke the \textbf{sledgehammer} command.
blanchet@39566
   103
Sledgehammer also provides an automatic mode that can be enabled via the
blanchet@39566
   104
``Auto Sledgehammer'' option from the ``Isabelle'' menu in Proof General. In
blanchet@39566
   105
this mode, Sledgehammer is run on every newly entered theorem. The time limit
blanchet@39566
   106
for Auto Sledgehammer and other automatic tools can be set using the ``Auto
blanchet@39566
   107
Tools Time Limit'' option.
blanchet@39566
   108
blanchet@36918
   109
\newbox\boxA
blanchet@36918
   110
\setbox\boxA=\hbox{\texttt{nospam}}
blanchet@36918
   111
blanchet@40937
   112
To run Sledgehammer, you must make sure that the theory \textit{Sledgehammer} is
blanchet@40937
   113
imported---this is rarely a problem in practice since it is part of
blanchet@40937
   114
\textit{Main}. Examples of Sledgehammer use can be found in Isabelle's
blanchet@36918
   115
\texttt{src/HOL/Metis\_Examples} directory.
blanchet@36918
   116
Comments and bug reports concerning Sledgehammer or this manual should be
blanchet@36918
   117
directed to
blanchet@36918
   118
\texttt{blan{\color{white}nospam}\kern-\wd\boxA{}chette@\allowbreak
blanchet@36918
   119
in.\allowbreak tum.\allowbreak de}.
blanchet@36918
   120
blanchet@36918
   121
\vskip2.5\smallskipamount
blanchet@36918
   122
blanchet@36918
   123
%\textbf{Acknowledgment.} The author would like to thank Mark Summerfield for
blanchet@36918
   124
%suggesting several textual improvements.
blanchet@36918
   125
blanchet@36918
   126
\section{Installation}
blanchet@36918
   127
\label{installation}
blanchet@36918
   128
blanchet@36918
   129
Sledgehammer is part of Isabelle, so you don't need to install it. However, it
blanchet@40254
   130
relies on third-party automatic theorem provers (ATPs) and SAT solvers.
blanchet@40254
   131
Currently, E, SPASS, and Vampire can be run locally; in addition, E, Vampire,
blanchet@40254
   132
SInE-E, and SNARK are available remotely via SystemOnTPTP \cite{sutcliffe-2000}.
blanchet@40254
   133
If you want better performance, you should install E and SPASS locally.
blanchet@36918
   134
blanchet@38289
   135
There are three main ways to install ATPs on your machine:
blanchet@36918
   136
blanchet@36918
   137
\begin{enum}
blanchet@36918
   138
\item[$\bullet$] If you installed an official Isabelle package with everything
blanchet@36918
   139
inside, it should already include properly setup executables for E and SPASS,
blanchet@38289
   140
ready to use.%
blanchet@38289
   141
\footnote{Vampire's license prevents us from doing the same for this otherwise
blanchet@38289
   142
wonderful tool.}
blanchet@36918
   143
blanchet@38289
   144
\item[$\bullet$] Alternatively, you can download the Isabelle-aware E and SPASS
blanchet@36918
   145
binary packages from Isabelle's download page. Extract the archives, then add a
blanchet@40444
   146
line to your \texttt{\char`\~/.isabelle/etc/components} file with the absolute
blanchet@40444
   147
path to E or SPASS. For example, if the \texttt{components} does not exist yet
blanchet@40444
   148
and you extracted SPASS to \texttt{/usr/local/spass-3.7}, create the
blanchet@40444
   149
\texttt{components} file with the single line
blanchet@36918
   150
blanchet@36918
   151
\prew
blanchet@36918
   152
\texttt{/usr/local/spass-3.7}
blanchet@36918
   153
\postw
blanchet@36918
   154
blanchet@38289
   155
in it.
blanchet@38289
   156
blanchet@38289
   157
\item[$\bullet$] If you prefer to build E or SPASS yourself, or obtained a
blanchet@38289
   158
Vampire executable from somewhere (e.g., \url{http://www.vprover.org/}),
blanchet@38289
   159
set the environment variable \texttt{E\_HOME}, \texttt{SPASS\_HOME}, or
blanchet@38289
   160
\texttt{VAMPIRE\_HOME} to the directory that contains the \texttt{eproof},
blanchet@38309
   161
\texttt{SPASS}, or \texttt{vampire} executable. Sledgehammer has been tested
blanchet@38309
   162
with E 1.0 and 1.2, SPASS 3.5 and 3.7, and Vampire 1.0%
blanchet@38309
   163
\footnote{Following the rewrite of Vampire, the counter for version numbers was
blanchet@38309
   164
reset to 0; hence the new Vampire 1.0 is more recent than Vampire 11.5.}%
blanchet@38309
   165
. Since the ATPs' output formats are neither documented nor stable, other
blanchet@38309
   166
versions of the ATPs might or might not work well with Sledgehammer.
blanchet@36918
   167
\end{enum}
blanchet@36918
   168
blanchet@36918
   169
To check whether E and SPASS are installed, follow the example in
blanchet@36918
   170
\S\ref{first-steps}.
blanchet@36918
   171
blanchet@37517
   172
Remote ATP invocation via the SystemOnTPTP web service requires Perl with the
blanchet@39388
   173
World Wide Web Library (\texttt{libwww-perl}) installed. If you must use a proxy
blanchet@39388
   174
server to access the Internet, set the \texttt{http\_proxy} environment variable
blanchet@39389
   175
to the proxy, either in the environment in which Isabelle is launched or in your
blanchet@39389
   176
\texttt{\char`\~/.isabelle/etc/settings} file. Here are a few examples:
blanchet@39388
   177
blanchet@39388
   178
\prew
blanchet@39389
   179
\texttt{http\_proxy=http://proxy.example.org} \\
blanchet@39389
   180
\texttt{http\_proxy=http://proxy.example.org:8080} \\
blanchet@39389
   181
\texttt{http\_proxy=http://joeblow:pAsSwRd@proxy.example.org}
blanchet@39388
   182
\postw
blanchet@37517
   183
blanchet@36918
   184
\section{First Steps}
blanchet@36918
   185
\label{first-steps}
blanchet@36918
   186
blanchet@36918
   187
To illustrate Sledgehammer in context, let us start a theory file and
blanchet@36918
   188
attempt to prove a simple lemma:
blanchet@36918
   189
blanchet@36918
   190
\prew
blanchet@36918
   191
\textbf{theory}~\textit{Scratch} \\
blanchet@36918
   192
\textbf{imports}~\textit{Main} \\
blanchet@36918
   193
\textbf{begin} \\[2\smallskipamount]
blanchet@36918
   194
%
blanchet@36918
   195
\textbf{lemma} ``$[a] = [b] \,\longleftrightarrow\, a = b$'' \\
blanchet@36918
   196
\textbf{sledgehammer}
blanchet@36918
   197
\postw
blanchet@36918
   198
blanchet@37517
   199
Instead of issuing the \textbf{sledgehammer} command, you can also find
blanchet@37517
   200
Sledgehammer in the ``Commands'' submenu of the ``Isabelle'' menu in Proof
blanchet@37517
   201
General or press the Emacs key sequence C-c C-a C-s.
blanchet@37517
   202
Either way, Sledgehammer produces the following output after a few seconds:
blanchet@36918
   203
blanchet@36918
   204
\prew
blanchet@36918
   205
\slshape
blanchet@40241
   206
Sledgehammer: ``\textit{e}'' for subgoal 1: \\
blanchet@36918
   207
$([a] = [b]) = (a = b)$ \\
blanchet@36918
   208
Try this command: \textbf{by} (\textit{metis hd.simps}). \\
blanchet@38289
   209
To minimize the number of lemmas, try this: \\
blanchet@40240
   210
\textbf{sledgehammer} \textit{minimize} [\textit{prover} = \textit{e}] (\textit{hd.simps}). \\[3\smallskipamount]
blanchet@36918
   211
%
blanchet@40241
   212
Sledgehammer: ``\textit{spass}'' for subgoal 1: \\
blanchet@36918
   213
$([a] = [b]) = (a = b)$ \\
blanchet@36918
   214
Try this command: \textbf{by} (\textit{metis insert\_Nil last\_ConsL}). \\
blanchet@38289
   215
To minimize the number of lemmas, try this: \\
blanchet@40240
   216
\textbf{sledgehammer} \textit{minimize} [\textit{prover} = \textit{spass}] (\textit{insert\_Nil last\_ConsL}). \\[3\smallskipamount]
blanchet@36918
   217
%
blanchet@40254
   218
Sledgehammer: ``\textit{vampire}'' for subgoal 1: \\
blanchet@36918
   219
$([a] = [b]) = (a = b)$ \\
blanchet@40254
   220
Try this command: \textbf{by} (\textit{metis eq\_commute last\_snoc}) \\
blanchet@38289
   221
To minimize the number of lemmas, try this: \\
blanchet@40254
   222
\textbf{sledgehammer} \textit{minimize} [\textit{prover} = \textit{vampire}]~(\textit{eq\_commute last\_snoc}). \\[3\smallskipamount]
blanchet@40254
   223
%
blanchet@40254
   224
Sledgehammer: ``\textit{remote\_sine\_e}'' for subgoal 1: \\
blanchet@40254
   225
$([a] = [b]) = (a = b)$ \\
blanchet@40254
   226
Try this command: \textbf{by} (\textit{metis hd.simps}) \\
blanchet@40254
   227
To minimize the number of lemmas, try this: \\
blanchet@40444
   228
\textbf{sledgehammer} \textit{minimize} [\textit{prover} = \textit{remote\_sine\_e}]~(\textit{hd.simps}).
blanchet@41190
   229
%
blanchet@41190
   230
Sledgehammer: ``\textit{remote\_z3}'' for subgoal 1: \\
blanchet@41190
   231
$([a] = [b]) = (a = b)$ \\
blanchet@41190
   232
Try this command: \textbf{by} (\textit{metis hd.simps}) \\
blanchet@41190
   233
To minimize the number of lemmas, try this: \\
blanchet@41190
   234
\textbf{sledgehammer} \textit{minimize} [\textit{prover} = \textit{remote\_sine\_e}]~(\textit{hd.simps}).
blanchet@36918
   235
\postw
blanchet@36918
   236
blanchet@41190
   237
Sledgehammer ran E, SPASS, Vampire, SInE-E, and Z3 in parallel. Depending on
blanchet@41190
   238
which provers are installed and how many processor cores are available, some of
blanchet@41190
   239
the provers might be missing or present with a \textit{remote\_} prefix.
blanchet@36918
   240
blanchet@40254
   241
For each successful prover, Sledgehammer gives a one-liner proof that uses the
blanchet@40254
   242
\textit{metis} or \textit{smt} method. You can click the proof to insert it into
blanchet@40254
   243
the theory text. You can click the ``\textbf{sledgehammer} \textit{minimize}''
blanchet@40254
   244
command if you want to look for a shorter (and probably faster) proof. But here
blanchet@40254
   245
the proof found by E looks perfect, so click it to finish the proof.
blanchet@36918
   246
blanchet@36918
   247
You can ask Sledgehammer for an Isar text proof by passing the
blanchet@36918
   248
\textit{isar\_proof} option:
blanchet@36918
   249
blanchet@36918
   250
\prew
blanchet@36918
   251
\textbf{sledgehammer} [\textit{isar\_proof}]
blanchet@36918
   252
\postw
blanchet@36918
   253
blanchet@36918
   254
When Isar proof construction is successful, it can yield proofs that are more
blanchet@36918
   255
readable and also faster than the \textit{metis} one-liners. This feature is
blanchet@40254
   256
experimental and is only available for ATPs.
blanchet@36918
   257
blanchet@37517
   258
\section{Hints}
blanchet@37517
   259
\label{hints}
blanchet@37517
   260
blanchet@37517
   261
For best results, first simplify your problem by calling \textit{auto} or at
blanchet@37517
   262
least \textit{safe} followed by \textit{simp\_all}. None of the ATPs contain
blanchet@37517
   263
arithmetic decision procedures. They are not especially good at heavy rewriting,
blanchet@37517
   264
but because they regard equations as undirected, they often prove theorems that
blanchet@37517
   265
require the reverse orientation of a \textit{simp} rule. Higher-order problems
blanchet@37517
   266
can be tackled, but the success rate is better for first-order problems. Hence,
blanchet@37517
   267
you may get better results if you first simplify the problem to remove
blanchet@37517
   268
higher-order features.
blanchet@37517
   269
blanchet@39566
   270
Note that problems can be easy for \textit{auto} and difficult for ATPs, but the
blanchet@39566
   271
reverse is also true, so don't be discouraged if your first attempts fail.
blanchet@39566
   272
Because the system refers to all theorems known to Isabelle, it is particularly
blanchet@39566
   273
suitable when your goal has a short proof from lemmas that you don't know about.
blanchet@37517
   274
blanchet@36918
   275
\section{Command Syntax}
blanchet@36918
   276
\label{command-syntax}
blanchet@36918
   277
blanchet@36918
   278
Sledgehammer can be invoked at any point when there is an open goal by entering
blanchet@36918
   279
the \textbf{sledgehammer} command in the theory file. Its general syntax is as
blanchet@36918
   280
follows:
blanchet@36918
   281
blanchet@36918
   282
\prew
blanchet@36918
   283
\textbf{sledgehammer} \textit{subcommand\/$^?$ options\/$^?$ facts\_override\/$^?$ num\/$^?$}
blanchet@36918
   284
\postw
blanchet@36918
   285
blanchet@36918
   286
For convenience, Sledgehammer is also available in the ``Commands'' submenu of
blanchet@36918
   287
the ``Isabelle'' menu in Proof General or by pressing the Emacs key sequence C-c
blanchet@36918
   288
C-a C-s. This is equivalent to entering the \textbf{sledgehammer} command with
blanchet@36918
   289
no arguments in the theory text.
blanchet@36918
   290
blanchet@36918
   291
In the general syntax, the \textit{subcommand} may be any of the following:
blanchet@36918
   292
blanchet@36918
   293
\begin{enum}
blanchet@40444
   294
\item[$\bullet$] \textbf{\textit{run} (the default):} Runs Sledgehammer on
blanchet@40444
   295
subgoal number \textit{num} (1 by default), with the given options and facts.
blanchet@36918
   296
blanchet@36918
   297
\item[$\bullet$] \textbf{\textit{minimize}:} Attempts to minimize the provided facts
blanchet@36918
   298
(specified in the \textit{facts\_override} argument) to obtain a simpler proof
blanchet@36918
   299
involving fewer facts. The options and goal number are as for \textit{run}.
blanchet@36918
   300
blanchet@40444
   301
\item[$\bullet$] \textbf{\textit{messages}:} Redisplays recent messages issued
blanchet@40444
   302
by Sledgehammer. This allows you to examine results that might have been lost
blanchet@40444
   303
due to Sledgehammer's asynchronous nature. The \textit{num} argument specifies a
blanchet@36918
   304
limit on the number of messages to display (5 by default).
blanchet@36918
   305
blanchet@42591
   306
\item[$\bullet$] \textbf{\textit{supported\_provers}:} Prints the list of
blanchet@42588
   307
automatic provers supported by Sledgehammer. See \S\ref{installation} and
blanchet@42588
   308
\S\ref{mode-of-operation} for more information on how to install automatic
blanchet@42588
   309
provers.
blanchet@36918
   310
blanchet@40240
   311
\item[$\bullet$] \textbf{\textit{running\_provers}:} Prints information about
blanchet@40240
   312
currently running automatic provers, including elapsed runtime and remaining
blanchet@40240
   313
time until timeout.
blanchet@36918
   314
blanchet@40240
   315
\item[$\bullet$] \textbf{\textit{kill\_provers}:} Terminates all running
blanchet@40240
   316
automatic provers.
blanchet@36918
   317
blanchet@36918
   318
\item[$\bullet$] \textbf{\textit{refresh\_tptp}:} Refreshes the list of remote
blanchet@36918
   319
ATPs available at System\-On\-TPTP \cite{sutcliffe-2000}.
blanchet@36918
   320
\end{enum}
blanchet@36918
   321
blanchet@36918
   322
Sledgehammer's behavior can be influenced by various \textit{options}, which can
blanchet@36918
   323
be specified in brackets after the \textbf{sledgehammer} command. The
blanchet@36918
   324
\textit{options} are a list of key--value pairs of the form ``[$k_1 = v_1,
blanchet@36918
   325
\ldots, k_n = v_n$]''. For Boolean options, ``= \textit{true}'' is optional. For
blanchet@36918
   326
example:
blanchet@36918
   327
blanchet@36918
   328
\prew
blanchet@36918
   329
\textbf{sledgehammer} [\textit{isar\_proof}, \,\textit{timeout} = 120$\,s$]
blanchet@36918
   330
\postw
blanchet@36918
   331
blanchet@36918
   332
Default values can be set using \textbf{sledgehammer\_\allowbreak params}:
blanchet@36918
   333
blanchet@36918
   334
\prew
blanchet@36918
   335
\textbf{sledgehammer\_params} \textit{options}
blanchet@36918
   336
\postw
blanchet@36918
   337
blanchet@36918
   338
The supported options are described in \S\ref{option-reference}.
blanchet@36918
   339
blanchet@36918
   340
The \textit{facts\_override} argument lets you alter the set of facts that go
blanchet@36918
   341
through the relevance filter. It may be of the form ``(\textit{facts})'', where
blanchet@36918
   342
\textit{facts} is a space-separated list of Isabelle facts (theorems, local
blanchet@36918
   343
assumptions, etc.), in which case the relevance filter is bypassed and the given
blanchet@39566
   344
facts are used. It may also be of the form ``(\textit{add}:\ \textit{facts}$_1$)'',
blanchet@39566
   345
``(\textit{del}:\ \textit{facts}$_2$)'', or ``(\textit{add}:\ \textit{facts}$_1$\
blanchet@39566
   346
\textit{del}:\ \textit{facts}$_2$)'', where the relevance filter is instructed to
blanchet@36918
   347
proceed as usual except that it should consider \textit{facts}$_1$
blanchet@36918
   348
highly-relevant and \textit{facts}$_2$ fully irrelevant.
blanchet@36918
   349
blanchet@39566
   350
You can instruct Sledgehammer to run automatically on newly entered theorems by
blanchet@39566
   351
enabling the ``Auto Sledgehammer'' option from the ``Isabelle'' menu in Proof
blanchet@40240
   352
General. For automatic runs, only the first prover set using \textit{provers}
blanchet@39566
   353
(\S\ref{mode-of-operation}) is considered, \textit{verbose}
blanchet@39566
   354
(\S\ref{output-format}) and \textit{debug} (\S\ref{output-format}) are disabled,
blanchet@40254
   355
fewer facts are passed to the prover, and \textit{timeout}
blanchet@40254
   356
(\S\ref{mode-of-operation}) is superseded by the ``Auto Tools Time Limit'' in
blanchet@40254
   357
Proof General's ``Isabelle'' menu. Sledgehammer's output is also more concise.
blanchet@39566
   358
blanchet@36918
   359
\section{Option Reference}
blanchet@36918
   360
\label{option-reference}
blanchet@36918
   361
blanchet@36918
   362
\def\flushitem#1{\item[]\noindent\kern-\leftmargin \textbf{#1}}
blanchet@36918
   363
\def\qty#1{$\left<\textit{#1}\right>$}
blanchet@36918
   364
\def\qtybf#1{$\mathbf{\left<\textbf{\textit{#1}}\right>}$}
blanchet@36918
   365
\def\optrue#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{bool}$\bigr]$\quad [\textit{true}]\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
blanchet@36918
   366
\def\opfalse#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{bool}$\bigr]$\quad [\textit{false}]\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
blanchet@36918
   367
\def\opsmart#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{bool\_or\_smart}$\bigr]$\quad [\textit{smart}]\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
blanchet@36918
   368
\def\opsmartx#1#2{\flushitem{\textit{#1} $\bigl[$= \qtybf{bool\_or\_smart}$\bigr]$\quad [\textit{smart}]\hfill\\\hbox{}\hfill (neg.: \textit{#2})}\nopagebreak\\[\parskip]}
blanchet@36918
   369
\def\opnodefault#1#2{\flushitem{\textit{#1} = \qtybf{#2}} \nopagebreak\\[\parskip]}
blanchet@36918
   370
\def\opdefault#1#2#3{\flushitem{\textit{#1} = \qtybf{#2}\quad [\textit{#3}]} \nopagebreak\\[\parskip]}
blanchet@36918
   371
\def\oparg#1#2#3{\flushitem{\textit{#1} \qtybf{#2} = \qtybf{#3}} \nopagebreak\\[\parskip]}
blanchet@36918
   372
\def\opargbool#1#2#3{\flushitem{\textit{#1} \qtybf{#2} $\bigl[$= \qtybf{bool}$\bigr]$\hfill (neg.: \textit{#3})}\nopagebreak\\[\parskip]}
blanchet@36918
   373
\def\opargboolorsmart#1#2#3{\flushitem{\textit{#1} \qtybf{#2} $\bigl[$= \qtybf{bool\_or\_smart}$\bigr]$\hfill (neg.: \textit{#3})}\nopagebreak\\[\parskip]}
blanchet@36918
   374
blanchet@36918
   375
Sledgehammer's options are categorized as follows:\ mode of operation
blanchet@39228
   376
(\S\ref{mode-of-operation}), problem encoding (\S\ref{problem-encoding}),
blanchet@39228
   377
relevance filter (\S\ref{relevance-filter}), output format
blanchet@39228
   378
(\S\ref{output-format}), and authentication (\S\ref{authentication}).
blanchet@36918
   379
blanchet@36918
   380
The descriptions below refer to the following syntactic quantities:
blanchet@36918
   381
blanchet@36918
   382
\begin{enum}
blanchet@36918
   383
\item[$\bullet$] \qtybf{string}: A string.
blanchet@36918
   384
\item[$\bullet$] \qtybf{bool\/}: \textit{true} or \textit{false}.
blanchet@40444
   385
\item[$\bullet$] \qtybf{bool\_or\_smart\/}: \textit{true}, \textit{false}, or
blanchet@40444
   386
\textit{smart}.
blanchet@36918
   387
\item[$\bullet$] \qtybf{int\/}: An integer.
blanchet@40584
   388
\item[$\bullet$] \qtybf{float\_pair\/}: A pair of floating-point numbers
blanchet@40584
   389
(e.g., 0.6 0.95).
blanchet@38814
   390
\item[$\bullet$] \qtybf{int\_or\_smart\/}: An integer or \textit{smart}.
blanchet@40584
   391
\item[$\bullet$] \qtybf{float\_or\_none\/}: An integer (e.g., 60) or
blanchet@40584
   392
floating-point number (e.g., 0.5) expressing a number of seconds, or the keyword
blanchet@40584
   393
\textit{none} ($\infty$ seconds).
blanchet@36918
   394
\end{enum}
blanchet@36918
   395
blanchet@36918
   396
Default values are indicated in square brackets. Boolean options have a negated
blanchet@39228
   397
counterpart (e.g., \textit{blocking} vs.\ \textit{non\_blocking}). When setting
blanchet@36918
   398
Boolean options, ``= \textit{true}'' may be omitted.
blanchet@36918
   399
blanchet@36918
   400
\subsection{Mode of Operation}
blanchet@36918
   401
\label{mode-of-operation}
blanchet@36918
   402
blanchet@36918
   403
\begin{enum}
blanchet@40240
   404
\opnodefault{provers}{string}
blanchet@40240
   405
Specifies the automatic provers to use as a space-separated list (e.g.,
blanchet@40240
   406
``\textit{e}~\textit{spass}''). The following provers are supported:
blanchet@36918
   407
blanchet@36918
   408
\begin{enum}
blanchet@36918
   409
\item[$\bullet$] \textbf{\textit{e}:} E is an ATP developed by Stephan Schulz
blanchet@36918
   410
\cite{schulz-2002}. To use E, set the environment variable
blanchet@36918
   411
\texttt{E\_HOME} to the directory that contains the \texttt{eproof} executable,
blanchet@36918
   412
or install the prebuilt E package from Isabelle's download page. See
blanchet@36918
   413
\S\ref{installation} for details.
blanchet@36918
   414
blanchet@36918
   415
\item[$\bullet$] \textbf{\textit{spass}:} SPASS is an ATP developed by Christoph
blanchet@36918
   416
Weidenbach et al.\ \cite{weidenbach-et-al-2009}. To use SPASS, set the
blanchet@36918
   417
environment variable \texttt{SPASS\_HOME} to the directory that contains the
blanchet@36918
   418
\texttt{SPASS} executable, or install the prebuilt SPASS package from Isabelle's
blanchet@37389
   419
download page. Sledgehammer requires version 3.5 or above. See
blanchet@37389
   420
\S\ref{installation} for details.
blanchet@36918
   421
blanchet@36918
   422
\item[$\bullet$] \textbf{\textit{vampire}:} Vampire is an ATP developed by
blanchet@36918
   423
Andrei Voronkov and his colleagues \cite{riazanov-voronkov-2002}. To use
blanchet@36918
   424
Vampire, set the environment variable \texttt{VAMPIRE\_HOME} to the directory
blanchet@41190
   425
that contains the \texttt{vampire} executable. Sledgehammer has been tested with
blanchet@41190
   426
versions 11, 0.6, and 1.0.
blanchet@36918
   427
blanchet@41190
   428
\item[$\bullet$] \textbf{\textit{z3}:} Z3 is an SMT solver developed at
blanchet@41190
   429
Microsoft Research \cite{z3}. To use Z3, set the environment variable
blanchet@41190
   430
\texttt{Z3\_SOLVER} to the complete path of the executable, including the file
blanchet@41190
   431
name. Sledgehammer has been tested with 2.7 to 2.15.
blanchet@41190
   432
blanchet@41190
   433
\item[$\bullet$] \textbf{\textit{yices}:} Yices is an SMT solver developed at
blanchet@41190
   434
SRI \cite{yices}. To use Yices, set the environment variable
blanchet@41190
   435
\texttt{YICES\_SOLVER} to the complete path of the executable, including the
blanchet@41190
   436
file name. Sledgehammer has been tested with version 1.0.
blanchet@41190
   437
blanchet@41190
   438
\item[$\bullet$] \textbf{\textit{cvc3}:} CVC3 is an SMT solver developed by
blanchet@41190
   439
Clark Barrett, Cesare Tinelli, and their colleagues \cite{cvc3}. To use CVC3,
blanchet@41190
   440
set the environment variable \texttt{CVC3\_SOLVER} to the complete path of the
blanchet@41190
   441
executable, including the file name. Sledgehammer has been tested with version
blanchet@41190
   442
2.2.
blanchet@40254
   443
blanchet@38824
   444
\item[$\bullet$] \textbf{\textit{remote\_e}:} The remote version of E runs
blanchet@36918
   445
on Geoff Sutcliffe's Miami servers \cite{sutcliffe-2000}.
blanchet@36918
   446
blanchet@36918
   447
\item[$\bullet$] \textbf{\textit{remote\_vampire}:} The remote version of
blanchet@38824
   448
Vampire runs on Geoff Sutcliffe's Miami servers. Version 9 is used.
blanchet@36918
   449
blanchet@38824
   450
\item[$\bullet$] \textbf{\textit{remote\_sine\_e}:} SInE-E is a metaprover
blanchet@38824
   451
developed by Kry\v stof Hoder \cite{sine} based on E. The remote version of
blanchet@38824
   452
SInE runs on Geoff Sutcliffe's Miami servers.
blanchet@38824
   453
blanchet@38824
   454
\item[$\bullet$] \textbf{\textit{remote\_snark}:} SNARK is a prover
blanchet@38824
   455
developed by Stickel et al.\ \cite{snark}. The remote version of
blanchet@38824
   456
SNARK runs on Geoff Sutcliffe's Miami servers.
blanchet@40254
   457
blanchet@41190
   458
\item[$\bullet$] \textbf{\textit{remote\_z3}:} The remote version of Z3 runs on
blanchet@41190
   459
servers at the TU M\"unchen (or wherever \texttt{REMOTE\_SMT\_URL} is set to
blanchet@41190
   460
point).
blanchet@40254
   461
blanchet@41190
   462
\item[$\bullet$] \textbf{\textit{remote\_cvc3}:} The remote version of CVC3 runs
blanchet@41190
   463
on servers at the TU M\"unchen (or wherever \texttt{REMOTE\_SMT\_URL} is set to
blanchet@41190
   464
point).
blanchet@36918
   465
\end{enum}
blanchet@36918
   466
blanchet@41190
   467
By default, Sledgehammer will run E, SPASS, Vampire, SInE-E, and Z3 (or whatever
blanchet@41190
   468
the SMT module's \emph{smt\_solver} configuration option is set to) in
blanchet@40254
   469
parallel---either locally or remotely, depending on the number of processor
blanchet@40254
   470
cores available. For historical reasons, the default value of this option can be
blanchet@40254
   471
overridden using the option ``Sledgehammer: Provers'' from the ``Isabelle'' menu
blanchet@40254
   472
in Proof General.
blanchet@36918
   473
blanchet@40240
   474
It is a good idea to run several provers in parallel, although it could slow
blanchet@40254
   475
down your machine. Running E, SPASS, Vampire, and SInE-E together for 5 seconds
blanchet@40254
   476
yields a better success rate than running the most effective of these (Vampire)
blanchet@40254
   477
for 120 seconds \cite{boehme-nipkow-2010}.
blanchet@40240
   478
blanchet@40240
   479
\opnodefault{prover}{string}
blanchet@40240
   480
Alias for \textit{provers}.
blanchet@40240
   481
blanchet@40240
   482
\opnodefault{atps}{string}
blanchet@40240
   483
Legacy alias for \textit{provers}.
blanchet@36918
   484
blanchet@36918
   485
\opnodefault{atp}{string}
blanchet@40240
   486
Legacy alias for \textit{provers}.
blanchet@36918
   487
blanchet@40584
   488
\opdefault{timeout}{float\_or\_none}{\upshape 30}
blanchet@40582
   489
Specifies the maximum number of seconds that the automatic provers should spend
blanchet@40240
   490
searching for a proof. For historical reasons, the default value of this option
blanchet@40240
   491
can be overridden using the option ``Sledgehammer: Time Limit'' from the
blanchet@40240
   492
``Isabelle'' menu in Proof General.
blanchet@39228
   493
blanchet@39227
   494
\opfalse{blocking}{non\_blocking}
blanchet@39227
   495
Specifies whether the \textbf{sledgehammer} command should operate
blanchet@39227
   496
synchronously. The asynchronous (non-blocking) mode lets the user start proving
blanchet@39227
   497
the putative theorem manually while Sledgehammer looks for a proof, but it can
blanchet@39227
   498
also be more confusing.
blanchet@39227
   499
blanchet@36918
   500
\opfalse{overlord}{no\_overlord}
blanchet@36918
   501
Specifies whether Sledgehammer should put its temporary files in
blanchet@36918
   502
\texttt{\$ISA\-BELLE\_\allowbreak HOME\_\allowbreak USER}, which is useful for
blanchet@36918
   503
debugging Sledgehammer but also unsafe if several instances of the tool are run
blanchet@36918
   504
simultaneously. The files are identified by the prefix \texttt{prob\_}; you may
blanchet@36918
   505
safely remove them after Sledgehammer has run.
blanchet@36918
   506
blanchet@36918
   507
\nopagebreak
blanchet@36918
   508
{\small See also \textit{debug} (\S\ref{output-format}).}
blanchet@36918
   509
\end{enum}
blanchet@36918
   510
blanchet@36918
   511
\subsection{Problem Encoding}
blanchet@36918
   512
\label{problem-encoding}
blanchet@36918
   513
blanchet@36918
   514
\begin{enum}
blanchet@36918
   515
\opfalse{explicit\_apply}{implicit\_apply}
blanchet@36918
   516
Specifies whether function application should be encoded as an explicit
blanchet@40254
   517
``apply'' operator in ATP problems. If the option is set to \textit{false}, each
blanchet@40254
   518
function will be directly applied to as many arguments as possible. Enabling
blanchet@40254
   519
this option can sometimes help discover higher-order proofs that otherwise would
blanchet@40254
   520
not be found.
blanchet@36918
   521
blanchet@36918
   522
\opfalse{full\_types}{partial\_types}
blanchet@40254
   523
Specifies whether full-type information is encoded in ATP problems. Enabling
blanchet@40254
   524
this option can prevent the discovery of type-incorrect proofs, but it also
blanchet@40254
   525
tends to slow down the ATPs significantly. For historical reasons, the default
blanchet@40254
   526
value of this option can be overridden using the option ``Sledgehammer: Full
blanchet@40254
   527
Types'' from the ``Isabelle'' menu in Proof General.
blanchet@38814
   528
\end{enum}
blanchet@36918
   529
blanchet@38814
   530
\subsection{Relevance Filter}
blanchet@38814
   531
\label{relevance-filter}
blanchet@38814
   532
blanchet@38814
   533
\begin{enum}
blanchet@40584
   534
\opdefault{relevance\_thresholds}{float\_pair}{\upshape 0.45~0.85}
blanchet@38985
   535
Specifies the thresholds above which facts are considered relevant by the
blanchet@38985
   536
relevance filter. The first threshold is used for the first iteration of the
blanchet@38985
   537
relevance filter and the second threshold is used for the last iteration (if it
blanchet@38985
   538
is reached). The effective threshold is quadratically interpolated for the other
blanchet@40584
   539
iterations. Each threshold ranges from 0 to 1, where 0 means that all theorems
blanchet@40584
   540
are relevant and 1 only theorems that refer to previously seen constants.
blanchet@36918
   541
blanchet@40584
   542
\opsmart{max\_relevant}{int\_or\_smart}
blanchet@38985
   543
Specifies the maximum number of facts that may be returned by the relevance
blanchet@38985
   544
filter. If the option is set to \textit{smart}, it is set to a value that was
blanchet@40240
   545
empirically found to be appropriate for the prover. A typical value would be
blanchet@40240
   546
300.
blanchet@36918
   547
\end{enum}
blanchet@36918
   548
blanchet@36918
   549
\subsection{Output Format}
blanchet@36918
   550
\label{output-format}
blanchet@36918
   551
blanchet@36918
   552
\begin{enum}
blanchet@36918
   553
blanchet@36918
   554
\opfalse{verbose}{quiet}
blanchet@36918
   555
Specifies whether the \textbf{sledgehammer} command should explain what it does.
blanchet@41456
   556
This option is implicitly disabled for automatic runs.
blanchet@36918
   557
blanchet@36918
   558
\opfalse{debug}{no\_debug}
blanchet@40444
   559
Specifies whether Sledgehammer should display additional debugging information
blanchet@40444
   560
beyond what \textit{verbose} already displays. Enabling \textit{debug} also
blanchet@41456
   561
enables \textit{verbose} and \textit{blocking} (\S\ref{mode-of-operation})
blanchet@41456
   562
behind the scenes. The \textit{debug} option is implicitly disabled for
blanchet@41456
   563
automatic runs.
blanchet@36918
   564
blanchet@36918
   565
\nopagebreak
blanchet@36918
   566
{\small See also \textit{overlord} (\S\ref{mode-of-operation}).}
blanchet@36918
   567
blanchet@36918
   568
\opfalse{isar\_proof}{no\_isar\_proof}
blanchet@36918
   569
Specifies whether Isar proofs should be output in addition to one-liner
blanchet@36918
   570
\textit{metis} proofs. Isar proof construction is still experimental and often
blanchet@36918
   571
fails; however, they are usually faster and sometimes more robust than
blanchet@36918
   572
\textit{metis} proofs.
blanchet@36918
   573
blanchet@40584
   574
\opdefault{isar\_shrink\_factor}{int}{\upshape 1}
blanchet@36918
   575
Specifies the granularity of the Isar proof. A value of $n$ indicates that each
blanchet@36918
   576
Isar proof step should correspond to a group of up to $n$ consecutive proof
blanchet@36918
   577
steps in the ATP proof.
blanchet@36918
   578
blanchet@36918
   579
\end{enum}
blanchet@36918
   580
blanchet@39228
   581
\subsection{Authentication}
blanchet@39228
   582
\label{authentication}
blanchet@36918
   583
blanchet@36918
   584
\begin{enum}
blanchet@39228
   585
\opnodefault{expect}{string}
blanchet@39228
   586
Specifies the expected outcome, which must be one of the following:
blanchet@39228
   587
blanchet@39228
   588
\begin{enum}
blanchet@40444
   589
\item[$\bullet$] \textbf{\textit{some}:} Sledgehammer found a (potentially
blanchet@40444
   590
unsound) proof.
blanchet@39228
   591
\item[$\bullet$] \textbf{\textit{none}:} Sledgehammer found no proof.
blanchet@40444
   592
\item[$\bullet$] \textbf{\textit{unknown}:} Sledgehammer encountered some
blanchet@40444
   593
problem.
blanchet@39228
   594
\end{enum}
blanchet@39228
   595
blanchet@39228
   596
Sledgehammer emits an error (if \textit{blocking} is enabled) or a warning
blanchet@39228
   597
(otherwise) if the actual outcome differs from the expected outcome. This option
blanchet@39228
   598
is useful for regression testing.
blanchet@39228
   599
blanchet@39228
   600
\nopagebreak
blanchet@39228
   601
{\small See also \textit{blocking} (\S\ref{mode-of-operation}).}
blanchet@36918
   602
\end{enum}
blanchet@36918
   603
blanchet@36918
   604
\let\em=\sl
blanchet@36918
   605
\bibliography{../manual}{}
blanchet@36918
   606
\bibliographystyle{abbrv}
blanchet@36918
   607
blanchet@36918
   608
\end{document}