baa 0.17.1

BitVector and Array Arithmetic
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

// Copyright 2024 Cornell University
// released under BSD 3-Clause License
// author: Kevin Laeufer <laeufer@cornell.edu>
//
// Contains tests for bit vector comparison operations. We use num-bigint as a
// reference implementation.
#[cfg(feature = "bigint")]
use baa::*;
#[cfg(feature = "bigint")]
use num_bigint::*;
use proptest::prelude::*;

#[cfg(feature = "bigint")]
fn do_test_cmp_signed(
    a: BigInt,
    b: BigInt,
    width: WidthInt,
    our: fn(&BitVecValue, &BitVecValue) -> bool,
    big: fn(BigInt, BigInt) -> bool,
) {
    let a_vec = BitVecValue::from_big_int(&a, width);
    let b_vec = BitVecValue::from_big_int(&b, width);
    let res_bool = our(&a_vec, &b_vec);
    let expected_bool = big(a.clone(), b.clone());
    assert_eq!(expected_bool, res_bool, "{a} {b} {expected_bool}");
}

#[cfg(feature = "bigint")]
fn do_test_cmp_unsigned(
    a_signed: BigInt,
    b_signed: BigInt,
    width: WidthInt,
    our: fn(&BitVecValue, &BitVecValue) -> bool,
    big: fn(BigUint, BigUint) -> bool,
) {
    let a = a_signed.magnitude();
    let b = b_signed.magnitude();
    let a_vec = BitVecValue::from_big_uint(a, width);
    let b_vec = BitVecValue::from_big_uint(b, width);
    let res_bool = our(&a_vec, &b_vec);
    let expected_bool = big(a.clone(), b.clone());
    assert_eq!(expected_bool, res_bool, "{a} {b} {expected_bool}");
}

#[cfg(feature = "bigint")]
fn do_test_cmp_greater(a: BigInt, b: BigInt, width: WidthInt) {
    do_test_cmp_unsigned(a, b, width, |a, b| a.is_greater(b), |a, b| a > b)
}

#[cfg(feature = "bigint")]
fn do_test_cmp_greater_signed(a: BigInt, b: BigInt, width: WidthInt) {
    do_test_cmp_signed(a, b, width, |a, b| a.is_greater_signed(b), |a, b| a > b)
}

#[cfg(feature = "bigint")]
fn do_test_cmp_greater_equal(a: BigInt, b: BigInt, width: WidthInt) {
    do_test_cmp_unsigned(a, b, width, |a, b| a.is_greater_or_equal(b), |a, b| a >= b)
}

#[cfg(feature = "bigint")]
fn do_test_cmp_greater_equal_signed(a: BigInt, b: BigInt, width: WidthInt) {
    do_test_cmp_signed(
        a,
        b,
        width,
        |a, b| a.is_greater_or_equal_signed(b),
        |a, b| a >= b,
    )
}

#[cfg(feature = "bigint")]
fn do_test_cmp_equal(a: BigInt, b: BigInt, width: WidthInt) {
    do_test_cmp_unsigned(a, b, width, |a, b| a.is_equal(b), |a, b| a == b)
}

#[cfg(feature = "bigint")]
fn do_test_cmp_equal_signed(a: BigInt, b: BigInt, width: WidthInt) {
    do_test_cmp_signed(a, b, width, |a, b| a.is_equal(b), |a, b| a == b)
}

//////////////////////////
// Unit Tests
//////////////////////////
#[cfg(feature = "bigint")]
#[test]
fn do_test_cmp_greater_signed_regressions() {
    do_test_cmp_greater_signed(
        BigInt::parse_bytes(b"2812269376756553621043437133860079836754636903388049287067766551164406258259928767528960", 10).unwrap(),
        BigInt::parse_bytes(b"16927137481", 10).unwrap(),
        292
    );
}

//////////////////////////
// Random Tests
//////////////////////////
#[cfg(feature = "bigint")]
mod bitvec_arithmetic;
#[cfg(feature = "bigint")]
use bitvec_arithmetic::gen_big_int_pair;

proptest! {
    #![proptest_config(ProptestConfig::with_cases(5000))]


    #[cfg(feature = "bigint")]
    #[test]
    fn test_cmp_greater((a, b, width) in gen_big_int_pair()) {
        do_test_cmp_greater(a, b, width);
    }

    #[cfg(feature = "bigint")]
    #[test]
    fn test_cmp_greater_signed((a, b, width) in gen_big_int_pair()) {
        do_test_cmp_greater_signed(a, b, width);
    }

    #[cfg(feature = "bigint")]
    #[test]
    fn test_cmp_greater_equal((a, b, width) in gen_big_int_pair()) {
        do_test_cmp_greater_equal(a, b, width);
    }

    #[cfg(feature = "bigint")]
    #[test]
    fn test_cmp_greater_equal_signed((a, b, width) in gen_big_int_pair()) {
        do_test_cmp_greater_equal_signed(a, b, width);
    }

    #[cfg(feature = "bigint")]
    #[test]
    fn test_cmp_equal((a, b, width) in gen_big_int_pair()) {
        do_test_cmp_equal(a, b, width);
    }

    #[cfg(feature = "bigint")]
    #[test]
    fn test_cmp_equal_signed((a, b, width) in gen_big_int_pair()) {
        do_test_cmp_equal_signed(a, b, width);
    }
}