simplicityhl-as-rust 0.2.0

Tools for working with SimplicityHL as literal Rust
Documentation
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
/* This file has been automatically generated. */

//! # Arithmetic
//!
//! This module defines jets that compute arithmetic functions.

#![allow(unused)]
#![allow(clippy::complexity)]

use super::*;

/// Add two integers and return the carry.
///
/// ## Cost
///
/// 112 mWU _(milli weight units)_
pub fn add_8(a: u8, b: u8) -> (bool, u8) {
    todo!()
}

/// Add two integers and return the carry.
///
/// ## Cost
///
/// 108 mWU _(milli weight units)_
pub fn add_16(a: u16, b: u16) -> (bool, u16) {
    todo!()
}

/// Add two integers and return the carry.
///
/// ## Cost
///
/// 117 mWU _(milli weight units)_
pub fn add_32(a: u32, b: u32) -> (bool, u32) {
    todo!()
}

/// Add two integers and return the carry.
///
/// ## Cost
///
/// 109 mWU _(milli weight units)_
pub fn add_64(a: u64, b: u64) -> (bool, u64) {
    todo!()
}

/// Decrement an integer by one and return the borrow bit.
///
/// ## Cost
///
/// 79 mWU _(milli weight units)_
pub fn decrement_8(a: u8) -> (bool, u8) {
    todo!()
}

/// Decrement an integer by one and return the borrow bit.
///
/// ## Cost
///
/// 85 mWU _(milli weight units)_
pub fn decrement_16(a: u16) -> (bool, u16) {
    todo!()
}

/// Decrement an integer by one and return the borrow bit.
///
/// ## Cost
///
/// 91 mWU _(milli weight units)_
pub fn decrement_32(a: u32) -> (bool, u32) {
    todo!()
}

/// Decrement an integer by one and return the borrow bit.
///
/// ## Cost
///
/// 89 mWU _(milli weight units)_
pub fn decrement_64(a: u64) -> (bool, u64) {
    todo!()
}

/// Divide the first integer by the second integer, and return the remainder.
///
/// ## Cost
///
/// 128 mWU _(milli weight units)_
pub fn div_mod_8(a: u8, b: u8) -> (u8, u8) {
    todo!()
}

/// Divide the first integer by the second integer, and return the remainder.
///
/// ## Cost
///
/// 118 mWU _(milli weight units)_
pub fn div_mod_16(a: u16, b: u16) -> (u16, u16) {
    todo!()
}

/// Divide the first integer by the second integer, and return the remainder.
///
/// ## Cost
///
/// 115 mWU _(milli weight units)_
pub fn div_mod_32(a: u32, b: u32) -> (u32, u32) {
    todo!()
}

/// Divide the first integer by the second integer, and return the remainder.
///
/// ## Cost
///
/// 86 mWU _(milli weight units)_
pub fn div_mod_64(a: u64, b: u64) -> (u64, u64) {
    todo!()
}

/// Divide the 128-bit integer `a` by the 64-bit integer `b`.
/// Return a tuple of the quotient `q` and the remainer `r`.
///
/// Use this jet to recursively define wide integer divisions.
///
/// ## Preconditions
/// 1. `q` < 2^64
/// 2. 2^63 ≤ `b`
///
/// Return `(u64::MAX, u64::MAX)` when the preconditions are not satisfied.
///
/// ## Cost
///
/// 208 mWU _(milli weight units)_
pub fn div_mod_128_64(a: u128, b: u64) -> (u64, u64) {
    todo!()
}

/// Divide the first integer by the second integer.
///
/// ## Cost
///
/// 108 mWU _(milli weight units)_
pub fn divide_8(a: u8, b: u8) -> u8 {
    todo!()
}

/// Divide the first integer by the second integer.
///
/// ## Cost
///
/// 98 mWU _(milli weight units)_
pub fn divide_16(a: u16, b: u16) -> u16 {
    todo!()
}

