src/HOL/Library/Mapping.thy
changeset 49929 70300f1b6835
parent 49834 b27bbb021df1
child 49939 eb8b434158c8
equal deleted inserted replaced
49928:e3f0a92de280 49929:70300f1b6835
     1 (* Author: Florian Haftmann, TU Muenchen *)
     1 (*  Title:      HOL/Library/Mapping.thy
       
     2     Author:     Florian Haftmann and Ondrej Kuncar
       
     3 *)
     2 
     4 
     3 header {* An abstract view on maps for code generation. *}
     5 header {* An abstract view on maps for code generation. *}
     4 
     6 
     5 theory Mapping
     7 theory Mapping
     6 imports Main
     8 imports Main "~~/src/HOL/Library/Quotient_Option"
     7 begin
     9 begin
     8 
    10 
     9 subsection {* Type definition and primitive operations *}
    11 subsection {* Type definition and primitive operations *}
    10 
    12 
    11 typedef ('a, 'b) mapping = "UNIV :: ('a \<rightharpoonup> 'b) set"
    13 typedef ('a, 'b) mapping = "UNIV :: ('a \<rightharpoonup> 'b) set"
    12   morphisms lookup Mapping ..
    14   morphisms rep Mapping ..
    13 
    15 
    14 lemma lookup_Mapping [simp]:
    16 setup_lifting(no_code) type_definition_mapping
    15   "lookup (Mapping f) = f"
    17 
    16   by (rule Mapping_inverse) rule
    18 lift_definition empty :: "('a, 'b) mapping" is "(\<lambda>_. None)" .
    17 
    19 
    18 lemma Mapping_lookup [simp]:
    20 lift_definition lookup :: "('a, 'b) mapping \<Rightarrow> 'a \<Rightarrow> 'b option" is "\<lambda>m k. m k" .
    19   "Mapping (lookup m) = m"
    21 
    20   by (fact lookup_inverse)
    22 lift_definition update :: "'a \<Rightarrow> 'b \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" is "\<lambda>k v m. m(k \<mapsto> v)" .
    21 
    23 
    22 lemma Mapping_inject [simp]:
    24 lift_definition delete :: "'a \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" is "\<lambda>k m. m(k := None)" .
    23   "Mapping f = Mapping g \<longleftrightarrow> f = g"
    25 
    24   by (simp add: Mapping_inject)
    26 lift_definition keys :: "('a, 'b) mapping \<Rightarrow> 'a set" is dom .
    25 
    27 
    26 lemma mapping_eq_iff:
    28 lift_definition tabulate :: "'a list \<Rightarrow> ('a \<Rightarrow> 'b) \<Rightarrow> ('a, 'b) mapping" is
    27   "m = n \<longleftrightarrow> lookup m = lookup n"
    29   "\<lambda>ks f. (map_of (List.map (\<lambda>k. (k, f k)) ks))" .
    28   by (simp add: lookup_inject)
    30 
    29 
    31 lift_definition bulkload :: "'a list \<Rightarrow> (nat, 'a) mapping" is
    30 lemma mapping_eqI:
    32   "\<lambda>xs k. if k < length xs then Some (xs ! k) else None" .
    31   "lookup m = lookup n \<Longrightarrow> m = n"
    33 
    32   by (simp add: mapping_eq_iff)
    34 lift_definition map :: "('c \<Rightarrow> 'a) \<Rightarrow> ('b \<Rightarrow> 'd) \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('c, 'd) mapping" is
    33 
    35   "\<lambda>f g m. (Option.map g \<circ> m \<circ> f)" .
    34 definition empty :: "('a, 'b) mapping" where
       
    35   "empty = Mapping (\<lambda>_. None)"
       
    36 
       
    37 definition update :: "'a \<Rightarrow> 'b \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
       
    38   "update k v m = Mapping ((lookup m)(k \<mapsto> v))"
       
    39 
       
    40 definition delete :: "'a \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
       
    41   "delete k m = Mapping ((lookup m)(k := None))"
       
    42 
       
    43 
    36 
    44 subsection {* Functorial structure *}
    37 subsection {* Functorial structure *}
    45 
    38 
    46 definition map :: "('c \<Rightarrow> 'a) \<Rightarrow> ('b \<Rightarrow> 'd) \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('c, 'd) mapping" where
       
    47   "map f g m = Mapping (Option.map g \<circ> lookup m \<circ> f)"
       
    48 
       
    49 lemma lookup_map [simp]:
       
    50   "lookup (map f g m) = Option.map g \<circ> lookup m \<circ> f"
       
    51   by (simp add: map_def)
       
    52 
       
    53 enriched_type map: map
    39 enriched_type map: map
    54   by (simp_all add: mapping_eq_iff fun_eq_iff Option.map.compositionality Option.map.id)
    40   by (transfer, auto simp add: fun_eq_iff Option.map.compositionality Option.map.id)+
    55 
       
    56 
    41 
    57 subsection {* Derived operations *}
    42 subsection {* Derived operations *}
    58 
       
    59 definition keys :: "('a, 'b) mapping \<Rightarrow> 'a set" where
       
    60   "keys m = dom (lookup m)"
       
    61 
    43 
    62 definition ordered_keys :: "('a\<Colon>linorder, 'b) mapping \<Rightarrow> 'a list" where
    44 definition ordered_keys :: "('a\<Colon>linorder, 'b) mapping \<Rightarrow> 'a list" where
    63   "ordered_keys m = (if finite (keys m) then sorted_list_of_set (keys m) else [])"
    45   "ordered_keys m = (if finite (keys m) then sorted_list_of_set (keys m) else [])"
    64 
    46 
    65 definition is_empty :: "('a, 'b) mapping \<Rightarrow> bool" where
    47 definition is_empty :: "('a, 'b) mapping \<Rightarrow> bool" where
    72   "replace k v m = (if k \<in> keys m then update k v m else m)"
    54   "replace k v m = (if k \<in> keys m then update k v m else m)"
    73 
    55 
    74 definition default :: "'a \<Rightarrow> 'b \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
    56 definition default :: "'a \<Rightarrow> 'b \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
    75   "default k v m = (if k \<in> keys m then m else update k v m)"
    57   "default k v m = (if k \<in> keys m then m else update k v m)"
    76 
    58 
    77 definition map_entry :: "'a \<Rightarrow> ('b \<Rightarrow> 'b) \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
    59 lift_definition map_entry :: "'a \<Rightarrow> ('b \<Rightarrow> 'b) \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" is
    78   "map_entry k f m = (case lookup m k of None \<Rightarrow> m
    60   "\<lambda>k f m. (case m k of None \<Rightarrow> m
    79     | Some v \<Rightarrow> update k (f v) m)" 
    61     | Some v \<Rightarrow> m (k \<mapsto> (f v)))" .
       
    62 
       
    63 lemma map_entry_code [code]: "map_entry k f m = (case lookup m k of None \<Rightarrow> m
       
    64     | Some v \<Rightarrow> update k (f v) m)" by transfer rule
    80 
    65 
    81 definition map_default :: "'a \<Rightarrow> 'b \<Rightarrow> ('b \<Rightarrow> 'b) \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
    66 definition map_default :: "'a \<Rightarrow> 'b \<Rightarrow> ('b \<Rightarrow> 'b) \<Rightarrow> ('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping" where
    82   "map_default k v f m = map_entry k f (default k v m)" 
    67   "map_default k v f m = map_entry k f (default k v m)" 
    83 
    68 
    84 definition tabulate :: "'a list \<Rightarrow> ('a \<Rightarrow> 'b) \<Rightarrow> ('a, 'b) mapping" where
       
    85   "tabulate ks f = Mapping (map_of (List.map (\<lambda>k. (k, f k)) ks))"
       
    86 
       
    87 definition bulkload :: "'a list \<Rightarrow> (nat, 'a) mapping" where
       
    88   "bulkload xs = Mapping (\<lambda>k. if k < length xs then Some (xs ! k) else None)"
       
    89 
       
    90 
       
    91 subsection {* Properties *}
    69 subsection {* Properties *}
    92 
    70 
    93 lemma keys_is_none_lookup [code_unfold]:
    71 lemma keys_is_none_rep [code_unfold]:
    94   "k \<in> keys m \<longleftrightarrow> \<not> (Option.is_none (lookup m k))"
    72   "k \<in> keys m \<longleftrightarrow> \<not> (Option.is_none (lookup m k))"
    95   by (auto simp add: keys_def is_none_def)
    73   by transfer (auto simp add: is_none_def)
    96 
    74 
    97 lemma lookup_empty [simp]:
    75 lemma tabulate_alt_def:
    98   "lookup empty = Map.empty"
    76   "map_of (List.map (\<lambda>k. (k, f k)) ks) = (Some o f) |` set ks"
    99   by (simp add: empty_def)
    77   by (induct ks) (auto simp add: tabulate_def restrict_map_def)
   100 
       
   101 lemma lookup_update [simp]:
       
   102   "lookup (update k v m) = (lookup m) (k \<mapsto> v)"
       
   103   by (simp add: update_def)
       
   104 
       
   105 lemma lookup_delete [simp]:
       
   106   "lookup (delete k m) = (lookup m) (k := None)"
       
   107   by (simp add: delete_def)
       
   108 
       
   109 lemma lookup_map_entry [simp]:
       
   110   "lookup (map_entry k f m) = (lookup m) (k := Option.map f (lookup m k))"
       
   111   by (cases "lookup m k") (simp_all add: map_entry_def fun_eq_iff)
       
   112 
       
   113 lemma lookup_tabulate [simp]:
       
   114   "lookup (tabulate ks f) = (Some o f) |` set ks"
       
   115   by (induct ks) (auto simp add: tabulate_def restrict_map_def fun_eq_iff)
       
   116 
       
   117 lemma lookup_bulkload [simp]:
       
   118   "lookup (bulkload xs) = (\<lambda>k. if k < length xs then Some (xs ! k) else None)"
       
   119   by (simp add: bulkload_def)
       
   120 
    78 
   121 lemma update_update:
    79 lemma update_update:
   122   "update k v (update k w m) = update k v m"
    80   "update k v (update k w m) = update k v m"
   123   "k \<noteq> l \<Longrightarrow> update k v (update l w m) = update l w (update k v m)"
    81   "k \<noteq> l \<Longrightarrow> update k v (update l w m) = update l w (update k v m)"
   124   by (rule mapping_eqI, simp add: fun_upd_twist)+
    82   by (transfer, simp add: fun_upd_twist)+
   125 
    83 
   126 lemma update_delete [simp]:
    84 lemma update_delete [simp]:
   127   "update k v (delete k m) = update k v m"
    85   "update k v (delete k m) = update k v m"
   128   by (rule mapping_eqI) simp
    86   by transfer simp
   129 
    87 
   130 lemma delete_update:
    88 lemma delete_update:
   131   "delete k (update k v m) = delete k m"
    89   "delete k (update k v m) = delete k m"
   132   "k \<noteq> l \<Longrightarrow> delete k (update l v m) = update l v (delete k m)"
    90   "k \<noteq> l \<Longrightarrow> delete k (update l v m) = update l v (delete k m)"
   133   by (rule mapping_eqI, simp add: fun_upd_twist)+
    91   by (transfer, simp add: fun_upd_twist)+
   134 
    92 
   135 lemma delete_empty [simp]:
    93 lemma delete_empty [simp]:
   136   "delete k empty = empty"
    94   "delete k empty = empty"
   137   by (rule mapping_eqI) simp
    95   by transfer simp
   138 
    96 
   139 lemma replace_update:
    97 lemma replace_update:
   140   "k \<notin> keys m \<Longrightarrow> replace k v m = m"
    98   "k \<notin> keys m \<Longrightarrow> replace k v m = m"
   141   "k \<in> keys m \<Longrightarrow> replace k v m = update k v m"
    99   "k \<in> keys m \<Longrightarrow> replace k v m = update k v m"
   142   by (rule mapping_eqI) (auto simp add: replace_def fun_upd_twist)+
   100   by (transfer, auto simp add: replace_def fun_upd_twist)+
   143 
   101 
   144 lemma size_empty [simp]:
   102 lemma size_empty [simp]:
   145   "size empty = 0"
   103   "size empty = 0"
   146   by (simp add: size_def keys_def)
   104   unfolding size_def by transfer simp
   147 
   105 
   148 lemma size_update:
   106 lemma size_update:
   149   "finite (keys m) \<Longrightarrow> size (update k v m) =
   107   "finite (keys m) \<Longrightarrow> size (update k v m) =
   150     (if k \<in> keys m then size m else Suc (size m))"
   108     (if k \<in> keys m then size m else Suc (size m))"
   151   by (auto simp add: size_def insert_dom keys_def)
   109   unfolding size_def by transfer (auto simp add: insert_dom)
   152 
   110 
   153 lemma size_delete:
   111 lemma size_delete:
   154   "size (delete k m) = (if k \<in> keys m then size m - 1 else size m)"
   112   "size (delete k m) = (if k \<in> keys m then size m - 1 else size m)"
   155   by (simp add: size_def keys_def)
   113   unfolding size_def by transfer simp
   156 
   114 
   157 lemma size_tabulate [simp]:
   115 lemma size_tabulate [simp]:
   158   "size (tabulate ks f) = length (remdups ks)"
   116   "size (tabulate ks f) = length (remdups ks)"
   159   by (simp add: size_def distinct_card [of "remdups ks", symmetric] comp_def keys_def)
   117   unfolding size_def by transfer (auto simp add: tabulate_alt_def card_set comp_def)
   160 
   118 
   161 lemma bulkload_tabulate:
   119 lemma bulkload_tabulate:
   162   "bulkload xs = tabulate [0..<length xs] (nth xs)"
   120   "bulkload xs = tabulate [0..<length xs] (nth xs)"
   163   by (rule mapping_eqI) (simp add: fun_eq_iff)
   121   by transfer (auto simp add: tabulate_alt_def)
   164 
   122 
   165 lemma is_empty_empty: (*FIXME*)
   123 lemma is_empty_empty [simp]:
   166   "is_empty m \<longleftrightarrow> m = Mapping Map.empty"
       
   167   by (cases m) (simp add: is_empty_def keys_def)
       
   168 
       
   169 lemma is_empty_empty' [simp]:
       
   170   "is_empty empty"
   124   "is_empty empty"
   171   by (simp add: is_empty_empty empty_def) 
   125   unfolding is_empty_def by transfer simp 
   172 
   126 
   173 lemma is_empty_update [simp]:
   127 lemma is_empty_update [simp]:
   174   "\<not> is_empty (update k v m)"
   128   "\<not> is_empty (update k v m)"
   175   by (simp add: is_empty_empty update_def)
   129   unfolding is_empty_def by transfer simp
   176 
   130 
   177 lemma is_empty_delete:
   131 lemma is_empty_delete:
   178   "is_empty (delete k m) \<longleftrightarrow> is_empty m \<or> keys m = {k}"
   132   "is_empty (delete k m) \<longleftrightarrow> is_empty m \<or> keys m = {k}"
   179   by (auto simp add: delete_def is_empty_def keys_def simp del: dom_eq_empty_conv)
   133   unfolding is_empty_def by transfer (auto simp del: dom_eq_empty_conv)
   180 
   134 
   181 lemma is_empty_replace [simp]:
   135 lemma is_empty_replace [simp]:
   182   "is_empty (replace k v m) \<longleftrightarrow> is_empty m"
   136   "is_empty (replace k v m) \<longleftrightarrow> is_empty m"
   183   by (auto simp add: replace_def) (simp add: is_empty_def)
   137   unfolding is_empty_def replace_def by transfer auto
   184 
   138 
   185 lemma is_empty_default [simp]:
   139 lemma is_empty_default [simp]:
   186   "\<not> is_empty (default k v m)"
   140   "\<not> is_empty (default k v m)"
   187   by (auto simp add: default_def) (simp add: is_empty_def)
   141   unfolding is_empty_def default_def by transfer auto
   188 
   142 
   189 lemma is_empty_map_entry [simp]:
   143 lemma is_empty_map_entry [simp]:
   190   "is_empty (map_entry k f m) \<longleftrightarrow> is_empty m"
   144   "is_empty (map_entry k f m) \<longleftrightarrow> is_empty m"
   191   by (cases "lookup m k")
   145   unfolding is_empty_def 
   192     (auto simp add: map_entry_def, simp add: is_empty_empty)
   146   apply transfer by (case_tac "m k") auto
   193 
   147 
   194 lemma is_empty_map_default [simp]:
   148 lemma is_empty_map_default [simp]:
   195   "\<not> is_empty (map_default k v f m)"
   149   "\<not> is_empty (map_default k v f m)"
   196   by (simp add: map_default_def)
   150   by (simp add: map_default_def)
   197 
   151 
   198 lemma keys_empty [simp]:
   152 lemma keys_empty [simp]:
   199   "keys empty = {}"
   153   "keys empty = {}"
   200   by (simp add: keys_def)
   154   by transfer simp
   201 
   155 
   202 lemma keys_update [simp]:
   156 lemma keys_update [simp]:
   203   "keys (update k v m) = insert k (keys m)"
   157   "keys (update k v m) = insert k (keys m)"
   204   by (simp add: keys_def)
   158   by transfer simp
   205 
   159 
   206 lemma keys_delete [simp]:
   160 lemma keys_delete [simp]:
   207   "keys (delete k m) = keys m - {k}"
   161   "keys (delete k m) = keys m - {k}"
   208   by (simp add: keys_def)
   162   by transfer simp
   209 
   163 
   210 lemma keys_replace [simp]:
   164 lemma keys_replace [simp]:
   211   "keys (replace k v m) = keys m"
   165   "keys (replace k v m) = keys m"
   212   by (auto simp add: keys_def replace_def)
   166   unfolding replace_def by transfer (simp add: insert_absorb)
   213 
   167 
   214 lemma keys_default [simp]:
   168 lemma keys_default [simp]:
   215   "keys (default k v m) = insert k (keys m)"
   169   "keys (default k v m) = insert k (keys m)"
   216   by (auto simp add: keys_def default_def)
   170   unfolding default_def by transfer (simp add: insert_absorb)
   217 
   171 
   218 lemma keys_map_entry [simp]:
   172 lemma keys_map_entry [simp]:
   219   "keys (map_entry k f m) = keys m"
   173   "keys (map_entry k f m) = keys m"
   220   by (auto simp add: keys_def)
   174   apply transfer by (case_tac "m k") auto
   221 
   175 
   222 lemma keys_map_default [simp]:
   176 lemma keys_map_default [simp]:
   223   "keys (map_default k v f m) = insert k (keys m)"
   177   "keys (map_default k v f m) = insert k (keys m)"
   224   by (simp add: map_default_def)
   178   by (simp add: map_default_def)
   225 
   179 
   226 lemma keys_tabulate [simp]:
   180 lemma keys_tabulate [simp]:
   227   "keys (tabulate ks f) = set ks"
   181   "keys (tabulate ks f) = set ks"
   228   by (simp add: tabulate_def keys_def map_of_map_restrict o_def)
   182   by transfer (simp add: map_of_map_restrict o_def)
   229 
   183 
   230 lemma keys_bulkload [simp]:
   184 lemma keys_bulkload [simp]:
   231   "keys (bulkload xs) = {0..<length xs}"
   185   "keys (bulkload xs) = {0..<length xs}"
   232   by (simp add: keys_tabulate bulkload_tabulate)
   186   by (simp add: keys_tabulate bulkload_tabulate)
   233 
   187 
   295 code_datatype empty update
   249 code_datatype empty update
   296 
   250 
   297 instantiation mapping :: (type, type) equal
   251 instantiation mapping :: (type, type) equal
   298 begin
   252 begin
   299 
   253 
   300 definition [code del]:
   254 lift_definition equal_mapping :: "('a, 'b) mapping \<Rightarrow> ('a, 'b) mapping \<Rightarrow> bool" is "op=" .
   301   "HOL.equal m n \<longleftrightarrow> lookup m = lookup n"
       
   302 
   255 
   303 instance proof
   256 instance proof
   304 qed (simp add: equal_mapping_def mapping_eq_iff)
   257 qed(transfer, rule)
   305 
   258 
   306 end
   259 end
   307 
   260 
   308 
   261 
   309 hide_const (open) empty is_empty lookup update delete ordered_keys keys size
   262 hide_const (open) empty is_empty rep lookup update delete ordered_keys keys size
   310   replace default map_entry map_default tabulate bulkload map
   263   replace default map_entry map_default tabulate bulkload map
   311 
   264 
   312 end
   265 end