bva 0.4.1

bva is a rust crate for manipulating and doing arithmetics on bit vectors of fixed but arbitrary size.
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

use num_bigint::BigInt;
use rand::random;

use crate::auto::Bv;
use crate::dynamic::Bvd;
use crate::fixed::Bvf;
use crate::utils::Integer;
use crate::{Bit, BitVector};

mod arithmetic;
mod auto;
mod binary;
mod bitvector;
mod comparison;
mod conversion;
mod dynamic;
mod fixed;
mod formatting;
mod iter;
mod utils;

fn random_bv<B: BitVector>(length: usize) -> B {
    let mut bv = B::zeros(length);
    for i in 0..length {
        bv.set(i, Bit::from(random::<bool>()));
    }
    bv
}

fn random_test_bv<B: BitVector>(length: usize) -> (B, BigInt) {
    let bv: B = random_bv(length);
    let mut bi = BigInt::from(0u8);
    for i in 0..bv.len() {
        bi.set_bit(i as u64, bv.get(i).into());
    }
    (bv, bi)
}

impl<I1: Integer, const N: usize> PartialEq<BigInt> for Bvf<I1, N> {
    fn eq(&self, other: &BigInt) -> bool {
        for i in 0..self.len() {
            if self.get(i) != Bit::from(other.bit(i as u64)) {
                return false;
            }
        }
        true
    }
}

impl PartialEq<BigInt> for Bvd {
    fn eq(&self, other: &BigInt) -> bool {
        for i in 0..self.len() {
            if self.get(i) != Bit::from(other.bit(i as u64)) {
                return false;
            }
        }
        true
    }
}

impl PartialEq<BigInt> for Bv {
    fn eq(&self, other: &BigInt) -> bool {
        for i in 0..self.len() {
            if self.get(i) != Bit::from(other.bit(i as u64)) {
                return false;
            }
        }
        true
    }
}

macro_rules! bvf_inner_unroll {
    ($func:ident, {$($lhs:ty),+}, $sl:tt) => {
        $(
            bvf_inner_unroll!($func, $lhs, $sl);
        )+
    };
    ($func:ident, $lhs:ty, {$($sl:literal),+}) => {
        $(
            $func::<$lhs, $sl>();
        )+
    };
}

macro_rules! bvf_inner_unroll_cap {
    ($func:ident, {$($lhs:ty),+}, $sl:tt) => {
        $(
            bvf_inner_unroll_cap!($func, $lhs, $sl);
        )+
    };
    ($func:ident, $lhs:ty, {$($sl:literal),+}) => {
        $(
            $func::<Bvf<$lhs, $sl>>(Bvf::<$lhs, $sl>::capacity());
        )+
    };
}

macro_rules! bvf_bvf_inner_unroll {
    ($func:ident, $types:tt, $sizes:tt) => {
        bvf_bvf_inner_unroll!($func, $types, $types, $sizes, $sizes);
    };
    ($func:ident, {$($lhs:ty),+}, $rhs:tt, $sl:tt, $sr:tt) => {
        $(
            bvf_bvf_inner_unroll!($func, $lhs, $rhs, $sl, $sr);
        )+
    };
    ($func:ident, $lhs:ty, {$($rhs:ty),+}, $sl:tt, $sr:tt) => {
        $(
            bvf_bvf_inner_unroll!($func, $lhs, $rhs, $sl, $sr);
        )+
    };
    ($func:ident, $lhs:ty, $rhs:ty, {$($sl:literal),+}, $sr:tt) => {
        $(
            bvf_bvf_inner_unroll!($func, $lhs, $rhs, $sl, $sr);
        )+
    };
    ($func:ident, $lhs:ty, $rhs:ty, $sl:literal, {$($sr:literal),+}) => {
        $(
            $func::<$lhs, $rhs, $sl, $sr>();
        )+
    };
}

