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
use crate::prelude::*;
use core::ops::{BitOr, BitOrAssign};
#[allow(clippy::suspicious_op_assign_impl)]
impl<const PRECISION: usize, const BITS: usize> BitOrAssign<Self> for HyperLogLog<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Computes union between HLL counters.
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
/// # use core::ops::BitOrAssign;
///
/// let mut hll = HyperLogLog::<8, 6>::new();
/// hll.insert(1u8);
///
/// let mut hll2 = HyperLogLog::<8, 6>::new();
/// hll2.insert(2u8);
///
/// hll.bitor_assign(hll2);
///
/// assert!(hll.estimate_cardinality() > 2.0 - 0.1, "The cardinality is {}, we were expecting 2.", hll.estimate_cardinality());
/// assert!(hll.estimate_cardinality() < 2.0 + 0.1, "The cardinality is {}, we were expecting 2.", hll.estimate_cardinality());
///
/// let mut hll = HyperLogLog::<8, 6>::new();
/// hll.insert(1u8);
///
/// let mut hll2 = HyperLogLog::<8, 6>::new();
/// hll2.insert(1u8);
///
/// hll.bitor_assign(hll2);
///
/// assert!(hll.estimate_cardinality() > 1.0 - 0.1, "The cardinality is {}, we were expecting 1.", hll.estimate_cardinality());
/// assert!(hll.estimate_cardinality() < 1.0 + 0.1, "The cardinality is {}, we were expecting 1.", hll.estimate_cardinality());
///
/// let mut hll3 = HyperLogLog::<16, 6>::new();
/// hll3.insert(3u8);
/// hll3.insert(4u8);
///
/// let mut hll4 = HyperLogLog::<16, 6>::new();
/// hll4.insert(5u8);
/// hll4.insert(6u8);
///
/// hll3.bitor_assign(hll4);
///
/// assert!(hll3.estimate_cardinality() > 4.0 - 0.1, "Expected a value equal to around 4, got {}", hll3.estimate_cardinality());
/// assert!(hll3.estimate_cardinality() < 4.0 + 0.1, "Expected a value equal to around 4, got {}", hll3.estimate_cardinality());
/// ```
fn bitor_assign(&mut self, rhs: Self) {
self.bitor_assign(&rhs)
}
}
#[allow(clippy::suspicious_op_assign_impl)]
impl<const PRECISION: usize, const BITS: usize> BitOrAssign<&Self> for HyperLogLog<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Computes union between HLL counters.
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
/// # use core::ops::BitOrAssign;
///
/// let mut hll = HyperLogLog::<8, 6>::new();
/// hll.insert(1u8);
///
/// let mut hll2 = HyperLogLog::<8, 6>::new();
/// hll2.insert(2u8);
///
/// hll.bitor_assign(&hll2);
///
/// assert!(hll.estimate_cardinality() > 2.0 - 0.1, "The cardinality is {}, we were expecting 2.", hll.estimate_cardinality());
/// assert!(hll.estimate_cardinality() < 2.0 + 0.1, "The cardinality is {}, we were expecting 2.", hll.estimate_cardinality());
///
/// let mut hll = HyperLogLog::<8, 6>::new();
/// hll.insert(1u8);
///
/// let mut hll2 = HyperLogLog::<8, 6>::new();
/// hll2.insert(1u8);
///
/// hll.bitor_assign(&hll2);
///
/// assert!(hll.estimate_cardinality() > 1.0 - 0.1, "The cardinality is {}, we were expecting 1.", hll.estimate_cardinality());
/// assert!(hll.estimate_cardinality() < 1.0 + 0.1, "The cardinality is {}, we were expecting 1.", hll.estimate_cardinality());
///
/// let mut hll3 = HyperLogLog::<16, 6>::new();
/// hll3.insert(3u8);
/// hll3.insert(4u8);
///
/// let mut hll4 = HyperLogLog::<16, 6>::new();
/// hll4.insert(5u8);
/// hll4.insert(6u8);
///
/// hll3.bitor_assign(&hll4);
///
/// assert!(hll3.estimate_cardinality() > 4.0 - 0.1, "Expected a value equal to around 4, got {}", hll3.estimate_cardinality());
/// assert!(hll3.estimate_cardinality() < 4.0 + 0.1, "Expected a value equal to around 4, got {}", hll3.estimate_cardinality());
/// ```
fn bitor_assign(&mut self, rhs: &Self) {
let mut new_number_of_zeros = 0;
for (left_word, mut right_word) in self.words.iter_mut().zip(rhs.words.into_iter()) {
let mut left_word_copy = *left_word;
for i in 0..Self::NUMBER_OF_REGISTERS_IN_WORD {
let mut left_register = left_word_copy & Self::LOWER_REGISTER_MASK;
let right_register = right_word & Self::LOWER_REGISTER_MASK;
left_register = (left_register).max(right_register);
*left_word &= !(Self::LOWER_REGISTER_MASK << (i * BITS));
*left_word |= left_register << (i * BITS);
new_number_of_zeros += (left_register == 0) as usize;
left_word_copy >>= BITS;
right_word >>= BITS;
}
}
self.number_of_zero_register = new_number_of_zeros - self.get_number_of_padding_registers();
}
}
impl<const PRECISION: usize, const BITS: usize> BitOr<Self> for HyperLogLog<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
type Output = Self;
#[inline(always)]
/// Computes the union between two HyperLogLog counters of the same precision and number of bits per register.
///
/// # Example
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
/// let mut hll1 = HyperLogLog::<14, 5>::new();
/// hll1.insert(&1);
/// hll1.insert(&2);
///
/// let mut hll2 = HyperLogLog::<14, 5>::new();
/// hll2.insert(&2);
/// hll2.insert(&3);
///
/// let hll_union = hll1 | hll2;
///
/// assert!(hll_union.estimate_cardinality() >= 3.0_f32 * 0.9 &&
/// hll_union.estimate_cardinality() <= 3.0_f32 * 1.1);
/// ```
///
/// Merging a set with an empty set should not change the cardinality.
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
/// let mut hll1 = HyperLogLog::<14, 5>::new();
/// hll1.insert(&1);
/// hll1.insert(&2);
///
/// let hll_union = hll1.clone() | HyperLogLog::<14, 5>::new();
/// assert_eq!(
/// hll_union,
/// hll1,
/// concat!(
/// "The cardinality of the union should ",
/// "be the same as the cardinality of the first set."
/// )
/// );
/// ```
///
/// We can create the HLL counters from array from registers,
/// so to be able to check that everything works as expected.
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
///
/// let first_registers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
/// let second_registers = [9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 19];
/// let expected = [9, 9, 9, 9, 9, 9, 9, 9, 9, 10, 11, 12, 13, 14, 15, 19];
///
/// let mut hll1 = HyperLogLog::<4, 5>::from_registers(&first_registers);
/// let mut hll2 = HyperLogLog::<4, 5>::from_registers(&second_registers);
/// let union = hll1 | hll2;
///
/// assert_eq!(union.get_registers(), expected, "The registers are not the expected ones, got {:?} instead of {:?}.", union.get_registers(), expected);
/// ```
///
fn bitor(mut self, rhs: Self) -> Self {
self.bitor_assign(rhs);
self
}
}
impl<const PRECISION: usize, const BITS: usize> BitOr<&Self> for HyperLogLog<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
type Output = Self;
#[inline(always)]
/// Computes the union between two HyperLogLog counters of the same precision and number of bits per register.
///
/// # Example
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
/// let mut hll1 = HyperLogLog::<14, 5>::new();
/// hll1.insert(&1);
/// hll1.insert(&2);
///
/// let mut hll2 = HyperLogLog::<14, 5>::new();
/// hll2.insert(&2);
/// hll2.insert(&3);
///
/// let hll_union = hll1 | hll2;
///
/// assert!(hll_union.estimate_cardinality() >= 3.0_f32 * 0.9 &&
/// hll_union.estimate_cardinality() <= 3.0_f32 * 1.1);
/// ```
///
/// Merging a set with an empty set should not change the cardinality.
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
/// let mut hll1 = HyperLogLog::<14, 5>::new();
/// hll1.insert(&1);
/// hll1.insert(&2);
///
/// let hll_union = hll1.clone() | HyperLogLog::<14, 5>::new();
/// assert_eq!(
/// hll_union,
/// hll1,
/// concat!(
/// "The cardinality of the union should ",
/// "be the same as the cardinality of the first set."
/// )
/// );
/// ```
///
/// We can create the HLL counters from array from registers,
/// so to be able to check that everything works as expected.
///
/// ```rust
/// # use hyperloglog_rs::HyperLogLog;
///
/// let first_registers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16];
/// let second_registers = [9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 9, 19];
/// let expected = [9, 9, 9, 9, 9, 9, 9, 9, 9, 10, 11, 12, 13, 14, 15, 19];
///
/// let mut hll1 = HyperLogLog::<4, 5>::from_registers(&first_registers);
/// let mut hll2 = HyperLogLog::<4, 5>::from_registers(&second_registers);
/// let union = hll1 | &hll2;
///
/// assert_eq!(union.get_registers(), expected, "The registers are not the expected ones, got {:?} instead of {:?}.", union.get_registers(), expected);
/// ```
///
fn bitor(mut self, rhs: &Self) -> Self {
self.bitor_assign(rhs);
self
}
}