/// Divide the first integer by the second integer.
///
/// ## Cost
///
/// 100 mWU _(milli weight units)_
pub fn divide_32(a: u32, b: u32) -> u32 {
    todo!()
}

/// Divide the first integer by the second integer.
///
/// ## Cost
///
/// 101 mWU _(milli weight units)_
pub fn divide_64(a: u64, b: u64) -> u64 {
    todo!()
}

/// Check if the first integer is divisible by the second integer.
///
/// ## Cost
///
/// 98 mWU _(milli weight units)_
pub fn divides_8(a: u8, b: u8) -> bool {
    todo!()
}

/// Check if the first integer is divisible by the second integer.
///
/// ## Cost
///
/// 93 mWU _(milli weight units)_
pub fn divides_16(a: u16, b: u16) -> bool {
    todo!()
}

/// Check if the first integer is divisible by the second integer.
///
/// ## Cost
///
/// 87 mWU _(milli weight units)_
pub fn divides_32(a: u32, b: u32) -> bool {
    todo!()
}

/// Check if the first integer is divisible by the second integer.
///
/// ## Cost
///
/// 91 mWU _(milli weight units)_
pub fn divides_64(a: u64, b: u64) -> bool {
    todo!()
}

/// Add two integers. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 127 mWU _(milli weight units)_
pub fn full_add_8(a: bool, b: u8, c: u8) -> (bool, u8) {
    todo!()
}

/// Add two integers. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 121 mWU _(milli weight units)_
pub fn full_add_16(a: bool, b: u16, c: u16) -> (bool, u16) {
    todo!()
}

/// Add two integers. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 119 mWU _(milli weight units)_
pub fn full_add_32(a: bool, b: u32, c: u32) -> (bool, u32) {
    todo!()
}

/// Add two integers. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 121 mWU _(milli weight units)_
pub fn full_add_64(a: bool, b: u64, c: u64) -> (bool, u64) {
    todo!()
}

/// Decrement an integer by one. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 91 mWU _(milli weight units)_
pub fn full_decrement_8(a: bool, b: u8) -> (bool, u8) {
    todo!()
}

/// Decrement an integer by one. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 92 mWU _(milli weight units)_
pub fn full_decrement_16(a: bool, b: u16) -> (bool, u16) {
    todo!()
}

/// Decrement an integer by one. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 107 mWU _(milli weight units)_
pub fn full_decrement_32(a: bool, b: u32) -> (bool, u32) {
    todo!()
}

/// Decrement an integer by one. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 81 mWU _(milli weight units)_
pub fn full_decrement_64(a: bool, b: u64) -> (bool, u64) {
    todo!()
}

/// Increment an integer by one. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 72 mWU _(milli weight units)_
pub fn full_increment_8(a: bool, b: u8) -> (bool, u8) {
    todo!()
}

/// Increment an integer by one. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 89 mWU _(milli weight units)_
pub fn full_increment_16(a: bool, b: u16) -> (bool, u16) {
    todo!()
}

/// Increment an integer by one. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 104 mWU _(milli weight units)_
pub fn full_increment_32(a: bool, b: u32) -> (bool, u32) {
    todo!()
}

/// Increment an integer by one. Take a carry-in and return a carry-out.
///
/// ## Cost
///
/// 99 mWU _(milli weight units)_
pub fn full_increment_64(a: bool, b: u64) -> (bool, u64) {
    todo!()
}

/// Helper for multiplying integers. Take the product of the first pair of integers and add the sum of the second pair.
///
/// ## Cost
///
/// 109 mWU _(milli weight units)_
pub fn full_multiply_8(a: (u8, u8), b: (u8, u8)) -> u16 {
    todo!()
}

/// Helper for multiplying integers. Take the product of the first pair of integers and add the sum of the second pair.
///
/// ## Cost
///
/// 112 mWU _(milli weight units)_
pub fn full_multiply_16(a: (u16, u16), b: (u16, u16)) -> u32 {
    todo!()
}