macro_rules! op_test_block {
    ($lhs:ty, $rhs:ty, $op:path, $op_assign:path, $size:ident) => {
        let modulo = BigInt::from(1u8) << $size;
        let (bv1, bi1) = random_test_bv::<$lhs>($size);
        let (bv2, bi2) = random_test_bv::<$rhs>($size);
        let reference = $op(&bi1, &bi2) % &modulo;
        // Normal op
        assert_eq!($op(&bv1, &bv2), reference);
        assert_eq!($op(bv1.clone(), &bv2), reference);
        assert_eq!($op(&bv1, bv2.clone()), reference);
        assert_eq!($op(bv1.clone(), bv2.clone()), reference);
        // Assign op
        let mut bv3 = bv1.clone();
        $op_assign(&mut bv3, &bv2);
        assert_eq!(bv3, reference);
        bv3 = bv1.clone();
        $op_assign(&mut bv3, bv2);
        assert_eq!(bv3, reference);
    };

    ($lhs:ty, {$($rhs:ty),+}, $op:path, $op_assign:path, $size:ident) => {
        $(
            let modulo = BigInt::from(1u8) << $size;
            let (bv1, bi1) = random_test_bv::<$lhs>($size);
            let uint = random::<$rhs>();
            let reference = $op(&bi1, BigInt::from(uint)) % &modulo;
            // Normal op
            assert_eq!($op(&bv1, &uint), reference);
            assert_eq!($op(bv1.clone(), &uint), reference);
            assert_eq!($op(&bv1, uint), reference);
            assert_eq!($op(bv1.clone(), uint), reference);
            // Assign op
            let mut bv2 = bv1.clone();
            $op_assign(&mut bv2, &uint);
            assert_eq!(bv2, reference);
            bv2 = bv1.clone();
            $op_assign(&mut bv2, uint);
            assert_eq!(bv2, reference);
        )+
    };
}

// Variant more suited for division and modulo but also test lhs and rhs of different sizes.
macro_rules! op_test_block2 {
    ($lhs:ty, $rhs:ty, $op:path, $op_assign:path, $size:ident) => {
        let modulo = BigInt::from(1u8) << $size;
        let (bv1, bi1) = random_test_bv::<$lhs>($size);
        let (mut bv2, mut bi2) = random_test_bv::<$rhs>(usize::max(1, $size / 2));
        while bv2.is_zero() {
            (bv2, bi2) = random_test_bv::<$rhs>(usize::max(1, $size / 2));
        }
        let reference = $op(&bi1, &bi2) % &modulo;
        // Normal op
        assert_eq!($op(&bv1, &bv2), reference);
        assert_eq!($op(bv1.clone(), &bv2), reference);
        assert_eq!($op(&bv1, bv2.clone()), reference);
        assert_eq!($op(bv1.clone(), bv2.clone()), reference);
        // Assign op
        let mut bv3 = bv1.clone();
        $op_assign(&mut bv3, &bv2);
        assert_eq!(bv3, reference);
        bv3 = bv1.clone();
        $op_assign(&mut bv3, bv2);
        assert_eq!(bv3, reference);
    };

    ($lhs:ty, {$($rhs:ty),+}, $op:path, $op_assign:path, $size:ident) => {
        $(
            let modulo = BigInt::from(1u8) << $size;
            let (bv1, bi1) = random_test_bv::<$lhs>($size);
            let mut uint = random::<$rhs>();
            while uint == 0 {
                uint = random::<$rhs>();
            }
            let reference = $op(&bi1, BigInt::from(uint)) % &modulo;
            // Normal op
            assert_eq!($op(&bv1, &uint), reference);
            assert_eq!($op(bv1.clone(), &uint), reference);
            assert_eq!($op(&bv1, uint), reference);
            assert_eq!($op(bv1.clone(), uint), reference);
            // Assign op
            let mut bv2 = bv1.clone();
            $op_assign(&mut bv2, &uint);
            assert_eq!(bv2, reference);
            bv2 = bv1.clone();
            $op_assign(&mut bv2, uint);
            assert_eq!(bv2, reference);
        )+
    };
}

// Variant which test lhs smaller than rhs.
macro_rules! op_test_block3 {
    ($lhs:ty, $rhs:ty, $op:path, $op_assign:path, $size:ident) => {
        let modulo = BigInt::from(1u8) << usize::max(1, $size / 2);
        let (bv1, bi1) = random_test_bv::<$lhs>(usize::max(1, $size / 2));
        let (bv2, bi2) = random_test_bv::<$rhs>($size);
        let reference = $op(&bi1, &bi2) % &modulo;
        // Normal op
        assert_eq!($op(&bv1, &bv2), reference);
        assert_eq!($op(bv1.clone(), &bv2), reference);
        assert_eq!($op(&bv1, bv2.clone()), reference);
        assert_eq!($op(bv1.clone(), bv2.clone()), reference);
        // Assign op
        let mut bv3 = bv1.clone();
        $op_assign(&mut bv3, &bv2);
        assert_eq!(bv3, reference);
        bv3 = bv1.clone();
        $op_assign(&mut bv3, bv2);
        assert_eq!(bv3, reference);
    };

    ($lhs:ty, {$($rhs:ty),+}, $op:path, $op_assign:path, $size:ident) => {};
}

