path: root/theories/Numbers/DecimalFacts.v

(************************************************************************)
(*         *   The Coq Proof Assistant / The Coq Development Team       *)
(*  v      *         Copyright INRIA, CNRS and contributors             *)
(* <O___,, * (see version control and CREDITS file for authors & dates) *)
(*   \VV/  **************************************************************)
(*    //   *    This file is distributed under the terms of the         *)
(*         *     GNU Lesser General Public License Version 2.1          *)
(*         *     (see LICENSE file for the text of the license)         *)
(************************************************************************)

(** * DecimalFacts : some facts about Decimal numbers *)

Require Import Decimal Arith.

Lemma uint_dec (d d' : uint) : { d = d' } + { d <> d' }.
Proof.
  decide equality.
Defined.

Lemma rev_revapp d d' :
  rev (revapp d d') = revapp d' d.
Proof.
  revert d'. induction d; simpl; intros; now rewrite ?IHd.
Qed.

Lemma rev_rev d : rev (rev d) = d.
Proof.
  apply rev_revapp.
Qed.

Lemma revapp_rev_nil d : revapp (rev d) Nil = d.
Proof. now fold (rev (rev d)); rewrite rev_rev. Qed.

Lemma app_nil_r d : app d Nil = d.
Proof. now unfold app; rewrite revapp_rev_nil. Qed.

Lemma app_int_nil_r d : app_int d Nil = d.
Proof. now case d; intro d'; simpl; rewrite app_nil_r. Qed.

Lemma revapp_revapp_1 d d' d'' :
  nb_digits d <= 1 ->
  revapp (revapp d d') d'' = revapp d' (revapp d d'').
Proof.
  now case d; clear d; intro d;
    [|case d; clear d; intro d;
      [|simpl; case nb_digits; [|intros n]; intros Hn; exfalso;
        [apply (Nat.nle_succ_diag_l _ Hn)|
         apply (Nat.nle_succ_0 _ (le_S_n _ _ Hn))]..]..].
Qed.

Lemma nb_digits_pos d : d <> Nil -> 0 < nb_digits d.
Proof. now case d; [|intros d' _; apply Nat.lt_0_succ..]. Qed.

Lemma nb_digits_revapp d d' :
  nb_digits (revapp d d') = nb_digits d + nb_digits d'.
Proof.
  now revert d'; induction d; [|intro d'; simpl; rewrite IHd; simpl..].
Qed.

Lemma nb_digits_rev u : nb_digits (rev u) = nb_digits u.
Proof. now unfold rev; rewrite nb_digits_revapp. Qed.

Lemma nb_digits_nzhead u : nb_digits (nzhead u) <= nb_digits u.
Proof. now induction u; [|apply le_S|..]. Qed.

Lemma del_head_nb_digits (u:uint) : del_head (nb_digits u) u = Nil.
Proof. now induction u. Qed.

Lemma nb_digits_del_head n u :
  n <= nb_digits u -> nb_digits (del_head n u) = nb_digits u - n.
Proof.
  revert u; induction n; intros u; [now rewrite Nat.sub_0_r|].
  now case u; clear u; intro u; [|intro Hn; apply IHn, le_S_n..].
Qed.

Lemma nb_digits_iter_D0 n d :
  nb_digits (Nat.iter n D0 d) = n + nb_digits d.
Proof. now induction n; simpl; [|rewrite IHn]. Qed.

Fixpoint nth n u :=
  match n with
  | O =>
    match u with
    | Nil => Nil
    | D0 d => D0 Nil
    | D1 d => D1 Nil
    | D2 d => D2 Nil
    | D3 d => D3 Nil
    | D4 d => D4 Nil
    | D5 d => D5 Nil
    | D6 d => D6 Nil
    | D7 d => D7 Nil
    | D8 d => D8 Nil
    | D9 d => D9 Nil
    end
  | S n =>
    match u with
    | Nil => Nil
    | D0 d | D1 d | D2 d | D3 d | D4 d | D5 d | D6 d | D7 d | D8 d | D9 d =>
      nth n d
    end
  end.

Lemma nb_digits_nth n u : nb_digits (nth n u) <= 1.
Proof.
  revert u; induction n.
  - now intro u; case u; [apply Nat.le_0_1|..].
  - intro u; case u; [apply Nat.le_0_1|intro u'; apply IHn..].
Qed.

Lemma del_head_nth n u :
  n < nb_digits u ->
  del_head n u = revapp (nth n u) (del_head (S n) u).
Proof.
  revert u; induction n; intro u; [now case u|].
  now case u; [|intro u'; intro H; apply IHn, le_S_n..].
Qed.

Lemma nth_revapp_r n d d' :
  nb_digits d <= n ->
  nth n (revapp d d') = nth (n - nb_digits d) d'.
Proof.
  revert d d'; induction n; intro d.
  - now case d; intro d';
      [case d'|intros d'' H; exfalso; revert H; apply Nat.nle_succ_0..].
  - now induction d;
      [intro d'; case d'|
       intros d' H;
       simpl revapp; rewrite IHd; [|now apply le_Sn_le];
       rewrite Nat.sub_succ_l; [|now apply le_S_n];
       simpl; rewrite <-(IHn _ _ (le_S_n _ _ H))..].
Qed.

Lemma nth_revapp_l n d d' :
  n < nb_digits d ->
  nth n (revapp d d') = nth (nb_digits d - n - 1) d.
Proof.
  revert d d'; induction n; intro d.
  - rewrite Nat.sub_0_r.
    now induction d;
      [|intros d' _; simpl revapp;
       revert IHd; case d; clear d; [|intro d..]; intro IHd;
       [|rewrite IHd; [simpl nb_digits; rewrite (Nat.sub_succ_l _ (S _))|];
         [|apply le_n_S, Nat.le_0_l..]..]..].
  - now induction d;
      [|intros d' H;
        simpl revapp; simpl nb_digits;
        simpl in H; generalize (lt_S_n _ _ H); clear H; intro H;
        case (le_lt_eq_dec _ _ H); clear H; intro H;
        [rewrite (IHd _ H), Nat.sub_succ_l;
         [rewrite Nat.sub_succ_l; [|apply Nat.le_add_le_sub_r]|
          apply le_Sn_le]|
         rewrite nth_revapp_r; rewrite <-H;
         [rewrite Nat.sub_succ, Nat.sub_succ_l; [rewrite !Nat.sub_diag|]|]]..].
Qed.

Lemma app_del_tail_head (u:uint) n :
  n <= nb_digits u ->
  app (del_tail n u) (del_head (nb_digits u - n) u) = u.
Proof.
  unfold app, del_tail; rewrite rev_rev.
  induction n.
  - intros _; rewrite Nat.sub_0_r, del_head_nb_digits; simpl.
    now rewrite revapp_rev_nil.
  - intro Hn.
    rewrite (del_head_nth (_ - _));
      [|now apply Nat.sub_lt; [|apply Nat.lt_0_succ]].
    rewrite Nat.sub_succ_r, <-Nat.sub_1_r.
    rewrite <-(nth_revapp_l _ _ Nil Hn); fold (rev u).
    rewrite <-revapp_revapp_1; [|now apply nb_digits_nth].
    rewrite <-(del_head_nth _ _); [|now rewrite nb_digits_rev].
    rewrite Nat.sub_1_r, Nat.succ_pred_pos; [|now apply Nat.lt_add_lt_sub_r].
    apply (IHn (le_Sn_le _ _ Hn)).
Qed.

Lemma app_int_del_tail_head n (d:int) :
  let ad := match d with Pos d | Neg d => d end in
  n <= nb_digits ad ->
  app_int (del_tail_int n d) (del_head (nb_digits ad - n) ad) = d.
Proof. now case d; clear d; simpl; intros u Hu; rewrite app_del_tail_head. Qed.

(** Normalization on little-endian numbers *)

Fixpoint nztail d :=
  match d with
  | Nil => Nil
  | D0 d => match nztail d with Nil => Nil | d' => D0 d' end
  | D1 d => D1 (nztail d)
  | D2 d => D2 (nztail d)
  | D3 d => D3 (nztail d)
  | D4 d => D4 (nztail d)
  | D5 d => D5 (nztail d)
  | D6 d => D6 (nztail d)
  | D7 d => D7 (nztail d)
  | D8 d => D8 (nztail d)
  | D9 d => D9 (nztail d)
  end.

Definition lnorm d :=
  match nztail d with
  | Nil => zero
  | d => d
  end.

Lemma nzhead_revapp_0 d d' : nztail d = Nil ->
  nzhead (revapp d d') = nzhead d'.
Proof.
  revert d'. induction d; intros d' [=]; simpl; trivial.
  destruct (nztail d); now rewrite IHd.
Qed.

Lemma nzhead_revapp d d' : nztail d <> Nil ->
  nzhead (revapp d d') = revapp (nztail d) d'.
Proof.
  revert d'.
  induction d; intros d' H; simpl in *;
  try destruct (nztail d) eqn:E;
  (now rewrite ?nzhead_revapp_0) || (now rewrite IHd).
Qed.

Lemma nzhead_rev d : nztail d <> Nil ->
  nzhead (rev d) = rev (nztail d).
Proof.
  apply nzhead_revapp.
Qed.

Lemma rev_nztail_rev d :
  rev (nztail (rev d)) = nzhead d.
Proof.
  destruct (uint_dec (nztail (rev d)) Nil) as [H|H].
  - rewrite H. unfold rev; simpl.
    rewrite <- (rev_rev d). symmetry.
    now apply nzhead_revapp_0.
  - now rewrite <- nzhead_rev, rev_rev.
Qed.

Lemma nzhead_D0 u : nzhead (D0 u) = nzhead u.
Proof. reflexivity. Qed.

Lemma nzhead_iter_D0 n u : nzhead (Nat.iter n D0 u) = nzhead u.
Proof. now induction n. Qed.

Lemma revapp_nil_inv d d' : revapp d d' = Nil -> d = Nil /\ d' = Nil.
Proof.
  revert d'.
  induction d; simpl; intros d' H; auto; now apply IHd in H.
Qed.

Lemma rev_nil_inv d : rev d = Nil -> d = Nil.
Proof.
  apply revapp_nil_inv.
Qed.

Lemma rev_lnorm_rev d :
  rev (lnorm (rev d)) = unorm d.
Proof.
  unfold unorm, lnorm.
  rewrite <- rev_nztail_rev.
  destruct nztail; simpl; trivial;
    destruct rev eqn:E; trivial; now apply rev_nil_inv in E.
Qed.

Lemma nzhead_nonzero d d' : nzhead d <> D0 d'.
Proof.
  induction d; easy.
Qed.

Lemma unorm_0 d : unorm d = zero <-> nzhead d = Nil.
Proof.
  unfold unorm. split.
  - generalize (nzhead_nonzero d).
    destruct nzhead; intros H [=]; trivial. now destruct (H u).
  - now intros ->.
Qed.

Lemma unorm_nonnil d : unorm d <> Nil.
Proof.
  unfold unorm. now destruct nzhead.
Qed.

Lemma unorm_D0 u : unorm (D0 u) = unorm u.
Proof. reflexivity. Qed.

Lemma unorm_iter_D0 n u : unorm (Nat.iter n D0 u) = unorm u.
Proof. now induction n. Qed.

Lemma nb_digits_unorm u :
  u <> Nil -> nb_digits (unorm u) <= nb_digits u.
Proof.
  case u; clear u; [now simpl|intro u..]; [|now simpl..].
  intros _; unfold unorm.
  case_eq (nzhead (D0 u)); [|now intros u' <-; apply nb_digits_nzhead..].
  intros _; apply le_n_S, Nat.le_0_l.
Qed.

Lemma del_head_nonnil n u :
  n < nb_digits u -> del_head n u <> Nil.
Proof.
  now revert n; induction u; intro n;
    [|case n; [|intro n'; simpl; intro H; apply IHu, lt_S_n]..].
Qed.

Lemma del_tail_nonnil n u :
  n < nb_digits u -> del_tail n u <> Nil.
Proof.
  unfold del_tail.
  rewrite <-nb_digits_rev.
  generalize (rev u); clear u; intro u.
  intros Hu H.
  generalize (rev_nil_inv _ H); clear H.
  now apply del_head_nonnil.
Qed.

Lemma nzhead_invol d : nzhead (nzhead d) = nzhead d.
Proof.
  now induction d.
Qed.

Lemma nztail_invol d : nztail (nztail d) = nztail d.
Proof.
  rewrite <-(rev_rev (nztail _)), <-(rev_rev (nztail d)), <-(rev_rev d).
  now rewrite !rev_nztail_rev, nzhead_invol.
Qed.

Lemma unorm_invol d : unorm (unorm d) = unorm d.
Proof.
  unfold unorm.
  destruct (nzhead d) eqn:E; trivial.
  destruct (nzhead_nonzero _ _ E).
Qed.

Lemma norm_invol d : norm (norm d) = norm d.
Proof.
  unfold norm.
  destruct d.
  - f_equal. apply unorm_invol.
  - destruct (nzhead d) eqn:E; auto.
    destruct (nzhead_nonzero _ _ E).
Qed.

Lemma nzhead_del_tail_nzhead_eq n u :
  nzhead u = u ->
  n < nb_digits u ->
  nzhead (del_tail n u) = del_tail n u.
Proof.
  intros Hu Hn.
  assert (Hhd : forall u,
             nzhead u = u <-> match nth 0 u with D0 _ => False | _ => True end).
  { clear n u Hu Hn; intro u.
    case u; clear u; [|intro u..]; [now simpl| |now simpl..]; simpl.
    split; [|now simpl].
    apply nzhead_nonzero. }
  assert (Hhd' : nth 0 (del_tail n u) = nth 0 u).
  { rewrite <-(app_del_tail_head _ _ (le_Sn_le _ _ Hn)) at 2.
    unfold app.
    rewrite nth_revapp_l.
    - rewrite <-(nth_revapp_l _ _ Nil).
      + now fold (rev (rev (del_tail n u))); rewrite rev_rev.
      + unfold del_tail; rewrite rev_rev.
        rewrite nb_digits_del_head; rewrite nb_digits_rev.
        * now rewrite <-Nat.lt_add_lt_sub_r.
        * now apply Nat.lt_le_incl.
    - unfold del_tail; rewrite rev_rev.
      rewrite nb_digits_del_head; rewrite nb_digits_rev.
      + now rewrite <-Nat.lt_add_lt_sub_r.
      + now apply Nat.lt_le_incl. }
  revert Hu; rewrite Hhd; intro Hu.
  now rewrite Hhd, Hhd'.
Qed.

Lemma nzhead_del_tail_nzhead n u :
  n < nb_digits (nzhead u) ->
  nzhead (del_tail n (nzhead u)) = del_tail n (nzhead u).
Proof. apply nzhead_del_tail_nzhead_eq, nzhead_invol. Qed.

Lemma unorm_del_tail_unorm n u :
  n < nb_digits (unorm u) ->
  unorm (del_tail n (unorm u)) = del_tail n (unorm u).
Proof.
  case (uint_dec (nzhead u) Nil).
  - unfold unorm; intros->; case n; [now simpl|]; intro n'.
    now simpl; intro H; exfalso; generalize (lt_S_n _ _ H).
  - unfold unorm.
    set (m := match nzhead u with Nil => zero | _ => _ end).
    intros H.
    replace m with (nzhead u).
    + intros H'.
      rewrite (nzhead_del_tail_nzhead _ _ H').
      now generalize (del_tail_nonnil _ _ H'); case del_tail.
    + now unfold m; revert H; case nzhead.
Qed.

Lemma norm_del_tail_int_norm n d :
  n < nb_digits (match norm d with Pos d | Neg d => d end) ->
  norm (del_tail_int n (norm d)) = del_tail_int n (norm d).
Proof.
  case d; clear d; intros u; simpl.
  - now intro H; simpl; rewrite unorm_del_tail_unorm.
  - case (uint_dec (nzhead u) Nil); intro Hu.
    + now rewrite Hu; case n; [|intros n' Hn'; generalize (lt_S_n _ _ Hn')].
    + set (m := match nzhead u with Nil => Pos zero | _ => _ end).
      replace m with (Neg (nzhead u)); [|now unfold m; revert Hu; case nzhead].
      unfold del_tail_int.
      clear m Hu.
      simpl.
      intro H; generalize (del_tail_nonnil _ _ H).
      rewrite (nzhead_del_tail_nzhead _ _ H).
      now case del_tail.
Qed.

Lemma nzhead_app_nzhead d d' :
  nzhead (app (nzhead d) d') = nzhead (app d d').
Proof.
  unfold app.
  rewrite <-(rev_nztail_rev d), rev_rev.
  generalize (rev d); clear d; intro d.
  generalize (nzhead_revapp_0 d d').
  generalize (nzhead_revapp d d').
  generalize (nzhead_revapp_0 (nztail d) d').
  generalize (nzhead_revapp (nztail d) d').
  rewrite nztail_invol.
  now case nztail;
    [intros _ H _ H'; rewrite (H eq_refl), (H' eq_refl)
    |intros d'' H _ H' _; rewrite H; [rewrite H'|]..].
Qed.

Lemma unorm_app_unorm d d' :
  unorm (app (unorm d) d') = unorm (app d d').
Proof.
  unfold unorm.
  rewrite <-(nzhead_app_nzhead d d').
  now case (nzhead d).
Qed.

Lemma norm_app_int_norm d d' :
  unorm d' = zero ->
  norm (app_int (norm d) d') = norm (app_int d d').
Proof.
  case d; clear d; intro d; simpl.
  - now rewrite unorm_app_unorm.
  - unfold app_int, app.
    rewrite unorm_0; intro Hd'.
    rewrite <-rev_nztail_rev.
    generalize (nzhead_revapp (rev d) d').
    generalize (nzhead_revapp_0 (rev d) d').
    now case_eq (nztail (rev d));
      [intros Hd'' H _; rewrite (H eq_refl); simpl;
       unfold unorm; simpl; rewrite Hd'
      |intros d'' Hd'' _ H; rewrite H; clear H; [|now simpl];
       set (r := rev _);
       set (m := match r with Nil => Pos zero | _ => _ end);
       assert (H' : m = Neg r);
       [now unfold m; case_eq r; unfold r;
        [intro H''; generalize (rev_nil_inv _ H'')|..]
       |rewrite H'; unfold r; clear m r H'];
       unfold norm;
       rewrite rev_rev, <-Hd'';
       rewrite nzhead_revapp; rewrite nztail_invol; [|rewrite Hd'']..].
Qed.