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

use std::cmp::{Ordering, PartialEq, PartialOrd};
use std::ops::{Not, Sub};

use crate::auto::Bv;
use crate::bit::Bit;
use crate::dynamic::Bvd;
use crate::fixed::Bvf;
use crate::tests::{bvf_bvf_inner_unroll, bvf_inner_unroll, random_bv};
use crate::utils::{Integer, StaticCast};
use crate::BitVector;

fn eq_inner<B1, B2>(max_capacity: usize)
where
    B1: BitVector + PartialEq<B2> + Not<Output = B1>,
    B2: BitVector + PartialEq<B1> + for<'a> TryFrom<&'a B1, Error: std::fmt::Debug>,
{
    for length in 1..max_capacity {
        let mut bv1 = random_bv::<B1>(length);
        let mut bv2 = B2::try_from(&bv1).unwrap();
        bv1.resize(max_capacity, Bit::Zero);
        bv2.resize(bv2.significant_bits(), Bit::Zero);
        assert_eq!(bv1, bv2);
        assert_eq!(bv2, bv1);
        assert_ne!(!bv1, bv2);
    }
}

fn eq_inner_bvf_bvf<I1: Integer, I2: Integer, const N1: usize, const N2: usize>()
where
    I1: StaticCast<I2>,
    I2: StaticCast<I1>,
{
    eq_inner::<Bvf<I1, N1>, Bvf<I2, N2>>(usize::min(
        Bvf::<I1, N1>::capacity(),
        Bvf::<I2, N2>::capacity(),
    ));
}

fn eq_inner_bvf_bvd<I: Integer, const N: usize>()
where
    I: StaticCast<u64>,
    u64: StaticCast<I>,
{
    eq_inner::<Bvf<I, N>, Bvd>(Bvf::<I, N>::capacity());
    eq_inner::<Bvd, Bvf<I, N>>(Bvf::<I, N>::capacity());
}

fn eq_inner_bvf_bv<I: Integer, const N: usize>()
where
    I: StaticCast<u64>,
    u64: StaticCast<I>,
{
    eq_inner::<Bvf<I, N>, Bv>(Bvf::<I, N>::capacity());
    eq_inner::<Bv, Bvf<I, N>>(Bvf::<I, N>::capacity());
}

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

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

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

#[test]
fn eq_bvd_bvd() {
    eq_inner::<Bvd, Bvd>(512);
}

#[test]
fn eq_bvd_bv() {
    eq_inner::<Bvd, Bv>(512);
    eq_inner::<Bv, Bvd>(512);
}

#[test]
fn eq_bv_bv() {
    eq_inner::<Bv, Bv>(512);
}

fn cmp_inner<B1, B2>(max_capacity: usize)
where
    B1: BitVector + PartialOrd<B2>,
    for<'a, 'b> &'a B1: Sub<&'b B2, Output = B1>,
    B2: BitVector + PartialOrd<B1> + for<'a> TryFrom<&'a B1, Error: std::fmt::Debug>,
    for<'a, 'b> &'a B2: Sub<&'b B1, Output = B2>,
{
    for length in 0..max_capacity {
        let mut bv1 = random_bv::<B1>(length);
        let mut bv2 = random_bv::<B2>(length);
        bv1.resize(max_capacity, Bit::Zero);
        bv2.resize(bv2.significant_bits(), Bit::Zero);
        match bv1.partial_cmp(&bv2).unwrap() {
            Ordering::Less => {
                assert_eq!(bv2.partial_cmp(&bv1).unwrap(), Ordering::Greater);
                let diff = &bv2 - &bv1;
                // If bv1 < bv2, then bv2 - bv1 > 0 and so it shouldn't overflow
                assert_ne!(diff.partial_cmp(&bv2).unwrap(), Ordering::Greater);
            }
            Ordering::Equal => {
                assert_eq!(bv2.partial_cmp(&bv1).unwrap(), Ordering::Equal);
                let diff = &bv2 - &bv1;
                assert!(diff.is_zero());
            }
            Ordering::Greater => {
                assert_eq!(bv2.partial_cmp(&bv1).unwrap(), Ordering::Less);
                let diff = &bv1 - &bv2;
                // If bv1 > bv2, then bv1 - bv2 > 0 and so it shouldn't overflow
                assert_ne!(diff.partial_cmp(&bv1).unwrap(), Ordering::Greater);
            }
        }
    }
}

fn cmp_inner_bvf_bvf<I1: Integer, I2: Integer, const N1: usize, const N2: usize>()
where
    I1: StaticCast<I2>,
    I2: StaticCast<I1>,
{
    cmp_inner::<Bvf<I1, N1>, Bvf<I2, N2>>(usize::min(
        Bvf::<I1, N1>::capacity(),
        Bvf::<I2, N2>::capacity(),
    ));
}

fn cmp_inner_bvf_bvd<I: Integer, const N: usize>()
where
    I: StaticCast<u64>,
    u64: StaticCast<I>,
{
    cmp_inner::<Bvf<I, N>, Bvd>(Bvf::<I, N>::capacity());
    cmp_inner::<Bvd, Bvf<I, N>>(Bvf::<I, N>::capacity());
}

fn cmp_inner_bvf_bv<I: Integer, const N: usize>()
where
    I: StaticCast<u64>,
    u64: StaticCast<I>,
{
    cmp_inner::<Bvf<I, N>, Bv>(Bvf::<I, N>::capacity());
    cmp_inner::<Bv, Bvf<I, N>>(Bvf::<I, N>::capacity());
}

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

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

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

#[test]
fn cmp_bvd_bvd() {
    cmp_inner::<Bvd, Bvd>(512);
}

#[test]
fn cmp_bvd_bv() {
    cmp_inner::<Bvd, Bv>(512);
    cmp_inner::<Bv, Bvd>(512);
}

#[test]
fn cmp_bv_bv() {
    cmp_inner::<Bv, Bv>(512);
}