Theory Word_Lib.Typedef_Morphisms

(*
 * Copyright Data61, CSIRO (ABN 41 687 119 230)
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *)

(*
  Author: Jeremy Dawson and Gerwin Klein, NICTA

  Consequences of type definition theorems, and of extended type definition.
*)

section ‹Type Definition Theorems›

theory Typedef_Morphisms
  imports Main "HOL-Library.Word" More_Int Bit_Comprehension
begin

subsection "More lemmas about normal type definitions"

lemma tdD1: "type_definition Rep Abs A ⟹ ∀x. Rep x ∈ A"
  and tdD2: "type_definition Rep Abs A ⟹ ∀x. Abs (Rep x) = x"
  and tdD3: "type_definition Rep Abs A ⟹ ∀y. y ∈ A ⟶ Rep (Abs y) = y"
  by (auto simp: type_definition_def)

lemma td_nat_int: "type_definition int nat (Collect ((≤) 0))"
  unfolding type_definition_def by auto

context type_definition
begin

declare Rep [iff] Rep_inverse [simp] Rep_inject [simp]

lemma Abs_eqD: "Abs x = Abs y ⟹ x ∈ A ⟹ y ∈ A ⟹ x = y"
  by (simp add: Abs_inject)

lemma Abs_inverse': "r ∈ A ⟹ Abs r = a ⟹ Rep a = r"
  by (safe elim!: Abs_inverse)

lemma Rep_comp_inverse: "Rep ∘ f = g ⟹ Abs ∘ g = f"
  using Rep_inverse by auto

lemma Rep_eqD [elim!]: "Rep x = Rep y ⟹ x = y"
  by simp

lemma Rep_inverse': "Rep a = r ⟹ Abs r = a"
  by (safe intro!: Rep_inverse)

lemma comp_Abs_inverse: "f ∘ Abs = g ⟹ g ∘ Rep = f"
  using Rep_inverse by auto

lemma set_Rep: "A = range Rep"
proof (rule set_eqI)
  show "x ∈ A ⟷ x ∈ range Rep" for x
    by (auto dest: Abs_inverse [of x, symmetric])
qed

lemma set_Rep_Abs: "A = range (Rep ∘ Abs)"
proof (rule set_eqI)
  show "x ∈ A ⟷ x ∈ range (Rep ∘ Abs)" for x
    by (auto dest: Abs_inverse [of x, symmetric])
qed

lemma Abs_inj_on: "inj_on Abs A"
  unfolding inj_on_def
  by (auto dest: Abs_inject [THEN iffD1])

lemma image: "Abs ` A = UNIV"
  by (fact Abs_image)

lemmas td_thm = type_definition_axioms

lemma fns1: "Rep ∘ fa = fr ∘ Rep ∨ fa ∘ Abs = Abs ∘ fr ⟹ Abs ∘ fr ∘ Rep = fa"
  by (auto dest: Rep_comp_inverse elim: comp_Abs_inverse simp: o_assoc)

lemmas fns1a = disjI1 [THEN fns1]
lemmas fns1b = disjI2 [THEN fns1]

lemma fns4: "Rep ∘ fa ∘ Abs = fr ⟹ Rep ∘ fa = fr ∘ Rep ∧ fa ∘ Abs = Abs ∘ fr"
  by auto

end

interpretation nat_int: type_definition int nat "Collect ((≤) 0)"
  by (rule td_nat_int)

declare
  nat_int.Rep_cases [cases del]
  nat_int.Abs_cases [cases del]
  nat_int.Rep_induct [induct del]
  nat_int.Abs_induct [induct del]


subsection "Extended form of type definition predicate"

lemma td_conds:
  "norm ∘ norm = norm ⟹
    fr ∘ norm = norm ∘ fr ⟷ norm ∘ fr ∘ norm = fr ∘ norm ∧ norm ∘ fr ∘ norm = norm ∘ fr"
  by (metis fun.map_comp)

lemma fn_comm_power:
  assumes "fa ∘ tr = tr ∘ fr"
  shows "fa ^^ n ∘ tr = tr ∘ fr ^^ n"