/// Helper for multiplying integers. Take the product of the first pair of integers and add the sum of the second pair.
///
/// ## Cost
///
/// 96 mWU _(milli weight units)_
pub fn full_multiply_32(a: (u32, u32), b: (u32, u32)) -> u64 {
    todo!()
}

/// Helper for multiplying integers. Take the product of the first pair of integers and add the sum of the second pair.
///
/// ## Cost
///
/// 127 mWU _(milli weight units)_
pub fn full_multiply_64(a: (u64, u64), b: (u64, u64)) -> u128 {
    todo!()
}

/// Subtract the second integer from the first integer. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 126 mWU _(milli weight units)_
pub fn full_subtract_8(a: bool, b: u8, c: u8) -> (bool, u8) {
    todo!()
}

/// Subtract the second integer from the first integer. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 121 mWU _(milli weight units)_
pub fn full_subtract_16(a: bool, b: u16, c: u16) -> (bool, u16) {
    todo!()
}

/// Subtract the second integer from the first integer. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 116 mWU _(milli weight units)_
pub fn full_subtract_32(a: bool, b: u32, c: u32) -> (bool, u32) {
    todo!()
}

/// Subtract the second integer from the first integer. Take a borrow-in and return a borrow-out.
///
/// ## Cost
///
/// 98 mWU _(milli weight units)_
pub fn full_subtract_64(a: bool, b: u64, c: u64) -> (bool, u64) {
    todo!()
}

/// Increment an integer by one and return the carry.
///
/// ## Cost
///
/// 85 mWU _(milli weight units)_
pub fn increment_8(a: u8) -> (bool, u8) {
    todo!()
}

/// Increment an integer by one and return the carry.
///
/// ## Cost
///
/// 69 mWU _(milli weight units)_
pub fn increment_16(a: u16) -> (bool, u16) {
    todo!()
}

/// Increment an integer by one and return the carry.
///
/// ## Cost
///
/// 92 mWU _(milli weight units)_
pub fn increment_32(a: u32) -> (bool, u32) {
    todo!()
}

/// Increment an integer by one and return the carry.
///
/// ## Cost
///
/// 87 mWU _(milli weight units)_
pub fn increment_64(a: u64) -> (bool, u64) {
    todo!()
}

/// Check if an integer is one.
///
/// ## Cost
///
/// 91 mWU _(milli weight units)_
pub fn is_one_8(a: u8) -> bool {
    todo!()
}

/// Check if an integer is one.
///
/// ## Cost
///
/// 82 mWU _(milli weight units)_
pub fn is_one_16(a: u16) -> bool {
    todo!()
}

/// Check if an integer is one.
///
/// ## Cost
///
/// 65 mWU _(milli weight units)_
pub fn is_one_32(a: u32) -> bool {
    todo!()
}

/// Check if an integer is one.
///
/// ## Cost
///
/// 83 mWU _(milli weight units)_
pub fn is_one_64(a: u64) -> bool {
    todo!()
}

/// Check if an integer is zero.
///
/// ## Cost
///
/// 77 mWU _(milli weight units)_
pub fn is_zero_8(a: u8) -> bool {
    todo!()
}

/// Check if an integer is zero.
///
/// ## Cost
///
/// 75 mWU _(milli weight units)_
pub fn is_zero_16(a: u16) -> bool {
    todo!()
}

/// Check if an integer is zero.
///
/// ## Cost
///
/// 85 mWU _(milli weight units)_
pub fn is_zero_32(a: u32) -> bool {
    todo!()
}

/// Check if an integer is zero.
///
/// ## Cost
///
/// 80 mWU _(milli weight units)_
pub fn is_zero_64(a: u64) -> bool {
    todo!()
}

/// Check if an integer is less than or equal to another integer.
///
/// ## Cost
///
/// 109 mWU _(milli weight units)_
pub fn le_8(a: u8, b: u8) -> bool {
    todo!()
}

/// Check if an integer is less than or equal to another integer.
///
/// ## Cost
///
/// 112 mWU _(milli weight units)_
pub fn le_16(a: u16, b: u16) -> bool {
    todo!()
}

