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 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
use std::ops::{Index, IndexMut};
use crate::prelude::*;
use serde::de::Visitor;
use serde::ser::SerializeSeq;
use serde::{Deserialize, Deserializer, Serialize, Serializer};
#[repr(transparent)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct HyperLogLogArray<const PRECISION: usize, const BITS: usize, const N: usize>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
counters: [HyperLogLog<PRECISION, BITS>; N],
}
impl<const PRECISION: usize, const BITS: usize, const N: usize> Default
for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Creates a new HyperLogLogArray with the given precision and number of bits.
///
/// # Returns
/// A new HyperLogLogArray with the given precision and number of bits.
///
/// # Example
///
/// ```rust
/// #![feature(generic_const_exprs)]
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<12, 6, 3>::default();
/// ```
fn default() -> Self {
Self {
counters: [HyperLogLog::new(); N],
}
}
}
impl<const PRECISION: usize, const BITS: usize, const N: usize> HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Creates a new HyperLogLogArray with the given precision and number of bits.
///
/// # Example
///
/// ```
/// #![feature(generic_const_exprs)]
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<12, 6, 3>::new();
/// ```
pub fn new() -> Self {
Self {
counters: [HyperLogLog::new(); N],
}
}
#[inline(always)]
/// Returns the estimated overlap cardinality matrices with the provided HyperLogLogArray.
///
/// # Arguments
/// * `other`: The HyperLogLogArray to estimate the overlap cardinality matrices with.
///
/// # Returns
/// The estimated overlap cardinality matrices with the provided HyperLogLogArray.
///
pub fn estimate_overlap_cardinalities(&self, other: &Self) -> [[f32; N]; N] {
HyperLogLog::estimated_overlap_cardinality_matrix(self.as_ref(), other.as_ref())
}
#[inline(always)]
/// Returns the estimated difference cardinality matrices with the provided HyperLogLog.
///
/// # Arguments
/// * `other`: The HyperLogLog to estimate the difference cardinality matrices with.
///
/// # Returns
/// The estimated difference cardinality matrices with the provided HyperLogLogArray.
///
pub fn estimated_difference_cardinality_vector(
&self,
other: &HyperLogLog<PRECISION, BITS>,
) -> [f32; N] {
HyperLogLog::estimated_difference_cardinality_vector(self.as_ref(), other)
}
#[inline(always)]
/// Returns the estimated overlap and difference cardinality matrices and vectors with the provided HyperLogLogArray.
///
/// # Arguments
/// * `other`: The HyperLogLogArray to estimate the overlap and difference cardinality matrices and vectors with.
///
/// # Returns
/// The estimated overlap and difference cardinality matrices and vectors with the provided HyperLogLogArray.
pub fn estimated_overlap_and_differences_cardinality_matrices(
&self,
other: &Self,
) -> ([[f32; N]; N], [f32; N], [f32; N]) {
HyperLogLog::estimated_overlap_and_differences_cardinality_matrices(
self.as_ref(),
other.as_ref(),
)
}
}
impl<const PRECISION: usize, const BITS: usize, const N: usize>
AsRef<[HyperLogLog<PRECISION, BITS>; N]> for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Returns a reference to the underlying array of HyperLogLog counters.
///
/// # Returns
/// A reference to the underlying array of HyperLogLog counters.
fn as_ref(&self) -> &[HyperLogLog<PRECISION, BITS>; N] {
&self.counters
}
}
impl<const PRECISION: usize, const BITS: usize, const N: usize>
AsMut<[HyperLogLog<PRECISION, BITS>; N]> for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Returns a mutable reference to the underlying array of HyperLogLog counters.
///
/// # Returns
/// A mutable reference to the underlying array of HyperLogLog counters.
fn as_mut(&mut self) -> &mut [HyperLogLog<PRECISION, BITS>; N] {
&mut self.counters
}
}
impl<const PRECISION: usize, const BITS: usize, const N: usize> Index<usize>
for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
type Output = HyperLogLog<PRECISION, BITS>;
#[inline(always)]
/// Returns a reference to the HyperLogLog counter at the given index.
///
/// # Arguments
/// * `index`: The index of the HyperLogLog counter to return.
///
/// # Returns
/// A reference to the HyperLogLog counter at the given index.
///
/// # Panics
/// Panics if the index is out of bounds.
///
/// # Example
///
/// ```rust
/// #![feature(generic_const_exprs)]
/// use hyperloglog_rs::prelude::*;
///
/// let mut hll_array = HyperLogLogArray::<12, 6, 4>::new();
/// hll_array[0].insert(&1);
/// hll_array[1].insert(&2);
/// hll_array[2].insert(&3);
///
/// assert!(hll_array[0].estimate_cardinality() > 0.9
/// && hll_array[1].estimate_cardinality() < 1.1
/// );
/// assert!(hll_array[1].estimate_cardinality() > 0.9
/// && hll_array[1].estimate_cardinality() < 1.1
/// );
/// assert!(hll_array[2].estimate_cardinality() > 0.9
/// && hll_array[2].estimate_cardinality() < 1.1
/// );
/// assert!(hll_array[3].estimate_cardinality() > -0.1
/// && hll_array[3].estimate_cardinality() < 0.1
/// );
///
/// ```
fn index(&self, index: usize) -> &Self::Output {
&self.counters[index]
}
}
impl<const PRECISION: usize, const BITS: usize, const N: usize> IndexMut<usize>
for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Returns a mutable reference to the HyperLogLog counter at the given index.
///
/// # Arguments
/// * `index`: The index of the HyperLogLog counter to return.
///
/// # Returns
/// A mutable reference to the HyperLogLog counter at the given index.
///
/// # Panics
/// Panics if the index is out of bounds.
///
/// # Example
///
/// ```rust
/// #![feature(generic_const_exprs)]
/// use hyperloglog_rs::prelude::*;
///
/// let mut hll_array = HyperLogLogArray::<12, 6, 4>::new();
/// hll_array[0].insert(&1);
/// hll_array[1].insert(&2);
/// hll_array[2].insert(&3);
///
/// assert!(hll_array[0].estimate_cardinality() > 0.9
/// && hll_array[1].estimate_cardinality() < 1.1
/// );
/// assert!(hll_array[1].estimate_cardinality() > 0.9
/// && hll_array[1].estimate_cardinality() < 1.1
/// );
/// assert!(hll_array[2].estimate_cardinality() > 0.9
/// && hll_array[2].estimate_cardinality() < 1.1
/// );
/// assert!(hll_array[3].estimate_cardinality() > -0.1
/// && hll_array[3].estimate_cardinality() < 0.1
/// );
///
/// ```
fn index_mut(&mut self, index: usize) -> &mut Self::Output {
&mut self.counters[index]
}
}
impl<const PRECISION: usize, const BITS: usize, const N: usize> Serialize
for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Serializes the HyperLogLog counter using the given serializer.
///
/// This method is part of the `Serialize` trait implementation for the HyperLogLog struct,
/// allowing the counter to be serialized into a format supported by the serializer.
///
/// # Arguments
/// * `serializer`: The serializer used to serialize the HyperLogLog counter.
///
/// # Returns
/// The serialization result, indicating success or failure.
///
/// # Example
/// In this example, we serialize an array of HyperLogLog counters into a JSON string.
/// The resulting string is then deserialized back into an array of HyperLogLog counters.
///
/// Since we cannot implement these traits for array, we need to wrap the array in a struct,
/// which in this case is `HyperLogLogArray`.
///
/// ```rust
/// #![feature(generic_const_exprs)]
/// use serde::Serialize;
/// use serde_json::Serializer;
/// use hyperloglog_rs::prelude::*;
///
/// let mut hll_array = HyperLogLogArray::<12, 6, 3>::new();
/// hll_array[0].insert(&1);
/// hll_array[1].insert(&2);
/// hll_array[2].insert(&3);
/// let mut serializer = Serializer::new(Vec::new());
/// let result = hll_array.serialize(&mut serializer);
/// assert!(result.is_ok(), "Serialization failed, error: {:?}", result.err());
/// let hll_array_str = String::from_utf8(serializer.into_inner()).unwrap();
/// let hll_array_deserialized = serde_json::from_str(&hll_array_str);
/// assert!(hll_array_deserialized.is_ok(), "Deserialization failed, error: {:?}", hll_array_deserialized.err());
/// let hll_array_deserialized = hll_array_deserialized.unwrap();
/// assert_eq!(hll_array, hll_array_deserialized, "Deserialized array does not match original array");
/// ```
///
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut seq = serializer.serialize_seq(Some(self.counters.len()))?;
for counter in self.counters {
seq.serialize_element(&counter)?;
}
seq.end()
}
}
impl<'de, const PRECISION: usize, const BITS: usize, const N: usize> Deserialize<'de>
for HyperLogLogArray<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Deserializes the HyperLogLog counter using the given deserializer.
///
/// This method is part of the `Deserialize` trait implementation for the HyperLogLog struct,
/// allowing the counter to be deserialized from a format supported by the deserializer.
///
/// # Arguments
/// * `deserializer`: The deserializer used to deserialize the HyperLogLog counter.
///
/// # Returns
/// The deserialization result, indicating success or failure.
///
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
Ok(Self {
counters: deserializer.deserialize_seq(HLLArrayVisitor)?,
})
}
}
#[derive(Default)]
/// Struct to deserialize a vector of u32
pub struct HLLArrayVisitor<const PRECISION: usize, const BITS: usize, const N: usize>;
/// A visitor implementation used for deserializing an array of HLL into a fixed-size array.
///
/// This visitor is used internally by the `serde` deserialization process for the HyperLogLog struct.
/// It converts the deserialized sequence of HLL values into a fixed-size array.
///
/// # Generic Parameters
///
/// * `'de`: Lifetime specifier for the deserialization process.
/// * `PRECISION`: The precision parameter of the HyperLogLog counter.
/// * `BITS`: The number of bits used for each register in the HyperLogLog counter.
///
/// # Constraints
/// The visitor requires the following constraints:
///
/// * The precision and bits parameters must satisfy the condition `[(); ceil(1 << PRECISION, 32 / BITS)]:`.
///
/// # Associated Types
///
/// * `Value`: The type of the resulting fixed-size array.
///
/// # Methods
///
/// ## expecting
///
/// Sets the error message for the expectation of an array of HLL.
///
/// ### Arguments
///
/// * `formatter`: A mutable reference to the formatter used to format the error message.
///
/// ### Returns
/// A `std::fmt::Result` indicating the success or failure of the formatting operation.
///
/// ## visit_seq
/// Processes the deserialized sequence and converts it into a fixed-size array of HLL values.
///
/// ### Arguments
/// * `seq`: The sequence access object used to iterate over the deserialized elements.
///
/// ### Returns
/// The resulting fixed-size array of u32 values, or an error if the deserialization failed.
impl<'de, const PRECISION: usize, const BITS: usize, const N: usize> Visitor<'de>
for HLLArrayVisitor<PRECISION, BITS, N>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
type Value = [HyperLogLog<PRECISION, BITS>; N];
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("an array of HLL")
}
fn visit_seq<A: serde::de::SeqAccess<'de>>(self, mut seq: A) -> Result<Self::Value, A::Error> {
let mut hll_array = [HyperLogLog::new(); N];
let mut hll_array_iter = hll_array.iter_mut();
while let Some(value) = seq.next_element()? {
if let Some(target) = hll_array_iter.next() {
*target = value;
} else {
return Err(serde::de::Error::invalid_length(hll_array.len(), &self));
}
}
Ok(hll_array)
}
}
impl<const PRECISION: usize, const BITS: usize> Serialize for HyperLogLog<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Serializes the HyperLogLog counter using the given serializer.
///
/// This method is part of the `Serialize` trait implementation for the HyperLogLog struct,
/// allowing the counter to be serialized into a format supported by the serializer.
///
/// # Arguments
/// * `serializer`: The serializer used to serialize the HyperLogLog counter.
///
/// # Returns
/// The serialization result, indicating success or failure.
///
/// # Example
///
/// ```
/// use serde::Serialize;
/// use serde_json::Serializer;
/// use hyperloglog_rs::HyperLogLog;
///
/// let hll = HyperLogLog::<12, 6>::new();
/// let mut serializer = Serializer::new(Vec::new());
/// let result = hll.serialize(&mut serializer);
/// assert!(result.is_ok(), "Serialization failed, error: {:?}", result.err());
/// ```
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
let mut seq = serializer.serialize_seq(Some(self.words.len()))?;
for word in self.words {
seq.serialize_element(&word)?;
}
seq.end()
}
}
impl<'de, const PRECISION: usize, const BITS: usize> Deserialize<'de>
for HyperLogLog<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
#[inline(always)]
/// Deserializes the HyperLogLog counter using the given deserializer.
///
/// This method is part of the `Deserialize` trait implementation for the HyperLogLog struct,
/// allowing the counter to be deserialized from a format supported by the deserializer.
///
/// # Arguments
/// * `deserializer`: The deserializer used to deserialize the HyperLogLog counter.
///
/// # Returns
/// The deserialization result, indicating success or failure.
///
/// # Example
///
/// ```
/// #![feature(generic_const_exprs)]
/// use serde::de::Deserialize;
/// use serde_json::Deserializer;
/// use hyperloglog_rs::HyperLogLog;
///
/// let words = [0, 0, 0, 0, 5, 0, 4, 0, 0, 3, 0, 0, 0];
/// let words_str = "[0, 0, 0, 0, 5, 0, 4, 0, 0, 3, 0, 0, 0]";
/// let mut deserializer = Deserializer::from_str(words_str);
/// let result = HyperLogLog::<6, 6>::deserialize(&mut deserializer);
/// assert!(result.is_ok(), "Deserialization failed, error: {:?}", result.err());
/// let hll = result.unwrap();
/// hll.get_words().iter().zip(words.iter()).for_each(|(a, b)| assert_eq!(a, b, "Deserialized words do not match, expected: {}, actual: {}", b, a));
/// ```
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error> {
let mut hll = Self {
words: deserializer.deserialize_seq(U32ArrayVisitor)?,
number_of_zero_register: 0,
};
hll.number_of_zero_register = hll.iter().filter(|®ister| register == 0).count();
Ok(hll)
}
}
#[derive(Default)]
/// Struct to deserialize a vector of u32
pub struct U32ArrayVisitor<const PRECISION: usize, const BITS: usize>;
/// A visitor implementation used for deserializing an array of u32 into a fixed-size array.
///
/// This visitor is used internally by the `serde` deserialization process for the HyperLogLog struct.
/// It converts the deserialized sequence of u32 values into a fixed-size array.
///
/// # Generic Parameters
///
/// * `'de`: Lifetime specifier for the deserialization process.
/// * `PRECISION`: The precision parameter of the HyperLogLog counter.
/// * `BITS`: The number of bits used for each register in the HyperLogLog counter.
///
/// # Constraints
/// The visitor requires the following constraints:
///
/// * The precision and bits parameters must satisfy the condition `[(); ceil(1 << PRECISION, 32 / BITS)]:`.
///
/// # Associated Types
///
/// * `Value`: The type of the resulting fixed-size array.
///
/// # Methods
///
/// ## expecting
///
/// Sets the error message for the expectation of an array of u32.
///
/// ### Arguments
///
/// * `formatter`: A mutable reference to the formatter used to format the error message.
///
/// ### Returns
/// A `std::fmt::Result` indicating the success or failure of the formatting operation.
///
/// ## visit_seq
/// Processes the deserialized sequence and converts it into a fixed-size array of u32 values.
///
/// ### Arguments
/// * `seq`: The sequence access object used to iterate over the deserialized elements.
///
/// ### Returns
/// The resulting fixed-size array of u32 values, or an error if the deserialization failed.
impl<'de, const PRECISION: usize, const BITS: usize> Visitor<'de>
for U32ArrayVisitor<PRECISION, BITS>
where
[(); ceil(1 << PRECISION, 32 / BITS)]:,
{
type Value = [u32; ceil(1 << PRECISION, 32 / BITS)];
fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
formatter.write_str("an array of u32")
}
fn visit_seq<A: serde::de::SeqAccess<'de>>(self, mut seq: A) -> Result<Self::Value, A::Error> {
let mut words_array = [0; ceil(1 << PRECISION, 32 / BITS)];
let mut words_array_iter = words_array.iter_mut();
while let Some(value) = seq.next_element()? {
if let Some(target) = words_array_iter.next() {
*target = value;
} else {
return Err(serde::de::Error::invalid_length(words_array.len(), &self));
}
}
Ok(words_array)
}
}