summaryrefslogtreecommitdiff
path: root/backends/lean/Base/Primitives/Scalar.lean
blob: db522df22a2914c72b07a6ca62df668b91407483 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
import Lean
import Lean.Meta.Tactic.Simp
import Mathlib.Tactic.Linarith
import Base.Primitives.Base
import Base.Diverge.Base
import Base.Progress.Base
import Base.Arith.Int

namespace Primitives

----------------------
-- MACHINE INTEGERS --
----------------------

-- We redefine our machine integers types.

-- For Isize/Usize, we reuse `getNumBits` from `USize`. You cannot reduce `getNumBits`
-- using the simplifier, meaning that proofs do not depend on the compile-time value of
-- USize.size. (Lean assumes 32 or 64-bit platforms, and Rust doesn't really support, at
-- least officially, 16-bit microcontrollers, so this seems like a fine design decision
-- for now.)

-- Note from Chris Bailey: "If there's more than one salient property of your
-- definition then the subtyping strategy might get messy, and the property part
-- of a subtype is less discoverable by the simplifier or tactics like
-- library_search." So, we will not add refinements on the return values of the
-- operations defined on Primitives, but will rather rely on custom lemmas to
-- invert on possible return values of the primitive operations.

-- Machine integer constants, done via `ofNatCore`, which requires a proof that
-- the `Nat` fits within the desired integer type. We provide a custom tactic.

open Result Error
open System.Platform.getNumBits

-- TODO: is there a way of only importing System.Platform.getNumBits?
--
@[simp] def size_num_bits : Nat := (System.Platform.getNumBits ()).val

-- Remark: Lean seems to use < for the comparisons with the upper bounds by convention.

-- The "structured" bounds
def Isize.smin : Int := - (HPow.hPow 2 (size_num_bits - 1))
def Isize.smax : Int := (HPow.hPow 2 (size_num_bits - 1)) - 1
def I8.smin    : Int := - (HPow.hPow 2 7)
def I8.smax    : Int := HPow.hPow 2 7 - 1
def I16.smin   : Int := - (HPow.hPow 2 15)
def I16.smax   : Int := HPow.hPow 2 15 - 1
def I32.smin   : Int := -(HPow.hPow 2 31)
def I32.smax   : Int := HPow.hPow 2 31 - 1
def I64.smin   : Int := -(HPow.hPow 2 63)
def I64.smax   : Int := HPow.hPow 2 63 - 1
def I128.smin  : Int := -(HPow.hPow 2 127)
def I128.smax  : Int := HPow.hPow 2 127 - 1
def Usize.smin : Int := 0
def Usize.smax : Int := HPow.hPow 2 size_num_bits - 1
def U8.smin    : Int := 0
def U8.smax    : Int := HPow.hPow 2 8 - 1
def U16.smin   : Int := 0
def U16.smax   : Int := HPow.hPow 2 16 - 1
def U32.smin   : Int := 0
def U32.smax   : Int := HPow.hPow 2 32 - 1
def U64.smin   : Int := 0
def U64.smax   : Int := HPow.hPow 2 64 - 1
def U128.smin  : Int := 0
def U128.smax  : Int := HPow.hPow 2 128 - 1

-- The "normalized" bounds, that we use in practice
def I8.min    : Int   := -128
def I8.max    : Int   := 127
def I16.min   : Int  := -32768
def I16.max   : Int  := 32767
def I32.min   : Int  := -2147483648
def I32.max   : Int  := 2147483647
def I64.min   : Int  := -9223372036854775808
def I64.max   : Int  := 9223372036854775807
def I128.min  : Int := -170141183460469231731687303715884105728
def I128.max  : Int := 170141183460469231731687303715884105727
@[simp]
def U8.min    : Int   := 0
def U8.max    : Int   := 255
@[simp]
def U16.min   : Int  := 0
def U16.max   : Int  := 65535
@[simp]
def U32.min   : Int  := 0
def U32.max   : Int  := 4294967295
@[simp]
def U64.min   : Int  := 0
def U64.max   : Int  := 18446744073709551615
@[simp]
def U128.min  : Int := 0
def U128.max  : Int := 340282366920938463463374607431768211455
@[simp]
def Usize.min : Int := 0