/// Check if an integer is less than or equal to another integer.
///
/// ## Cost
///
/// 93 mWU _(milli weight units)_
pub fn le_32(a: u32, b: u32) -> bool {
    todo!()
}

/// Check if an integer is less than or equal to another integer.
///
/// ## Cost
///
/// 93 mWU _(milli weight units)_
pub fn le_64(a: u64, b: u64) -> bool {
    todo!()
}

/// Check if an integer is less than another integer.
///
/// ## Cost
///
/// 107 mWU _(milli weight units)_
pub fn lt_8(a: u8, b: u8) -> bool {
    todo!()
}

/// Check if an integer is less than another integer.
///
/// ## Cost
///
/// 123 mWU _(milli weight units)_
pub fn lt_16(a: u16, b: u16) -> bool {
    todo!()
}

/// Check if an integer is less than another integer.
///
/// ## Cost
///
/// 107 mWU _(milli weight units)_
pub fn lt_32(a: u32, b: u32) -> bool {
    todo!()
}

/// Check if an integer is less than another integer.
///
/// ## Cost
///
/// 76 mWU _(milli weight units)_
pub fn lt_64(a: u64, b: u64) -> bool {
    todo!()
}

/// Return the bigger of two integers.
///
/// ## Cost
///
/// 96 mWU _(milli weight units)_
pub fn max_8(a: u8, b: u8) -> u8 {
    todo!()
}

/// Return the bigger of two integers.
///
/// ## Cost
///
/// 114 mWU _(milli weight units)_
pub fn max_16(a: u16, b: u16) -> u16 {
    todo!()
}

/// Return the bigger of two integers.
///
/// ## Cost
///
/// 92 mWU _(milli weight units)_
pub fn max_32(a: u32, b: u32) -> u32 {
    todo!()
}

/// Return the bigger of two integers.
///
/// ## Cost
///
/// 104 mWU _(milli weight units)_
pub fn max_64(a: u64, b: u64) -> u64 {
    todo!()
}

/// Return the median of three integers.
///
/// ## Cost
///
/// 122 mWU _(milli weight units)_
pub fn median_8(a: u8, b: u8, c: u8) -> u8 {
    todo!()
}

/// Return the median of three integers.
///
/// ## Cost
///
/// 123 mWU _(milli weight units)_
pub fn median_16(a: u16, b: u16, c: u16) -> u16 {
    todo!()
}

/// Return the median of three integers.
///
/// ## Cost
///
/// 101 mWU _(milli weight units)_
pub fn median_32(a: u32, b: u32, c: u32) -> u32 {
    todo!()
}

/// Return the median of three integers.
///
/// ## Cost
///
/// 109 mWU _(milli weight units)_
pub fn median_64(a: u64, b: u64, c: u64) -> u64 {
    todo!()
}

/// Return the smaller of two integers.
///
/// ## Cost
///
/// 99 mWU _(milli weight units)_
pub fn min_8(a: u8, b: u8) -> u8 {
    todo!()
}

/// Return the smaller of two integers.
///
/// ## Cost
///
/// 97 mWU _(milli weight units)_
pub fn min_16(a: u16, b: u16) -> u16 {
    todo!()
}

/// Return the smaller of two integers.
///
/// ## Cost
///
/// 113 mWU _(milli weight units)_
pub fn min_32(a: u32, b: u32) -> u32 {
    todo!()
}

/// Return the smaller of two integers.
///
/// ## Cost
///
/// 102 mWU _(milli weight units)_
pub fn min_64(a: u64, b: u64) -> u64 {
    todo!()
}

/// Compute the remainder after dividing both integers.
///
/// ## Cost
///
/// 102 mWU _(milli weight units)_
pub fn modulo_8(a: u8, b: u8) -> u8 {
    todo!()
}

/// Compute the remainder after dividing both integers.
///
/// ## Cost
///
/// 103 mWU _(milli weight units)_
pub fn modulo_16(a: u16, b: u16) -> u16 {
    todo!()
}

