src/HOL/Option.thy
author krauss
Sun, 05 Sep 2010 21:39:16 +0200
changeset 39149 aabd6d4a5c3a
parent 38857 97775f3e8722
child 39150 c4ff5fd8db99
permissions -rw-r--r--
added Option.bind
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     1
(*  Title:      HOL/Option.thy
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     2
    Author:     Folklore
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     3
*)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     4
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     5
header {* Datatype option *}
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     6
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     7
theory Option
35719
99b6152aedf5 split off theory Big_Operators from theory Finite_Set
haftmann
parents: 34886
diff changeset
     8
imports Datatype
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
     9
begin
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    10
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    11
datatype 'a option = None | Some 'a
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    12
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    13
lemma not_None_eq [iff]: "(x ~= None) = (EX y. x = Some y)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    14
  by (induct x) auto
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    15
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    16
lemma not_Some_eq [iff]: "(ALL y. x ~= Some y) = (x = None)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    17
  by (induct x) auto
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    18
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    19
text{*Although it may appear that both of these equalities are helpful
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    20
only when applied to assumptions, in practice it seems better to give
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    21
them the uniform iff attribute. *}
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    22
31080
21ffc770ebc0 lemmas by Andreas Lochbihler
nipkow
parents: 30327
diff changeset
    23
lemma inj_Some [simp]: "inj_on Some A"
21ffc770ebc0 lemmas by Andreas Lochbihler
nipkow
parents: 30327
diff changeset
    24
by (rule inj_onI) simp
21ffc770ebc0 lemmas by Andreas Lochbihler
nipkow
parents: 30327
diff changeset
    25
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    26
lemma option_caseE:
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    27
  assumes c: "(case x of None => P | Some y => Q y)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    28
  obtains
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    29
    (None) "x = None" and P
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    30
  | (Some) y where "x = Some y" and "Q y"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    31
  using c by (cases x) simp_all
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    32
31080
21ffc770ebc0 lemmas by Andreas Lochbihler
nipkow
parents: 30327
diff changeset
    33
lemma UNIV_option_conv: "UNIV = insert None (range Some)"
21ffc770ebc0 lemmas by Andreas Lochbihler
nipkow
parents: 30327
diff changeset
    34
by(auto intro: classical)
21ffc770ebc0 lemmas by Andreas Lochbihler
nipkow
parents: 30327
diff changeset
    35
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    36
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    37
subsubsection {* Operations *}
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    38
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    39
primrec the :: "'a option => 'a" where
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    40
"the (Some x) = x"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    41
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    42
primrec set :: "'a option => 'a set" where
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    43
"set None = {}" |
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    44
"set (Some x) = {x}"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    45
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    46
lemma ospec [dest]: "(ALL x:set A. P x) ==> A = Some x ==> P x"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    47
  by simp
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    48
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    49
declaration {* fn _ =>
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    50
  Classical.map_cs (fn cs => cs addSD2 ("ospec", thm "ospec"))
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    51
*}
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    52
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    53
lemma elem_set [iff]: "(x : set xo) = (xo = Some x)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    54
  by (cases xo) auto
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    55
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    56
lemma set_empty_eq [simp]: "(set xo = {}) = (xo = None)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    57
  by (cases xo) auto
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    58
31154
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
    59
definition map :: "('a \<Rightarrow> 'b) \<Rightarrow> 'a option \<Rightarrow> 'b option" where
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
    60
  "map = (%f y. case y of None => None | Some x => Some (f x))"
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    61
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    62
lemma option_map_None [simp, code]: "map f None = None"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    63
  by (simp add: map_def)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    64
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    65
lemma option_map_Some [simp, code]: "map f (Some x) = Some (f x)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    66
  by (simp add: map_def)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    67
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    68
lemma option_map_is_None [iff]:
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    69
    "(map f opt = None) = (opt = None)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    70
  by (simp add: map_def split add: option.split)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    71
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    72
lemma option_map_eq_Some [iff]:
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    73
    "(map f xo = Some y) = (EX z. xo = Some z & f z = y)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    74
  by (simp add: map_def split add: option.split)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    75
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    76
lemma option_map_comp:
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    77
    "map f (map g opt) = map (f o g) opt"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    78
  by (simp add: map_def split add: option.split)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    79
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    80
lemma option_map_o_sum_case [simp]:
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    81
    "map f o sum_case g h = sum_case (map f o g) (map f o h)"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    82
  by (rule ext) (simp split: sum.split)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    83