proof -
  have "⋀x. (fa ^^ n) (tr x) = tr ((fr ^^ n) x)"
  proof (induction n)
    case 0
    then show ?case by auto
  next
    case (Suc n)
    then show ?case
      by (metis assms comp_def funpow.simps(2))
  qed
  then show ?thesis
    by force
qed

lemmas fn_comm_power' =
  ext [THEN fn_comm_power, THEN fun_cong, unfolded o_def]


locale td_ext = type_definition +
  fixes norm
  assumes eq_norm: "⋀x. Rep (Abs x) = norm x"
begin

lemma Abs_norm [simp]: "Abs (norm x) = Abs x"
  using Rep_inverse' eq_norm by blast

lemma td_th: "g ∘ Abs = f ⟹ f (Rep x) = g x"
  by auto

lemma eq_norm': "Rep ∘ Abs = norm"
  by (auto simp: eq_norm)

lemma norm_Rep [simp]: "norm (Rep x) = Rep x"
  using eq_norm' td_th by force

lemmas td = td_thm

lemma set_iff_norm: "w ∈ A ⟷ w = norm w"
  by (auto simp: set_Rep_Abs eq_norm' eq_norm [symmetric])

lemma inverse_norm: "Abs n = w ⟷ Rep w = norm n"
  by (metis Rep_inverse eq_norm)

lemma norm_eq_iff: "norm x = norm y ⟷ Abs x = Abs y"
  by (simp add: eq_norm' [symmetric])

lemma norm_comps:
  "Abs ∘ norm = Abs"
  "norm ∘ Rep = Rep"
  "norm ∘ norm = norm"
  by (auto simp: eq_norm' [symmetric] o_def)

lemmas norm_norm [simp] = norm_comps

lemma fns5: "Rep ∘ fa ∘ Abs = fr ⟹ fr ∘ norm = fr ∧ norm ∘ fr = fr"
  by (fold eq_norm') auto

text ‹
  following give conditions for converses to ‹td_fns1›
  ▪ the condition ‹norm ∘ fr ∘ norm = fr ∘ norm› says that
    ‹fr› takes normalised arguments to normalised results
  ▪ ‹norm ∘ fr ∘ norm = norm ∘ fr› says that ‹fr›
    takes norm-equivalent arguments to norm-equivalent results
  ▪ ‹fr ∘ norm = fr› says that ‹fr›
    takes norm-equivalent arguments to the same result
  ▪ ‹norm ∘ fr = fr› says that ‹fr› takes any argument to a normalised result
›
lemma fns2: "Abs ∘ fr ∘ Rep = fa ⟹ norm ∘ fr ∘ norm = fr ∘ norm ⟷ Rep ∘ fa = fr ∘ Rep"
  by (metis (no_types, lifting) comp_Abs_inverse comp_assoc eq_norm')

lemma fns3: "Abs ∘ fr ∘ Rep = fa ⟹ norm ∘ fr ∘ norm = norm ∘ fr ⟷ fa ∘ Abs = Abs ∘ fr"
  by (metis (no_types, lifting) eq_norm' fun.map_comp norm_norm(1))

lemma fns: "fr ∘ norm = norm ∘ fr ⟹ fa ∘ Abs = Abs ∘ fr ⟷ Rep ∘ fa = fr ∘ Rep"
  by (metis (mono_tags, lifting) eq_norm' fns2 fns4 fun.map_comp norm_norm(1))

lemma range_norm: "range (Rep ∘ Abs) = A"
  by (simp add: set_Rep_Abs)

end

lemmas td_ext_def' =
  td_ext_def [unfolded type_definition_def td_ext_axioms_def]


subsection ‹Type-definition locale instantiations›

definition uints :: "nat ⇒ int set"
  ― ‹the sets of integers representing the words›
  where "uints n = range (take_bit n)"

definition sints :: "nat ⇒ int set"
  where "sints n = range (signed_take_bit (n - 1))"

lemma uints_num: "uints n = {i. 0 ≤ i ∧ i < 2 ^ n}"
  by (simp add: uints_def range_bintrunc)

lemma sints_num: "sints n = {i. - (2 ^ (n - 1)) ≤ i ∧ i < 2 ^ (n - 1)}"
  by (simp add: sints_def range_sbintrunc)

definition unats :: "nat ⇒ nat set"
  where "unats n = {i. i < 2 ^ n}"

― ‹naturals›
lemma uints_unats: "uints n = int ` unats n"
  unfolding unats_def uints_num
  using nonneg_int_cases by fastforce

lemma unats_uints: "unats n = nat ` uints n"
  by (auto simp: uints_unats image_iff)

lemma td_ext_uint:
  "td_ext (uint :: 'a word ⇒ int) word_of_int (uints (LENGTH('a::len)))
    (λw::int. w mod 2 ^ LENGTH('a))"
  unfolding td_ext_def'
  by transfer (simp add: uints_num take_bit_eq_mod)

interpretation word_uint:
  td_ext
    "uint::'a::len word ⇒ int"
    word_of_int
    "uints (LENGTH('a::len))"
    "λw. w mod 2 ^ LENGTH('a::len)"
  by (fact td_ext_uint)

lemmas td_uint = word_uint.td_thm
lemmas int_word_uint = word_uint.eq_norm

lemma td_ext_ubin:
  "td_ext (uint :: 'a word ⇒ int) word_of_int (uints (LENGTH('a::len)))
    (take_bit (LENGTH('a)))"
  by (simp add: td_ext_axioms.intro td_ext_def td_uint uint_word_of_int_eq)

interpretation word_ubin:
  td_ext
    "uint::'a::len word ⇒ int"
    word_of_int
    "uints (LENGTH('a::len))"
    "take_bit (LENGTH('a::len))"
  by (fact td_ext_ubin)

lemma td_ext_unat [OF refl]:
  "n = LENGTH('a::len) ⟹
    td_ext (unat :: 'a word ⇒ nat) of_nat (unats n) (λi. i mod 2 ^ n)"
  by (simp add: td_ext_def' unat_of_nat unats_def)

lemmas unat_of_nat = td_ext_unat [THEN td_ext.eq_norm]

interpretation word_unat:
  td_ext
    "unat::'a::len word ⇒ nat"
    of_nat
    "unats (LENGTH('a::len))"
    "λi. i mod 2 ^ LENGTH('a::len)"
  by (rule td_ext_unat)

lemmas td_unat = word_unat.td_thm

lemma unat_le: "y ≤ unat z ⟹ y ∈ unats (LENGTH('a))"
  for z :: "'a::len word"
  by (metis le_unat_uoi word_unat.Rep)

lemma td_ext_sbin:
  "td_ext (sint :: 'a word ⇒ int) word_of_int (sints (LENGTH('a::len)))
    (signed_take_bit (LENGTH('a) - 1))"
  by (standard; transfer) (auto simp add: sints_def)

lemma td_ext_sint:
  "td_ext (sint :: 'a word ⇒ int) word_of_int (sints (LENGTH('a::len)))
     (λw. (w + 2 ^ (LENGTH('a) - 1)) mod 2 ^ LENGTH('a) -
         2 ^ (LENGTH('a) - 1))"
  using td_ext_sbin [where ?'a = 'a] by (simp add: no_sbintr_alt2)

text ‹
  We do ‹sint› before ‹sbin›, before ‹sint› is the user version
  and interpretations do not produce thm duplicates. I.e.
  we get the name ‹word_sint.Rep_eqD›, but not ‹word_sbin.Req_eqD›,
  because the latter is the same thm as the former.
›
interpretation word_sint:
  td_ext
    "sint ::'a::len word ⇒ int"
    word_of_int
    "sints (LENGTH('a::len))"
    "λw. (w + 2^(LENGTH('a::len) - 1)) mod 2^LENGTH('a::len) -
      2 ^ (LENGTH('a::len) - 1)"
  by (rule td_ext_sint)

interpretation word_sbin:
  td_ext
    "sint ::'a::len word ⇒ int"
    word_of_int
    "sints (LENGTH('a::len))"
    "signed_take_bit (LENGTH('a::len) - 1)"
  by (rule td_ext_sbin)

lemmas int_word_sint = td_ext_sint [THEN td_ext.eq_norm]

lemmas td_sint = word_sint.td

lemma uints_mod: "uints n = range (λw. w mod 2 ^ n)"
  by (fact uints_def [unfolded no_bintr_alt1])

lemmas bintr_num =
  word_ubin.norm_eq_iff [of "numeral a" "numeral b", symmetric, folded word_numeral_alt] for a b
lemmas sbintr_num =
  word_sbin.norm_eq_iff [of "numeral a" "numeral b", symmetric, folded word_numeral_alt] for a b

lemmas uint_div_alt = word_div_def [THEN trans [OF uint_cong int_word_uint]]
lemmas uint_mod_alt = word_mod_def [THEN trans [OF uint_cong int_word_uint]]

interpretation test_bit:
  td_ext
    "bit :: 'a::len word ⇒ nat ⇒ bool"
    set_bits
    "{f. ∀i. f i ⟶ i < LENGTH('a::len)}"
    "(λh i. h i ∧ i < LENGTH('a::len))"
  by standard (auto simp add: bit_imp_le_length bit_set_bits_word_iff set_bits_bit_eq)

lemmas td_nth = test_bit.td_thm

lemma sints_subset:
  assumes "m ≤ n"
  shows "sints m ⊆ sints n"
proof -
  have "⋀i::int. ⟦- (2 ^ (m - Suc 0)) ≤ i; i < 2 ^ (m - Suc 0)⟧
         ⟹ - (2 ^ (n - Suc 0)) ≤ i"
    by (smt (verit, ccfv_SIG) assms le_diff_conv power_increasing_iff)
  moreover
  have "⋀i::int. ⟦- (2 ^ (m - Suc 0)) ≤ i; i < 2 ^ (m - Suc 0)⟧
         ⟹ i < 2 ^ (n - Suc 0)"
    using assms order_less_le_trans  by fastforce
  ultimately show ?thesis
    by (auto simp add: sints_num)
qed

lemma uints_mono_iff: "uints l ⊆ uints m ⟷ l ≤ m"
  using power_increasing_iff[of "2::int" l m]
  unfolding uints_num subset_iff mem_Collect_eq
  by (smt (verit, best) not_exp_less_eq_0_int)

lemmas uints_monoI = uints_mono_iff[THEN iffD2]

lemma Bit_in_uints_Suc: "of_bool c + 2 * w ∈ uints (Suc m)" if "w ∈ uints m"
  using that
  by (auto simp: uints_num)

lemma Bit_in_uintsI: "of_bool c + 2 * w ∈ uints m" if "w ∈ uints (m - 1)" "m > 0"
  using Bit_in_uints_Suc[OF that(1)] that(2)
  by auto

lemma bin_cat_in_uintsI:
  ‹concat_bit n b a ∈ uints m› if ‹a ∈ uints l› ‹l + n ≤ m›
proof -
  from ‹a ∈ uints l› have ‹0 ≤ a› ‹a < 2 ^ l›
    by (auto simp add: uints_def range_bintrunc)
  define q where ‹q = m - n›
  with ‹l + n ≤ m› have ‹m = n + q›
    by simp
  from ‹q = m - n› ‹l + n ≤ m› have ‹l ≤ q›
    by simp
  then have ‹(2::int) ^ l ≤ 2 ^ q›
    by simp
  with ‹a < 2 ^ l› have ‹a < 2 ^ q›
    by linarith
  have ‹take_bit n b < 2 ^ n * 2 ^ q›
    using take_bit_int_less_exp [of n b]
    by (rule order.strict_trans2) simp
  then have ‹take_bit n b < 2 ^ (n + q)›
    by (simp add: power_add)
  moreover have ‹push_bit n a < 2 ^ (n + q)›
    using ‹a < 2 ^ q› by (simp add: power_add push_bit_eq_mult)
  ultimately have ‹concat_bit n b a < 2 ^ (n + q)›
    by (simp add: concat_bit_def OR_upper)
  with ‹0 ≤ a› show ?thesis
    by (simp add: uints_def range_bintrunc ‹m = n + q›)
qed

end