doc-src/IsarRef/Thy/HOL_Specific.thy
author Cezary Kaliszyk <cezarykaliszyk@gmail.com>
Fri, 10 Feb 2012 09:02:51 +0100
changeset 46447 f37da60a8cc6
parent 46028 9f113cdf3d66
child 46448 f1201fac7398
permissions -rw-r--r--
specification of the quotient package
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
26840
ec46381f149d added logic-specific sessions;
wenzelm
parents:
diff changeset
     1
theory HOL_Specific
44055
65cdd08bd7fd updated imports;
wenzelm
parents: 43994
diff changeset
     2
imports Base Main "~~/src/HOL/Library/Old_Recdef"
26840
ec46381f149d added logic-specific sessions;
wenzelm
parents:
diff changeset
     3
begin
ec46381f149d added logic-specific sessions;
wenzelm
parents:
diff changeset
     4
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
     5
chapter {* Isabelle/HOL \label{ch:hol} *}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
     6
42914
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
     7
section {* Higher-Order Logic *}
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
     8
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
     9
text {* Isabelle/HOL is based on Higher-Order Logic, a polymorphic
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    10
  version of Church's Simple Theory of Types.  HOL can be best
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    11
  understood as a simply-typed version of classical set theory.  The
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    12
  logic was first implemented in Gordon's HOL system
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    13
  \cite{mgordon-hol}.  It extends Church's original logic
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    14
  \cite{church40} by explicit type variables (naive polymorphism) and
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    15
  a sound axiomatization scheme for new types based on subsets of
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    16
  existing types.
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    17
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    18
  Andrews's book \cite{andrews86} is a full description of the
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    19
  original Church-style higher-order logic, with proofs of correctness
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    20
  and completeness wrt.\ certain set-theoretic interpretations.  The
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    21
  particular extensions of Gordon-style HOL are explained semantically
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    22
  in two chapters of the 1993 HOL book \cite{pitts93}.
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    23
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    24
  Experience with HOL over decades has demonstrated that higher-order
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    25
  logic is widely applicable in many areas of mathematics and computer
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    26
  science.  In a sense, Higher-Order Logic is simpler than First-Order
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    27
  Logic, because there are fewer restrictions and special cases.  Note
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    28
  that HOL is \emph{weaker} than FOL with axioms for ZF set theory,
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    29
  which is traditionally considered the standard foundation of regular
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    30
  mathematics, but for most applications this does not matter.  If you
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    31
  prefer ML to Lisp, you will probably prefer HOL to ZF.
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    32
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    33
  \medskip The syntax of HOL follows @{text "\<lambda>"}-calculus and
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    34
  functional programming.  Function application is curried.  To apply
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    35
  the function @{text f} of type @{text "\<tau>\<^sub>1 \<Rightarrow> \<tau>\<^sub>2 \<Rightarrow> \<tau>\<^sub>3"} to the
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    36
  arguments @{text a} and @{text b} in HOL, you simply write @{text "f
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    37
  a b"} (as in ML or Haskell).  There is no ``apply'' operator; the
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    38
  existing application of the Pure @{text "\<lambda>"}-calculus is re-used.
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    39
  Note that in HOL @{text "f (a, b)"} means ``@{text "f"} applied to
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    40
  the pair @{text "(a, b)"} (which is notation for @{text "Pair a
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    41
  b"}).  The latter typically introduces extra formal efforts that can
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    42
  be avoided by currying functions by default.  Explicit tuples are as
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    43
  infrequent in HOL formalizations as in good ML or Haskell programs.
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    44
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    45
  \medskip Isabelle/HOL has a distinct feel, compared to other
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    46
  object-logics like Isabelle/ZF.  It identifies object-level types
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    47
  with meta-level types, taking advantage of the default
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    48
  type-inference mechanism of Isabelle/Pure.  HOL fully identifies
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    49
  object-level functions with meta-level functions, with native
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    50
  abstraction and application.
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    51
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    52
  These identifications allow Isabelle to support HOL particularly
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    53
  nicely, but they also mean that HOL requires some sophistication
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    54
  from the user.  In particular, an understanding of Hindley-Milner
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    55
  type-inference with type-classes, which are both used extensively in
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    56
  the standard libraries and applications.  Beginners can set
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    57
  @{attribute show_types} or even @{attribute show_sorts} to get more
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    58
  explicit information about the result of type-inference.  *}
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    59
e6ed6b951201 moved/updated basic HOL overview;
wenzelm
parents: 42913
diff changeset
    60
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    61
section {* Inductive and coinductive definitions \label{sec:hol-inductive} *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    62
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    63
text {* An \emph{inductive definition} specifies the least predicate
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    64
  or set @{text R} closed under given rules: applying a rule to
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    65
  elements of @{text R} yields a result within @{text R}.  For
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    66
  example, a structural operational semantics is an inductive
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    67
  definition of an evaluation relation.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    68
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    69
  Dually, a \emph{coinductive definition} specifies the greatest
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    70
  predicate or set @{text R} that is consistent with given rules:
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    71
  every element of @{text R} can be seen as arising by applying a rule
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    72
  to elements of @{text R}.  An important example is using
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    73
  bisimulation relations to formalise equivalence of processes and
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    74
  infinite data structures.
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    75
  
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    76
  Both inductive and coinductive definitions are based on the
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    77
  Knaster-Tarski fixed-point theorem for complete lattices.  The
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    78
  collection of introduction rules given by the user determines a
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    79
  functor on subsets of set-theoretic relations.  The required
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    80
  monotonicity of the recursion scheme is proven as a prerequisite to
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    81
  the fixed-point definition and the resulting consequences.  This
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    82
  works by pushing inclusion through logical connectives and any other
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    83
  operator that might be wrapped around recursive occurrences of the
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    84
  defined relation: there must be a monotonicity theorem of the form
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    85
  @{text "A \<le> B \<Longrightarrow> \<M> A \<le> \<M> B"}, for each premise @{text "\<M> R t"} in an
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    86
  introduction rule.  The default rule declarations of Isabelle/HOL
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
    87
  already take care of most common situations.
42907
dfd4ef8e73f6 updated and re-unified HOL typedef, with some live examples;
wenzelm
parents: 42705
diff changeset
    88
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
    89
  \begin{matharray}{rcl}
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    90
    @{command_def (HOL) "inductive"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    91
    @{command_def (HOL) "inductive_set"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    92
    @{command_def (HOL) "coinductive"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    93
    @{command_def (HOL) "coinductive_set"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    94
    @{attribute_def (HOL) mono} & : & @{text attribute} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
    95
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
    96
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
    97
  @{rail "
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    98
    (@@{command (HOL) inductive} | @@{command (HOL) inductive_set} |
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
    99
      @@{command (HOL) coinductive} | @@{command (HOL) coinductive_set})
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   100
    @{syntax target}? \\
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   101
    @{syntax \"fixes\"} (@'for' @{syntax \"fixes\"})? (@'where' clauses)? \\
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   102
    (@'monos' @{syntax thmrefs})?
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   103
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   104
    clauses: (@{syntax thmdecl}? @{syntax prop} + '|')
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   105
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   106
    @@{attribute (HOL) mono} (() | 'add' | 'del')
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   107
  "}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   108
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   109
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   110
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   111
  \item @{command (HOL) "inductive"} and @{command (HOL)
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   112
  "coinductive"} define (co)inductive predicates from the introduction
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   113
  rules.
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   114
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   115
  The propositions given as @{text "clauses"} in the @{keyword
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   116
  "where"} part are either rules of the usual @{text "\<And>/\<Longrightarrow>"} format
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   117
  (with arbitrary nesting), or equalities using @{text "\<equiv>"}.  The
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   118
  latter specifies extra-logical abbreviations in the sense of
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   119
  @{command_ref abbreviation}.  Introducing abstract syntax
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   120
  simultaneously with the actual introduction rules is occasionally
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   121
  useful for complex specifications.
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   122
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   123
  The optional @{keyword "for"} part contains a list of parameters of
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   124
  the (co)inductive predicates that remain fixed throughout the
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   125
  definition, in contrast to arguments of the relation that may vary
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   126
  in each occurrence within the given @{text "clauses"}.
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   127
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   128
  The optional @{keyword "monos"} declaration contains additional
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   129
  \emph{monotonicity theorems}, which are required for each operator
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   130
  applied to a recursive set in the introduction rules.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   131
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   132
  \item @{command (HOL) "inductive_set"} and @{command (HOL)
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   133
  "coinductive_set"} are wrappers for to the previous commands for
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   134
  native HOL predicates.  This allows to define (co)inductive sets,
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   135
  where multiple arguments are simulated via tuples.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   136
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   137
  \item @{attribute (HOL) mono} declares monotonicity rules in the
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   138
  context.  These rule are involved in the automated monotonicity
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   139
  proof of the above inductive and coinductive definitions.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   140
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   141
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   142
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   143
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   144
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   145
subsection {* Derived rules *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   146
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   147
text {* A (co)inductive definition of @{text R} provides the following
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   148
  main theorems:
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   149
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   150
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   151
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   152
  \item @{text R.intros} is the list of introduction rules as proven
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   153
  theorems, for the recursive predicates (or sets).  The rules are
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   154
  also available individually, using the names given them in the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   155
  theory file;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   156
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   157
  \item @{text R.cases} is the case analysis (or elimination) rule;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   158
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   159
  \item @{text R.induct} or @{text R.coinduct} is the (co)induction
44273
336752fb25df adding documentation about simps equation in the inductive package
bulwahn
parents: 44055
diff changeset
   160
  rule;
336752fb25df adding documentation about simps equation in the inductive package
bulwahn
parents: 44055
diff changeset
   161
336752fb25df adding documentation about simps equation in the inductive package
bulwahn
parents: 44055
diff changeset
   162
  \item @{text R.simps} is the equation unrolling the fixpoint of the
336752fb25df adding documentation about simps equation in the inductive package
bulwahn
parents: 44055
diff changeset
   163
  predicate one step.
336752fb25df adding documentation about simps equation in the inductive package
bulwahn
parents: 44055
diff changeset
   164
 
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   165
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   166
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   167
  When several predicates @{text "R\<^sub>1, \<dots>, R\<^sub>n"} are
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   168
  defined simultaneously, the list of introduction rules is called
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   169
  @{text "R\<^sub>1_\<dots>_R\<^sub>n.intros"}, the case analysis rules are
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   170
  called @{text "R\<^sub>1.cases, \<dots>, R\<^sub>n.cases"}, and the list
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   171
  of mutual induction rules is called @{text
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   172
  "R\<^sub>1_\<dots>_R\<^sub>n.inducts"}.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   173
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   174
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   175
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   176
subsection {* Monotonicity theorems *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   177
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   178
text {* The context maintains a default set of theorems that are used
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   179
  in monotonicity proofs.  New rules can be declared via the
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   180
  @{attribute (HOL) mono} attribute.  See the main Isabelle/HOL
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   181
  sources for some examples.  The general format of such monotonicity
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   182
  theorems is as follows:
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   183
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   184
  \begin{itemize}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   185
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   186
  \item Theorems of the form @{text "A \<le> B \<Longrightarrow> \<M> A \<le> \<M> B"}, for proving
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   187
  monotonicity of inductive definitions whose introduction rules have
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   188
  premises involving terms such as @{text "\<M> R t"}.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   189
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   190
  \item Monotonicity theorems for logical operators, which are of the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   191
  general form @{text "(\<dots> \<longrightarrow> \<dots>) \<Longrightarrow> \<dots> (\<dots> \<longrightarrow> \<dots>) \<Longrightarrow> \<dots> \<longrightarrow> \<dots>"}.  For example, in
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   192
  the case of the operator @{text "\<or>"}, the corresponding theorem is
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   193
  \[
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   194
  \infer{@{text "P\<^sub>1 \<or> P\<^sub>2 \<longrightarrow> Q\<^sub>1 \<or> Q\<^sub>2"}}{@{text "P\<^sub>1 \<longrightarrow> Q\<^sub>1"} & @{text "P\<^sub>2 \<longrightarrow> Q\<^sub>2"}}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   195
  \]
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   196
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   197
  \item De Morgan style equations for reasoning about the ``polarity''
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   198
  of expressions, e.g.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   199
  \[
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   200
  @{prop "\<not> \<not> P \<longleftrightarrow> P"} \qquad\qquad
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   201
  @{prop "\<not> (P \<and> Q) \<longleftrightarrow> \<not> P \<or> \<not> Q"}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   202
  \]
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   203
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   204
  \item Equations for reducing complex operators to more primitive
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   205
  ones whose monotonicity can easily be proved, e.g.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   206
  \[
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   207
  @{prop "(P \<longrightarrow> Q) \<longleftrightarrow> \<not> P \<or> Q"} \qquad\qquad
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   208
  @{prop "Ball A P \<equiv> \<forall>x. x \<in> A \<longrightarrow> P x"}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   209
  \]
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   210
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   211
  \end{itemize}
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   212
*}
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   213
42913
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   214
subsubsection {* Examples *}
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   215
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   216
text {* The finite powerset operator can be defined inductively like this: *}
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   217
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   218
inductive_set Fin :: "'a set \<Rightarrow> 'a set set" for A :: "'a set"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   219
where
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   220
  empty: "{} \<in> Fin A"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   221
| insert: "a \<in> A \<Longrightarrow> B \<in> Fin A \<Longrightarrow> insert a B \<in> Fin A"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   222
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   223
text {* The accessible part of a relation is defined as follows: *}
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   224
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   225
inductive acc :: "('a \<Rightarrow> 'a \<Rightarrow> bool) \<Rightarrow> 'a \<Rightarrow> bool"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   226
  for r :: "'a \<Rightarrow> 'a \<Rightarrow> bool"  (infix "\<prec>" 50)
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   227
where acc: "(\<And>y. y \<prec> x \<Longrightarrow> acc r y) \<Longrightarrow> acc r x"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   228
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   229
text {* Common logical connectives can be easily characterized as
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   230
non-recursive inductive definitions with parameters, but without
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   231
arguments. *}
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   232
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   233
inductive AND for A B :: bool
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   234
where "A \<Longrightarrow> B \<Longrightarrow> AND A B"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   235
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   236
inductive OR for A B :: bool
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   237
where "A \<Longrightarrow> OR A B"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   238
  | "B \<Longrightarrow> OR A B"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   239
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   240
inductive EXISTS for B :: "'a \<Rightarrow> bool"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   241
where "B a \<Longrightarrow> EXISTS B"
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   242
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   243
text {* Here the @{text "cases"} or @{text "induct"} rules produced by
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   244
  the @{command inductive} package coincide with the expected
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   245
  elimination rules for Natural Deduction.  Already in the original
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   246
  article by Gerhard Gentzen \cite{Gentzen:1935} there is a hint that
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   247
  each connective can be characterized by its introductions, and the
68bc69bdce88 updated and re-unified (co)inductive definitions in HOL;
wenzelm
parents: 42912
diff changeset
   248
  elimination can be constructed systematically. *}
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   249
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   250
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   251
section {* Recursive functions \label{sec:recursion} *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   252
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   253
text {*
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   254
  \begin{matharray}{rcl}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   255
    @{command_def (HOL) "primrec"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   256
    @{command_def (HOL) "fun"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   257
    @{command_def (HOL) "function"} & : & @{text "local_theory \<rightarrow> proof(prove)"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   258
    @{command_def (HOL) "termination"} & : & @{text "local_theory \<rightarrow> proof(prove)"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   259
  \end{matharray}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   260
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   261
  @{rail "
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   262
    @@{command (HOL) primrec} @{syntax target}? @{syntax \"fixes\"} @'where' equations
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   263
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   264
    (@@{command (HOL) fun} | @@{command (HOL) function}) @{syntax target}? functionopts?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   265
      @{syntax \"fixes\"} \\ @'where' equations
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   266
    ;
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   267
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   268
    equations: (@{syntax thmdecl}? @{syntax prop} + '|')
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   269
    ;
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   270
    functionopts: '(' (('sequential' | 'domintros') + ',') ')'
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   271
    ;
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   272
    @@{command (HOL) termination} @{syntax term}?
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
   273
  "}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   274
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   275
  \begin{description}
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   276
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   277
  \item @{command (HOL) "primrec"} defines primitive recursive
42912
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   278
  functions over datatypes (see also @{command_ref (HOL) datatype} and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   279
  @{command_ref (HOL) rep_datatype}).  The given @{text equations}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   280
  specify reduction rules that are produced by instantiating the
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   281
  generic combinator for primitive recursion that is available for
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   282
  each datatype.
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   283
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   284
  Each equation needs to be of the form:
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   285
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   286
  @{text [display] "f x\<^sub>1 \<dots> x\<^sub>m (C y\<^sub>1 \<dots> y\<^sub>k) z\<^sub>1 \<dots> z\<^sub>n = rhs"}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   287
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   288
  such that @{text C} is a datatype constructor, @{text rhs} contains
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   289
  only the free variables on the left-hand side (or from the context),
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   290
  and all recursive occurrences of @{text "f"} in @{text "rhs"} are of
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   291
  the form @{text "f \<dots> y\<^sub>i \<dots>"} for some @{text i}.  At most one
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   292
  reduction rule for each constructor can be given.  The order does
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   293
  not matter.  For missing constructors, the function is defined to
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   294
  return a default value, but this equation is made difficult to
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   295
  access for users.
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   296
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   297
  The reduction rules are declared as @{attribute simp} by default,
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   298
  which enables standard proof methods like @{method simp} and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   299
  @{method auto} to normalize expressions of @{text "f"} applied to
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   300
  datatype constructions, by simulating symbolic computation via
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   301
  rewriting.
35744
93603d7b8ee9 removed obsolete HOL 'typedecl';
wenzelm
parents: 35613
diff changeset
   302
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   303
  \item @{command (HOL) "function"} defines functions by general
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   304
  wellfounded recursion. A detailed description with examples can be
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   305
  found in \cite{isabelle-function}. The function is specified by a
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   306
  set of (possibly conditional) recursive equations with arbitrary
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   307
  pattern matching. The command generates proof obligations for the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   308
  completeness and the compatibility of patterns.
42907
dfd4ef8e73f6 updated and re-unified HOL typedef, with some live examples;
wenzelm
parents: 42705
diff changeset
   309
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   310
  The defined function is considered partial, and the resulting
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   311
  simplification rules (named @{text "f.psimps"}) and induction rule
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   312
  (named @{text "f.pinduct"}) are guarded by a generated domain
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   313
  predicate @{text "f_dom"}. The @{command (HOL) "termination"}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   314
  command can then be used to establish that the function is total.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   315
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   316
  \item @{command (HOL) "fun"} is a shorthand notation for ``@{command
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   317
  (HOL) "function"}~@{text "(sequential)"}, followed by automated
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   318
  proof attempts regarding pattern matching and termination.  See
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   319
  \cite{isabelle-function} for further details.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   320
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   321
  \item @{command (HOL) "termination"}~@{text f} commences a
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   322
  termination proof for the previously defined function @{text f}.  If
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   323
  this is omitted, the command refers to the most recent function
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   324
  definition.  After the proof is closed, the recursive equations and
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   325
  the induction principle is established.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   326
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   327
  \end{description}
42907
dfd4ef8e73f6 updated and re-unified HOL typedef, with some live examples;
wenzelm
parents: 42705
diff changeset
   328
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   329
  Recursive definitions introduced by the @{command (HOL) "function"}
42912
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   330
  command accommodate reasoning by induction (cf.\ @{method induct}):
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   331
  rule @{text "f.induct"} refers to a specific induction rule, with
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   332
  parameters named according to the user-specified equations. Cases
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   333
  are numbered starting from 1.  For @{command (HOL) "primrec"}, the
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   334
  induction principle coincides with structural recursion on the
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   335
  datatype where the recursion is carried out.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   336
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   337
  The equations provided by these packages may be referred later as
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   338
  theorem list @{text "f.simps"}, where @{text f} is the (collective)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   339
  name of the functions defined.  Individual equations may be named
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   340
  explicitly as well.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   341
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   342
  The @{command (HOL) "function"} command accepts the following
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   343
  options.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   344
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   345
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   346
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   347
  \item @{text sequential} enables a preprocessor which disambiguates
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   348
  overlapping patterns by making them mutually disjoint.  Earlier
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   349
  equations take precedence over later ones.  This allows to give the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   350
  specification in a format very similar to functional programming.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   351
  Note that the resulting simplification and induction rules
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   352
  correspond to the transformed specification, not the one given
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   353
  originally. This usually means that each equation given by the user
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   354
  may result in several theorems.  Also note that this automatic
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   355
  transformation only works for ML-style datatype patterns.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   356
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   357
  \item @{text domintros} enables the automated generation of
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   358
  introduction rules for the domain predicate. While mostly not
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   359
  needed, they can be helpful in some proofs about partial functions.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   360
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   361
  \end{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   362
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   363
42912
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   364
subsubsection {* Example: evaluation of expressions *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   365
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   366
text {* Subsequently, we define mutual datatypes for arithmetic and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   367
  boolean expressions, and use @{command primrec} for evaluation
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   368
  functions that follow the same recursive structure. *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   369
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   370
datatype 'a aexp =
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   371
    IF "'a bexp"  "'a aexp"  "'a aexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   372
  | Sum "'a aexp"  "'a aexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   373
  | Diff "'a aexp"  "'a aexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   374
  | Var 'a
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   375
  | Num nat
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   376
and 'a bexp =
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   377
    Less "'a aexp"  "'a aexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   378
  | And "'a bexp"  "'a bexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   379
  | Neg "'a bexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   380
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   381
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   382
text {* \medskip Evaluation of arithmetic and boolean expressions *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   383
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   384
primrec evala :: "('a \<Rightarrow> nat) \<Rightarrow> 'a aexp \<Rightarrow> nat"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   385
  and evalb :: "('a \<Rightarrow> nat) \<Rightarrow> 'a bexp \<Rightarrow> bool"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   386
where
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   387
  "evala env (IF b a1 a2) = (if evalb env b then evala env a1 else evala env a2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   388
| "evala env (Sum a1 a2) = evala env a1 + evala env a2"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   389
| "evala env (Diff a1 a2) = evala env a1 - evala env a2"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   390
| "evala env (Var v) = env v"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   391
| "evala env (Num n) = n"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   392
| "evalb env (Less a1 a2) = (evala env a1 < evala env a2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   393
| "evalb env (And b1 b2) = (evalb env b1 \<and> evalb env b2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   394
| "evalb env (Neg b) = (\<not> evalb env b)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   395
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   396
text {* Since the value of an expression depends on the value of its
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   397
  variables, the functions @{const evala} and @{const evalb} take an
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   398
  additional parameter, an \emph{environment} that maps variables to
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   399
  their values.
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   400
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   401
  \medskip Substitution on expressions can be defined similarly.  The
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   402
  mapping @{text f} of type @{typ "'a \<Rightarrow> 'a aexp"} given as a
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   403
  parameter is lifted canonically on the types @{typ "'a aexp"} and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   404
  @{typ "'a bexp"}, respectively.
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   405
*}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   406
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   407
primrec substa :: "('a \<Rightarrow> 'b aexp) \<Rightarrow> 'a aexp \<Rightarrow> 'b aexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   408
  and substb :: "('a \<Rightarrow> 'b aexp) \<Rightarrow> 'a bexp \<Rightarrow> 'b bexp"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   409
where
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   410
  "substa f (IF b a1 a2) = IF (substb f b) (substa f a1) (substa f a2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   411
| "substa f (Sum a1 a2) = Sum (substa f a1) (substa f a2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   412
| "substa f (Diff a1 a2) = Diff (substa f a1) (substa f a2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   413
| "substa f (Var v) = f v"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   414
| "substa f (Num n) = Num n"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   415
| "substb f (Less a1 a2) = Less (substa f a1) (substa f a2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   416
| "substb f (And b1 b2) = And (substb f b1) (substb f b2)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   417
| "substb f (Neg b) = Neg (substb f b)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   418
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   419
text {* In textbooks about semantics one often finds substitution
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   420
  theorems, which express the relationship between substitution and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   421
  evaluation.  For @{typ "'a aexp"} and @{typ "'a bexp"}, we can prove
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   422
  such a theorem by mutual induction, followed by simplification.
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   423
*}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   424
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   425
lemma subst_one:
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   426
  "evala env (substa (Var (v := a')) a) = evala (env (v := evala env a')) a"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   427
  "evalb env (substb (Var (v := a')) b) = evalb (env (v := evala env a')) b"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   428
  by (induct a and b) simp_all
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   429
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   430
lemma subst_all:
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   431
  "evala env (substa s a) = evala (\<lambda>x. evala env (s x)) a"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   432
  "evalb env (substb s b) = evalb (\<lambda>x. evala env (s x)) b"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   433
  by (induct a and b) simp_all
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   434
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   435
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   436
subsubsection {* Example: a substitution function for terms *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   437
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   438
text {* Functions on datatypes with nested recursion are also defined
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   439
  by mutual primitive recursion. *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   440
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   441
datatype ('a, 'b) "term" = Var 'a | App 'b "('a, 'b) term list"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   442
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   443
text {* A substitution function on type @{typ "('a, 'b) term"} can be
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   444
  defined as follows, by working simultaneously on @{typ "('a, 'b)
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   445
  term list"}: *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   446
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   447
primrec subst_term :: "('a \<Rightarrow> ('a, 'b) term) \<Rightarrow> ('a, 'b) term \<Rightarrow> ('a, 'b) term" and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   448
  subst_term_list :: "('a \<Rightarrow> ('a, 'b) term) \<Rightarrow> ('a, 'b) term list \<Rightarrow> ('a, 'b) term list"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   449
where
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   450
  "subst_term f (Var a) = f a"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   451
| "subst_term f (App b ts) = App b (subst_term_list f ts)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   452
| "subst_term_list f [] = []"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   453
| "subst_term_list f (t # ts) = subst_term f t # subst_term_list f ts"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   454
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   455
text {* The recursion scheme follows the structure of the unfolded
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   456
  definition of type @{typ "('a, 'b) term"}.  To prove properties of this
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   457
  substitution function, mutual induction is needed:
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   458
*}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   459
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   460
lemma "subst_term (subst_term f1 \<circ> f2) t = subst_term f1 (subst_term f2 t)" and
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   461
  "subst_term_list (subst_term f1 \<circ> f2) ts = subst_term_list f1 (subst_term_list f2 ts)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   462
  by (induct t and ts) simp_all
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   463
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   464
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   465
subsubsection {* Example: a map function for infinitely branching trees *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   466
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   467
text {* Defining functions on infinitely branching datatypes by
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   468
  primitive recursion is just as easy.
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   469
*}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   470
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   471
datatype 'a tree = Atom 'a | Branch "nat \<Rightarrow> 'a tree"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   472
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   473
primrec map_tree :: "('a \<Rightarrow> 'b) \<Rightarrow> 'a tree \<Rightarrow> 'b tree"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   474
where
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   475
  "map_tree f (Atom a) = Atom (f a)"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   476
| "map_tree f (Branch ts) = Branch (\<lambda>x. map_tree f (ts x))"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   477
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   478
text {* Note that all occurrences of functions such as @{text ts}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   479
  above must be applied to an argument.  In particular, @{term
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   480
  "map_tree f \<circ> ts"} is not allowed here. *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   481
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   482
text {* Here is a simple composition lemma for @{term map_tree}: *}
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   483
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   484
lemma "map_tree g (map_tree f t) = map_tree (g \<circ> f) t"
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   485
  by (induct t) simp_all
a5bbc11474f9 clarified current 'primrec' vs. old 'recdef';
wenzelm
parents: 42911
diff changeset
   486
42907
dfd4ef8e73f6 updated and re-unified HOL typedef, with some live examples;
wenzelm
parents: 42705
diff changeset
   487
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   488
subsection {* Proof methods related to recursive definitions *}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   489
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   490
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   491
  \begin{matharray}{rcl}
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   492
    @{method_def (HOL) pat_completeness} & : & @{text method} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   493
    @{method_def (HOL) relation} & : & @{text method} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   494
    @{method_def (HOL) lexicographic_order} & : & @{text method} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   495
    @{method_def (HOL) size_change} & : & @{text method} \\
45944
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   496
    @{method_def (HOL) induction_schema} & : & @{text method} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   497
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   498
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
   499
  @{rail "
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   500
    @@{method (HOL) relation} @{syntax term}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   501
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   502
    @@{method (HOL) lexicographic_order} (@{syntax clasimpmod} * )
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   503
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   504
    @@{method (HOL) size_change} ( orders (@{syntax clasimpmod} * ) )
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   505
    ;
45944
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   506
    @@{method (HOL) induction_schema}
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   507
    ;
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   508
    orders: ( 'max' | 'min' | 'ms' ) *
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   509
  "}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   510
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   511
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   512
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   513
  \item @{method (HOL) pat_completeness} is a specialized method to
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   514
  solve goals regarding the completeness of pattern matching, as
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   515
  required by the @{command (HOL) "function"} package (cf.\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   516
  \cite{isabelle-function}).
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   517
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   518
  \item @{method (HOL) relation}~@{text R} introduces a termination
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   519
  proof using the relation @{text R}.  The resulting proof state will
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   520
  contain goals expressing that @{text R} is wellfounded, and that the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   521
  arguments of recursive calls decrease with respect to @{text R}.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   522
  Usually, this method is used as the initial proof step of manual
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   523
  termination proofs.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   524
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   525
  \item @{method (HOL) "lexicographic_order"} attempts a fully
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   526
  automated termination proof by searching for a lexicographic
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   527
  combination of size measures on the arguments of the function. The
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   528
  method accepts the same arguments as the @{method auto} method,
42930
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   529
  which it uses internally to prove local descents.  The @{syntax
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   530
  clasimpmod} modifiers are accepted (as for @{method auto}).
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   531
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   532
  In case of failure, extensive information is printed, which can help
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   533
  to analyse the situation (cf.\ \cite{isabelle-function}).
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   534
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   535
  \item @{method (HOL) "size_change"} also works on termination goals,
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   536
  using a variation of the size-change principle, together with a
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   537
  graph decomposition technique (see \cite{krauss_phd} for details).
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   538
  Three kinds of orders are used internally: @{text max}, @{text min},
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   539
  and @{text ms} (multiset), which is only available when the theory
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   540
  @{text Multiset} is loaded. When no order kinds are given, they are
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   541
  tried in order. The search for a termination proof uses SAT solving
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   542
  internally.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   543
42930
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   544
  For local descent proofs, the @{syntax clasimpmod} modifiers are
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   545
  accepted (as for @{method auto}).
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   546
45944
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   547
  \item @{method (HOL) induction_schema} derives user-specified
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   548
   induction rules from well-founded induction and completeness of
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   549
   patterns. This factors out some operations that are done internally
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   550
   by the function package and makes them available separately. See
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   551
   @{file "~~/src/HOL/ex/Induction_Schema.thy"} for examples.
e586f6d136b7 added some basic documentation about method induction_schema extracted from old NEWS
bulwahn
parents: 45943
diff changeset
   552
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   553
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   554
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   555
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   556
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   557
subsection {* Functions with explicit partiality *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   558
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   559
text {*
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   560
  \begin{matharray}{rcl}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   561
    @{command_def (HOL) "partial_function"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   562
    @{attribute_def (HOL) "partial_function_mono"} & : & @{text attribute} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   563
  \end{matharray}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   564
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   565
  @{rail "
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   566
    @@{command (HOL) partial_function} @{syntax target}?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   567
      '(' @{syntax nameref} ')' @{syntax \"fixes\"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   568
      @'where' @{syntax thmdecl}? @{syntax prop}
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
   569
  "}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   570
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   571
  \begin{description}
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   572
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   573
  \item @{command (HOL) "partial_function"}~@{text "(mode)"} defines
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   574
  recursive functions based on fixpoints in complete partial
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   575
  orders. No termination proof is required from the user or
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   576
  constructed internally. Instead, the possibility of non-termination
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   577
  is modelled explicitly in the result type, which contains an
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   578
  explicit bottom element.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   579
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   580
  Pattern matching and mutual recursion are currently not supported.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   581
  Thus, the specification consists of a single function described by a
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   582
  single recursive equation.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   583
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   584
  There are no fixed syntactic restrictions on the body of the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   585
  function, but the induced functional must be provably monotonic
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   586
  wrt.\ the underlying order.  The monotonicitity proof is performed
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   587
  internally, and the definition is rejected when it fails. The proof
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   588
  can be influenced by declaring hints using the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   589
  @{attribute (HOL) partial_function_mono} attribute.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   590
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   591
  The mandatory @{text mode} argument specifies the mode of operation
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   592
  of the command, which directly corresponds to a complete partial
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   593
  order on the result type. By default, the following modes are
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   594
  defined:
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   595
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   596
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   597
  \item @{text option} defines functions that map into the @{type
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   598
  option} type. Here, the value @{term None} is used to model a
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   599
  non-terminating computation. Monotonicity requires that if @{term
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   600
  None} is returned by a recursive call, then the overall result
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   601
  must also be @{term None}. This is best achieved through the use of
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   602
  the monadic operator @{const "Option.bind"}.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   603
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   604
  \item @{text tailrec} defines functions with an arbitrary result
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   605
  type and uses the slightly degenerated partial order where @{term
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   606
  "undefined"} is the bottom element.  Now, monotonicity requires that
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   607
  if @{term undefined} is returned by a recursive call, then the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   608
  overall result must also be @{term undefined}. In practice, this is
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   609
  only satisfied when each recursive call is a tail call, whose result
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   610
  is directly returned. Thus, this mode of operation allows the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   611
  definition of arbitrary tail-recursive functions.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   612
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   613
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   614
  Experienced users may define new modes by instantiating the locale
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   615
  @{const "partial_function_definitions"} appropriately.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   616
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   617
  \item @{attribute (HOL) partial_function_mono} declares rules for
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   618
  use in the internal monononicity proofs of partial function
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   619
  definitions.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   620
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   621
  \end{description}
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   622
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   623
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   624
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   625
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   626
subsection {* Old-style recursive function definitions (TFL) *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   627
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   628
text {*
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   629
  The old TFL commands @{command (HOL) "recdef"} and @{command (HOL)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   630
  "recdef_tc"} for defining recursive are mostly obsolete; @{command
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   631
  (HOL) "function"} or @{command (HOL) "fun"} should be used instead.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   632
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   633
  \begin{matharray}{rcl}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   634
    @{command_def (HOL) "recdef"} & : & @{text "theory \<rightarrow> theory)"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   635
    @{command_def (HOL) "recdef_tc"}@{text "\<^sup>*"} & : & @{text "theory \<rightarrow> proof(prove)"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   636
  \end{matharray}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   637
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   638
  @{rail "
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   639
    @@{command (HOL) recdef} ('(' @'permissive' ')')? \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   640
      @{syntax name} @{syntax term} (@{syntax prop} +) hints?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   641
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   642
    recdeftc @{syntax thmdecl}? tc
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   643
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   644
    hints: '(' @'hints' ( recdefmod * ) ')'
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   645
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   646
    recdefmod: (('recdef_simp' | 'recdef_cong' | 'recdef_wf')
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   647
      (() | 'add' | 'del') ':' @{syntax thmrefs}) | @{syntax clasimpmod}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   648
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   649
    tc: @{syntax nameref} ('(' @{syntax nat} ')')?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   650
  "}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   651
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   652
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   653
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   654
  \item @{command (HOL) "recdef"} defines general well-founded
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   655
  recursive functions (using the TFL package), see also
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   656
  \cite{isabelle-HOL}.  The ``@{text "(permissive)"}'' option tells
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   657
  TFL to recover from failed proof attempts, returning unfinished
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   658
  results.  The @{text recdef_simp}, @{text recdef_cong}, and @{text
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   659
  recdef_wf} hints refer to auxiliary rules to be used in the internal
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   660
  automated proof process of TFL.  Additional @{syntax clasimpmod}
42930
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   661
  declarations may be given to tune the context of the Simplifier
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   662
  (cf.\ \secref{sec:simplifier}) and Classical reasoner (cf.\
41394a61cca9 updated and re-unified classical proof methods;
wenzelm
parents: 42926
diff changeset
   663
  \secref{sec:classical}).
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   664
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   665
  \item @{command (HOL) "recdef_tc"}~@{text "c (i)"} recommences the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   666
  proof for leftover termination condition number @{text i} (default
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   667
  1) as generated by a @{command (HOL) "recdef"} definition of
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   668
  constant @{text c}.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   669
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   670
  Note that in most cases, @{command (HOL) "recdef"} is able to finish
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   671
  its internal proofs without manual intervention.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   672
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   673
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   674
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   675
  \medskip Hints for @{command (HOL) "recdef"} may be also declared
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   676
  globally, using the following attributes.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   677
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   678
  \begin{matharray}{rcl}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   679
    @{attribute_def (HOL) recdef_simp} & : & @{text attribute} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   680
    @{attribute_def (HOL) recdef_cong} & : & @{text attribute} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   681
    @{attribute_def (HOL) recdef_wf} & : & @{text attribute} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   682
  \end{matharray}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   683
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   684
  @{rail "
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   685
    (@@{attribute (HOL) recdef_simp} | @@{attribute (HOL) recdef_cong} |
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   686
      @@{attribute (HOL) recdef_wf}) (() | 'add' | 'del')
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   687
  "}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   688
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   689
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   690
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   691
section {* Datatypes \label{sec:hol-datatype} *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   692
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   693
text {*
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   694
  \begin{matharray}{rcl}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   695
    @{command_def (HOL) "datatype"} & : & @{text "theory \<rightarrow> theory"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   696
    @{command_def (HOL) "rep_datatype"} & : & @{text "theory \<rightarrow> proof(prove)"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   697
  \end{matharray}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   698
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   699
  @{rail "
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   700
    @@{command (HOL) datatype} (spec + @'and')
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   701
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   702
    @@{command (HOL) rep_datatype} ('(' (@{syntax name} +) ')')? (@{syntax term} +)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   703
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   704
45839
43a5b86bc102 'datatype' specifications allow explicit sort constraints;
wenzelm
parents: 45768
diff changeset
   705
    spec: @{syntax typespec_sorts} @{syntax mixfix}? '=' (cons + '|')
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   706
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   707
    cons: @{syntax name} (@{syntax type} * ) @{syntax mixfix}?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   708
  "}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   709
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   710
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   711
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   712
  \item @{command (HOL) "datatype"} defines inductive datatypes in
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   713
  HOL.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   714
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   715
  \item @{command (HOL) "rep_datatype"} represents existing types as
42909
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   716
  datatypes.
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   717
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   718
  For foundational reasons, some basic types such as @{typ nat}, @{typ
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   719
  "'a \<times> 'b"}, @{typ "'a + 'b"}, @{typ bool} and @{typ unit} are
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   720
  introduced by more primitive means using @{command_ref typedef}.  To
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   721
  recover the rich infrastructure of @{command datatype} (e.g.\ rules
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   722
  for @{method cases} and @{method induct} and the primitive recursion
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   723
  combinators), such types may be represented as actual datatypes
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   724
  later.  This is done by specifying the constructors of the desired
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   725
  type, and giving a proof of the induction rule, distinctness and
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   726
  injectivity of constructors.
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   727
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   728
  For example, see @{file "~~/src/HOL/Sum_Type.thy"} for the
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   729
  representation of the primitive sum type as fully-featured datatype.
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   730
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   731
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   732
42909
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   733
  The generated rules for @{method induct} and @{method cases} provide
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   734
  case names according to the given constructors, while parameters are
66b189dc5b83 updated and re-unified HOL rep_datatype;
wenzelm
parents: 42908
diff changeset
   735
  named after the types (see also \secref{sec:cases-induct}).
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   736
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   737
  See \cite{isabelle-HOL} for more details on datatypes, but beware of
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   738
  the old-style theory syntax being used there!  Apart from proper
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   739
  proof methods for case-analysis and induction, there are also
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   740
  emulations of ML tactics @{method (HOL) case_tac} and @{method (HOL)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   741
  induct_tac} available, see \secref{sec:hol-induct-tac}; these admit
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   742
  to refer directly to the internal structure of subgoals (including
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
   743
  internally bound parameters).
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   744
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   745
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   746
42910
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   747
subsubsection {* Examples *}
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   748
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   749
text {* We define a type of finite sequences, with slightly different
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   750
  names than the existing @{typ "'a list"} that is already in @{theory
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   751
  Main}: *}
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   752
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   753
datatype 'a seq = Empty | Seq 'a "'a seq"
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   754
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   755
text {* We can now prove some simple lemma by structural induction: *}
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   756
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   757
lemma "Seq x xs \<noteq> xs"
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   758
proof (induct xs arbitrary: x)
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   759
  case Empty
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   760
  txt {* This case can be proved using the simplifier: the freeness
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   761
    properties of the datatype are already declared as @{attribute
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   762
    simp} rules. *}
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   763
  show "Seq x Empty \<noteq> Empty"
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   764
    by simp
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   765
next
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   766
  case (Seq y ys)
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   767
  txt {* The step case is proved similarly. *}
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   768
  show "Seq x (Seq y ys) \<noteq> Seq y ys"
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   769
    using `Seq y ys \<noteq> ys` by simp
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   770
qed
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   771
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   772
text {* Here is a more succinct version of the same proof: *}
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   773
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   774
lemma "Seq x xs \<noteq> xs"
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   775
  by (induct xs arbitrary: x) simp_all
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   776
6834af822a8b updated and simplified HOL datatype examples (NB: special treatment of distinctness has been discontinued in the vicinity of 542b34b178ec);
wenzelm
parents: 42909
diff changeset
   777
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   778
section {* Records \label{sec:hol-record} *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   779
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   780
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   781
  In principle, records merely generalize the concept of tuples, where
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   782
  components may be addressed by labels instead of just position.  The
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   783
  logical infrastructure of records in Isabelle/HOL is slightly more
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   784
  advanced, though, supporting truly extensible record schemes.  This
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   785
  admits operations that are polymorphic with respect to record
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   786
  extension, yielding ``object-oriented'' effects like (single)
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   787
  inheritance.  See also \cite{NaraschewskiW-TPHOLs98} for more
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   788
  details on object-oriented verification and record subtyping in HOL.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   789
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   790
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   791
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   792
subsection {* Basic concepts *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   793
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   794
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   795
  Isabelle/HOL supports both \emph{fixed} and \emph{schematic} records
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   796
  at the level of terms and types.  The notation is as follows:
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   797
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   798
  \begin{center}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   799
  \begin{tabular}{l|l|l}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   800
    & record terms & record types \\ \hline
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   801
    fixed & @{text "\<lparr>x = a, y = b\<rparr>"} & @{text "\<lparr>x :: A, y :: B\<rparr>"} \\
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   802
    schematic & @{text "\<lparr>x = a, y = b, \<dots> = m\<rparr>"} &
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   803
      @{text "\<lparr>x :: A, y :: B, \<dots> :: M\<rparr>"} \\
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   804
  \end{tabular}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   805
  \end{center}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   806
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   807
  \noindent The ASCII representation of @{text "\<lparr>x = a\<rparr>"} is @{text
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   808
  "(| x = a |)"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   809
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   810
  A fixed record @{text "\<lparr>x = a, y = b\<rparr>"} has field @{text x} of value
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   811
  @{text a} and field @{text y} of value @{text b}.  The corresponding
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   812
  type is @{text "\<lparr>x :: A, y :: B\<rparr>"}, assuming that @{text "a :: A"}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   813
  and @{text "b :: B"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   814
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   815
  A record scheme like @{text "\<lparr>x = a, y = b, \<dots> = m\<rparr>"} contains fields
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   816
  @{text x} and @{text y} as before, but also possibly further fields
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   817
  as indicated by the ``@{text "\<dots>"}'' notation (which is actually part
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   818
  of the syntax).  The improper field ``@{text "\<dots>"}'' of a record
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   819
  scheme is called the \emph{more part}.  Logically it is just a free
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   820
  variable, which is occasionally referred to as ``row variable'' in
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   821
  the literature.  The more part of a record scheme may be
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   822
  instantiated by zero or more further components.  For example, the
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   823
  previous scheme may get instantiated to @{text "\<lparr>x = a, y = b, z =
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   824
  c, \<dots> = m'\<rparr>"}, where @{text m'} refers to a different more part.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   825
  Fixed records are special instances of record schemes, where
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   826
  ``@{text "\<dots>"}'' is properly terminated by the @{text "() :: unit"}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   827
  element.  In fact, @{text "\<lparr>x = a, y = b\<rparr>"} is just an abbreviation
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   828
  for @{text "\<lparr>x = a, y = b, \<dots> = ()\<rparr>"}.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   829
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   830
  \medskip Two key observations make extensible records in a simply
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   831
  typed language like HOL work out:
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   832
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   833
  \begin{enumerate}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   834
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   835
  \item the more part is internalized, as a free term or type
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   836
  variable,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   837
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   838
  \item field names are externalized, they cannot be accessed within
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   839
  the logic as first-class values.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   840
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   841
  \end{enumerate}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   842
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   843
  \medskip In Isabelle/HOL record types have to be defined explicitly,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   844
  fixing their field names and types, and their (optional) parent
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   845
  record.  Afterwards, records may be formed using above syntax, while
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   846
  obeying the canonical order of fields as given by their declaration.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   847
  The record package provides several standard operations like
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   848
  selectors and updates.  The common setup for various generic proof
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   849
  tools enable succinct reasoning patterns.  See also the Isabelle/HOL
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   850
  tutorial \cite{isabelle-hol-book} for further instructions on using
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   851
  records in practice.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   852
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   853
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   854
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   855
subsection {* Record specifications *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   856
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   857
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   858
  \begin{matharray}{rcl}
28761
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
   859
    @{command_def (HOL) "record"} & : & @{text "theory \<rightarrow> theory"} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   860
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   861
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
   862
  @{rail "
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42704
diff changeset
   863
    @@{command (HOL) record} @{syntax typespec_sorts} '=' \\
42704
3f19e324ff59 tuned rail diagrams and layout;
wenzelm
parents: 42652
diff changeset
   864
      (@{syntax type} '+')? (@{syntax constdecl} +)
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
   865
  "}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   866
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   867
  \begin{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   868
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   869
  \item @{command (HOL) "record"}~@{text "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>m) t = \<tau> + c\<^sub>1 :: \<sigma>\<^sub>1
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   870
  \<dots> c\<^sub>n :: \<sigma>\<^sub>n"} defines extensible record type @{text "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>m) t"},
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   871
  derived from the optional parent record @{text "\<tau>"} by adding new
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   872
  field components @{text "c\<^sub>i :: \<sigma>\<^sub>i"} etc.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   873
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   874
  The type variables of @{text "\<tau>"} and @{text "\<sigma>\<^sub>i"} need to be
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   875
  covered by the (distinct) parameters @{text "\<alpha>\<^sub>1, \<dots>,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   876
  \<alpha>\<^sub>m"}.  Type constructor @{text t} has to be new, while @{text
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   877
  \<tau>} needs to specify an instance of an existing record type.  At
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   878
  least one new field @{text "c\<^sub>i"} has to be specified.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   879
  Basically, field names need to belong to a unique record.  This is
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   880
  not a real restriction in practice, since fields are qualified by
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   881
  the record name internally.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   882
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   883
  The parent record specification @{text \<tau>} is optional; if omitted
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   884
  @{text t} becomes a root record.  The hierarchy of all records
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   885
  declared within a theory context forms a forest structure, i.e.\ a
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   886
  set of trees starting with a root record each.  There is no way to
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   887
  merge multiple parent records!
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   888
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   889
  For convenience, @{text "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>m) t"} is made a
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   890
  type abbreviation for the fixed record type @{text "\<lparr>c\<^sub>1 ::
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   891
  \<sigma>\<^sub>1, \<dots>, c\<^sub>n :: \<sigma>\<^sub>n\<rparr>"}, likewise is @{text
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   892
  "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>m, \<zeta>) t_scheme"} made an abbreviation for
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   893
  @{text "\<lparr>c\<^sub>1 :: \<sigma>\<^sub>1, \<dots>, c\<^sub>n :: \<sigma>\<^sub>n, \<dots> ::
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   894
  \<zeta>\<rparr>"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   895
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
   896
  \end{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   897
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   898
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   899
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   900
subsection {* Record operations *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   901
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   902
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   903
  Any record definition of the form presented above produces certain
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   904
  standard operations.  Selectors and updates are provided for any
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   905
  field, including the improper one ``@{text more}''.  There are also
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   906
  cumulative record constructor functions.  To simplify the
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   907
  presentation below, we assume for now that @{text "(\<alpha>\<^sub>1, \<dots>,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   908
  \<alpha>\<^sub>m) t"} is a root record with fields @{text "c\<^sub>1 ::
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   909
  \<sigma>\<^sub>1, \<dots>, c\<^sub>n :: \<sigma>\<^sub>n"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   910
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   911
  \medskip \textbf{Selectors} and \textbf{updates} are available for
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   912
  any field (including ``@{text more}''):
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   913
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   914
  \begin{matharray}{lll}
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   915
    @{text "c\<^sub>i"} & @{text "::"} & @{text "\<lparr>\<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr> \<Rightarrow> \<sigma>\<^sub>i"} \\
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   916
    @{text "c\<^sub>i_update"} & @{text "::"} & @{text "\<sigma>\<^sub>i \<Rightarrow> \<lparr>\<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr> \<Rightarrow> \<lparr>\<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr>"} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   917
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   918
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   919
  There is special syntax for application of updates: @{text "r\<lparr>x :=
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   920
  a\<rparr>"} abbreviates term @{text "x_update a r"}.  Further notation for
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   921
  repeated updates is also available: @{text "r\<lparr>x := a\<rparr>\<lparr>y := b\<rparr>\<lparr>z :=
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   922
  c\<rparr>"} may be written @{text "r\<lparr>x := a, y := b, z := c\<rparr>"}.  Note that
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   923
  because of postfix notation the order of fields shown here is
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   924
  reverse than in the actual term.  Since repeated updates are just
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   925
  function applications, fields may be freely permuted in @{text "\<lparr>x
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   926
  := a, y := b, z := c\<rparr>"}, as far as logical equality is concerned.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   927
  Thus commutativity of independent updates can be proven within the
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   928
  logic for any two fields, but not as a general theorem.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   929
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   930
  \medskip The \textbf{make} operation provides a cumulative record
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   931
  constructor function:
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   932
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   933
  \begin{matharray}{lll}
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   934
    @{text "t.make"} & @{text "::"} & @{text "\<sigma>\<^sub>1 \<Rightarrow> \<dots> \<sigma>\<^sub>n \<Rightarrow> \<lparr>\<^vec>c :: \<^vec>\<sigma>\<rparr>"} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   935
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   936
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   937
  \medskip We now reconsider the case of non-root records, which are
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   938
  derived of some parent.  In general, the latter may depend on
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   939
  another parent as well, resulting in a list of \emph{ancestor
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   940
  records}.  Appending the lists of fields of all ancestors results in
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   941
  a certain field prefix.  The record package automatically takes care
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   942
  of this by lifting operations over this context of ancestor fields.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   943
  Assuming that @{text "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>m) t"} has ancestor
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   944
  fields @{text "b\<^sub>1 :: \<rho>\<^sub>1, \<dots>, b\<^sub>k :: \<rho>\<^sub>k"},
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   945
  the above record operations will get the following types:
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   946
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   947
  \medskip
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   948
  \begin{tabular}{lll}
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   949
    @{text "c\<^sub>i"} & @{text "::"} & @{text "\<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr> \<Rightarrow> \<sigma>\<^sub>i"} \\
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   950
    @{text "c\<^sub>i_update"} & @{text "::"} & @{text "\<sigma>\<^sub>i \<Rightarrow>
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   951
      \<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr> \<Rightarrow>
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   952
      \<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr>"} \\
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   953
    @{text "t.make"} & @{text "::"} & @{text "\<rho>\<^sub>1 \<Rightarrow> \<dots> \<rho>\<^sub>k \<Rightarrow> \<sigma>\<^sub>1 \<Rightarrow> \<dots> \<sigma>\<^sub>n \<Rightarrow>
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   954
      \<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>\<rparr>"} \\
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   955
  \end{tabular}
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   956
  \medskip
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   957
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   958
  \noindent Some further operations address the extension aspect of a
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   959
  derived record scheme specifically: @{text "t.fields"} produces a
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   960
  record fragment consisting of exactly the new fields introduced here
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   961
  (the result may serve as a more part elsewhere); @{text "t.extend"}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   962
  takes a fixed record and adds a given more part; @{text
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   963
  "t.truncate"} restricts a record scheme to a fixed record.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   964
26852
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   965
  \medskip
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   966
  \begin{tabular}{lll}
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   967
    @{text "t.fields"} & @{text "::"} & @{text "\<sigma>\<^sub>1 \<Rightarrow> \<dots> \<sigma>\<^sub>n \<Rightarrow> \<lparr>\<^vec>c :: \<^vec>\<sigma>\<rparr>"} \\
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   968
    @{text "t.extend"} & @{text "::"} & @{text "\<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>\<rparr> \<Rightarrow>
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   969
      \<zeta> \<Rightarrow> \<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr>"} \\
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   970
    @{text "t.truncate"} & @{text "::"} & @{text "\<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>, \<dots> :: \<zeta>\<rparr> \<Rightarrow> \<lparr>\<^vec>b :: \<^vec>\<rho>, \<^vec>c :: \<^vec>\<sigma>\<rparr>"} \\
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   971
  \end{tabular}
a31203f58b20 misc tuning;
wenzelm
parents: 26849
diff changeset
   972
  \medskip
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   973
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   974
  \noindent Note that @{text "t.make"} and @{text "t.fields"} coincide
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   975
  for root records.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   976
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   977
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   978
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   979
subsection {* Derived rules and proof tools *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   980
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   981
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   982
  The record package proves several results internally, declaring
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   983
  these facts to appropriate proof tools.  This enables users to
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   984
  reason about record structures quite conveniently.  Assume that
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   985
  @{text t} is a record type as specified above.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   986
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   987
  \begin{enumerate}
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   988
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   989
  \item Standard conversions for selectors or updates applied to
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   990
  record constructor terms are made part of the default Simplifier
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   991
  context; thus proofs by reduction of basic operations merely require
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   992
  the @{method simp} method without further arguments.  These rules
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   993
  are available as @{text "t.simps"}, too.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
   994
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   995
  \item Selectors applied to updated records are automatically reduced
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   996
  by an internal simplification procedure, which is also part of the
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   997
  standard Simplifier setup.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   998
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
   999
  \item Inject equations of a form analogous to @{prop "(x, y) = (x',
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1000
  y') \<equiv> x = x' \<and> y = y'"} are declared to the Simplifier and Classical
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1001
  Reasoner as @{attribute iff} rules.  These rules are available as
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1002
  @{text "t.iffs"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1003
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1004
  \item The introduction rule for record equality analogous to @{text
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1005
  "x r = x r' \<Longrightarrow> y r = y r' \<dots> \<Longrightarrow> r = r'"} is declared to the Simplifier,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1006
  and as the basic rule context as ``@{attribute intro}@{text "?"}''.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1007
  The rule is called @{text "t.equality"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1008
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1009
  \item Representations of arbitrary record expressions as canonical
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1010
  constructor terms are provided both in @{method cases} and @{method
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1011
  induct} format (cf.\ the generic proof methods of the same name,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1012
  \secref{sec:cases-induct}).  Several variations are available, for
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1013
  fixed records, record schemes, more parts etc.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
  1014
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1015
  The generic proof methods are sufficiently smart to pick the most
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1016
  sensible rule according to the type of the indicated record
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1017
  expression: users just need to apply something like ``@{text "(cases
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1018
  r)"}'' to a certain proof problem.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1019
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1020
  \item The derived record operations @{text "t.make"}, @{text
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1021
  "t.fields"}, @{text "t.extend"}, @{text "t.truncate"} are \emph{not}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1022
  treated automatically, but usually need to be expanded by hand,
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1023
  using the collective fact @{text "t.defs"}.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1024
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1025
  \end{enumerate}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1026
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1027
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1028
42911
6891e8a8d748 record examples;
wenzelm
parents: 42910
diff changeset
  1029
subsubsection {* Examples *}
6891e8a8d748 record examples;
wenzelm
parents: 42910
diff changeset
  1030
6891e8a8d748 record examples;
wenzelm
parents: 42910
diff changeset
  1031
text {* See @{file "~~/src/HOL/ex/Records.thy"}, for example. *}
6891e8a8d748 record examples;
wenzelm
parents: 42910
diff changeset
  1032
6891e8a8d748 record examples;
wenzelm
parents: 42910
diff changeset
  1033
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1034
section {* Adhoc tuples *}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1035
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1036
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1037
  \begin{matharray}{rcl}
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1038
    @{attribute_def (HOL) split_format}@{text "\<^sup>*"} & : & @{text attribute} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1039
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1040
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1041
  @{rail "
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1042
    @@{attribute (HOL) split_format} ('(' 'complete' ')')?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1043
  "}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1044
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1045
  \begin{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1046
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1047
  \item @{attribute (HOL) split_format}\ @{text "(complete)"} causes
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1048
  arguments in function applications to be represented canonically
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1049
  according to their tuple type structure.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1050
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1051
  Note that this operation tends to invent funny names for new local
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1052
  parameters introduced.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1053
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1054
  \end{description}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1055
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1056
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1057
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1058
section {* Typedef axiomatization \label{sec:hol-typedef} *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1059
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1060
text {* A Gordon/HOL-style type definition is a certain axiom scheme
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1061
  that identifies a new type with a subset of an existing type.  More
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1062
  precisely, the new type is defined by exhibiting an existing type
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1063
  @{text \<tau>}, a set @{text "A :: \<tau> set"}, and a theorem that proves
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1064
  @{prop "\<exists>x. x \<in> A"}.  Thus @{text A} is a non-empty subset of @{text
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1065
  \<tau>}, and the new type denotes this subset.  New functions are
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1066
  postulated that establish an isomorphism between the new type and
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1067
  the subset.  In general, the type @{text \<tau>} may involve type
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1068
  variables @{text "\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>n"} which means that the type definition
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1069
  produces a type constructor @{text "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>n) t"} depending on
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1070
  those type arguments.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1071
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1072
  The axiomatization can be considered a ``definition'' in the sense
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1073
  of the particular set-theoretic interpretation of HOL
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1074
  \cite{pitts93}, where the universe of types is required to be
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1075
  downwards-closed wrt.\ arbitrary non-empty subsets.  Thus genuinely
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1076
  new types introduced by @{command "typedef"} stay within the range
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1077
  of HOL models by construction.  Note that @{command_ref
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1078
  type_synonym} from Isabelle/Pure merely introduces syntactic
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1079
  abbreviations, without any logical significance.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1080
  
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1081
  \begin{matharray}{rcl}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1082
    @{command_def (HOL) "typedef"} & : & @{text "local_theory \<rightarrow> proof(prove)"} \\
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1083
  \end{matharray}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1084
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1085
  @{rail "
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1086
    @@{command (HOL) typedef} alt_name? abs_type '=' rep_set
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1087
    ;
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1088
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1089
    alt_name: '(' (@{syntax name} | @'open' | @'open' @{syntax name}) ')'
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1090
    ;
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1091
    abs_type: @{syntax typespec_sorts} @{syntax mixfix}?
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1092
    ;
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1093
    rep_set: @{syntax term} (@'morphisms' @{syntax name} @{syntax name})?
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1094
  "}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1095
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1096
  \begin{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1097
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1098
  \item @{command (HOL) "typedef"}~@{text "(\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>n) t = A"}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1099
  axiomatizes a type definition in the background theory of the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1100
  current context, depending on a non-emptiness result of the set
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1101
  @{text A} that needs to be proven here.  The set @{text A} may
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1102
  contain type variables @{text "\<alpha>\<^sub>1, \<dots>, \<alpha>\<^sub>n"} as specified on the LHS,
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1103
  but no term variables.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1104
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1105
  Even though a local theory specification, the newly introduced type
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1106
  constructor cannot depend on parameters or assumptions of the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1107
  context: this is structurally impossible in HOL.  In contrast, the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1108
  non-emptiness proof may use local assumptions in unusual situations,
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1109
  which could result in different interpretations in target contexts:
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1110
  the meaning of the bijection between the representing set @{text A}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1111
  and the new type @{text t} may then change in different application
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1112
  contexts.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1113
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1114
  By default, @{command (HOL) "typedef"} defines both a type
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1115
  constructor @{text t} for the new type, and a term constant @{text
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1116
  t} for the representing set within the old type.  Use the ``@{text
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1117
  "(open)"}'' option to suppress a separate constant definition
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1118
  altogether.  The injection from type to set is called @{text Rep_t},
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1119
  its inverse @{text Abs_t}, unless explicit @{keyword (HOL)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1120
  "morphisms"} specification provides alternative names.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1121
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1122
  The core axiomatization uses the locale predicate @{const
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1123
  type_definition} as defined in Isabelle/HOL.  Various basic
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1124
  consequences of that are instantiated accordingly, re-using the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1125
  locale facts with names derived from the new type constructor.  Thus
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1126
  the generic @{thm type_definition.Rep} is turned into the specific
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1127
  @{text "Rep_t"}, for example.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1128
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1129
  Theorems @{thm type_definition.Rep}, @{thm
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1130
  type_definition.Rep_inverse}, and @{thm type_definition.Abs_inverse}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1131
  provide the most basic characterization as a corresponding
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1132
  injection/surjection pair (in both directions).  The derived rules
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1133
  @{thm type_definition.Rep_inject} and @{thm
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1134
  type_definition.Abs_inject} provide a more convenient version of
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1135
  injectivity, suitable for automated proof tools (e.g.\ in
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1136
  declarations involving @{attribute simp} or @{attribute iff}).
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1137
  Furthermore, the rules @{thm type_definition.Rep_cases}~/ @{thm
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1138
  type_definition.Rep_induct}, and @{thm type_definition.Abs_cases}~/
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1139
  @{thm type_definition.Abs_induct} provide alternative views on
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1140
  surjectivity.  These rules are already declared as set or type rules
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1141
  for the generic @{method cases} and @{method induct} methods,
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1142
  respectively.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1143
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1144
  An alternative name for the set definition (and other derived
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1145
  entities) may be specified in parentheses; the default is to use
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1146
  @{text t} directly.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1147
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1148
  \end{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1149
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1150
  \begin{warn}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1151
  If you introduce a new type axiomatically, i.e.\ via @{command_ref
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1152
  typedecl} and @{command_ref axiomatization}, the minimum requirement
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1153
  is that it has a non-empty model, to avoid immediate collapse of the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1154
  HOL logic.  Moreover, one needs to demonstrate that the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1155
  interpretation of such free-form axiomatizations can coexist with
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1156
  that of the regular @{command_def typedef} scheme, and any extension
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1157
  that other people might have introduced elsewhere (e.g.\ in HOLCF
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1158
  \cite{MuellerNvOS99}).
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1159
  \end{warn}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1160
*}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1161
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1162
subsubsection {* Examples *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1163
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1164
text {* Type definitions permit the introduction of abstract data
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1165
  types in a safe way, namely by providing models based on already
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1166
  existing types.  Given some abstract axiomatic description @{text P}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1167
  of a type, this involves two steps:
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1168
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1169
  \begin{enumerate}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1170
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1171
  \item Find an appropriate type @{text \<tau>} and subset @{text A} which
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1172
  has the desired properties @{text P}, and make a type definition
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1173
  based on this representation.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1174
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1175
  \item Prove that @{text P} holds for @{text \<tau>} by lifting @{text P}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1176
  from the representation.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1177
42908
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1178
  \end{enumerate}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1179
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1180
  You can later forget about the representation and work solely in
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1181
  terms of the abstract properties @{text P}.
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1182
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1183
  \medskip The following trivial example pulls a three-element type
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1184
  into existence within the formal logical environment of HOL. *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1185
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1186
typedef three = "{(True, True), (True, False), (False, True)}"
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1187
  by blast
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1188
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1189
definition "One = Abs_three (True, True)"
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1190
definition "Two = Abs_three (True, False)"
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1191
definition "Three = Abs_three (False, True)"
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1192
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1193
lemma three_distinct: "One \<noteq> Two"  "One \<noteq> Three"  "Two \<noteq> Three"
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1194
  by (simp_all add: One_def Two_def Three_def Abs_three_inject three_def)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1195
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1196
lemma three_cases:
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1197
  fixes x :: three obtains "x = One" | "x = Two" | "x = Three"
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1198
  by (cases x) (auto simp: One_def Two_def Three_def Abs_three_inject three_def)
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1199
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1200
text {* Note that such trivial constructions are better done with
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1201
  derived specification mechanisms such as @{command datatype}: *}
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1202
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1203
datatype three' = One' | Two' | Three'
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1204
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1205
text {* This avoids re-doing basic definitions and proofs from the
eb94cfaaf5d4 rearranged some sections;
wenzelm
parents: 42907
diff changeset
  1206
  primitive @{command typedef} above. *}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1207
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1208
41396
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1209
section {* Functorial structure of types *}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1210
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1211
text {*
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1212
  \begin{matharray}{rcl}
41505
6d19301074cf "enriched_type" replaces less specific "type_lifting"
haftmann
parents: 41396
diff changeset
  1213
    @{command_def (HOL) "enriched_type"} & : & @{text "local_theory \<rightarrow> proof(prove)"}
41396
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1214
  \end{matharray}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1215
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1216
  @{rail "
42617
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1217
    @@{command (HOL) enriched_type} (@{syntax name} ':')? @{syntax term}
41396
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1218
    ;
42617
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1219
  "}
41396
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1220
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1221
  \begin{description}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1222
42617
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1223
  \item @{command (HOL) "enriched_type"}~@{text "prefix: m"} allows to
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1224
  prove and register properties about the functorial structure of type
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1225
  constructors.  These properties then can be used by other packages
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1226
  to deal with those type constructors in certain type constructions.
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1227
  Characteristic theorems are noted in the current local theory.  By
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1228
  default, they are prefixed with the base name of the type
77d239840285 more precise rail diagrams;
wenzelm
parents: 42596
diff changeset
  1229
  constructor, an explicit prefix can be given alternatively.
41396
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1230
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1231
  The given term @{text "m"} is considered as \emph{mapper} for the
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1232
  corresponding type constructor and must conform to the following
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1233
  type pattern:
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1234
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1235
  \begin{matharray}{lll}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1236
    @{text "m"} & @{text "::"} &
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1237
      @{text "\<sigma>\<^isub>1 \<Rightarrow> \<dots> \<sigma>\<^isub>k \<Rightarrow> (\<^vec>\<alpha>\<^isub>n) t \<Rightarrow> (\<^vec>\<beta>\<^isub>n) t"} \\
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1238
  \end{matharray}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1239
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1240
  \noindent where @{text t} is the type constructor, @{text
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1241
  "\<^vec>\<alpha>\<^isub>n"} and @{text "\<^vec>\<beta>\<^isub>n"} are distinct
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1242
  type variables free in the local theory and @{text "\<sigma>\<^isub>1"},
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1243
  \ldots, @{text "\<sigma>\<^isub>k"} is a subsequence of @{text "\<alpha>\<^isub>1 \<Rightarrow>
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1244
  \<beta>\<^isub>1"}, @{text "\<beta>\<^isub>1 \<Rightarrow> \<alpha>\<^isub>1"}, \ldots,
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1245
  @{text "\<alpha>\<^isub>n \<Rightarrow> \<beta>\<^isub>n"}, @{text "\<beta>\<^isub>n \<Rightarrow>
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1246
  \<alpha>\<^isub>n"}.
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1247
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1248
  \end{description}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1249
*}
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1250
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1251
section {* Quotient types *}
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1252
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1253
text {*
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1254
  The quotient package defines a new quotient type given a raw type
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1255
  and a partial equivalence relation.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1256
  It also includes automation for transporting definitions and theorems.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1257
  It can automatically produce definitions and theorems on the quotient type,
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1258
  given the corresponding constants and facts on the raw type.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1259
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1260
  \begin{matharray}{rcl}
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1261
    @{command_def (HOL) "quotient_type"} & : & @{text "local_theory \<rightarrow> proof(prove)"}\\
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1262
    @{command_def (HOL) "quotient_definition"} & : & @{text "local_theory \<rightarrow> proof(prove)"}\\
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1263
    @{command_def (HOL) "print_quotmaps"} & : & @{text "context \<rightarrow>"}\\
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1264
    @{command_def (HOL) "print_quotients"} & : & @{text "context \<rightarrow>"}\\
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1265
    @{command_def (HOL) "print_quotconsts"} & : & @{text "context \<rightarrow>"}\\
46447
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1266
    @{method_def (HOL) "lifting"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1267
    @{method_def (HOL) "lifting_setup"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1268
    @{method_def (HOL) "descending"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1269
    @{method_def (HOL) "descending_setup"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1270
    @{method_def (HOL) "partiality_descending"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1271
    @{method_def (HOL) "partiality_descending_setup"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1272
    @{method_def (HOL) "regularize"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1273
    @{method_def (HOL) "injection"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1274
    @{method_def (HOL) "cleaning"} & : & @{text method} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1275
    @{attribute_def (HOL) "quot_lifted"} & : & @{text attribute} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1276
    @{attribute_def (HOL) "quot_respect"} & : & @{text attribute} \\
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1277
    @{attribute_def (HOL) "quot_preserve"} & : & @{text attribute} \\
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1278
  \end{matharray}
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1279
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1280
  @{rail "
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1281
    @@{command (HOL) quotient_type} (spec + @'and');
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1282
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1283
    spec: @{syntax typespec} @{syntax mixfix}? '=' \\
45678
1a6206f538d4 updated documentation for the quotient package
kuncar
parents: 45409
diff changeset
  1284
     @{syntax type} '/' ('partial' ':')? @{syntax term} \\
1a6206f538d4 updated documentation for the quotient package
kuncar
parents: 45409
diff changeset
  1285
     (@'morphisms' @{syntax name} @{syntax name})?; 
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1286
  "}
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1287
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1288
  @{rail "
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1289
    @@{command (HOL) quotient_definition} constdecl? @{syntax thmdecl}? \\
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1290
    @{syntax term} 'is' @{syntax term};
46447
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1291
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1292
    constdecl: @{syntax name} ('::' @{syntax type})? @{syntax mixfix}?
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1293
  "}
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1294
46447
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1295
  @{rail "
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1296
    @@{method (HOL) lifting} @{syntax thmrefs}?
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1297
    ;
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1298
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1299
    @@{method (HOL) lifting_setup} @{syntax thmrefs}?
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1300
    ;
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1301
  "}
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1302
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1303
  \begin{description}
46447
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1304
45767
fe2fd2f76f48 the note about morphisms moved in the description part
kuncar
parents: 45701
diff changeset
  1305
  \item @{command (HOL) "quotient_type"} defines quotient types. The injection from a quotient type 
fe2fd2f76f48 the note about morphisms moved in the description part
kuncar
parents: 45701
diff changeset
  1306
  to a raw type is called @{text rep_t}, its inverse @{text abs_t} unless explicit @{keyword (HOL)
46447
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1307
  "morphisms"} specification provides alternative names. @{command (HOL) "quotient_type"} requires
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1308
  the user to prove that the relation is an equivalence relation (predicate @{text equivp}), unless
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1309
  the user specifies explicitely @{text partial} in which case the obligation is @{text part_equivp}.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1310
  A quotient defined with @{text partial} is weaker in the sense that less things can be proved
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1311
  automatically.
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1312
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1313
  \item @{command (HOL) "quotient_definition"} defines a constant on the quotient type.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1314
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1315
  \item @{command (HOL) "print_quotmaps"} prints quotient map functions.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1316
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1317
  \item @{command (HOL) "print_quotients"} prints quotients.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1318
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1319
  \item @{command (HOL) "print_quotconsts"} prints quotient constants.
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1320
46447
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1321
  \item @{method (HOL) "lifting"} and @{method (HOL) "lifting_setup"}
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1322
    methods match the current goal with the given raw theorem to be
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1323
    lifted producing three new subgoals: regularization, injection and
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1324
    cleaning subgoals. @{method (HOL) "lifting"} tries to apply the
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1325
    heuristics for automatically solving these three subgoals and
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1326
    leaves only the subgoals unsolved by the heuristics to the user as
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1327
    opposed to @{method (HOL) "lifting_setup"} which leaves the three
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1328
    subgoals unsolved.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1329
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1330
  \item @{method (HOL) "descending"} and @{method (HOL)
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1331
    "descending_setup"} try to guess a raw statement that would lift
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1332
    to the current subgoal. Such statement is assumed as a new subgoal
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1333
    and @{method (HOL) "descending"} continues in the same way as
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1334
    @{method (HOL) "lifting"} does. @{method (HOL) "descending"} tries
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1335
    to solve the arising regularization, injection and cleaning
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1336
    subgoals with the analoguous method @{method (HOL)
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1337
    "descending_setup"} which leaves the four unsolved subgoals.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1338
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1339
  \item @{method (HOL) "partiality_descending"} finds the regularized
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1340
    theorem that would lift to the current subgoal, lifts it and
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1341
    leaves as a subgoal. This method can be used with partial
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1342
    equivalence quotients where the non regularized statements would
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1343
    not be true. @{method (HOL) "partiality_descending_setup"} leaves
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1344
    the injection and cleaning subgoals unchanged.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1345
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1346
  \item @{method (HOL) "regularize"} applies the regularization
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1347
    heuristics to the current subgoal.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1348
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1349
  \item @{method (HOL) "injection"} applies the injection heuristics
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1350
    to the current goal using the stored quotient respectfulness
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1351
    theorems.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1352
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1353
  \item @{method (HOL) "cleaning"} applies the injection cleaning
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1354
    heuristics to the current subgoal using the stored quotient
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1355
    preservation theorems.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1356
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1357
  \item @{attribute (HOL) quot_lifted} attribute tries to
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1358
    automatically transport the theorem to the quotient type.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1359
    The attribute uses all the defined quotients types and quotient
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1360
    constants often producing undesired results or theorems that
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1361
    cannot be lifted.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1362
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1363
  \item @{attribute (HOL) quot_respect} and @{attribute (HOL)
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1364
    quot_preserve} attributes declare a theorem as a respectfulness
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1365
    and preservation theorem respectively.  These are stored in the
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1366
    local theory store and used by the @{method (HOL) "injection"}
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1367
    and @{method (HOL) "cleaning"} methods respectively.
f37da60a8cc6 specification of the quotient package
Cezary Kaliszyk <cezarykaliszyk@gmail.com>
parents: 46028
diff changeset
  1368
43993
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1369
  \end{description}
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1370
b141d7a3d4e3 rudimentary documentation of the quotient package in the isar reference manual
bulwahn
parents: 43914
diff changeset
  1371
*}
41396
5379e4a85a66 documentation stub on type_lifting
haftmann
parents: 40918
diff changeset
  1372
43994
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1373
section {* Coercive subtyping *}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1374
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1375
text {*
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1376
  \begin{matharray}{rcl}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1377
    @{attribute_def (HOL) coercion} & : & @{text attribute} \\
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1378
    @{attribute_def (HOL) coercion_enabled} & : & @{text attribute} \\
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1379
    @{attribute_def (HOL) coercion_map} & : & @{text attribute} \\
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1380
  \end{matharray}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1381
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1382
  @{rail "
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1383
    @@{attribute (HOL) coercion} (@{syntax term})?
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1384
    ;
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1385
  "}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1386
  @{rail "
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1387
    @@{attribute (HOL) coercion_map} (@{syntax term})?
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1388
    ;
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1389
  "}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1390
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1391
  Coercive subtyping allows the user to omit explicit type conversions,
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1392
  also called \emph{coercions}.  Type inference will add them as
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1393
  necessary when parsing a term. See
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1394
  \cite{traytel-berghofer-nipkow-2011} for details.
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1395
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1396
  \begin{description}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1397
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1398
  \item @{attribute (HOL) "coercion"}~@{text "f"} registers a new
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1399
  coercion function @{text "f :: \<sigma>\<^isub>1 \<Rightarrow>
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1400
  \<sigma>\<^isub>2"} where @{text "\<sigma>\<^isub>1"} and @{text
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1401
  "\<sigma>\<^isub>2"} are nullary type constructors. Coercions are
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1402
  composed by the inference algorithm if needed. Note that the type
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1403
  inference algorithm is complete only if the registered coercions form
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1404
  a lattice.
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1405
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1406
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1407
  \item @{attribute (HOL) "coercion_map"}~@{text "map"} registers a new
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1408
  map function to lift coercions through type constructors. The function
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1409
  @{text "map"} must conform to the following type pattern
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1410
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1411
  \begin{matharray}{lll}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1412
    @{text "map"} & @{text "::"} &
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1413
      @{text "f\<^isub>1 \<Rightarrow> \<dots> \<Rightarrow> f\<^isub>n \<Rightarrow> (\<alpha>\<^isub>1, \<dots>, \<alpha>\<^isub>n) t \<Rightarrow> (\<beta>\<^isub>1, \<dots>, \<beta>\<^isub>n) t"} \\
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1414
  \end{matharray}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1415
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1416
  where @{text "t"} is a type constructor and @{text "f\<^isub>i"} is of
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1417
  type @{text "\<alpha>\<^isub>i \<Rightarrow> \<beta>\<^isub>i"} or
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1418
  @{text "\<beta>\<^isub>i \<Rightarrow> \<alpha>\<^isub>i"}.
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1419
  Registering a map function overwrites any existing map function for
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1420
  this particular type constructor.
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1421
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1422
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1423
  \item @{attribute (HOL) "coercion_enabled"} enables the coercion
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1424
  inference algorithm.
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1425
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1426
  \end{description}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1427
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1428
*}
5de4bde3ad41 document coercions
noschinl
parents: 43993
diff changeset
  1429
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1430
section {* Arithmetic proof support *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1431
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1432
text {*
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1433
  \begin{matharray}{rcl}
28761
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  1434
    @{method_def (HOL) arith} & : & @{text method} \\
30863
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1435
    @{attribute_def (HOL) arith} & : & @{text attribute} \\
28761
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  1436
    @{attribute_def (HOL) arith_split} & : & @{text attribute} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1437
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1438
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1439
  The @{method (HOL) arith} method decides linear arithmetic problems
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1440
  (on types @{text nat}, @{text int}, @{text real}).  Any current
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1441
  facts are inserted into the goal before running the procedure.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1442
30863
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1443
  The @{attribute (HOL) arith} attribute declares facts that are
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1444
  always supplied to the arithmetic provers implicitly.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1445
30863
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1446
  The @{attribute (HOL) arith_split} attribute declares case split
30865
5106e13d400f fixed formal markup;
wenzelm
parents: 30863
diff changeset
  1447
  rules to be expanded before @{method (HOL) arith} is invoked.
30863
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1448
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1449
  Note that a simpler (but faster) arithmetic prover is
5dc392a59bb7 Finite_Set: lemma
nipkow
parents: 30242
diff changeset
  1450
  already invoked by the Simplifier.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1451
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1452
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1453
30169
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1454
section {* Intuitionistic proof search *}
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1455
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1456
text {*
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1457
  \begin{matharray}{rcl}
30171
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1458
    @{method_def (HOL) iprover} & : & @{text method} \\
30169
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1459
  \end{matharray}
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1460
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1461
  @{rail "
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1462
    @@{method (HOL) iprover} ( @{syntax rulemod} * )
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1463
  "}
30169
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1464
30171
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1465
  The @{method (HOL) iprover} method performs intuitionistic proof
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1466
  search, depending on specifically declared rules from the context,
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1467
  or given as explicit arguments.  Chained facts are inserted into the
35613
9d3ff36ad4e1 eliminated Args.bang_facts (legacy feature);
wenzelm
parents: 35351
diff changeset
  1468
  goal before commencing proof search.
9d3ff36ad4e1 eliminated Args.bang_facts (legacy feature);
wenzelm
parents: 35351
diff changeset
  1469
30169
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1470
  Rules need to be classified as @{attribute (Pure) intro},
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1471
  @{attribute (Pure) elim}, or @{attribute (Pure) dest}; here the
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1472
  ``@{text "!"}'' indicator refers to ``safe'' rules, which may be
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1473
  applied aggressively (without considering back-tracking later).
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1474
  Rules declared with ``@{text "?"}'' are ignored in proof search (the
42626
6ac8c55c657e eliminated some duplicate "def" positions;
wenzelm
parents: 42617
diff changeset
  1475
  single-step @{method (Pure) rule} method still observes these).  An
30169
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1476
  explicit weight annotation may be given as well; otherwise the
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1477
  number of rule premises will be taken into account here.
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1478
*}
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1479
43578
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1480
section {* Model Elimination and Resolution *}
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1481
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1482
text {*
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1483
  \begin{matharray}{rcl}
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1484
    @{method_def (HOL) "meson"} & : & @{text method} \\
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1485
    @{method_def (HOL) "metis"} & : & @{text method} \\
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1486
  \end{matharray}
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1487
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1488
  @{rail "
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1489
    @@{method (HOL) meson} @{syntax thmrefs}?
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1490
    ;
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1491
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1492
    @@{method (HOL) metis} ( '(' ('partial_types' | 'full_types' | 'no_types'
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1493
                                  | @{syntax name}) ')' )? @{syntax thmrefs}?
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1494
  "}
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1495
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1496
  The @{method (HOL) meson} method implements Loveland's model elimination
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1497
  procedure \cite{loveland-78}. See @{file "~~/src/HOL/ex/Meson_Test.thy"} for
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1498
  examples.
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1499
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1500
  The @{method (HOL) metis} method combines ordered resolution and ordered
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1501
  paramodulation to find first-order (or mildly higher-order) proofs. The first
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1502
  optional argument specifies a type encoding; see the Sledgehammer manual
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1503
  \cite{isabelle-sledgehammer} for details. The @{file
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1504
  "~~/src/HOL/Metis_Examples"} directory contains several small theories
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1505
  developed to a large extent using Metis.
36ba44fe0781 document "meson" and "metis" in HOL specific section of the Isar ref manual
blanchet
parents: 43270
diff changeset
  1506
*}
30169
9531eaafd781 moved method "iprover" to HOL specific part;
wenzelm
parents: 29560
diff changeset
  1507
30171
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1508
section {* Coherent Logic *}
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1509
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1510
text {*
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1511
  \begin{matharray}{rcl}
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1512
    @{method_def (HOL) "coherent"} & : & @{text method} \\
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1513
  \end{matharray}
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1514
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1515
  @{rail "
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1516
    @@{method (HOL) coherent} @{syntax thmrefs}?
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1517
  "}
30171
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1518
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1519
  The @{method (HOL) coherent} method solves problems of
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1520
  \emph{Coherent Logic} \cite{Bezem-Coquand:2005}, which covers
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1521
  applications in confluence theory, lattice theory and projective
40800
330eb65c9469 Parse.liberal_name for document antiquotations and attributes;
wenzelm
parents: 40711
diff changeset
  1522
  geometry.  See @{file "~~/src/HOL/ex/Coherent.thy"} for some
30171
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1523
  examples.
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1524
*}
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1525
5989863ffafc added method "coherent";
wenzelm
parents: 30169
diff changeset
  1526
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1527
section {* Proving propositions *}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1528
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1529
text {*
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1530
  In addition to the standard proof methods, a number of diagnosis
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1531
  tools search for proofs and provide an Isar proof snippet on success.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1532
  These tools are available via the following commands.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1533
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1534
  \begin{matharray}{rcl}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1535
    @{command_def (HOL) "solve_direct"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1536
    @{command_def (HOL) "try"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
43016
42330f25142c renamed "try" "try_methods"
blanchet
parents: 42705
diff changeset
  1537
    @{command_def (HOL) "try_methods"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1538
    @{command_def (HOL) "sledgehammer"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1539
    @{command_def (HOL) "sledgehammer_params"} & : & @{text "theory \<rightarrow> theory"}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1540
  \end{matharray}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1541
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1542
  @{rail "
43040
665623e695ea document new "try"
blanchet
parents: 43019
diff changeset
  1543
    @@{command (HOL) try}
665623e695ea document new "try"
blanchet
parents: 43019
diff changeset
  1544
    ;
665623e695ea document new "try"
blanchet
parents: 43019
diff changeset
  1545
43016
42330f25142c renamed "try" "try_methods"
blanchet
parents: 42705
diff changeset
  1546
    @@{command (HOL) try_methods} ( ( ( 'simp' | 'intro' | 'elim' | 'dest' ) ':' @{syntax thmrefs} ) + ) ?
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1547
      @{syntax nat}?
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1548
    ;
43040
665623e695ea document new "try"
blanchet
parents: 43019
diff changeset
  1549
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1550
    @@{command (HOL) sledgehammer} ( '[' args ']' )? facts? @{syntax nat}?
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1551
    ;
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1552
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1553
    @@{command (HOL) sledgehammer_params} ( ( '[' args ']' ) ? )
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1554
    ;
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1555
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1556
    args: ( @{syntax name} '=' value + ',' )
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1557
    ;
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1558
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1559
    facts: '(' ( ( ( ( 'add' | 'del' ) ':' ) ? @{syntax thmrefs} ) + ) ? ')'
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1560
    ;
43019
619f16bf2150 removed FIXME: "try_methods" doesn't take a clasimpmod, because it needs to generate Isar proof text in case of success and hence needs total control over its arguments
blanchet
parents: 43016
diff changeset
  1561
  "} % FIXME check args "value"
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1562
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1563
  \begin{description}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1564
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1565
  \item @{command (HOL) "solve_direct"} checks whether the current subgoals can
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1566
    be solved directly by an existing theorem. Duplicate lemmas can be detected
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1567
    in this way.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1568
43016
42330f25142c renamed "try" "try_methods"
blanchet
parents: 42705
diff changeset
  1569
  \item @{command (HOL) "try_methods"} attempts to prove a subgoal using a combination
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1570
    of standard proof methods (@{text auto}, @{text simp}, @{text blast}, etc.).
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1571
    Additional facts supplied via @{text "simp:"}, @{text "intro:"},
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1572
    @{text "elim:"}, and @{text "dest:"} are passed to the appropriate proof
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1573
    methods.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1574
43914
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1575
  \item @{command (HOL) "try"} attempts to prove or disprove a subgoal
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1576
    using a combination of provers and disprovers (@{text "solve_direct"},
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1577
    @{text "quickcheck"}, @{text "try_methods"}, @{text "sledgehammer"},
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1578
    @{text "nitpick"}).
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1579
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1580
  \item @{command (HOL) "sledgehammer"} attempts to prove a subgoal using external
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1581
    automatic provers (resolution provers and SMT solvers). See the Sledgehammer
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1582
    manual \cite{isabelle-sledgehammer} for details.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1583
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1584
  \item @{command (HOL) "sledgehammer_params"} changes
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1585
    @{command (HOL) "sledgehammer"} configuration options persistently.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1586
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1587
  \end{description}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1588
*}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1589
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1590
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1591
section {* Checking and refuting propositions *}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1592
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1593
text {*
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1594
  Identifying incorrect propositions usually involves evaluation of
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1595
  particular assignments and systematic counterexample search.  This
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1596
  is supported by the following commands.
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1597
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1598
  \begin{matharray}{rcl}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1599
    @{command_def (HOL) "value"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
45409
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1600
    @{command_def (HOL) "values"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1601
    @{command_def (HOL) "quickcheck"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1602
    @{command_def (HOL) "refute"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1603
    @{command_def (HOL) "nitpick"}@{text "\<^sup>*"} & : & @{text "proof \<rightarrow>"} \\
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1604
    @{command_def (HOL) "quickcheck_params"} & : & @{text "theory \<rightarrow> theory"} \\
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1605
    @{command_def (HOL) "refute_params"} & : & @{text "theory \<rightarrow> theory"} \\
45943
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1606
    @{command_def (HOL) "nitpick_params"} & : & @{text "theory \<rightarrow> theory"} \\
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1607
    @{command_def (HOL) "quickcheck_generator"} & : & @{text "theory \<rightarrow> theory"}
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1608
  \end{matharray}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1609
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1610
  @{rail "
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1611
    @@{command (HOL) value} ( '[' name ']' )? modes? @{syntax term}
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1612
    ;
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1613
45409
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1614
    @@{command (HOL) values} modes? @{syntax nat}? @{syntax term}
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1615
    ;
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1616
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1617
    (@@{command (HOL) quickcheck} | @@{command (HOL) refute} | @@{command (HOL) nitpick})
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1618
      ( '[' args ']' )? @{syntax nat}?
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1619
    ;
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1620
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1621
    (@@{command (HOL) quickcheck_params} | @@{command (HOL) refute_params} |
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1622
      @@{command (HOL) nitpick_params}) ( '[' args ']' )?
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1623
    ;
45943
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1624
    @@{command (HOL) quickcheck_generator} typeconstructor \\
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1625
      'operations:' ( @{syntax term} +)
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1626
    ;
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1627
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1628
    modes: '(' (@{syntax name} +) ')'
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1629
    ;
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1630
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1631
    args: ( @{syntax name} '=' value + ',' )
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1632
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1633
  "} % FIXME check "value"
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1634
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1635
  \begin{description}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1636
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1637
  \item @{command (HOL) "value"}~@{text t} evaluates and prints a
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1638
    term; optionally @{text modes} can be specified, which are
42926
a8b655d089ac tuned secref (still dangling);
wenzelm
parents: 42914
diff changeset
  1639
    appended to the current print mode; see \secref{sec:print-modes}.
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1640
    Internally, the evaluation is performed by registered evaluators,
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1641
    which are invoked sequentially until a result is returned.
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1642
    Alternatively a specific evaluator can be selected using square
37444
2e7e7ff21e25 added simp evaluator
haftmann
parents: 37422
diff changeset
  1643
    brackets; typical evaluators use the current set of code equations
42926
a8b655d089ac tuned secref (still dangling);
wenzelm
parents: 42914
diff changeset
  1644
    to normalize and include @{text simp} for fully symbolic
a8b655d089ac tuned secref (still dangling);
wenzelm
parents: 42914
diff changeset
  1645
    evaluation using the simplifier, @{text nbe} for
a8b655d089ac tuned secref (still dangling);
wenzelm
parents: 42914
diff changeset
  1646
    \emph{normalization by evaluation} and \emph{code} for code
a8b655d089ac tuned secref (still dangling);
wenzelm
parents: 42914
diff changeset
  1647
    generation in SML.
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1648
45409
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1649
  \item @{command (HOL) "values"}~@{text t} enumerates a set comprehension
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1650
    by evaluation and prints its values up to the given number of solutions;  
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1651
    optionally @{text modes} can be specified, which are
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1652
    appended to the current print mode; see \secref{sec:print-modes}.
5abb0e738b00 adding some documentation about the values command to the isar reference
bulwahn
parents: 45408
diff changeset
  1653
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1654
  \item @{command (HOL) "quickcheck"} tests the current goal for
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1655
    counterexamples using a series of assignments for its
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1656
    free variables; by default the first subgoal is tested, an other
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1657
    can be selected explicitly using an optional goal index.
40918
7351c6afb348 explaining quickcheck testers in the documentation
bulwahn
parents: 40800
diff changeset
  1658
    Assignments can be chosen exhausting the search space upto a given
43914
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1659
    size, or using a fixed number of random assignments in the search space,
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1660
    or exploring the search space symbolically using narrowing.
40918
7351c6afb348 explaining quickcheck testers in the documentation
bulwahn
parents: 40800
diff changeset
  1661
    By default, quickcheck uses exhaustive testing.
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1662
    A number of configuration options are supported for
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1663
    @{command (HOL) "quickcheck"}, notably:
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1664
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1665
    \begin{description}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1666
43914
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1667
    \item[@{text tester}] specifies which testing approach to apply.
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1668
      There are three testers, @{text exhaustive},
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1669
      @{text random}, and @{text narrowing}.
40918
7351c6afb348 explaining quickcheck testers in the documentation
bulwahn
parents: 40800
diff changeset
  1670
      An unknown configuration option is treated as an argument to tester,
7351c6afb348 explaining quickcheck testers in the documentation
bulwahn
parents: 40800
diff changeset
  1671
      making @{text "tester ="} optional.
43914
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1672
      When multiple testers are given, these are applied in parallel. 
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1673
      If no tester is specified, quickcheck uses the testers that are
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1674
      set active, i.e., configurations
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1675
      @{text quickcheck_exhaustive_active}, @{text quickcheck_random_active},
64819f353c53 updating documentation about quickcheck; adding information about try
bulwahn
parents: 43578
diff changeset
  1676
      @{text quickcheck_narrowing_active} are set to true.
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1677
    \item[@{text size}] specifies the maximum size of the search space
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1678
    for assignment values.
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1679
45758
6210c350d88b documenting the genuine_only option in quickcheck;
bulwahn
parents: 45701
diff changeset
  1680
    \item[@{text genuine_only}] sets quickcheck only to return genuine
6210c350d88b documenting the genuine_only option in quickcheck;
bulwahn
parents: 45701
diff changeset
  1681
      counterexample, but not potentially spurious counterexamples due
6210c350d88b documenting the genuine_only option in quickcheck;
bulwahn
parents: 45701
diff changeset
  1682
      to underspecified functions.
6210c350d88b documenting the genuine_only option in quickcheck;
bulwahn
parents: 45701
diff changeset
  1683
    
42092
f07b373f25d3 adding documentation about the eval option in quickcheck
bulwahn
parents: 41846
diff changeset
  1684
    \item[@{text eval}] takes a term or a list of terms and evaluates
f07b373f25d3 adding documentation about the eval option in quickcheck
bulwahn
parents: 41846
diff changeset
  1685
      these terms under the variable assignment found by quickcheck.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
  1686
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1687
    \item[@{text iterations}] sets how many sets of assignments are
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1688
    generated for each particular size.
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1689
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1690
    \item[@{text no_assms}] specifies whether assumptions in
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1691
    structured proofs should be ignored.
35331
450ab945c451 document Quickcheck's "no_assms" option
blanchet
parents: 34172
diff changeset
  1692
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1693
    \item[@{text timeout}] sets the time limit in seconds.
40245
59f011c1877a updating documentation on quickcheck in the Isar reference
bulwahn
parents: 40171
diff changeset
  1694
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1695
    \item[@{text default_type}] sets the type(s) generally used to
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1696
    instantiate type variables.
40245
59f011c1877a updating documentation on quickcheck in the Isar reference
bulwahn
parents: 40171
diff changeset
  1697
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1698
    \item[@{text report}] if set quickcheck reports how many tests
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1699
    fulfilled the preconditions.
40245
59f011c1877a updating documentation on quickcheck in the Isar reference
bulwahn
parents: 40171
diff changeset
  1700
45766
46046d8e9659 updating documentation about quiet and verbose options in quickcheck
bulwahn
parents: 45758
diff changeset
  1701
    \item[@{text quiet}] if set quickcheck does not output anything
46046d8e9659 updating documentation about quiet and verbose options in quickcheck
bulwahn
parents: 45758
diff changeset
  1702
    while testing.
46046d8e9659 updating documentation about quiet and verbose options in quickcheck
bulwahn
parents: 45758
diff changeset
  1703
    
46046d8e9659 updating documentation about quiet and verbose options in quickcheck
bulwahn
parents: 45758
diff changeset
  1704
    \item[@{text verbose}] if set quickcheck informs about the
46046d8e9659 updating documentation about quiet and verbose options in quickcheck
bulwahn
parents: 45758
diff changeset
  1705
    current size and cardinality while testing.
40245
59f011c1877a updating documentation on quickcheck in the Isar reference
bulwahn
parents: 40171
diff changeset
  1706
40254
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1707
    \item[@{text expect}] can be used to check if the user's
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1708
    expectation was met (@{text no_expectation}, @{text
6d1ebaa7a4ba proper markup of formal text;
wenzelm
parents: 40245
diff changeset
  1709
    no_counterexample}, or @{text counterexample}).
40245
59f011c1877a updating documentation on quickcheck in the Isar reference
bulwahn
parents: 40171
diff changeset
  1710
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1711
    \end{description}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1712
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1713
    These option can be given within square brackets.
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1714
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1715
  \item @{command (HOL) "quickcheck_params"} changes
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1716
    @{command (HOL) "quickcheck"} configuration options persistently.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1717
45943
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1718
  \item @{command (HOL) "quickcheck_generator"} creates random and
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1719
    exhaustive value generators for a given type and operations.
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1720
    It generates values by using the operations as if they were
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1721
    constructors of that type.
8c4a5e664fbc adding documentation about the quickcheck_generator command in the IsarRef
bulwahn
parents: 45839
diff changeset
  1722
42215
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1723
  \item @{command (HOL) "refute"} tests the current goal for
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1724
    counterexamples using a reduction to SAT. The following configuration
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1725
    options are supported:
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1726
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1727
    \begin{description}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1728
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1729
    \item[@{text minsize}] specifies the minimum size (cardinality) of the
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1730
      models to search for.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1731
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1732
    \item[@{text maxsize}] specifies the maximum size (cardinality) of the
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1733
      models to search for. Nonpositive values mean $\infty$.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1734
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1735
    \item[@{text maxvars}] specifies the maximum number of Boolean variables
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1736
    to use when transforming the term into a propositional formula.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1737
    Nonpositive values mean $\infty$.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1738
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1739
    \item[@{text satsolver}] specifies the SAT solver to use.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1740
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1741
    \item[@{text no_assms}] specifies whether assumptions in
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1742
    structured proofs should be ignored.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1743
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1744
    \item[@{text maxtime}] sets the time limit in seconds.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1745
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1746
    \item[@{text expect}] can be used to check if the user's
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1747
    expectation was met (@{text genuine}, @{text potential},
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1748
    @{text none}, or @{text unknown}).
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1749
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1750
    \end{description}
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1751
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1752
    These option can be given within square brackets.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1753
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1754
  \item @{command (HOL) "refute_params"} changes
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1755
    @{command (HOL) "refute"} configuration options persistently.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1756
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1757
  \item @{command (HOL) "nitpick"} tests the current goal for counterexamples
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1758
    using a reduction to first-order relational logic. See the Nitpick manual
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1759
    \cite{isabelle-nitpick} for details.
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1760
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1761
  \item @{command (HOL) "nitpick_params"} changes
de9d43c427ae document "nitpick(_params)", "refute(_params)", "try", "sledgehammer(_params)", and "solve_direct"
blanchet
parents: 42123
diff changeset
  1762
    @{command (HOL) "nitpick"} configuration options persistently.
31912
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1763
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1764
  \end{description}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1765
*}
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1766
f5bd306f5e9d more friendly wrt. PGs interpretation of compound *); added dedicated section on value and quickcheck
haftmann
parents: 31254
diff changeset
  1767
28752
wenzelm
parents: 28687
diff changeset
  1768
section {* Unstructured case analysis and induction \label{sec:hol-induct-tac} *}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1769
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1770
text {*
27123
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1771
  The following tools of Isabelle/HOL support cases analysis and
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1772
  induction in unstructured tactic scripts; see also
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1773
  \secref{sec:cases-induct} for proper Isar versions of similar ideas.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1774
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1775
  \begin{matharray}{rcl}
28761
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  1776
    @{method_def (HOL) case_tac}@{text "\<^sup>*"} & : & @{text method} \\
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  1777
    @{method_def (HOL) induct_tac}@{text "\<^sup>*"} & : & @{text method} \\
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  1778
    @{method_def (HOL) ind_cases}@{text "\<^sup>*"} & : & @{text method} \\
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  1779
    @{command_def (HOL) "inductive_cases"}@{text "\<^sup>*"} & : & @{text "local_theory \<rightarrow> local_theory"} \\
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1780
  \end{matharray}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1781
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1782
  @{rail "
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42704
diff changeset
  1783
    @@{method (HOL) case_tac} @{syntax goal_spec}? @{syntax term} rule?
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1784
    ;
42705
528a2ba8fa74 tuned some syntax names;
wenzelm
parents: 42704
diff changeset
  1785
    @@{method (HOL) induct_tac} @{syntax goal_spec}? (@{syntax insts} * @'and') rule?
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1786
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1787
    @@{method (HOL) ind_cases} (@{syntax prop}+) (@'for' (@{syntax name}+))?
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1788
    ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1789
    @@{command (HOL) inductive_cases} (@{syntax thmdecl}? (@{syntax prop}+) + @'and')
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1790
    ;
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1791
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1792
    rule: 'rule' ':' @{syntax thmref}
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1793
  "}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1794
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1795
  \begin{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1796
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1797
  \item @{method (HOL) case_tac} and @{method (HOL) induct_tac} admit
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1798
  to reason about inductive types.  Rules are selected according to
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1799
  the declarations by the @{attribute cases} and @{attribute induct}
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1800
  attributes, cf.\ \secref{sec:cases-induct}.  The @{command (HOL)
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1801
  datatype} package already takes care of this.
27123
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1802
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1803
  These unstructured tactics feature both goal addressing and dynamic
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1804
  instantiation.  Note that named rule cases are \emph{not} provided
27123
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1805
  as would be by the proper @{method cases} and @{method induct} proof
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1806
  methods (see \secref{sec:cases-induct}).  Unlike the @{method
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1807
  induct} method, @{method induct_tac} does not handle structured rule
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1808
  statements, only the compact object-logic conclusion of the subgoal
11fcdd5897dd case_tac/induct_tac: use same declarations as cases/induct;
wenzelm
parents: 27103
diff changeset
  1809
  being addressed.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
  1810
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1811
  \item @{method (HOL) ind_cases} and @{command (HOL)
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1812
  "inductive_cases"} provide an interface to the internal @{ML_text
26860
7c749112261c replaced some latex macros by antiquotations;
wenzelm
parents: 26852
diff changeset
  1813
  mk_cases} operation.  Rules are simplified in an unrestricted
7c749112261c replaced some latex macros by antiquotations;
wenzelm
parents: 26852
diff changeset
  1814
  forward manner.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1815
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1816
  While @{method (HOL) ind_cases} is a proof method to apply the
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1817
  result immediately as elimination rules, @{command (HOL)
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1818
  "inductive_cases"} provides case split theorems at the theory level
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1819
  for later use.  The @{keyword "for"} argument of the @{method (HOL)
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1820
  ind_cases} method allows to specify a list of variables that should
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1821
  be generalized before applying the resulting rule.
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1822
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  1823
  \end{description}
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1824
*}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1825
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1826
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1827
section {* Executable code *}
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1828
42627
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1829
text {* For validation purposes, it is often useful to \emph{execute}
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1830
  specifications.  In principle, execution could be simulated by
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1831
  Isabelle's inference kernel, i.e. by a combination of resolution and
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1832
  simplification.  Unfortunately, this approach is rather inefficient.
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1833
  A more efficient way of executing specifications is to translate
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1834
  them into a functional programming language such as ML.
26849
df50bc1249d7 converted HOL specific elements;
wenzelm
parents: 26840
diff changeset
  1835
45192
008710fff1cc really document just one code generator;
wenzelm
parents: 45187
diff changeset
  1836
  Isabelle provides a generic framework to support code generation
42627
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1837
  from executable specifications.  Isabelle/HOL instantiates these
45192
008710fff1cc really document just one code generator;
wenzelm
parents: 45187
diff changeset
  1838
  mechanisms in a way that is amenable to end-user applications.  Code
008710fff1cc really document just one code generator;
wenzelm
parents: 45187
diff changeset
  1839
  can be generated for functional programs (including overloading
008710fff1cc really document just one code generator;
wenzelm
parents: 45187
diff changeset
  1840
  using type classes) targeting SML \cite{SML}, OCaml \cite{OCaml},
008710fff1cc really document just one code generator;
wenzelm
parents: 45187
diff changeset
  1841
  Haskell \cite{haskell-revised-report} and Scala
42627
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1842
  \cite{scala-overview-tech-report}.  Conceptually, code generation is
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1843
  split up in three steps: \emph{selection} of code theorems,
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1844
  \emph{translation} into an abstract executable view and
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1845
  \emph{serialization} to a specific \emph{target language}.
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1846
  Inductive specifications can be executed using the predicate
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1847
  compiler which operates within HOL.  See \cite{isabelle-codegen} for
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  1848
  an introduction.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1849
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1850
  \begin{matharray}{rcl}
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1851
    @{command_def (HOL) "export_code"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1852
    @{attribute_def (HOL) code} & : & @{text attribute} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1853
    @{command_def (HOL) "code_abort"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1854
    @{command_def (HOL) "code_datatype"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1855
    @{command_def (HOL) "print_codesetup"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
45232
eb56e1774c26 updating documentation: code_inline -> code_unfold; added documentation about attribute code_unfold_post
bulwahn
parents: 45192
diff changeset
  1856
    @{attribute_def (HOL) code_unfold} & : & @{text attribute} \\
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1857
    @{attribute_def (HOL) code_post} & : & @{text attribute} \\
46028
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  1858
    @{attribute_def (HOL) code_abbrev} & : & @{text attribute} \\
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1859
    @{command_def (HOL) "print_codeproc"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1860
    @{command_def (HOL) "code_thms"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1861
    @{command_def (HOL) "code_deps"}@{text "\<^sup>*"} & : & @{text "context \<rightarrow>"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1862
    @{command_def (HOL) "code_const"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1863
    @{command_def (HOL) "code_type"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1864
    @{command_def (HOL) "code_class"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1865
    @{command_def (HOL) "code_instance"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1866
    @{command_def (HOL) "code_reserved"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1867
    @{command_def (HOL) "code_monad"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1868
    @{command_def (HOL) "code_include"} & : & @{text "theory \<rightarrow> theory"} \\
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1869
    @{command_def (HOL) "code_modulename"} & : & @{text "theory \<rightarrow> theory"} \\
45408
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1870
    @{command_def (HOL) "code_reflect"} & : & @{text "theory \<rightarrow> theory"} \\
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1871
    @{command_def (HOL) "code_pred"} & : & @{text "theory \<rightarrow> proof(prove)"}
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1872
  \end{matharray}
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1873
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1874
  @{rail "
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1875
    @@{command (HOL) export_code} ( constexpr + ) \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1876
       ( ( @'in' target ( @'module_name' @{syntax string} ) ? \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1877
        ( @'file' ( @{syntax string} | '-' ) ) ? ( '(' args ')' ) ?) + ) ?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1878
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1879
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1880
    const: @{syntax term}
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1881
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1882
40711
81bc73585eec globbing constant expressions use more idiomatic underscore rather than star
haftmann
parents: 40709
diff changeset
  1883
    constexpr: ( const | 'name._' | '_' )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1884
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1885
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1886
    typeconstructor: @{syntax nameref}
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1887
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1888
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1889
    class: @{syntax nameref}
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1890
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1891
38814
4d575fbfc920 official support for Scala
haftmann
parents: 38462
diff changeset
  1892
    target: 'SML' | 'OCaml' | 'Haskell' | 'Scala'
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1893
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1894
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1895
    @@{attribute (HOL) code} ( 'del' | 'abstype' | 'abstract' )?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1896
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1897
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1898
    @@{command (HOL) code_abort} ( const + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1899
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1900
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1901
    @@{command (HOL) code_datatype} ( const + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1902
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1903
45232
eb56e1774c26 updating documentation: code_inline -> code_unfold; added documentation about attribute code_unfold_post
bulwahn
parents: 45192
diff changeset
  1904
    @@{attribute (HOL) code_unfold} ( 'del' ) ?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1905
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1906
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1907
    @@{attribute (HOL) code_post} ( 'del' ) ?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1908
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1909
46028
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  1910
    @@{attribute (HOL) code_abbrev}
45232
eb56e1774c26 updating documentation: code_inline -> code_unfold; added documentation about attribute code_unfold_post
bulwahn
parents: 45192
diff changeset
  1911
    ;
eb56e1774c26 updating documentation: code_inline -> code_unfold; added documentation about attribute code_unfold_post
bulwahn
parents: 45192
diff changeset
  1912
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1913
    @@{command (HOL) code_thms} ( constexpr + ) ?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1914
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1915
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1916
    @@{command (HOL) code_deps} ( constexpr + ) ?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1917
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1918
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1919
    @@{command (HOL) code_const} (const + @'and') \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1920
      ( ( '(' target ( syntax ? + @'and' ) ')' ) + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1921
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1922
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1923
    @@{command (HOL) code_type} (typeconstructor + @'and') \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1924
      ( ( '(' target ( syntax ? + @'and' ) ')' ) + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1925
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1926
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1927
    @@{command (HOL) code_class} (class + @'and') \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1928
      ( ( '(' target \\ ( @{syntax string} ? + @'and' ) ')' ) + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1929
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1930
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1931
    @@{command (HOL) code_instance} (( typeconstructor '::' class ) + @'and') \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1932
      ( ( '(' target ( '-' ? + @'and' ) ')' ) + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1933
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1934
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1935
    @@{command (HOL) code_reserved} target ( @{syntax string} + )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1936
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1937
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1938
    @@{command (HOL) code_monad} const const target
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1939
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1940
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1941
    @@{command (HOL) code_include} target ( @{syntax string} ( @{syntax string} | '-') )
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1942
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1943
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1944
    @@{command (HOL) code_modulename} target ( ( @{syntax string} @{syntax string} ) + )
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1945
    ;
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1946
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1947
    @@{command (HOL) code_reflect} @{syntax string} \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1948
      ( @'datatypes' ( @{syntax string} '=' ( '_' | ( @{syntax string} + '|' ) + @'and' ) ) ) ? \\
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1949
      ( @'functions' ( @{syntax string} + ) ) ? ( @'file' @{syntax string} ) ?
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1950
    ;
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1951
45408
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1952
    @@{command (HOL) code_pred} \\( '(' @'modes' ':' modedecl ')')? \\ const
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1953
    ;
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1954
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1955
    syntax: @{syntax string} | ( @'infix' | @'infixl' | @'infixr' ) @{syntax nat} @{syntax string}
45408
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1956
    ;
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1957
    
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1958
    modedecl: (modes | ((const ':' modes) \\
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1959
         (@'and' ((const ':' modes @'and') +))?))
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1960
    ;
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1961
    
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  1962
    modes: mode @'as' const
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  1963
  "}
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1964
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1965
  \begin{description}
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1966
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1967
  \item @{command (HOL) "export_code"} generates code for a given list
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1968
  of constants in the specified target language(s).  If no
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1969
  serialization instruction is given, only abstract code is generated
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1970
  internally.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1971
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1972
  Constants may be specified by giving them literally, referring to
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1973
  all executable contants within a certain theory by giving @{text
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1974
  "name.*"}, or referring to \emph{all} executable constants currently
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1975
  available by giving @{text "*"}.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1976
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1977
  By default, for each involved theory one corresponding name space
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1978
  module is generated.  Alternativly, a module name may be specified
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1979
  after the @{keyword "module_name"} keyword; then \emph{all} code is
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1980
  placed in this module.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1981
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1982
  For \emph{SML}, \emph{OCaml} and \emph{Scala} the file specification
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1983
  refers to a single file; for \emph{Haskell}, it refers to a whole
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1984
  directory, where code is generated in multiple files reflecting the
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1985
  module hierarchy.  Omitting the file specification denotes standard
37749
c7e15d59c58d updated documentation
haftmann
parents: 37444
diff changeset
  1986
  output.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1987
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1988
  Serializers take an optional list of arguments in parentheses.  For
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1989
  \emph{SML} and \emph{OCaml}, ``@{text no_signatures}`` omits
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1990
  explicit module signatures.
42123
c407078c0d47 updated generated file;
wenzelm
parents: 42092
diff changeset
  1991
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1992
  For \emph{Haskell} a module name prefix may be given using the
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1993
  ``@{text "root:"}'' argument; ``@{text string_classes}'' adds a
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1994
  ``@{verbatim "deriving (Read, Show)"}'' clause to each appropriate
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  1995
  datatype declaration.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1996
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  1997
  \item @{attribute (HOL) code} explicitly selects (or with option
38462
34d3de1254cd formally document `code abstype` and `code abstract` attributes
haftmann
parents: 37820
diff changeset
  1998
  ``@{text "del"}'' deselects) a code equation for code generation.
34d3de1254cd formally document `code abstype` and `code abstract` attributes
haftmann
parents: 37820
diff changeset
  1999
  Usually packages introducing code equations provide a reasonable
34d3de1254cd formally document `code abstype` and `code abstract` attributes
haftmann
parents: 37820
diff changeset
  2000
  default setup for selection.  Variants @{text "code abstype"} and
34d3de1254cd formally document `code abstype` and `code abstract` attributes
haftmann
parents: 37820
diff changeset
  2001
  @{text "code abstract"} declare abstract datatype certificates or
34d3de1254cd formally document `code abstype` and `code abstract` attributes
haftmann
parents: 37820
diff changeset
  2002
  code equations on abstract datatype representations respectively.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2003
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2004
  \item @{command (HOL) "code_abort"} declares constants which are not
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2005
  required to have a definition by means of code equations; if needed
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2006
  these are implemented by program abort instead.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2007
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2008
  \item @{command (HOL) "code_datatype"} specifies a constructor set
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2009
  for a logical type.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2010
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2011
  \item @{command (HOL) "print_codesetup"} gives an overview on
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2012
  selected code equations and code generator datatypes.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2013
45232
eb56e1774c26 updating documentation: code_inline -> code_unfold; added documentation about attribute code_unfold_post
bulwahn
parents: 45192
diff changeset
  2014
  \item @{attribute (HOL) code_unfold} declares (or with option
46028
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2015
  ``@{text "del"}'' removes) theorems which during preprocessing
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2016
  are applied as rewrite rules to any code equation or evaluation
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2017
  input.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2018
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2019
  \item @{attribute (HOL) code_post} declares (or with option ``@{text
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2020
  "del"}'' removes) theorems which are applied as rewrite rules to any
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2021
  result of an evaluation.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2022
46028
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2023
  \item @{attribute (HOL) code_abbrev} declares equations which are
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2024
  applied as rewrite rules to any result of an evaluation and
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2025
  symmetrically during preprocessing to any code equation or evaluation
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2026
  input.
9f113cdf3d66 attribute code_abbrev superseedes code_unfold_post
haftmann
parents: 45944
diff changeset
  2027
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2028
  \item @{command (HOL) "print_codeproc"} prints the setup of the code
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2029
  generator preprocessor.
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2030
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2031
  \item @{command (HOL) "code_thms"} prints a list of theorems
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2032
  representing the corresponding program containing all given
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2033
  constants after preprocessing.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2034
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2035
  \item @{command (HOL) "code_deps"} visualizes dependencies of
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2036
  theorems representing the corresponding program containing all given
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2037
  constants after preprocessing.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2038
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2039
  \item @{command (HOL) "code_const"} associates a list of constants
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2040
  with target-specific serializations; omitting a serialization
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2041
  deletes an existing serialization.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2042
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2043
  \item @{command (HOL) "code_type"} associates a list of type
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2044
  constructors with target-specific serializations; omitting a
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2045
  serialization deletes an existing serialization.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2046
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2047
  \item @{command (HOL) "code_class"} associates a list of classes
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2048
  with target-specific class names; omitting a serialization deletes
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2049
  an existing serialization.  This applies only to \emph{Haskell}.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2050
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2051
  \item @{command (HOL) "code_instance"} declares a list of type
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2052
  constructor / class instance relations as ``already present'' for a
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2053
  given target.  Omitting a ``@{text "-"}'' deletes an existing
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2054
  ``already present'' declaration.  This applies only to
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2055
  \emph{Haskell}.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2056
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2057
  \item @{command (HOL) "code_reserved"} declares a list of names as
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2058
  reserved for a given target, preventing it to be shadowed by any
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2059
  generated code.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2060
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2061
  \item @{command (HOL) "code_monad"} provides an auxiliary mechanism
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2062
  to generate monadic code for Haskell.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2063
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2064
  \item @{command (HOL) "code_include"} adds arbitrary named content
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2065
  (``include'') to generated code.  A ``@{text "-"}'' as last argument
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2066
  will remove an already added ``include''.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2067
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2068
  \item @{command (HOL) "code_modulename"} declares aliasings from one
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2069
  module name onto another.
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2070
39608
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2071
  \item @{command (HOL) "code_reflect"} without a ``@{text "file"}''
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2072
  argument compiles code into the system runtime environment and
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2073
  modifies the code generator setup that future invocations of system
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2074
  runtime code generation referring to one of the ``@{text
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2075
  "datatypes"}'' or ``@{text "functions"}'' entities use these precompiled
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2076
  entities.  With a ``@{text "file"}'' argument, the corresponding code
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2077
  is generated into that specified file without modifying the code
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2078
  generator setup.
76bc7e4999f8 formal syntax diagram for code_reflect
haftmann
parents: 38814
diff changeset
  2079
45408
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  2080
  \item @{command (HOL) "code_pred"} creates code equations for a predicate
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  2081
    given a set of introduction rules. Optional mode annotations determine
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  2082
    which arguments are supposed to be input or output. If alternative 
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  2083
    introduction rules are declared, one must prove a corresponding elimination
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  2084
    rule.
7156f63ce3c2 adding a minimal documentation about the code_pred command to the isar reference
bulwahn
parents: 45232
diff changeset
  2085
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2086
  \end{description}
42627
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  2087
*}
37422
6d19e4e6ebf5 tuned internal order
haftmann
parents: 37379
diff changeset
  2088
42627
8749742785b8 moved material about old codegen to isar-ref manual;
wenzelm
parents: 42626
diff changeset
  2089
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2090
section {* Definition by specification \label{sec:hol-specification} *}
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2091
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2092
text {*
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2093
  \begin{matharray}{rcl}
28761
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  2094
    @{command_def (HOL) "specification"} & : & @{text "theory \<rightarrow> proof(prove)"} \\
9ec4482c9201 updated/refined types of Isar language elements, removed special LaTeX macros;
wenzelm
parents: 28760
diff changeset
  2095
    @{command_def (HOL) "ax_specification"} & : & @{text "theory \<rightarrow> proof(prove)"} \\
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2096
  \end{matharray}
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2097
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  2098
  @{rail "
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  2099
  (@@{command (HOL) specification} | @@{command (HOL) ax_specification})
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  2100
    '(' (decl +) ')' \\ (@{syntax thmdecl}? @{syntax prop} +)
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2101
  ;
42596
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  2102
  decl: ((@{syntax name} ':')? @{syntax term} '(' @'overloaded' ')'?)
6c621a9d612a modernized rail diagrams using @{rail} antiquotation;
wenzelm
parents: 42215
diff changeset
  2103
  "}
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2104
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2105
  \begin{description}
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2106
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2107
  \item @{command (HOL) "specification"}~@{text "decls \<phi>"} sets up a
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2108
  goal stating the existence of terms with the properties specified to
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2109
  hold for the constants given in @{text decls}.  After finishing the
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2110
  proof, the theory will be augmented with definitions for the given
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2111
  constants, as well as with theorems stating the properties for these
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2112
  constants.
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2113
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2114
  \item @{command (HOL) "ax_specification"}~@{text "decls \<phi>"} sets up
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2115
  a goal stating the existence of terms with the properties specified
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2116
  to hold for the constants given in @{text decls}.  After finishing
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2117
  the proof, the theory will be augmented with axioms expressing the
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2118
  properties given in the first place.
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2119
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2120
  \item @{text decl} declares a constant to be defined by the
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2121
  specification given.  The definition for the constant @{text c} is
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2122
  bound to the name @{text c_def} unless a theorem name is given in
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2123
  the declaration.  Overloaded constants should be declared as such.
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2124
28760
cbc435f7b16b unified use of declaration environment with IsarImplementation;
wenzelm
parents: 28752
diff changeset
  2125
  \end{description}
27045
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2126
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2127
  Whether to use @{command (HOL) "specification"} or @{command (HOL)
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2128
  "ax_specification"} is to some extent a matter of style.  @{command
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2129
  (HOL) "specification"} introduces no new axioms, and so by
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2130
  construction cannot introduce inconsistencies, whereas @{command
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2131
  (HOL) "ax_specification"} does introduce axioms, but only after the
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2132
  user has explicitly proven it to be safe.  A practical issue must be
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2133
  considered, though: After introducing two constants with the same
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2134
  properties using @{command (HOL) "specification"}, one can prove
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2135
  that the two constants are, in fact, equal.  If this might be a
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2136
  problem, one should use @{command (HOL) "ax_specification"}.
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2137
*}
4e7ecec1b685 moved (ax_)specification to end;
wenzelm
parents: 27041
diff changeset
  2138
26840
ec46381f149d added logic-specific sessions;
wenzelm
parents:
diff changeset
  2139
end