39149
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    84
primrec bind :: "'a option \<Rightarrow> ('a \<Rightarrow> 'b option) \<Rightarrow> 'b option" where
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    85
bind_lzero: "bind None f = None" |
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    86
bind_lunit: "bind (Some x) f = f x"
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    87
39149
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    88
lemma bind_runit[simp]: "bind x Some = x"
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    89
by (cases x) auto
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    90
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    91
lemma bind_assoc[simp]: "bind (bind x f) g = bind x (\<lambda>y. bind (f y) g)"
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    92
by (cases x) auto
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    93
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    94
lemma bind_rzero[simp]: "bind x (\<lambda>x. None) = None"
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    95
by (cases x) auto
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    96
aabd6d4a5c3a added Option.bind
krauss
parents: 38857
diff changeset
    97
hide_const (open) set map bind
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    98
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
    99
subsubsection {* Code generator setup *}
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   100
31154
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   101
definition is_none :: "'a option \<Rightarrow> bool" where
31998
2c7a24f74db9 code attributes use common underscore convention
haftmann
parents: 31154
diff changeset
   102
  [code_post]: "is_none x \<longleftrightarrow> x = None"
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   103
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   104
lemma is_none_code [code]:
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   105
  shows "is_none None \<longleftrightarrow> True"
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   106
    and "is_none (Some x) \<longleftrightarrow> False"
31154
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   107
  unfolding is_none_def by simp_all
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   108
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   109
lemma is_none_none:
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   110
  "is_none x \<longleftrightarrow> x = None"
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   111
  by (simp add: is_none_def)
f919b8e67413 preprocessing must consider eq
haftmann
parents: 31080
diff changeset
   112
32069
6d28bbd33e2c prefer code_inline over code_unfold; use code_unfold_post where appropriate
haftmann
parents: 31998
diff changeset
   113
lemma [code_unfold]:
38857
97775f3e8722 renamed class/constant eq to equal; tuned some instantiations
haftmann
parents: 37880
diff changeset
   114
  "HOL.equal x None \<longleftrightarrow> is_none x"
97775f3e8722 renamed class/constant eq to equal; tuned some instantiations
haftmann
parents: 37880
diff changeset
   115
  by (simp add: equal is_none_none)
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   116
36176
3fe7e97ccca8 replaced generic 'hide' command by more conventional 'hide_class', 'hide_type', 'hide_const', 'hide_fact' -- frees some popular keywords;
wenzelm
parents: 35719
diff changeset
   117
hide_const (open) is_none
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   118
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   119
code_type option
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   120
  (SML "_ option")
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   121
  (OCaml "_ option")
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   122
  (Haskell "Maybe _")
34886
873c31d9f10d some syntax setup for Scala
haftmann
parents: 32069
diff changeset
   123
  (Scala "!Option[(_)]")
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   124
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   125
code_const None and Some
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   126
  (SML "NONE" and "SOME")
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   127
  (OCaml "None" and "Some _")
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   128
  (Haskell "Nothing" and "Just")
37880
3b9ca8d2c5fb Scala: subtle difference in printing strings vs. complex mixfix syntax
haftmann
parents: 36176
diff changeset
   129
  (Scala "!None" and "Some")
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   130
38857
97775f3e8722 renamed class/constant eq to equal; tuned some instantiations
haftmann
parents: 37880
diff changeset
   131
code_instance option :: equal
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   132
  (Haskell -)
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   133
38857
97775f3e8722 renamed class/constant eq to equal; tuned some instantiations
haftmann
parents: 37880
diff changeset
   134
code_const "HOL.equal \<Colon> 'a option \<Rightarrow> 'a option \<Rightarrow> bool"
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   135
  (Haskell infixl 4 "==")
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   136
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   137
code_reserved SML
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   138
  option NONE SOME
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   139
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   140
code_reserved OCaml
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   141
  option None Some
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   142
34886
873c31d9f10d some syntax setup for Scala
haftmann
parents: 32069
diff changeset
   143
code_reserved Scala
873c31d9f10d some syntax setup for Scala
haftmann
parents: 32069
diff changeset
   144
  Option None Some
873c31d9f10d some syntax setup for Scala
haftmann
parents: 32069
diff changeset
   145
30246
8253519dfc90 Option.thy
nipkow
parents:
diff changeset
   146
end