/// Compute the remainder after dividing both integers.
///
/// ## Cost
///
/// 102 mWU _(milli weight units)_
pub fn modulo_32(a: u32, b: u32) -> u32 {
    todo!()
}

/// Compute the remainder after dividing both integers.
///
/// ## Cost
///
/// 85 mWU _(milli weight units)_
pub fn modulo_64(a: u64, b: u64) -> u64 {
    todo!()
}

/// Multiply two integers. The output is a 16-bit integer.
///
/// ## Cost
///
/// 93 mWU _(milli weight units)_
pub fn multiply_8(a: u8, b: u8) -> u16 {
    todo!()
}

/// Multiply two integers. The output is a 32-bit integer.
///
/// ## Cost
///
/// 90 mWU _(milli weight units)_
pub fn multiply_16(a: u16, b: u16) -> u32 {
    todo!()
}

/// Multiply two integers. The output is a 64-bit integer.
///
/// ## Cost
///
/// 90 mWU _(milli weight units)_
pub fn multiply_32(a: u32, b: u32) -> u64 {
    todo!()
}

/// Multiply two integers. The output is a 128-bit integer.
///
/// ## Cost
///
/// 85 mWU _(milli weight units)_
pub fn multiply_64(a: u64, b: u64) -> u128 {
    todo!()
}

/// Negate the integer (modulo 2⁸)  and return the borrow bit.
///
/// ## Cost
///
/// 91 mWU _(milli weight units)_
pub fn negate_8(a: u8) -> (bool, u8) {
    todo!()
}

/// Negate the integer (modulo 2¹⁶) and return the borrow bit.
///
/// ## Cost
///
/// 70 mWU _(milli weight units)_
pub fn negate_16(a: u16) -> (bool, u16) {
    todo!()
}

/// Negate the integer (modulo 2³²) and return the borrow bit.
///
/// ## Cost
///
/// 85 mWU _(milli weight units)_
pub fn negate_32(a: u32) -> (bool, u32) {
    todo!()
}

/// Negate the integer (modulo 2⁶⁴) and return the borrow bit.
///
/// ## Cost
///
/// 94 mWU _(milli weight units)_
pub fn negate_64(a: u64) -> (bool, u64) {
    todo!()
}

/// Return 1 as an 8-bit integer.
///
/// ## Cost
///
/// 62 mWU _(milli weight units)_
pub fn one_8() -> u8 {
    todo!()
}

/// Return 1 as a 16-bit integer.
///
/// ## Cost
///
/// 60 mWU _(milli weight units)_
pub fn one_16() -> u16 {
    todo!()
}

/// Return 1 as a 32-bit integer.
///
/// ## Cost
///
/// 59 mWU _(milli weight units)_
pub fn one_32() -> u32 {
    todo!()
}

/// Return 1 as a 64-bit integer.
///
/// ## Cost
///
/// 59 mWU _(milli weight units)_
pub fn one_64() -> u64 {
    todo!()
}

/// Subtract the second integer from the first integer, and return the borrow bit.
///
/// ## Cost
///
/// 109 mWU _(milli weight units)_
pub fn subtract_8(a: u8, b: u8) -> (bool, u8) {
    todo!()
}

/// Subtract the second integer from the first integer, and return the borrow bit.
///
/// ## Cost
///
/// 113 mWU _(milli weight units)_
pub fn subtract_16(a: u16, b: u16) -> (bool, u16) {
    todo!()
}

/// Subtract the second integer from the first integer, and return the borrow bit.
///
/// ## Cost
///
/// 118 mWU _(milli weight units)_
pub fn subtract_32(a: u32, b: u32) -> (bool, u32) {
    todo!()
}

/// Subtract the second integer from the first integer, and return the borrow bit.
///
/// ## Cost
///
/// 115 mWU _(milli weight units)_
pub fn subtract_64(a: u64, b: u64) -> (bool, u64) {
    todo!()
}