// Variant suited for shifts.
macro_rules! shift_test_block {
    ($lhs:ty, {$($rhs:ty),+}, $op:path, $op_assign:path, $size:ident) => {
        $(
            shift_test_block!($lhs, $rhs, $op, $op_assign, $size);
        )+
    };
    ($lhs:ty, $rhs:ty, $op:path, $op_assign:path, $size:ident) => {
        let modulo = BigInt::from(1u8) << $size;
        let shift = (random::<usize>() % (2 * $size)) as $rhs;
        let (bv, bi) = random_test_bv::<$lhs>($size);
        let reference = $op(&bi, shift) % modulo;
        // Normal op
        assert_eq!($op(&bv, &shift), reference);
        assert_eq!($op(bv.clone(), &shift), reference);
        assert_eq!($op(&bv, shift), reference);
        assert_eq!($op(bv.clone(), shift), reference);
        // Assign op
        let mut bv2 = bv.clone();
        $op_assign(&mut bv2, &shift);
        assert_eq!(bv2, reference);
        bv2 = bv.clone();
        $op_assign(&mut bv2, shift);
        assert_eq!(bv2, reference);
    };
}

macro_rules! op_test_section {
    ($op:path, $op_assign:path, {$($block:path),+}) => {
        fn bvf_bvf_inner<
            I1: Integer + StaticCast<I2>,
            I2: Integer + StaticCast<I1>,
            const N1: usize,
            const N2: usize,
        >() {
            for size in 1..usize::min(Bvf::<I1, N1>::capacity(), Bvf::<I2, N2>::capacity()) {
                $(
                    $block!(Bvf<I1, N1>, Bvf<I2, N2>, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bvf_bvf() {
            bvf_bvf_inner_unroll!(bvf_bvf_inner, {u8, u16, u32, u64, u128}, {1, 2, 3, 4, 5});
        }

        fn bvf_bvd_inner<I: Integer, const N: usize>()
        where
            u64: StaticCast<I>,
        {
            for size in 1..Bvf::<I, N>::capacity() {
                $(
                    $block!(Bvf<I, N>, Bvd, $op, $op_assign, size);
                    $block!(Bvd, Bvf<I, N>, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bvf_bvd() {
            bvf_inner_unroll!(bvf_bvd_inner, {u8, u16, u32, u64, u128}, {1, 2, 3, 4, 5});
        }

        fn bvf_bv_inner<I: Integer, const N: usize>()
        where
            u64: StaticCast<I>,
        {
            for size in 1..Bvf::<I, N>::capacity() {
                $(
                    $block!(Bvf<I, N>, Bv, $op, $op_assign, size);
                    $block!(Bv, Bvf<I, N>, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bvf_bv() {
            bvf_inner_unroll!(bvf_bv_inner, {u8, u16, u32, u64, u128}, {1, 2, 3, 4, 5});
        }

        fn bvf_uint_inner<I: Integer, const N: usize>()
        where
            u64: StaticCast<I>,
        {
            for size in 1..Bvf::<I, N>::capacity() {
                $(
                    $block!(Bvf<I, N>, {u8, u16, u32, u64, usize, u128}, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bvf_uint() {
            bvf_inner_unroll!(bvf_uint_inner, {u8, u16, u32, u64, u128}, {1, 2, 3, 4, 5});
        }

        #[test]
        fn bvd_bvd() {
            for size in 1..512 {
                $(
                    $block!(Bvd, Bvd, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bvd_bv() {
            for size in 1..512 {
                $(
                    $block!(Bvd, Bv, $op, $op_assign, size);
                    $block!(Bv, Bvd, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bvd_uint() {
            for size in 1..512 {
                $(
                    $block!(Bvd, {u8, u16, u32, u64, usize, u128}, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bv_bv() {
            for size in 1..512 {
                $(
                    $block!(Bv, Bv, $op, $op_assign, size);
                )+
            }
        }

        #[test]
        fn bv_uint() {
            for size in 1..512 {
                $(
                    $block!(Bv, {u8, u16, u32, u64, usize, u128}, $op, $op_assign, size);
                )+
            }
        }
    };
}

pub(crate) use bvf_bvf_inner_unroll;
pub(crate) use bvf_inner_unroll;
pub(crate) use bvf_inner_unroll_cap;
pub(crate) use op_test_block;
pub(crate) use op_test_block2;
pub(crate) use op_test_block3;
pub(crate) use op_test_section;
pub(crate) use shift_test_block;