nullvec 0.2.0

Rust nullable vector, which can contain null(missing) values as element
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

use std::ops::{Add, Sub, Mul, Div, Rem, BitAnd, BitOr, BitXor};

use algos::vec_ops::Elemwise;
use nullvec::NullVec;

macro_rules! add_vec_elemwise_op {
    ($t:ident, $tr:ident, $op:ident, $sym:tt) => {
        // Nullvec + Vec
        impl $tr<Vec<$t>> for NullVec<$t> {
            type Output = NullVec<$t>;
            fn $op(self, other: Vec<$t>) -> NullVec<$t> {
                let mask = self.mask.clone();
                let new_values = Elemwise::elemwise_oo(self.data, other, |x, y| x $sym y);
                NullVec::with_mask(new_values, mask)
            }
        }
        // Nullvec + &Vec
        impl<'a> $tr<&'a Vec<$t>> for NullVec<$t> {
            type Output = NullVec<$t>;
            fn $op(self, other: &Vec<$t>) -> NullVec<$t> {
                let mask = self.mask.clone();
                let new_values = Elemwise::elemwise_or(self.data, other, |x, y| x $sym y);
                NullVec::with_mask(new_values, mask)
            }
        }
        // &Nullvec + Vec
        impl<'b> $tr<Vec<$t>> for &'b NullVec<$t> {
            type Output = NullVec<$t>;
            fn $op(self, other: Vec<$t>) -> NullVec<$t> {
                let mask = self.mask.clone();
                let new_values = Elemwise::elemwise_ro(&self.data, other, |x, y| x $sym y);
                NullVec::with_mask(new_values, mask)
            }
        }
        // &Nullvec + &Vec
        impl<'a, 'b> $tr<&'a Vec<$t>> for &'b NullVec<$t> {
            type Output = NullVec<$t>;
            fn $op(self, other: &Vec<$t>) -> NullVec<$t> {
                let mask = self.mask.clone();
                let new_values = Elemwise::elemwise_rr(&self.data, other, |x, y| x $sym y);
                NullVec::with_mask(new_values, mask)
            }
        }
    }
}

macro_rules! add_vec_elemwise_arithmetic_op_patterns {
    ($t:ident) => {
        add_vec_elemwise_op!($t, Add, add, +);
        add_vec_elemwise_op!($t, Sub, sub, -);
        add_vec_elemwise_op!($t, Mul, mul, *);
        add_vec_elemwise_op!($t, Div, div, /);
        add_vec_elemwise_op!($t, Rem, rem, %);
    }
}
macro_dispatch!(
    add_vec_elemwise_arithmetic_op_patterns,
    i64,
    i32,
    i16,
    i8,
    isize,
    u64,
    u32,
    u16,
    u8,
    usize,
    f64,
    f32
);

macro_rules! add_vec_elemwise_bitwise_op_patterns {
    ($t:ident) => {
        add_vec_elemwise_op!($t, BitAnd, bitand, &);
        add_vec_elemwise_op!($t, BitOr, bitor, |);
        add_vec_elemwise_op!($t, BitXor, bitxor, ^);
    }
}
macro_dispatch!(
    add_vec_elemwise_bitwise_op_patterns,
    i64,
    i32,
    i16,
    i8,
    isize,
    u64,
    u32,
    u16,
    u8,
    usize,
    bool
);

#[cfg(test)]
mod tests {

    use std::f64;

    use nullvec::NullVec;

    #[test]
    fn test_int() {
        let values: Vec<usize> = vec![1, 2, 3];
        let nvec = NullVec::new(values);
        let res = nvec + vec![2, 2, 2];
        assert_eq!(res.data, vec![3, 4, 5]);
        assert_eq!(res.mask, None);
    }

    #[test]
    fn test_int_ref_rhs() {
        let values: Vec<usize> = vec![1, 2, 3];
        let nvec = NullVec::new(values);
        let res = nvec + &vec![2, 2, 2];
        assert_eq!(res.data, vec![3, 4, 5]);
        assert_eq!(res.mask, None);
    }

    #[test]
    fn test_int_ref_lhs() {
        let values: Vec<usize> = vec![1, 2, 3];
        let nvec = NullVec::new(values);
        let res = &nvec + vec![2, 2, 2];
        assert_eq!(res.data, vec![3, 4, 5]);
        assert_eq!(res.mask, None);
    }

    #[test]
    fn test_int_ref_both() {
        let values: Vec<usize> = vec![1, 2, 3];
        let nvec = NullVec::new(values);
        let res = &nvec + &vec![2, 2, 2];
        assert_eq!(res.data, vec![3, 4, 5]);
        assert_eq!(res.mask, None);
    }

    #[test]
    fn test_float() {
        let values: Vec<f64> = vec![1.1, 1.2, 1.3];
        let nvec = NullVec::new(values);

        let res = nvec + vec![2., 2., 2.];
        assert_eq!(res.data, vec![3.1, 3.2, 3.3]);
        assert_eq!(res.mask, None);
    }

    #[test]
    fn test_float_nan() {
        let values: Vec<f64> = vec![1.1, f64::NAN, 1.3];
        let nvec = NullVec::new(values);

        let res = nvec + vec![2., 2., 2.];
        assert_eq!(res.data, vec![3.1, 2., 3.3]);
        assert_eq!(res.mask, Some(vec![false, true, false]));
    }

    #[test]
    fn test_bool() {
        let values: Vec<bool> = vec![true, false, true];
        let nvec = NullVec::new(values);

        let res = nvec & vec![true, true, true];
        assert_eq!(res.data, vec![true, false, true]);
        assert_eq!(res.mask, None);
    }
}