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 core::{
hash::Hash,
ops::{Index, IndexMut},
};
use crate::prelude::*;
#[repr(transparent)]
#[derive(Debug, Clone, Copy, Eq)]
pub struct HyperLogLogArray<P: Precision + WordType<BITS>, const BITS: usize, const N: usize> {
counters: [HyperLogLog<P, BITS>; N],
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize> PartialEq
for HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Returns true if the HyperLogLogArray is equal to the other HyperLogLogArray.
///
/// # Arguments
/// * `other`: The other HyperLogLogArray to compare to.
///
/// # Returns
/// True if the HyperLogLogArray is equal to the other HyperLogLogArray.
fn eq(&self, other: &Self) -> bool {
self.counters.eq(&other.counters)
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize> Default
for HyperLogLogArray<P, BITS, N>
{
#[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
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::default();
/// ```
fn default() -> Self {
Self {
counters: [HyperLogLog::default(); N],
}
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize>
HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Creates a new HyperLogLogArray with the given precision and number of bits.
///
/// # Example
///
/// ```
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::new();
/// ```
pub fn new() -> Self {
Self {
counters: [HyperLogLog::default(); N],
}
}
#[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 overlap_and_differences_cardinality_matrices<F: Primitive<f32>>(
&self,
other: &Self,
) -> ([[F; N]; N], [F; N], [F; N]) {
HyperLogLog::overlap_and_differences_cardinality_matrices(self.as_ref(), other.as_ref())
}
#[inline(always)]
/// Returns the estimated normalized overlap and difference cardinality matrices and vectors with the provided HyperLogLogArray.
///
/// # Arguments
/// * `other`: The HyperLogLogArray to estimate the normalized overlap and difference cardinality matrices and vectors with.
///
/// # Returns
/// The estimated normalized overlap and difference cardinality matrices and vectors with the provided HyperLogLogArray.
pub fn normalized_overlap_and_differences_cardinality_matrices<F: Primitive<f32>>(
&self,
other: &Self,
) -> ([[F; N]; N], [F; N], [F; N]) {
HyperLogLog::normalized_overlap_and_differences_cardinality_matrices(
self.as_ref(),
other.as_ref(),
)
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize>
AsRef<[HyperLogLog<P, BITS>; N]> for HyperLogLogArray<P, BITS, N>
{
#[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<P, BITS>; N] {
&self.counters
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize>
AsMut<[HyperLogLog<P, BITS>; N]> for HyperLogLogArray<P, BITS, N>
{
#[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<P, BITS>; N] {
&mut self.counters
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize> Index<usize>
for HyperLogLogArray<P, BITS, N>
{
type Output = HyperLogLog<P, 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
/// use hyperloglog_rs::prelude::*;
///
/// let mut hll_array = HyperLogLogArray::<Precision12, 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<P: Precision + WordType<BITS>, const BITS: usize, const N: usize> IndexMut<usize>
for HyperLogLogArray<P, BITS, N>
{
#[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
/// use hyperloglog_rs::prelude::*;
///
/// let mut hll_array = HyperLogLogArray::<Precision12, 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<P: Precision + WordType<BITS>, const BITS: usize, const N: usize>
From<[HyperLogLog<P, BITS>; N]> for HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Creates a new HyperLogLogArray from the given array of HyperLogLog counters.
///
/// # Arguments
/// * `counters`: The array of HyperLogLog counters to create the HyperLogLogArray from.
///
/// # Returns
/// A new HyperLogLogArray from the given array of HyperLogLog counters.
///
/// # Example
///
/// ```rust
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::from([
/// HyperLogLog::default(),
/// HyperLogLog::default(),
/// HyperLogLog::default(),
/// ]);
/// ```
fn from(counters: [HyperLogLog<P, BITS>; N]) -> Self {
Self { counters }
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize, H: Hash> From<&[&[H]; N]>
for HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Creates a new HyperLogLogArray from the given array of vectors of hashable items.
///
/// # Arguments
/// * `items`: The array of vectors of hashable items to create the HyperLogLogArray from.
///
/// # Returns
/// A new HyperLogLogArray from the given array of vectors of hashable items.
///
/// # Example
///
/// ```rust
/// use core::hash::Hash;
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::from(&[
/// [1, 2, 3].as_slice(),
/// [4, 5, 6].as_slice(),
/// [7, 8, 9].as_slice(),
/// ]);
/// ```
fn from(items: &[&[H]; N]) -> Self {
let mut array = [HyperLogLog::default(); N];
for (i, item) in items.iter().enumerate() {
for item in item.iter() {
array[i].insert(item);
}
}
Self { counters: array }
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize> From<&[HyperLogLog<P, BITS>]>
for HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Creates a new HyperLogLogArray from the given vector of HyperLogLog counters.
///
/// # Arguments
/// * `counters`: The vector of HyperLogLog counters to create the HyperLogLogArray from.
///
/// # Returns
/// A new HyperLogLogArray from the given vector of HyperLogLog counters.
///
/// # Example
///
/// ```rust
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::from(vec![
/// HyperLogLog::default(),
/// HyperLogLog::default(),
/// HyperLogLog::default(),
/// ].as_slice());
/// ```
fn from(counters: &[HyperLogLog<P, BITS>]) -> Self {
assert_eq!(counters.len(), N, concat!(
"The length of the vector of HyperLogLog counters must be equal to the number of counters ",
"in the HyperLogLogArray."
));
let mut array = [HyperLogLog::default(); N];
array.copy_from_slice(&counters[..N]);
Self { counters: array }
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize, H: Hash> From<&[&[H]]>
for HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Creates a new HyperLogLogArray from the given vector of vectors of hashable items.
///
/// # Arguments
/// * `items`: The vector of vectors of hashable items to create the HyperLogLogArray from.
///
/// # Returns
/// A new HyperLogLogArray from the given vector of vectors of hashable items.
///
/// # Example
///
/// ```rust
/// use core::hash::Hash;
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::from(&[
/// [1, 2, 3].as_slice(),
/// [4, 5, 6].as_slice(),
/// [7, 8, 9].as_slice(),
/// ]);
/// ```
fn from(items: &[&[H]]) -> Self {
assert_eq!(items.len(), N, concat!(
"The length of the vector of vectors of hashable items must be equal to the number of counters ",
"in the HyperLogLogArray."
));
let mut array = [HyperLogLog::default(); N];
for (i, item) in items.iter().enumerate() {
for item in item.iter() {
array[i].insert(item);
}
}
Self { counters: array }
}
}
impl<P: Precision + WordType<BITS>, const BITS: usize, const N: usize, H: Hash> From<[&[H]; N]>
for HyperLogLogArray<P, BITS, N>
{
#[inline(always)]
/// Creates a new HyperLogLogArray from the given array of vectors of hashable items.
///
/// # Arguments
/// * `items`: The array of vectors of hashable items to create the HyperLogLogArray from.
///
/// # Returns
/// A new HyperLogLogArray from the given array of vectors of hashable items.
///
/// # Example
///
/// ```rust
/// use core::hash::Hash;
/// use hyperloglog_rs::prelude::*;
///
/// let hll_array = HyperLogLogArray::<Precision12, 6, 3>::from([
/// vec![1_usize, 2, 3].as_slice(),
/// vec![4, 5, 6].as_slice(),
/// vec![7, 8, 9].as_slice(),
/// ]);
/// ```
fn from(items: [&[H]; N]) -> Self {
let mut array = [HyperLogLog::default(); N];
for (i, item) in items.iter().enumerate() {
for item in item.iter() {
array[i].insert(item);
}
}
Self { counters: array }
}
}