doc-src/IsarImplementation/Thy/ML.thy
author haftmann
Tue, 23 Oct 2007 10:53:15 +0200
changeset 25151 9374a0df240c
parent 24110 4ab3084e311c
child 25185 762ed22d15c7
permissions -rw-r--r--
continued
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
18538
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
     1
(* $Id$ *)
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
     2
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
     3
theory "ML" imports base begin
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
     4
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
     5
chapter {* Aesthetics of ML programming *}
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
     6
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
     7
section {* Style *}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
     8
21502
7f3ea2b3bab6 prefer antiquotations over LaTeX macros;
wenzelm
parents: 21148
diff changeset
     9
text FIXME
7f3ea2b3bab6 prefer antiquotations over LaTeX macros;
wenzelm
parents: 21148
diff changeset
    10
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    11
text {* This style guide is loosely based on
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    12
  \url{http://caml.inria.fr/resources/doc/guides/guidelines.en.html}.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    13
%  FIMXE \url{http://www.cs.cornell.edu/Courses/cs312/2003sp/handouts/style.htm}
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    14
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    15
  Like any style guide, it should not be interpreted dogmatically, but
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    16
  with care and discernment.  Instead, it forms a collection of
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    17
  recommendations which, if obeyed, result in code that is not
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    18
  considered to be obfuscated.  In certain cases, derivations are
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    19
  encouraged, as far as you know what you are doing.
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    20
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    21
  \begin{description}
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    22
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    23
    \item[fundamental law of programming]
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    24
      Whenever writing code, keep in mind: A program is
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    25
      written once, modified ten times, and read
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    26
      100 times.  So simplify its writing,
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    27
      always keep future modifications in mind,
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    28
      and never jeopardize readability.  Every second you hesitate
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    29
      to spend on making your code more clear you will
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    30
      have to spend ten times understanding what you have
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    31
      written later on.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    32
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    33
    \item[white space matters]
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    34
      Treat white space in your code as if it determines
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    35
      the meaning of code.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    36
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    37
      \begin{itemize}
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    38
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    39
        \item The space bar is the easiest key to find on the keyboard,
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    40
          press it as often as necessary. @{verbatim "2 + 2"} is better
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    41
          than @{verbatim "2+2"}, likewise @{verbatim "f (x, y)"} is
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    42
          better than @{verbatim "f(x,y)"}.
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    43
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    44
        \item Restrict your lines to 80 characters.  This will allow
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    45
          you to keep the beginning of a line in view while watching
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    46
          its end.\footnote{To acknowledge the lax practice of
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    47
          text editing these days, we tolerate as much as 100
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    48
          characters per line, but anything beyond 120 is not
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    49
          considered proper source text.}
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    50
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    51
        \item Ban tabulators; they are a context-sensitive formatting
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    52
          feature and likely to confuse anyone not using your favorite
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    53
          editor.\footnote{Some modern programming language even
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    54
          forbid tabulators altogether according to the formal syntax
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    55
          definition.}
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    56
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    57
        \item Get rid of trailing whitespace.  Instead, do not
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    58
          suppress a trailing newline at the end of your files.
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    59
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    60
        \item Choose a generally accepted style of indentation,
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    61
          then use it systematically throughout the whole
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    62
          application.  An indentation of two spaces is appropriate.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    63
          Avoid dangling indentation.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    64
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    65
      \end{itemize}
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    66
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    67
    \item[cut-and-paste succeeds over copy-and-paste]
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    68
       \emph{Never} copy-and-paste code when programming.  If you
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    69
        need the same piece of code twice, introduce a
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    70
        reasonable auxiliary function (if there is no
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    71
        such function, very likely you got something wrong).
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    72
        Any copy-and-paste will turn out to be painful 
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    73
        when something has to be changed or fixed later on.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    74
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    75
    \item[comments]
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    76
      are a device which requires careful thinking before using
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    77
      it.  The best comment for your code should be the code itself.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    78
      Prefer efforts to write clear, understandable code
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    79
      over efforts to explain nasty code.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    80
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    81
    \item[functional programming is based on functions]
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    82
      Avoid ``constructivisms'', i.e.\ unnecessary concrete datatype
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    83
      representations.  Instead model things as abstract as
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    84
      appropriate.  For example, pass a table lookup function rather
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    85
      than a concrete table with lookup performed in body.  Accustom
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    86
      your way of coding to the level of expressiveness a functional
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    87
      programming language is giving onto you.
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    88
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    89
    \item[tuples]
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    90
      are often in the way.  When there is no striking argument
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    91
      to tuple function arguments, just write your function curried.
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    92
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
    93
    \item[telling names]
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    94
      Any name should tell its purpose as exactly as possible, while
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    95
      keeping its length to the absolutely necessary minimum.  Always
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    96
      give the same name to function arguments which have the same
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    97
      meaning. Separate words by underscores (@{verbatim
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    98
      int_of_string}, not @{verbatim intOfString}).\footnote{Some
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
    99
      recent tools for Emacs include special precautions to cope with
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   100
      bumpy names in @{text "camelCase"}, e.g.\ for improved on-screen
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   101
      readability.  It is easier to abstain from using such names in the
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   102
      first place.}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   103
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   104
  \end{description}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   105
*}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   106
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   107
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   108
section {* Thread-safe programming *}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   109
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   110
text {*
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   111
  Recent versions of Poly/ML (5.1 or later) support multithreaded
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   112
  execution based on native operating system threads of the
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   113
  underlying platform.  Thus threads will actually be executed in
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   114
  parallel on multi-core systems.  A speedup-factor of approximately
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   115
  2--4 can be expected for large well-structured Isabelle sessions,
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   116
  where theories are organized as a graph with sufficiently many
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   117
  independent nodes.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   118
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   119
  Threads lack the memory protection of separate processes, but
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   120
  operate concurrently on shared heap memory.  This has the advantage
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   121
  that results of independent computations are immediately available
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   122
  to other threads, without requiring explicit communication,
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   123
  reloading, or even recoding of data.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   124
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   125
  On the other hand, some programming guidelines need to be observed
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   126
  in order to make unprotected parallelism work out smoothly.  While
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   127
  the ML system implementation is responsible to maintain basic
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   128
  integrity of the representation of ML values in memory, the
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   129
  application programmer needs to ensure that multithreaded execution
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   130
  does not break the intended semantics.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   131
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   132
  \medskip \paragraph{Critical shared resources.} Actually only those
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   133
  parts outside the purely functional world of ML are critical.  In
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   134
  particular, this covers
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   135
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   136
  \begin{itemize}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   137
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   138
  \item global references (or arrays), i.e.\ those that persist over
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   139
  several invocations of associated operations,\footnote{This is
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   140
  independent of the visibility of such mutable values in the toplevel
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   141
  scope.}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   142
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   143
  \item global ML bindings in the toplevel environment (@{verbatim
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   144
  "type"}, @{verbatim val}, @{verbatim "structure"} etc.) due to
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   145
  run-time invocation of the compiler,
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   146
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   147
  \item direct I/O on shared channels, notably @{text "stdin"}, @{text
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   148
  "stdout"}, @{text "stderr"}.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   149
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   150
  \end{itemize}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   151
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   152
  The majority of tools implemented within the Isabelle/Isar framework
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   153
  will not require any of these critical elements: nothing special
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   154
  needs to be observed when staying in the purely functional fragment
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   155
  of ML.  Note that output via the official Isabelle channels does not
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   156
  even count as direct I/O in the above sense, so the operations @{ML
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   157
  "writeln"}, @{ML "warning"}, @{ML "tracing"} etc.\ are safe.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   158
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   159
  \paragraph{Multithreading in Isabelle/Isar.}  Our parallel execution
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   160
  model is centered around the theory loader.  Whenever a given
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   161
  subgraph of theories needs to be updated, the system schedules a
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   162
  number of threads to process the sources as required, while
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   163
  observing their dependencies.  Thus concurrency is limited to
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   164
  independent nodes according to the theory import relation.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   165
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   166
  Any user-code that works relatively to the present background theory
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   167
  is already safe.  Contextual data may be easily stored within the
24090
wenzelm
parents: 24089
diff changeset
   168
  theory or proof context, thanks to the generic data concept of
wenzelm
parents: 24089
diff changeset
   169
  Isabelle/Isar (see \secref{sec:context-data}).  This greatly
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   170
  diminishes the demand for global state information in the first
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   171
  place.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   172
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   173
  \medskip In rare situations where actual mutable content needs to be
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   174
  manipulated, Isabelle provides a single \emph{critical section} that
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   175
  may be entered while preventing any other thread from doing the
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   176
  same.  Entering the critical section without contention is very
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   177
  fast, and several basic system operations do so frequently.  This
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   178
  also means that each thread should leave the critical section
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   179
  quickly, otherwise parallel execution performance may degrade
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   180
  significantly.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   181
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   182
  Despite this potential bottle-neck, we refrain from fine-grained
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   183
  locking mechanisms: the restriction to a single lock prevents
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   184
  deadlocks without demanding further considerations in user programs.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   185
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   186
  \paragraph{Good conduct of impure programs.} The following
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   187
  guidelines enable non-functional programs to participate in
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   188
  multithreading.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   189
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   190
  \begin{itemize}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   191
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   192
  \item Minimize global state information.  Using proper theory and
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   193
  proof context data will actually return to functional update of
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   194
  values, without any special precautions for multithreading.  Apart
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   195
  from the fully general functors for theory and proof data (see
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   196
  \secref{sec:context-data}) there are drop-in replacements that
24090
wenzelm
parents: 24089
diff changeset
   197
  emulate primitive references for common cases of \emph{configuration
wenzelm
parents: 24089
diff changeset
   198
  options} for type @{ML_type "bool"}/@{ML_type "int"}/@{ML_type
24110
4ab3084e311c tuned config options: eliminated separate attribute "option";
wenzelm
parents: 24090
diff changeset
   199
  "string"} (see structure @{ML_struct Config} and @{ML
4ab3084e311c tuned config options: eliminated separate attribute "option";
wenzelm
parents: 24090
diff changeset
   200
  Attrib.config_bool} etc.), and lists of theorems (see functor
4ab3084e311c tuned config options: eliminated separate attribute "option";
wenzelm
parents: 24090
diff changeset
   201
  @{ML_functor NamedThmsFun}).
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   202
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   203
  \item Keep components with local state information
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   204
  \emph{re-entrant}.  Instead of poking initial values into (private)
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   205
  global references, create a new state record on each invocation, and
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   206
  pass that through any auxiliary functions of the component.  The
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   207
  state record may well contain mutable references, without requiring
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   208
  any special synchronizations, as long as each invocation sees its
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   209
  own copy.  Occasionally, one might even return to plain functional
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   210
  updates on non-mutable record values here.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   211
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   212
  \item Isolate process configuration flags.  The main legitimate
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   213
  application of global references is to configure the whole process
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   214
  in a certain way, essentially affecting all threads.  A typical
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   215
  example is the @{ML show_types} flag, which tells the pretty printer
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   216
  to output explicit type information for terms.  Such flags usually
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   217
  do not affect the functionality of the core system, but only the
24090
wenzelm
parents: 24089
diff changeset
   218
  view being presented to the user.
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   219
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   220
  Occasionally, such global process flags are treated like implicit
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   221
  arguments to certain operations, by using the @{ML setmp} combinator
24090
wenzelm
parents: 24089
diff changeset
   222
  for safe temporary assignment.  Its traditional purpose was to
wenzelm
parents: 24089
diff changeset
   223
  ensure proper recovery of the original value when exceptions are
wenzelm
parents: 24089
diff changeset
   224
  raised in the body, now the functionality is extended to enter the
wenzelm
parents: 24089
diff changeset
   225
  \emph{critical section} (with its usual potential of degrading
wenzelm
parents: 24089
diff changeset
   226
  parallelism).
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   227
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   228
  Note that recovery of plain value passing semantics via @{ML
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   229
  setmp}~@{text "ref value"} assumes that this @{text "ref"} is
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   230
  exclusively manipulated within the critical section.  In particular,
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   231
  any persistent global assignment of @{text "ref := value"} needs to
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   232
  be marked critical as well, to prevent intruding another threads
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   233
  local view, and a lost-update in the global scope, too.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   234
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   235
  \item Minimize global ML bindings.  Processing theories occasionally
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   236
  affects the global ML environment as well.  While each ML
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   237
  compilation unit is safe, the order of scheduling of independent
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   238
  declarations might cause problems when composing several modules
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   239
  later on, due to hiding of previous ML names.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   240
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   241
  This cannot be helped in general, because the ML toplevel lacks the
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   242
  graph structure of the Isabelle theory space.  Nevertheless, some
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   243
  sound conventions of keeping global ML names essentially disjoint
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   244
  (e.g.\ with the help of ML structures) prevents the problem to occur
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   245
  in most practical situations.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   246
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   247
  \end{itemize}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   248
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   249
  Recall that in an open ``LCF-style'' system like Isabelle/Isar, the
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   250
  user participates in constructing the overall environment.  This
24090
wenzelm
parents: 24089
diff changeset
   251
  means that state-based facilities offered by one component will
wenzelm
parents: 24089
diff changeset
   252
  require special caution later on.  So minimizing critical elements,
wenzelm
parents: 24089
diff changeset
   253
  by staying within the plain value-oriented view relative to theory
wenzelm
parents: 24089
diff changeset
   254
  or proof contexts most of the time, will also reduce the chance of
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   255
  mishaps occurring to end-users.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   256
*}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   257
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   258
text %mlref {*
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   259
  \begin{mldecls}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   260
  @{index_ML NAMED_CRITICAL: "string -> (unit -> 'a) -> 'a"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   261
  @{index_ML CRITICAL: "(unit -> 'a) -> 'a"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   262
  @{index_ML setmp: "'a ref -> 'a -> ('b -> 'c) -> 'b -> 'c"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   263
  \end{mldecls}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   264
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   265
  \begin{description}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   266
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   267
  \item @{ML NAMED_CRITICAL}~@{text "name f"} evaluates @{text "f ()"}
24090
wenzelm
parents: 24089
diff changeset
   268
  while staying within the critical section of Isabelle/Isar.  No
wenzelm
parents: 24089
diff changeset
   269
  other thread may do so at the same time, but non-critical parallel
wenzelm
parents: 24089
diff changeset
   270
  execution will continue.  The @{text "name"} argument serves for
wenzelm
parents: 24089
diff changeset
   271
  diagnostic purposes and might help to spot sources of congestion.
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   272
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   273
  \item @{ML CRITICAL} is the same as @{ML NAMED_CRITICAL} with empty
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   274
  name argument.
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   275
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   276
  \item @{ML setmp}~@{text "ref value f x"} evaluates @{text "f x"}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   277
  while staying within the critical section and having @{text "ref :=
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   278
  value"} assigned temporarily.  This recovers a value-passing
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   279
  semantics involving global references, regardless of exceptions or
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   280
  concurrency.
21148
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
   281
3a64d58a9f49 first version of style guide
haftmann
parents: 20520
diff changeset
   282
  \end{description}
18554
bff7a1466fe4 more stuff;
wenzelm
parents: 18538
diff changeset
   283
*}
18538
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
   284
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
   285
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
   286
chapter {* Basic library functions *}
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
   287
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   288
text {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   289
  Beyond the proposal of the SML/NJ basis library, Isabelle comes
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   290
  with its own library, from which selected parts are given here.
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   291
  See further files \emph{Pure/library.ML} and \emph{Pure/General/*.ML}.
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   292
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   294
section {* Linear transformations *}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   295
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   296
text %mlref {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   297
  \begin{mldecls}
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   298
  @{index_ML "op |> ": "'a * ('a -> 'b) -> 'b"} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   299
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   300
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   301
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   302
(*<*)
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   303
typedecl foo
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   304
consts foo :: foo
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   305
ML {*
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   306
val thy = Theory.copy @{theory}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   307
*}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   308
(*>*)
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   309
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   310
text {*
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   311
  Many problems in functional programming can be thought of
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   312
  as linear transformations, i.e.~a caluclation starts with a
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   313
  particular value @{text "x \<Colon> foo"} which is then transformed
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   314
  by application of a function @{text "f \<Colon> foo \<Rightarrow> foo"},
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   315
  continued by an application of a function @{text "g \<Colon> foo \<Rightarrow> bar"},
25151
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   316
  and so on.  As a canoncial example, take functions enriching
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   317
  a theory by constant declararion and primitive definitions:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   318
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   319
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   320
    @{ML "Sign.declare_const: Markup.property list -> bstring * typ * mixfix
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   321
       -> theory -> term * theory"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   322
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   323
    @{ML "Thm.add_def: bool -> bstring * term -> theory -> thm * theory"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   324
  \end{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   325
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   326
  Written with naive application, an addition of constant
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   327
  @{text bar} with type @{typ "foo \<Rightarrow> foo"} and
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   328
  a corresponding definition @{term "bar \<equiv> \<lambda>x. x"} would look like:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   329
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   330
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   331
  @{ML "(fn (t, thy) => Thm.add_def false
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   332
  (\"bar_def\", Logic.mk_equals (t, @{term \"%x. x\"})) thy)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   333
    (Sign.declare_const []
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   334
      (\"bar\", @{typ \"foo => foo\"}, NoSyn) thy)"}.
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   335
  \end{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   336
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   337
  With increasing numbers of applications, this code gets quite
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   338
  unreadable.  Further, it is unintuitive that things are
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   339
  written down in the opposite order as they actually ``happen''.
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   340
*}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   341
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   342
(*<*)
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   343
ML {*
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   344
val thy = Theory.copy @{theory}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   345
*}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   346
(*>*)
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   347
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   348
text {*
25151
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   349
  \noindent At this stage, Isabelle offers some combinators which allow
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   350
  for more convenient notation, most notably reverse application:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   351
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   352
@{ML "thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   353
|> Sign.declare_const [] (\"bar\", @{typ \"foo => foo\"}, NoSyn)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   354
|> (fn (t, thy) => thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   355
|> Thm.add_def false
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   356
     (\"bar_def\", Logic.mk_equals (t, @{term \"%x. x\"})))"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   357
  \end{quotation}
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   358
*}
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   359
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   360
text %mlref {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   361
  \begin{mldecls}
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   362
  @{index_ML "op |-> ": "('c * 'a) * ('c -> 'a -> 'b) -> 'b"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   363
  @{index_ML "op |>> ": "('a * 'c) * ('a -> 'b) -> 'b * 'c"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   364
  @{index_ML "op ||> ": "('c * 'a) * ('a -> 'b) -> 'c * 'b"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   365
  @{index_ML "op ||>> ": "('c * 'a) * ('a -> 'd * 'b) -> ('c * 'd) * 'b"} \\
25151
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   366
  \end{mldecls}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   367
*}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   368
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   369
text {*
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   370
  \noindent Usually, functions involving theory updates also return
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   371
  side results; to use these conveniently, yet another
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   372
  set of combinators is at hand, most notably @{ML "op |->"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   373
  which allows curried access to side results:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   374
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   375
@{ML "thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   376
|> Sign.declare_const [] (\"bar\", @{typ \"foo => foo\"}, NoSyn)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   377
|-> (fn t => Thm.add_def false
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   378
      (\"bar_def\", Logic.mk_equals (t, @{term \"%x. x\"})))
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   379
"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   380
  \end{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   381
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   382
  \noindent @{ML "op |>>"} allows for processing side results on their own:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   383
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   384
@{ML "thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   385
|> Sign.declare_const [] (\"bar\", @{typ \"foo => foo\"}, NoSyn)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   386
|>> (fn t => Logic.mk_equals (t, @{term \"%x. x\"}))
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   387
|-> (fn def => Thm.add_def false (\"bar_def\", def))
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   388
"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   389
  \end{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   390
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   391
  \noindent Orthogonally, @{ML "op ||>"} applies a transformation
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   392
  in the presence of side results which are left unchanged:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   393
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   394
@{ML "thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   395
|> Sign.declare_const [] (\"bar\", @{typ \"foo => foo\"}, NoSyn)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   396
||> Sign.add_path \"foobar\"
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   397
|-> (fn t => Thm.add_def false
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   398
      (\"bar_def\", Logic.mk_equals (t, @{term \"%x. x\"})))
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   399
||> Sign.restore_naming thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   400
"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   401
  \end{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   402
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   403
  \noindent @{index_ML "op ||>>"} accumulates side results:
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   404
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   405
@{ML "thy
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   406
|> Sign.declare_const [] (\"bar\", @{typ \"foo => foo\"}, NoSyn)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   407
||>> Sign.declare_const [] (\"foobar\", @{typ \"foo => foo\"}, NoSyn)
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   408
|-> (fn (t1, t2) => Thm.add_def false
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   409
      (\"bar_def\", Logic.mk_equals (t1, t2)))
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   410
"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   411
  \end{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   412
*}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   413
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   414
text %mlref {*
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   415
  \begin{mldecls}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   416
  @{index_ML fold: "('a -> 'b -> 'b) -> 'a list -> 'b -> 'b"} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   417
  @{index_ML fold_map: "('a -> 'b -> 'c * 'b) -> 'a list -> 'b -> 'c list * 'b"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   418
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   419
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   420
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   421
text {*
25151
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   422
  \noindent This principles naturally lift to @{text lists} using
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   423
  the @{ML fold} and @{ML fold_map} combinators.
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   424
  The first lifts a single function
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   425
  @{text "f \<Colon> 'a -> 'b -> 'b"} to @{text "'a list -> 'b -> 'b"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   426
  such that
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   427
  @{text "y |> fold f [x\<^isub>1, x\<^isub>2, \<dots> x\<^isub>n] \<equiv> y |> f x\<^isub>1 |> f x\<^isub>2 |> \<dots> |> f x\<^isub>n"};
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   428
  the second accumulates side results in a list by lifting
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   429
  a single function
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   430
  @{text "f \<Colon> 'a -> 'b -> 'c \<times> 'b"} to @{text "'a list -> 'b -> 'c list \<times> 'b"}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   431
  such that
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   432
  @{text "y |> fold_map f [x\<^isub>1, x\<^isub>2, \<dots> x\<^isub>n] \<equiv> y |> f x\<^isub>1 ||>> f x\<^isub>2 ||>> \<dots> ||>> f x\<^isub>n
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   433
    ||> (fn ((z\<^isub>1, z\<^isub>2), \<dots> z\<^isub>n) => [z\<^isub>1, z\<^isub>2, \<dots> z\<^isub>n])"};
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   434
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   435
  Example: FIXME
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   436
  \begin{quotation}
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   437
  \end{quotation}
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   438
*}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   439
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   440
text %mlref {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   441
  \begin{mldecls}
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   442
  @{index_ML "op #> ": "('a -> 'b) * ('b -> 'c) -> 'a -> 'c"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   443
  @{index_ML "op #-> ": "('a -> 'c * 'b) * ('c -> 'b -> 'd) -> 'a -> 'd"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   444
  @{index_ML "op #>> ": "('a -> 'c * 'b) * ('c -> 'd) -> 'a -> 'd * 'b"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   445
  @{index_ML "op ##> ": "('a -> 'c * 'b) * ('b -> 'd) -> 'a -> 'c * 'd"} \\
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   446
  @{index_ML "op ##>> ": "('a -> 'c * 'b) * ('b -> 'e * 'd) -> 'a -> ('c * 'e) * 'd"} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   447
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   448
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   449
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   450
text {*
22550
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   451
  \noindent All those linear combinators also exist in higher-order
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   452
  variants which do not expect a value on the left hand side
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   453
  but a function.
22322
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   454
*}
b9924abb8c66 continued
haftmann
parents: 22293
diff changeset
   455
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   456
text %mlref {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   457
  \begin{mldecls}
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   458
  @{index_ML "op ` ": "('b -> 'a) -> 'b -> 'a * 'b"} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   459
  @{index_ML tap: "('b -> 'a) -> 'b -> 'b"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   460
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   461
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   462
22550
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   463
text {*
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   464
  \noindent FIXME
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   465
*}
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   466
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   467
section {* Options and partiality *}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   468
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   469
text %mlref {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   470
  \begin{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   471
  @{index_ML is_some: "'a option -> bool"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   472
  @{index_ML is_none: "'a option -> bool"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   473
  @{index_ML the: "'a option -> 'a"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   474
  @{index_ML these: "'a list option -> 'a list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   475
  @{index_ML the_list: "'a option -> 'a list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   476
  @{index_ML the_default: "'a -> 'a option -> 'a"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   477
  @{index_ML try: "('a -> 'b) -> 'a -> 'b option"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   478
  @{index_ML can: "('a -> 'b) -> 'a -> bool"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   479
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   480
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   481
22550
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   482
text {*
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   483
  Standard selector functions on @{text option}s are provided.  The
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   484
  @{ML try} and @{ML can} functions provide a convenient interface for
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   485
  handling exceptions -- both take as arguments a function @{text f}
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   486
  together with a parameter @{text x} and handle any exception during
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   487
  the evaluation of the application of @{text f} to @{text x}, either
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   488
  return a lifted result (@{ML NONE} on failure) or a boolean value
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   489
  (@{ML false} on failure).
22550
c5039bee2602 updated
haftmann
parents: 22503
diff changeset
   490
*}
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   491
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   492
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   493
section {* Common data structures *}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   494
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   495
subsection {* Lists (as set-like data structures) *}
18538
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
   496
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   497
text {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   498
  \begin{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   499
  @{index_ML member: "('b * 'a -> bool) -> 'a list -> 'b -> bool"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   500
  @{index_ML insert: "('a * 'a -> bool) -> 'a -> 'a list -> 'a list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   501
  @{index_ML remove: "('b * 'a -> bool) -> 'b -> 'a list -> 'a list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   502
  @{index_ML merge: "('a * 'a -> bool) -> 'a list * 'a list -> 'a list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   503
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   504
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   505
22503
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   506
text {*
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   507
  Lists are often used as set-like data structures -- set-like in
25151
9374a0df240c continued
haftmann
parents: 24110
diff changeset
   508
  the sense that they support a notion of @{ML member}-ship,
22503
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   509
  @{ML insert}-ing and @{ML remove}-ing, but are order-sensitive.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   510
  This is convenient when implementing a history-like mechanism:
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   511
  @{ML insert} adds an element \emph{to the front} of a list,
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   512
  if not yet present; @{ML remove} removes \emph{all} occurences
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   513
  of a particular element.  Correspondingly @{ML merge} implements a 
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   514
  a merge on two lists suitable for merges of context data
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   515
  (\secref{sec:context-theory}).
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   516
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   517
  Functions are parametrized by an explicit equality function
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   518
  to accomplish overloaded equality;  in most cases of monomorphic
24089
070d539ba403 tuned section "Style";
wenzelm
parents: 23652
diff changeset
   519
  equality, writing @{ML "op ="} should suffice.
22503
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   520
*}
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   521
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   522
subsection {* Association lists *}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   523
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   524
text {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   525
  \begin{mldecls}
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   526
  @{index_ML_exn AList.DUP} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   527
  @{index_ML AList.lookup: "('a * 'b -> bool) -> ('b * 'c) list -> 'a -> 'c option"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   528
  @{index_ML AList.defined: "('a * 'b -> bool) -> ('b * 'c) list -> 'a -> bool"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   529
  @{index_ML AList.update: "('a * 'a -> bool) -> ('a * 'b) -> ('a * 'b) list -> ('a * 'b) list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   530
  @{index_ML AList.default: "('a * 'a -> bool) -> ('a * 'b) -> ('a * 'b) list -> ('a * 'b) list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   531
  @{index_ML AList.delete: "('a * 'b -> bool) -> 'a -> ('b * 'c) list -> ('b * 'c) list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   532
  @{index_ML AList.map_entry: "('a * 'b -> bool) -> 'a
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   533
    -> ('c -> 'c) -> ('b * 'c) list -> ('b * 'c) list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   534
  @{index_ML AList.map_default: "('a * 'a -> bool) -> 'a * 'b -> ('b -> 'b)
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   535
    -> ('a * 'b) list -> ('a * 'b) list"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   536
  @{index_ML AList.join: "('a * 'a -> bool) -> ('a -> 'b * 'b -> 'b) (*exception DUP*)
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   537
    -> ('a * 'b) list * ('a * 'b) list -> ('a * 'b) list (*exception AList.DUP*)"} \\
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   538
  @{index_ML AList.merge: "('a * 'a -> bool) -> ('b * 'b -> bool)
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   539
    -> ('a * 'b) list * ('a * 'b) list -> ('a * 'b) list (*exception AList.DUP*)"}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   540
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   541
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   542
22503
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   543
text {*
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   544
  Association lists can be seens as an extension of set-like lists:
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   545
  on the one hand, they may be used to implement finite mappings,
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   546
  on the other hand, they remain order-sensitive and allow for
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   547
  multiple key-value-pair with the same key: @{ML AList.lookup}
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   548
  returns the \emph{first} value corresponding to a particular
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   549
  key, if present.  @{ML AList.update} updates
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   550
  the \emph{first} occurence of a particular key; if no such
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   551
  key exists yet, the key-value-pair is added \emph{to the front}.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   552
  @{ML AList.delete} only deletes the \emph{first} occurence of a key.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   553
  @{ML AList.merge} provides an operation suitable for merges of context data
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   554
  (\secref{sec:context-theory}), where an equality parameter on
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   555
  values determines whether a merge should be considered a conflict.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   556
  A slightly generalized operation if implementend by the @{ML AList.join}
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   557
  function which allows for explicit conflict resolution.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   558
*}
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   559
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   560
subsection {* Tables *}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   561
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   562
text {*
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   563
  \begin{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   564
  @{index_ML_type "'a Symtab.table"} \\
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   565
  @{index_ML_exn Symtab.DUP: string} \\
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   566
  @{index_ML_exn Symtab.SAME} \\
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   567
  @{index_ML_exn Symtab.UNDEF: string} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   568
  @{index_ML Symtab.empty: "'a Symtab.table"} \\
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   569
  @{index_ML Symtab.lookup: "'a Symtab.table -> string -> 'a option"} \\
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   570
  @{index_ML Symtab.defined: "'a Symtab.table -> string -> bool"} \\
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   571
  @{index_ML Symtab.update: "(string * 'a) -> 'a Symtab.table -> 'a Symtab.table"} \\
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   572
  @{index_ML Symtab.default: "string * 'a -> 'a Symtab.table -> 'a Symtab.table"} \\
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   573
  @{index_ML Symtab.delete: "string
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   574
    -> 'a Symtab.table -> 'a Symtab.table (*exception Symtab.UNDEF*)"} \\
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   575
  @{index_ML Symtab.map_entry: "string -> ('a -> 'a)
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   576
    -> 'a Symtab.table -> 'a Symtab.table"} \\
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   577
  @{index_ML Symtab.map_default: "(string * 'a) -> ('a -> 'a)
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   578
    -> 'a Symtab.table -> 'a Symtab.table"} \\
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   579
  @{index_ML Symtab.join: "(string -> 'a * 'a -> 'a) (*exception Symtab.DUP/Symtab.SAME*)
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   580
    -> 'a Symtab.table * 'a Symtab.table
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   581
    -> 'a Symtab.table (*exception Symtab.DUP*)"} \\
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   582
  @{index_ML Symtab.merge: "('a * 'a -> bool)
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   583
    -> 'a Symtab.table * 'a Symtab.table
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   584
    -> 'a Symtab.table (*exception Symtab.DUP*)"}
22293
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   585
  \end{mldecls}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   586
*}
3593a76c9ed3 added outline for Isabelle library description
haftmann
parents: 21502
diff changeset
   587
22503
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   588
text {*
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   589
  Tables are an efficient representation of finite mappings without
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   590
  any notion of order;  due to their efficiency they should be used
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   591
  whenever such pure finite mappings are neccessary.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   592
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   593
  The key type of tables must be given explicitly by instantiating
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   594
  the @{ML_functor TableFun} functor which takes the key type
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   595
  together with its @{ML_type order}; for convience, we restrict
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   596
  here to the @{ML_struct Symtab} instance with @{ML_type string}
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   597
  as key type.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   598
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   599
  Most table functions correspond to those of association lists.
d53664118418 added some sketches about library functions
haftmann
parents: 22322
diff changeset
   600
*}
20489
a684fc70d04e tentative appendix C;
wenzelm
parents: 18554
diff changeset
   601
23652
94eeb79be496 simplified Symtab;
wenzelm
parents: 22550
diff changeset
   602
20489
a684fc70d04e tentative appendix C;
wenzelm
parents: 18554
diff changeset
   603
chapter {* Cookbook *}
a684fc70d04e tentative appendix C;
wenzelm
parents: 18554
diff changeset
   604
20491
wenzelm
parents: 20489
diff changeset
   605
section {* A method that depends on declarations in the context *}
20489
a684fc70d04e tentative appendix C;
wenzelm
parents: 18554
diff changeset
   606
a684fc70d04e tentative appendix C;
wenzelm
parents: 18554
diff changeset
   607
text FIXME
a684fc70d04e tentative appendix C;
wenzelm
parents: 18554
diff changeset
   608
18538
88fe84d4d151 outline;
wenzelm
parents: 18537
diff changeset
   609
end