def Isize.refined_min : { n:Int // n = I32.min  n = I64.min } :=
   Isize.smin, by
    simp [Isize.smin]
    cases System.Platform.numBits_eq <;>
    unfold System.Platform.numBits at * <;> simp [*] 

def Isize.refined_max : { n:Int // n = I32.max  n = I64.max } :=
   Isize.smax, by
    simp [Isize.smax]
    cases System.Platform.numBits_eq <;>
    unfold System.Platform.numBits at * <;> simp [*] 

def Usize.refined_max : { n:Int // n = U32.max  n = U64.max } :=
   Usize.smax, by
    simp [Usize.smax]
    cases System.Platform.numBits_eq <;>
    unfold System.Platform.numBits at * <;> simp [*] 

def Isize.min := Isize.refined_min.val
def Isize.max := Isize.refined_max.val
def Usize.max := Usize.refined_max.val

inductive ScalarTy :=
| Isize
| I8
| I16
| I32
| I64
| I128
| Usize
| U8
| U16
| U32
| U64
| U128

def ScalarTy.isSigned (ty : ScalarTy) : Bool :=
  match ty with
  | Isize
  | I8
  | I16
  | I32
  | I64
  | I128 => true
  | Usize
  | U8
  | U16
  | U32
  | U64
  | U128 => false


def Scalar.smin (ty : ScalarTy) : Int :=
  match ty with
  | .Isize => Isize.smin
  | .I8    => I8.smin
  | .I16   => I16.smin
  | .I32   => I32.smin
  | .I64   => I64.smin
  | .I128  => I128.smin
  | .Usize => Usize.smin
  | .U8    => U8.smin
  | .U16   => U16.smin
  | .U32   => U32.smin
  | .U64   => U64.smin
  | .U128  => U128.smin

def Scalar.smax (ty : ScalarTy) : Int :=
  match ty with
  | .Isize => Isize.smax
  | .I8    => I8.smax
  | .I16   => I16.smax
  | .I32   => I32.smax
  | .I64   => I64.smax
  | .I128  => I128.smax
  | .Usize => Usize.smax
  | .U8    => U8.smax
  | .U16   => U16.smax
  | .U32   => U32.smax
  | .U64   => U64.smax
  | .U128  => U128.smax

def Scalar.min (ty : ScalarTy) : Int :=
  match ty with
  | .Isize => Isize.min
  | .I8    => I8.min
  | .I16   => I16.min
  | .I32   => I32.min
  | .I64   => I64.min
  | .I128  => I128.min
  | .Usize => Usize.min
  | .U8    => U8.min
  | .U16   => U16.min
  | .U32   => U32.min
  | .U64   => U64.min
  | .U128  => U128.min

def Scalar.max (ty : ScalarTy) : Int :=
  match ty with
  | .Isize => Isize.max
  | .I8    => I8.max
  | .I16   => I16.max
  | .I32   => I32.max
  | .I64   => I64.max
  | .I128  => I128.max
  | .Usize => Usize.max
  | .U8    => U8.max
  | .U16   => U16.max
  | .U32   => U32.max
  | .U64   => U64.max
  | .U128  => U128.max

def Scalar.smin_eq (ty : ScalarTy) : Scalar.min ty = Scalar.smin ty := by
  cases ty <;> rfl

def Scalar.smax_eq (ty : ScalarTy) : Scalar.max ty = Scalar.smax ty := by
  cases ty <;> rfl

-- "Conservative" bounds
-- We use those because we can't compare to the isize bounds (which can't
-- reduce at compile-time). Whenever we perform an arithmetic operation like
-- addition we need to check that the result is in bounds: we first compare
-- to the conservative bounds, which reduce, then compare to the real bounds.
-- This is useful for the various #asserts that we want to reduce at
-- type-checking time.
def Scalar.cMin (ty : ScalarTy) : Int :=
  match ty with
  | .Isize => Scalar.min .I32
  | _ => Scalar.min ty

def Scalar.cMax (ty : ScalarTy) : Int :=
  match ty with
  | .Isize => Scalar.max .I32
  | .Usize => Scalar.max .U32
  | _ => Scalar.max ty

theorem Scalar.min_lt_max (ty : ScalarTy) : Scalar.min ty < Scalar.max ty := by
  cases ty <;> simp [Scalar.min, Scalar.max]
  . simp [Isize.min, Isize.max]
    have h1 := Isize.refined_min.property
    have h2 := Isize.refined_max.property
    cases h1 <;> cases h2 <;> simp [*]
  . simp [Usize.max]
    have h := Usize.refined_max.property
    cases h <;> simp [*]

theorem Scalar.min_le_max (ty : ScalarTy) : Scalar.min ty  Scalar.max ty := by
  have := Scalar.min_lt_max ty
  int_tac

theorem Scalar.cMin_bound ty : Scalar.min ty  Scalar.cMin ty := by
  cases ty <;> simp [Scalar.min, Scalar.max, Scalar.cMin, Scalar.cMax] at *
  have h := Isize.refined_min.property
  cases h <;> simp [*, Isize.min]

theorem Scalar.cMax_bound ty : Scalar.cMax ty  Scalar.max ty := by
  cases ty <;> simp [Scalar.min, Scalar.max, Scalar.cMin, Scalar.cMax] at *
  . have h := Isize.refined_max.property
    cases h <;> simp [*, Isize.max]
  . have h := Usize.refined_max.property
    cases h <;> simp [*, Usize.max]

theorem Scalar.cMin_suffices ty (h : Scalar.cMin ty  x) : Scalar.min ty  x := by
  have := Scalar.cMin_bound ty
  linarith

theorem Scalar.cMax_suffices ty (h : x  Scalar.cMax ty) : x  Scalar.max ty := by
  have := Scalar.cMax_bound ty
  linarith

structure Scalar (ty : ScalarTy) where
  val : Int
  hmin : Scalar.min ty  val
  hmax : val  Scalar.max ty
deriving Repr

theorem Scalar.bound_suffices (ty : ScalarTy) (x : Int) :
  Scalar.cMin ty  x  x  Scalar.cMax ty ->
  Scalar.min ty  x  x  Scalar.max ty
  :=
  λ h => by
  apply And.intro <;> have hmin := Scalar.cMin_bound ty <;> have hmax := Scalar.cMax_bound ty <;> linarith

def Scalar.ofIntCore {ty : ScalarTy} (x : Int)
  (hmin : Scalar.min ty  x) (hmax : x  Scalar.max ty) : Scalar ty :=
  { val := x, hmin := hmin, hmax := hmax }

-- Tactic to prove that integers are in bounds
-- TODO: use this: https://leanprover.zulipchat.com/#narrow/stream/270676-lean4/topic/instance.20with.20tactic.20autoparam
syntax "intlit" : tactic
macro_rules
  | `(tactic| intlit) => `(tactic| apply Scalar.bound_suffices; decide)

def Scalar.ofInt {ty : ScalarTy} (x : Int)
  (h : Scalar.min ty  x  x  Scalar.max ty := by intlit) : Scalar ty :=
  -- Remark: we initially wrote:
  --  let ⟨ hmin, hmax ⟩ := h
  --  Scalar.ofIntCore x hmin hmax
  -- We updated to the line below because a similar pattern in `Scalar.tryMk`
  -- made reduction block. Both versions seem to work for `Scalar.ofInt`, though.
  -- TODO: investigate
  Scalar.ofIntCore x h.left h.right

@[simp] def Scalar.check_bounds (ty : ScalarTy) (x : Int) : Bool :=
  (Scalar.cMin ty  x || Scalar.min ty  x)  (x  Scalar.cMax ty || x  Scalar.max ty)

theorem Scalar.check_bounds_prop {ty : ScalarTy} {x : Int} (h: Scalar.check_bounds ty x) :
  Scalar.min ty  x  x  Scalar.max ty := by
  simp at *
  have  hmin, hmax  := h
  have hbmin := Scalar.cMin_bound ty
  have hbmax := Scalar.cMax_bound ty
  cases hmin <;> cases hmax <;> apply And.intro <;> linarith

-- Further thoughts: look at what has been done here:
-- https://github.com/leanprover-community/mathlib4/blob/master/Mathlib/Data/Fin/Basic.lean
-- and
-- https://github.com/leanprover-community/mathlib4/blob/master/Mathlib/Data/UInt.lean
-- which both contain a fair amount of reasoning already!
def Scalar.tryMk (ty : ScalarTy) (x : Int) : Result (Scalar ty) :=
  if h:Scalar.check_bounds ty x then
    -- If we do:
    -- ```
    -- let ⟨ hmin, hmax ⟩ := (Scalar.check_bounds_prop h)
    -- Scalar.ofIntCore x hmin hmax
    -- ```
    -- then normalization blocks (for instance, some proofs which use reflexivity fail).
    -- However, the version below doesn't block reduction (TODO: investigate):
    return Scalar.ofInt x (Scalar.check_bounds_prop h)
  else fail integerOverflow

def Scalar.neg {ty : ScalarTy} (x : Scalar ty) : Result (Scalar ty) := Scalar.tryMk ty (- x.val)

-- Our custom remainder operation, which satisfies the semantics of Rust
-- TODO: is there a better way?
def scalar_rem (x y : Int) : Int :=
  if 0  x then x % y
  else - (|x| % |y|)

@[simp]
def scalar_rem_nonneg {x y : Int} (hx : 0  x) : scalar_rem x y = x % y := by
  intros
  simp [*, scalar_rem]

-- Our custom division operation, which satisfies the semantics of Rust
-- TODO: is there a better way?
def scalar_div (x y : Int) : Int :=
  if 0  x && 0  y then x / y
  else if 0  x && y < 0 then - (|x| / |y|)
  else if x < 0 && 0  y then - (|x| / |y|)
  else |x| / |y|

@[simp]
def scalar_div_nonneg {x y : Int} (hx : 0  x) (hy : 0  y) : scalar_div x y = x / y := by
  intros
  simp [*, scalar_div]

-- Checking that the remainder operation is correct
#assert scalar_rem 1 2 = 1
#assert scalar_rem (-1) 2 = -1
#assert scalar_rem 1 (-2) = 1
#assert scalar_rem (-1) (-2) = -1
#assert scalar_rem 7 3 = (1:Int)
#assert scalar_rem (-7) 3 = -1
#assert scalar_rem 7 (-3) = 1
#assert scalar_rem (-7) (-3) = -1

-- Checking that the division operation is correct
#assert scalar_div 3 2 = 1
#assert scalar_div (-3) 2 = -1
#assert scalar_div 3 (-2) = -1
#assert scalar_div (-3) (-2) = 1
#assert scalar_div 7 3 = 2
#assert scalar_div (-7) 3 = -2
#assert scalar_div 7 (-3) = -2
#assert scalar_div (-7) (-3) = 2

def Scalar.div {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Result (Scalar ty) :=
  if y.val != 0 then Scalar.tryMk ty (scalar_div x.val y.val) else fail divisionByZero

def Scalar.rem {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Result (Scalar ty) :=
  if y.val != 0 then Scalar.tryMk ty (scalar_rem x.val y.val) else fail divisionByZero

def Scalar.add {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Result (Scalar ty) :=
  Scalar.tryMk ty (x.val + y.val)

def Scalar.sub {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Result (Scalar ty) :=
  Scalar.tryMk ty (x.val - y.val)

def Scalar.mul {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Result (Scalar ty) :=
  Scalar.tryMk ty (x.val * y.val)

-- TODO: shift left
def Scalar.shiftl {ty0 ty1 : ScalarTy} (x : Scalar ty0) (y : Scalar ty1) : Result (Scalar ty0) :=
  sorry

-- TODO: shift right
def Scalar.shiftr {ty0 ty1 : ScalarTy} (x : Scalar ty0) (y : Scalar ty1) : Result (Scalar ty0) :=
  sorry

-- TODO: xor
def Scalar.xor {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Scalar ty :=
  sorry

-- TODO: and
def Scalar.and {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Scalar ty :=
  sorry

-- TODO: or
def Scalar.or {ty : ScalarTy} (x : Scalar ty) (y : Scalar ty) : Scalar ty :=
  sorry

-- Cast an integer from a [src_ty] to a [tgt_ty]
-- TODO: double-check the semantics of casts in Rust
def Scalar.cast {src_ty : ScalarTy} (tgt_ty : ScalarTy) (x : Scalar src_ty) : Result (Scalar tgt_ty) :=
  Scalar.tryMk tgt_ty x.val

-- The scalar types
-- We declare the definitions as reducible so that Lean can unfold them (useful
-- for type class resolution for instance).
@[reducible] def Isize := Scalar .Isize
@[reducible] def I8    := Scalar .I8
@[reducible] def I16   := Scalar .I16
@[reducible] def I32   := Scalar .I32
@[reducible] def I64   := Scalar .I64
@[reducible] def I128  := Scalar .I128
@[reducible] def Usize := Scalar .Usize
@[reducible] def U8    := Scalar .U8
@[reducible] def U16   := Scalar .U16
@[reducible] def U32   := Scalar .U32
@[reducible] def U64   := Scalar .U64
@[reducible] def U128  := Scalar .U128

instance (ty : ScalarTy) : Inhabited (Scalar ty) := by
  constructor; cases ty <;> apply (Scalar.ofInt 0)

-- TODO: reducible?
@[reducible] def core_isize_min : Isize := Scalar.ofInt Isize.min (by simp [Scalar.min, Scalar.max]; apply (Scalar.min_le_max .Isize))
@[reducible] def core_isize_max : Isize := Scalar.ofInt Isize.max (by simp [Scalar.min, Scalar.max]; apply (Scalar.min_le_max .Isize))
@[reducible] def core_i8_min : I8 := Scalar.ofInt I8.min
@[reducible] def core_i8_max : I8 := Scalar.ofInt I8.max
@[reducible] def core_i16_min : I16 := Scalar.ofInt I16.min
@[reducible] def core_i16_max : I16 := Scalar.ofInt I16.max
@[reducible] def core_i32_min : I32 := Scalar.ofInt I32.min
@[reducible] def core_i32_max : I32 := Scalar.ofInt I32.max
@[reducible] def core_i64_min : I64 := Scalar.ofInt I64.min
@[reducible] def core_i64_max : I64 := Scalar.ofInt I64.max
@[reducible] def core_i128_min : I128 := Scalar.ofInt I128.min
@[reducible] def core_i128_max : I128 := Scalar.ofInt I128.max

-- TODO: reducible?
@[reducible] def core_usize_min : Usize := Scalar.ofInt Usize.min
@[reducible] def core_usize_max : Usize := Scalar.ofInt Usize.max (by simp [Scalar.min, Scalar.max]; apply (Scalar.min_le_max .Usize))
@[reducible] def core_u8_min : U8 := Scalar.ofInt U8.min
@[reducible] def core_u8_max : U8 := Scalar.ofInt U8.max
@[reducible] def core_u16_min : U16 := Scalar.ofInt U16.min
@[reducible] def core_u16_max : U16 := Scalar.ofInt U16.max
@[reducible] def core_u32_min : U32 := Scalar.ofInt U32.min
@[reducible] def core_u32_max : U32 := Scalar.ofInt U32.max
@[reducible] def core_u64_min : U64 := Scalar.ofInt U64.min
@[reducible] def core_u64_max : U64 := Scalar.ofInt U64.max
@[reducible] def core_u128_min : U128 := Scalar.ofInt U128.min
@[reducible] def core_u128_max : U128 := Scalar.ofInt U128.max

-- TODO: below: not sure this is the best way.
-- Should we rather overload operations like +, -, etc.?
-- Also, it is possible to automate the generation of those definitions
-- with macros (but would it be a good idea? It would be less easy to
-- read the file, which is not supposed to change a lot)

-- Negation

/--
Remark: there is no heterogeneous negation in the Lean prelude: we thus introduce
one here.

The notation typeclass for heterogeneous addition.
This enables the notation `- a : β` where `a : α`.
-/
class HNeg (α : Type u) (β : outParam (Type v)) where
  /-- `- a` computes the negation of `a`.
  The meaning of this notation is type-dependent. -/
  hNeg : α  β

prefix:75  "-"   => HNeg.hNeg

instance : HNeg Isize (Result Isize) where hNeg x := Scalar.neg x
instance : HNeg I8 (Result I8) where hNeg x := Scalar.neg x
instance : HNeg I16 (Result I16) where hNeg x := Scalar.neg x
instance : HNeg I32 (Result I32) where hNeg x := Scalar.neg x
instance : HNeg I64 (Result I64) where hNeg x := Scalar.neg x
instance : HNeg I128 (Result I128) where hNeg x := Scalar.neg x

-- Addition
instance {ty} : HAdd (Scalar ty) (Scalar ty) (Result (Scalar ty)) where
  hAdd x y := Scalar.add x y

-- Substraction
instance {ty} : HSub (Scalar ty) (Scalar ty) (Result (Scalar ty)) where
  hSub x y := Scalar.sub x y

-- Multiplication
instance {ty} : HMul (Scalar ty) (Scalar ty) (Result (Scalar ty)) where
  hMul x y := Scalar.mul x y

-- Division
instance {ty} : HDiv (Scalar ty) (Scalar ty) (Result (Scalar ty)) where
  hDiv x y := Scalar.div x y

-- Remainder
instance {ty} : HMod (Scalar ty) (Scalar ty) (Result (Scalar ty)) where
  hMod x y := Scalar.rem x y

-- Shift left
instance {ty0 ty1} : HShiftLeft (Scalar ty0) (Scalar ty1) (Result (Scalar ty0)) where
  hShiftLeft x y := Scalar.shiftl x y

-- Shift right
instance {ty0 ty1} : HShiftRight (Scalar ty0) (Scalar ty1) (Result (Scalar ty0)) where
  hShiftRight x y := Scalar.shiftr x y

-- Xor
instance {ty} : HXor (Scalar ty) (Scalar ty) (Scalar ty) where
  hXor x y := Scalar.xor x y

-- Or
instance {ty} : HOr (Scalar ty) (Scalar ty) (Scalar ty) where
  hOr x y := Scalar.or x y

-- And
instance {ty} : HAnd (Scalar ty) (Scalar ty) (Scalar ty) where
  hAnd x y := Scalar.and x y

-- Generic theorem - shouldn't be used much
@[pspec]
theorem Scalar.add_spec {ty} {x y : Scalar ty}
  (hmin : Scalar.min ty  x.val + y.val)
  (hmax : x.val + y.val  Scalar.max ty) :
   z, x + y = ret z  z.val = x.val + y.val := by
  simp [HAdd.hAdd, add, Add.add]
  simp [tryMk]
  split
  . simp [pure]
    rfl
  . tauto

theorem Scalar.add_unsigned_spec {ty} (s: ¬ ty.isSigned) {x y : Scalar ty}
  (hmax : x.val + y.val  Scalar.max ty) :
   z, x + y = ret z  z.val = x.val + y.val := by
  have hmin : Scalar.min ty  x.val + y.val := by
    have hx := x.hmin
    have hy := y.hmin
    cases ty <;> simp [min] at * <;> linarith
  apply add_spec <;> assumption

/- Fine-grained theorems -/
@[pspec] theorem Usize.add_spec {x y : Usize} (hmax : x.val + y.val  Usize.max) :
   z, x + y = ret z  z.val = x.val + y.val := by
  apply Scalar.add_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U8.add_spec {x y : U8} (hmax : x.val + y.val  U8.max) :
   z, x + y = ret z  z.val = x.val + y.val := by
  apply Scalar.add_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U16.add_spec {x y : U16} (hmax : x.val + y.val  U16.max) :
   z, x + y = ret z  z.val = x.val + y.val := by
  apply Scalar.add_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U32.add_spec {x y : U32} (hmax : x.val + y.val  U32.max) :
   z, x + y = ret z  z.val = x.val + y.val := by
  apply Scalar.add_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U64.add_spec {x y : U64} (hmax : x.val + y.val  U64.max) :
   z, x + y = ret z  z.val = x.val + y.val := by
  apply Scalar.add_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U128.add_spec {x y : U128} (hmax : x.val + y.val  U128.max) :
   z, x + y = ret z  z.val = x.val + y.val := by
  apply Scalar.add_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem Isize.add_spec {x y : Isize}
  (hmin : Isize.min  x.val + y.val) (hmax : x.val + y.val  Isize.max) :
   z, x + y = ret z  z.val = x.val + y.val :=
  Scalar.add_spec hmin hmax

@[pspec] theorem I8.add_spec {x y : I8}
  (hmin : I8.min  x.val + y.val) (hmax : x.val + y.val  I8.max) :
   z, x + y = ret z  z.val = x.val + y.val :=
  Scalar.add_spec hmin hmax

@[pspec] theorem I16.add_spec {x y : I16}
  (hmin : I16.min  x.val + y.val) (hmax : x.val + y.val  I16.max) :
   z, x + y = ret z  z.val = x.val + y.val :=
  Scalar.add_spec hmin hmax

@[pspec] theorem I32.add_spec {x y : I32}
  (hmin : I32.min  x.val + y.val) (hmax : x.val + y.val  I32.max) :
   z, x + y = ret z  z.val = x.val + y.val :=
  Scalar.add_spec hmin hmax

@[pspec] theorem I64.add_spec {x y : I64}
  (hmin : I64.min  x.val + y.val) (hmax : x.val + y.val  I64.max) :
   z, x + y = ret z  z.val = x.val + y.val :=
  Scalar.add_spec hmin hmax

@[pspec] theorem I128.add_spec {x y : I128}
  (hmin : I128.min  x.val + y.val) (hmax : x.val + y.val  I128.max) :
   z, x + y = ret z  z.val = x.val + y.val :=
  Scalar.add_spec hmin hmax

-- Generic theorem - shouldn't be used much
@[pspec]
theorem Scalar.sub_spec {ty} {x y : Scalar ty}
  (hmin : Scalar.min ty  x.val - y.val)
  (hmax : x.val - y.val  Scalar.max ty) :
   z, x - y = ret z  z.val = x.val - y.val := by
  simp [HSub.hSub, sub, Sub.sub]
  simp [tryMk]
  split
  . simp [pure]
    rfl
  . tauto

theorem Scalar.sub_unsigned_spec {ty} (s: ¬ ty.isSigned) {x y : Scalar ty}
  (hmin : Scalar.min ty  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  have : x.val - y.val  Scalar.max ty := by
    have hx := x.hmin
    have hxm := x.hmax
    have hy := y.hmin
    cases ty <;> simp [min, max] at * <;> linarith
  intros
  apply sub_spec <;> assumption

/- Fine-grained theorems -/
@[pspec] theorem Usize.sub_spec {x y : Usize} (hmin : Usize.min  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  apply Scalar.sub_unsigned_spec <;> simp only [Scalar.min, *]

@[pspec] theorem U8.sub_spec {x y : U8} (hmin : U8.min  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  apply Scalar.sub_unsigned_spec <;> simp only [Scalar.min, *]

@[pspec] theorem U16.sub_spec {x y : U16} (hmin : U16.min  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  apply Scalar.sub_unsigned_spec <;> simp only [Scalar.min, *]

@[pspec] theorem U32.sub_spec {x y : U32} (hmin : U32.min  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  apply Scalar.sub_unsigned_spec <;> simp only [Scalar.min, *]

@[pspec] theorem U64.sub_spec {x y : U64} (hmin : U64.min  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  apply Scalar.sub_unsigned_spec <;> simp only [Scalar.min, *]

@[pspec] theorem U128.sub_spec {x y : U128} (hmin : U128.min  x.val - y.val) :
   z, x - y = ret z  z.val = x.val - y.val := by
  apply Scalar.sub_unsigned_spec <;> simp only [Scalar.min, *]

@[pspec] theorem Isize.sub_spec {x y : Isize} (hmin : Isize.min  x.val - y.val)
  (hmax : x.val - y.val  Isize.max) :
   z, x - y = ret z  z.val = x.val - y.val :=
  Scalar.sub_spec hmin hmax

@[pspec] theorem I8.sub_spec {x y : I8} (hmin : I8.min  x.val - y.val)
  (hmax : x.val - y.val  I8.max) :
   z, x - y = ret z  z.val = x.val - y.val :=
  Scalar.sub_spec hmin hmax

@[pspec] theorem I16.sub_spec {x y : I16} (hmin : I16.min  x.val - y.val)
  (hmax : x.val - y.val  I16.max) :
   z, x - y = ret z  z.val = x.val - y.val :=
  Scalar.sub_spec hmin hmax

@[pspec] theorem I32.sub_spec {x y : I32} (hmin : I32.min  x.val - y.val)
  (hmax : x.val - y.val  I32.max) :
   z, x - y = ret z  z.val = x.val - y.val :=
  Scalar.sub_spec hmin hmax

@[pspec] theorem I64.sub_spec {x y : I64} (hmin : I64.min  x.val - y.val)
  (hmax : x.val - y.val  I64.max) :
   z, x - y = ret z  z.val = x.val - y.val :=
  Scalar.sub_spec hmin hmax

@[pspec] theorem I128.sub_spec {x y : I128} (hmin : I128.min  x.val - y.val)
  (hmax : x.val - y.val  I128.max) :
   z, x - y = ret z  z.val = x.val - y.val :=
  Scalar.sub_spec hmin hmax

-- Generic theorem - shouldn't be used much
theorem Scalar.mul_spec {ty} {x y : Scalar ty}
  (hmin : Scalar.min ty  x.val * y.val)
  (hmax : x.val * y.val  Scalar.max ty) :
   z, x * y = ret z  z.val = x.val * y.val := by
  simp [HMul.hMul, mul, Mul.mul]
  simp [tryMk]
  split
  . simp [pure]
    rfl
  . tauto

theorem Scalar.mul_unsigned_spec {ty} (s: ¬ ty.isSigned) {x y : Scalar ty}
  (hmax : x.val * y.val  Scalar.max ty) :
   z, x * y = ret z  z.val = x.val * y.val := by
  have : Scalar.min ty  x.val * y.val := by
    have hx := x.hmin
    have hy := y.hmin
    cases ty <;> simp at * <;> apply mul_nonneg hx hy
  apply mul_spec <;> assumption

/- Fine-grained theorems -/
@[pspec] theorem Usize.mul_spec {x y : Usize} (hmax : x.val * y.val  Usize.max) :
   z, x * y = ret z  z.val = x.val * y.val := by
  apply Scalar.mul_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U8.mul_spec {x y : U8} (hmax : x.val * y.val  U8.max) :
   z, x * y = ret z  z.val = x.val * y.val := by
  apply Scalar.mul_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U16.mul_spec {x y : U16} (hmax : x.val * y.val  U16.max) :
   z, x * y = ret z  z.val = x.val * y.val := by
  apply Scalar.mul_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U32.mul_spec {x y : U32} (hmax : x.val * y.val  U32.max) :
   z, x * y = ret z  z.val = x.val * y.val := by
  apply Scalar.mul_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U64.mul_spec {x y : U64} (hmax : x.val * y.val  U64.max) :
   z, x * y = ret z  z.val = x.val * y.val := by
  apply Scalar.mul_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem U128.mul_spec {x y : U128} (hmax : x.val * y.val  U128.max) :
   z, x * y = ret z  z.val = x.val * y.val := by
  apply Scalar.mul_unsigned_spec <;> simp only [Scalar.max, *]

@[pspec] theorem Isize.mul_spec {x y : Isize} (hmin : Isize.min  x.val * y.val)
  (hmax : x.val * y.val  Isize.max) :
   z, x * y = ret z  z.val = x.val * y.val :=
  Scalar.mul_spec hmin hmax

@[pspec] theorem I8.mul_spec {x y : I8} (hmin : I8.min  x.val * y.val)
  (hmax : x.val * y.val  I8.max) :
   z, x * y = ret z  z.val = x.val * y.val :=
  Scalar.mul_spec hmin hmax

@[pspec] theorem I16.mul_spec {x y : I16} (hmin : I16.min  x.val * y.val)
  (hmax : x.val * y.val  I16.max) :
   z, x * y = ret z  z.val = x.val * y.val :=
  Scalar.mul_spec hmin hmax

@[pspec] theorem I32.mul_spec {x y : I32} (hmin : I32.min  x.val * y.val)
  (hmax : x.val * y.val  I32.max) :
   z, x * y = ret z  z.val = x.val * y.val :=
  Scalar.mul_spec hmin hmax

@[pspec] theorem I64.mul_spec {x y : I64} (hmin : I64.min  x.val * y.val)
  (hmax : x.val * y.val  I64.max) :
   z, x * y = ret z  z.val = x.val * y.val :=
  Scalar.mul_spec hmin hmax

@[pspec] theorem I128.mul_spec {x y : I128} (hmin : I128.min  x.val * y.val)
  (hmax : x.val * y.val  I128.max) :
   z, x * y = ret z  z.val = x.val * y.val :=
  Scalar.mul_spec hmin hmax

-- Generic theorem - shouldn't be used much
@[pspec]
theorem Scalar.div_spec {ty} {x y : Scalar ty}
  (hnz : y.val  0)
  (hmin : Scalar.min ty  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  Scalar.max ty) :
   z, x / y = ret z  z.val = scalar_div x.val y.val := by
  simp [HDiv.hDiv, div, Div.div]
  simp [tryMk, *]
  simp [pure]
  rfl

theorem Scalar.div_unsigned_spec {ty} (s: ¬ ty.isSigned) (x : Scalar ty) {y : Scalar ty}
  (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  have h : Scalar.min ty = 0 := by cases ty <;> simp at *
  have hx := x.hmin
  have hy := y.hmin
  simp [h] at hx hy
  have hmin : 0  x.val / y.val := Int.ediv_nonneg hx hy
  have hmax : x.val / y.val  Scalar.max ty := by
    have := Int.ediv_le_self y.val hx
    have := x.hmax
    linarith
  have hs := @div_spec ty x y hnz
  simp [*] at hs
  apply hs

/- Fine-grained theorems -/
@[pspec] theorem Usize.div_spec (x : Usize) {y : Usize} (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  apply Scalar.div_unsigned_spec <;> simp [*]

@[pspec] theorem U8.div_spec (x : U8) {y : U8} (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  apply Scalar.div_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U16.div_spec (x : U16) {y : U16} (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  apply Scalar.div_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U32.div_spec (x : U32) {y : U32} (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  apply Scalar.div_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U64.div_spec (x : U64) {y : U64} (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  apply Scalar.div_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U128.div_spec (x : U128) {y : U128} (hnz : y.val  0) :
   z, x / y = ret z  z.val = x.val / y.val := by
  apply Scalar.div_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem Isize.div_spec (x : Isize) {y : Isize}
  (hnz : y.val  0)
  (hmin : Isize.min  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  Isize.max):
   z, x / y = ret z  z.val = scalar_div x.val y.val :=
  Scalar.div_spec hnz hmin hmax

@[pspec] theorem I8.div_spec (x : I8) {y : I8}
  (hnz : y.val  0)
  (hmin : I8.min  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  I8.max):
   z, x / y = ret z  z.val = scalar_div x.val y.val :=
  Scalar.div_spec hnz hmin hmax

@[pspec] theorem I16.div_spec (x : I16) {y : I16}
  (hnz : y.val  0)
  (hmin : I16.min  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  I16.max):
   z, x / y = ret z  z.val = scalar_div x.val y.val :=
  Scalar.div_spec hnz hmin hmax

@[pspec] theorem I32.div_spec (x : I32) {y : I32}
  (hnz : y.val  0)
  (hmin : I32.min  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  I32.max):
   z, x / y = ret z  z.val = scalar_div x.val y.val :=
  Scalar.div_spec hnz hmin hmax

@[pspec] theorem I64.div_spec (x : I64) {y : I64}
  (hnz : y.val  0)
  (hmin : I64.min  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  I64.max):
   z, x / y = ret z  z.val = scalar_div x.val y.val :=
  Scalar.div_spec hnz hmin hmax

@[pspec] theorem I128.div_spec (x : I128) {y : I128}
  (hnz : y.val  0)
  (hmin : I128.min  scalar_div x.val y.val)
  (hmax : scalar_div x.val y.val  I128.max):
   z, x / y = ret z  z.val = scalar_div x.val y.val :=
  Scalar.div_spec hnz hmin hmax

-- Generic theorem - shouldn't be used much
@[pspec]
theorem Scalar.rem_spec {ty} {x y : Scalar ty}
  (hnz : y.val  0)
  (hmin : Scalar.min ty  scalar_rem x.val y.val)
  (hmax : scalar_rem x.val y.val  Scalar.max ty) :
   z, x % y = ret z  z.val = scalar_rem x.val y.val := by
  simp [HMod.hMod, rem]
  simp [tryMk, *]
  simp [pure]
  rfl

theorem Scalar.rem_unsigned_spec {ty} (s: ¬ ty.isSigned) (x : Scalar ty) {y : Scalar ty}
  (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  have h : Scalar.min ty = 0 := by cases ty <;> simp at *
  have hx := x.hmin
  have hy := y.hmin
  simp [h] at hx hy
  have hmin : 0  x.val % y.val := Int.emod_nonneg x.val hnz
  have hmax : x.val % y.val  Scalar.max ty := by
    have h : 0 < y.val := by int_tac
    have h := Int.emod_lt_of_pos x.val h
    have := y.hmax
    linarith
  have hs := @rem_spec ty x y hnz
  simp [*] at hs
  simp [*]

@[pspec] theorem Usize.rem_spec (x : Usize) {y : Usize} (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  apply Scalar.rem_unsigned_spec <;> simp [*]

@[pspec] theorem U8.rem_spec (x : U8) {y : U8} (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  apply Scalar.rem_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U16.rem_spec (x : U16) {y : U16} (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  apply Scalar.rem_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U32.rem_spec (x : U32) {y : U32} (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  apply Scalar.rem_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U64.rem_spec (x : U64) {y : U64} (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  apply Scalar.rem_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem U128.rem_spec (x : U128) {y : U128} (hnz : y.val  0) :
   z, x % y = ret z  z.val = x.val % y.val := by
  apply Scalar.rem_unsigned_spec <;> simp [Scalar.max, *]

@[pspec] theorem I8.rem_spec (x : I8) {y : I8}
  (hnz : y.val  0)
  (hmin : I8.min  scalar_rem x.val y.val)
  (hmax : scalar_rem x.val y.val  I8.max):
   z, x % y = ret z  z.val = scalar_rem x.val y.val :=
  Scalar.rem_spec hnz hmin hmax

@[pspec] theorem I16.rem_spec (x : I16) {y : I16}
  (hnz : y.val  0)
  (hmin : I16.min  scalar_rem x.val y.val)
  (hmax : scalar_rem x.val y.val  I16.max):
   z, x % y = ret z  z.val = scalar_rem x.val y.val :=
  Scalar.rem_spec hnz hmin hmax

@[pspec] theorem I32.rem_spec (x : I32) {y : I32}
  (hnz : y.val  0)
  (hmin : I32.min  scalar_rem x.val y.val)
  (hmax : scalar_rem x.val y.val  I32.max):
   z, x % y = ret z  z.val = scalar_rem x.val y.val :=
  Scalar.rem_spec hnz hmin hmax

@[pspec] theorem I64.rem_spec (x : I64) {y : I64}
  (hnz : y.val  0)
  (hmin : I64.min  scalar_rem x.val y.val)
  (hmax : scalar_rem x.val y.val  I64.max):
   z, x % y = ret z  z.val = scalar_rem x.val y.val :=
  Scalar.rem_spec hnz hmin hmax

@[pspec] theorem I128.rem_spec (x : I128) {y : I128}
  (hnz : y.val  0)
  (hmin : I128.min  scalar_rem x.val y.val)
  (hmax : scalar_rem x.val y.val  I128.max):
   z, x % y = ret z  z.val = scalar_rem x.val y.val :=
  Scalar.rem_spec hnz hmin hmax

-- ofIntCore
-- TODO: typeclass?
def Isize.ofIntCore := @Scalar.ofIntCore .Isize
def I8.ofIntCore    := @Scalar.ofIntCore .I8
def I16.ofIntCore   := @Scalar.ofIntCore .I16
def I32.ofIntCore   := @Scalar.ofIntCore .I32
def I64.ofIntCore   := @Scalar.ofIntCore .I64
def I128.ofIntCore  := @Scalar.ofIntCore .I128
def Usize.ofIntCore := @Scalar.ofIntCore .Usize
def U8.ofIntCore    := @Scalar.ofIntCore .U8
def U16.ofIntCore   := @Scalar.ofIntCore .U16
def U32.ofIntCore   := @Scalar.ofIntCore .U32
def U64.ofIntCore   := @Scalar.ofIntCore .U64
def U128.ofIntCore  := @Scalar.ofIntCore .U128

--  ofInt
-- TODO: typeclass?
abbrev Isize.ofInt := @Scalar.ofInt .Isize
abbrev I8.ofInt    := @Scalar.ofInt .I8
abbrev I16.ofInt   := @Scalar.ofInt .I16
abbrev I32.ofInt   := @Scalar.ofInt .I32
abbrev I64.ofInt   := @Scalar.ofInt .I64
abbrev I128.ofInt  := @Scalar.ofInt .I128
abbrev Usize.ofInt := @Scalar.ofInt .Usize
abbrev U8.ofInt    := @Scalar.ofInt .U8
abbrev U16.ofInt   := @Scalar.ofInt .U16
abbrev U32.ofInt   := @Scalar.ofInt .U32
abbrev U64.ofInt   := @Scalar.ofInt .U64
abbrev U128.ofInt  := @Scalar.ofInt .U128

postfix:max "#isize" => Isize.ofInt
postfix:max "#i8"    => I8.ofInt
postfix:max "#i16"   => I16.ofInt
postfix:max "#i32"   => I32.ofInt
postfix:max "#i64"   => I64.ofInt
postfix:max "#i128"  => I128.ofInt
postfix:max "#usize" => Usize.ofInt
postfix:max "#u8"    => U8.ofInt
postfix:max "#u16"   => U16.ofInt
postfix:max "#u32"   => U32.ofInt
postfix:max "#u64"   => U64.ofInt
postfix:max "#u128"  => U128.ofInt

-- Testing the notations
example : Result Usize := 0#usize + 1#usize

-- TODO: factor those lemmas out
@[simp] theorem Scalar.ofInt_val_eq {ty} (h : Scalar.min ty  x  x  Scalar.max ty) : (Scalar.ofInt x h).val = x := by
  simp [Scalar.ofInt, Scalar.ofIntCore]

@[simp] theorem Isize.ofInt_val_eq (h : Scalar.min ScalarTy.Isize  x  x  Scalar.max ScalarTy.Isize) : (Isize.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem I8.ofInt_val_eq (h : Scalar.min ScalarTy.I8  x  x  Scalar.max ScalarTy.I8) : (I8.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem I16.ofInt_val_eq (h : Scalar.min ScalarTy.I16  x  x  Scalar.max ScalarTy.I16) : (I16.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem I32.ofInt_val_eq (h : Scalar.min ScalarTy.I32  x  x  Scalar.max ScalarTy.I32) : (I32.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem I64.ofInt_val_eq (h : Scalar.min ScalarTy.I64  x  x  Scalar.max ScalarTy.I64) : (I64.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem I128.ofInt_val_eq (h : Scalar.min ScalarTy.I128  x  x  Scalar.max ScalarTy.I128) : (I128.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem Usize.ofInt_val_eq (h : Scalar.min ScalarTy.Usize  x  x  Scalar.max ScalarTy.Usize) : (Usize.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem U8.ofInt_val_eq (h : Scalar.min ScalarTy.U8  x  x  Scalar.max ScalarTy.U8) : (U8.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem U16.ofInt_val_eq (h : Scalar.min ScalarTy.U16  x  x  Scalar.max ScalarTy.U16) : (U16.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem U32.ofInt_val_eq (h : Scalar.min ScalarTy.U32  x  x  Scalar.max ScalarTy.U32) : (U32.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem U64.ofInt_val_eq (h : Scalar.min ScalarTy.U64  x  x  Scalar.max ScalarTy.U64) : (U64.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

@[simp] theorem U128.ofInt_val_eq (h : Scalar.min ScalarTy.U128  x  x  Scalar.max ScalarTy.U128) : (U128.ofInt x h).val = x := by
  apply Scalar.ofInt_val_eq h

-- Comparisons
instance {ty} : LT (Scalar ty) where
  lt a b := LT.lt a.val b.val

instance {ty} : LE (Scalar ty) where le a b := LE.le a.val b.val

instance Scalar.decLt {ty} (a b : Scalar ty) : Decidable (LT.lt a b) := Int.decLt ..
instance Scalar.decLe {ty} (a b : Scalar ty) : Decidable (LE.le a b) := Int.decLe ..

theorem Scalar.eq_of_val_eq {ty} :  {i j : Scalar ty}, Eq i.val j.val  Eq i j
  | _, _, _⟩, _, _, _⟩, rfl => rfl

theorem Scalar.val_eq_of_eq {ty} {i j : Scalar ty} (h : Eq i j) : Eq i.val j.val :=
  h  rfl

theorem Scalar.ne_of_val_ne {ty} {i j : Scalar ty} (h : Not (Eq i.val j.val)) : Not (Eq i j) :=
  fun h' => absurd (val_eq_of_eq h') h

instance (ty : ScalarTy) : DecidableEq (Scalar ty) :=
  fun i j =>
    match decEq i.val j.val with
    | isTrue h  => isTrue (Scalar.eq_of_val_eq h)
    | isFalse h => isFalse (Scalar.ne_of_val_ne h)

instance (ty : ScalarTy) : CoeOut (Scalar ty) Int where
  coe := λ v => v.val

@[simp] theorem Scalar.neq_to_neq_val {ty} :  {i j : Scalar ty}, (¬ i = j)  ¬ i.val = j.val := by
  intro i j; cases i; cases j; simp

-- -- We now define a type class that subsumes the various machine integer types, so
-- -- as to write a concise definition for scalar_cast, rather than exhaustively
-- -- enumerating all of the possible pairs. We remark that Rust has sane semantics
-- -- and fails if a cast operation would involve a truncation or modulo.

-- class MachineInteger (t: Type) where
--   size: Nat
--   val: t -> Fin size
--   ofNatCore: (n:Nat) -> LT.lt n size -> t

-- set_option hygiene false in
-- run_cmd
--   for typeName in [`UInt8, `UInt16, `UInt32, `UInt64, `USize].map Lean.mkIdent do
--   Lean.Elab.Command.elabCommand (← `(
--     namespace $typeName
--     instance: MachineInteger $typeName where
--       size := size
--       val := val
--       ofNatCore := ofNatCore
--     end $typeName
--   ))

-- -- Aeneas only instantiates the destination type (`src` is implicit). We rely on
-- -- Lean to infer `src`.

-- def scalar_cast { src: Type } (dst: Type) [ MachineInteger src ] [ MachineInteger dst ] (x: src): Result dst :=
--   if h: MachineInteger.val x < MachineInteger.size dst then
--     .ret (MachineInteger.ofNatCore (MachineInteger.val x).val h)
--   else
--     .fail integerOverflow

end Primitives