pub mod algo;
pub mod core;
pub mod dense;
pub mod meta;
pub mod sparse;
pub use algo::{
HLL_ALPHA_INF, HLL_DENSE_SIZE, HLL_HASH_BIT_COUNT, HLL_HASH_SEED, HLL_REGISTER_BITS,
HLL_REGISTER_COUNT_MASK, HLL_REGISTER_COUNT_POW, HLL_REGISTER_MAX, HLL_REGISTERS,
HLL_SEGMENT_BYTES, HLL_SEGMENT_COUNT, HLL_SEGMENT_REGISTERS, extract_dense_hll_result,
hll_estimate_from_histo, hll_murmur_hash_64a, hll_sigma, hll_tau, murmur_hash_64a, rapid_hash,
};
pub use core::HyperLogLog;
pub use dense::{
dense_estimate, get_register, hll_dense_estimate, hll_dense_estimate_segments,
hll_dense_get_register, hll_dense_reg_histo, hll_dense_set_register, hll_merge_bytes,
hll_merge_segments, set_register,
};
pub use meta::{HllEncodeType, HyperLogLogMeta};
pub use sparse::{
HLL_SPARSE_MAX_BYTES, HLL_SPARSE_VAL_MAX_LEN, HLL_SPARSE_VAL_MAX_VALUE,
HLL_SPARSE_XZERO_MAX_LEN, HLL_SPARSE_ZERO_MAX_LEN, HllSparseOp, decode_sparse_op,
encode_sparse_val, encode_sparse_zero, hll_dense_to_sparse, hll_merge_sparse_into_dense,
hll_sparse_estimate, hll_sparse_get_register, hll_sparse_is_valid, hll_sparse_new,
hll_sparse_reg_histo, hll_sparse_set_register, hll_sparse_to_dense,
};
use crate::db::WeDb;
use crate::error::Result;
use crate::key_composer::{KeyComposer, KeyTag};
use crate::meta::current_now_ms;
use rapidhash::RapidHashSet as HashSet;
#[inline]
fn compose_hll_meta_key(kc: &KeyComposer, key: &[u8]) -> Vec<u8> {
kc.compose_meta_key(KeyTag::HllMeta.as_slice(), key)
}
#[inline]
fn compose_hll_data_key(kc: &KeyComposer, key: &[u8]) -> Vec<u8> {
kc.compose_meta_key(KeyTag::HllRaw.as_slice(), key)
}
impl WeDb {
#[inline]
fn get_hll_meta_checked(
&self,
kc: &KeyComposer<'_>,
k: &[u8],
mk: &[u8],
now: u64,
) -> Result<Option<HyperLogLogMeta>> {
self.get_meta_checked(kc, k, mk, now)
}
pub fn pfadd_ns<K: AsRef<[u8]>, E: AsRef<[u8]>>(
&self,
ns: &str,
key: K,
elements: &[E],
) -> Result<bool> {
let k_bytes = key.as_ref();
let kc = KeyComposer::new(ns);
let meta_k = compose_hll_meta_key(&kc, k_bytes);
let data_k = compose_hll_data_key(&kc, k_bytes);
let now_ms = current_now_ms();
let (mut meta, exists_valid) =
match self.get_hll_meta_checked(&kc, k_bytes, &meta_k, now_ms)? {
Some(meta) => (meta, true),
None => (HyperLogLogMeta::new_with_version(0), false),
};
if elements.is_empty() {
return Ok(false);
}
let mut registers = if exists_valid {
self.data
.get(&data_k)?
.map(|v| v.to_vec())
.unwrap_or_else(|| vec![0u8; HLL_DENSE_SIZE])
} else {
vec![0u8; HLL_DENSE_SIZE]
};
if meta.encode_type == HllEncodeType::Dense && registers.len() < HLL_DENSE_SIZE {
registers.resize(HLL_DENSE_SIZE, 0);
}
let mut updated = false;
for el in elements {
let hash = rapid_hash(el.as_ref());
let (reg_idx, count) = extract_dense_hll_result(hash);
match meta.encode_type {
HllEncodeType::Dense => {
let cur = hll_dense_get_register(®isters, reg_idx);
if count > cur {
hll_dense_set_register(&mut registers, reg_idx, count);
updated = true;
}
}
HllEncodeType::Sparse => {
match hll_sparse_set_register(&mut registers, reg_idx, count) {
Ok(changed) => {
if changed {
updated = true;
}
}
Err(_) => {
let mut dense_buf = vec![0u8; HLL_DENSE_SIZE];
hll_sparse_to_dense(®isters, &mut dense_buf)?;
let cur = hll_dense_get_register(&dense_buf, reg_idx);
if count > cur {
hll_dense_set_register(&mut dense_buf, reg_idx, count);
updated = true;
}
registers = dense_buf;
meta.encode_type = HllEncodeType::Dense;
}
}
}
}
}
if updated {
meta.base.size = registers.len() as u64;
let mut batch = self.db.batch();
batch.insert(&self.data, &data_k, ®isters);
batch.insert(&self.meta, &meta_k, meta.encode());
batch.commit()?;
}
Ok(updated)
}
#[inline]
pub fn pfadd<K: AsRef<[u8]>, E: AsRef<[u8]>>(&self, key: K, elements: &[E]) -> Result<bool> {
self.pfadd_ns("default", key, elements)
}
pub fn pfcount_ns<K: AsRef<[u8]>>(&self, ns: &str, keys: &[K]) -> Result<u64> {
if keys.is_empty() {
return Ok(0);
}
let kc = KeyComposer::new(ns);
let now_ms = current_now_ms();
if keys.len() == 1 {
let k_bytes = keys[0].as_ref();
let meta_k = compose_hll_meta_key(&kc, k_bytes);
let meta = match self.get_hll_meta_checked(&kc, k_bytes, &meta_k, now_ms)? {
Some(meta) => meta,
None => return Ok(0),
};
let data_k = compose_hll_data_key(&kc, k_bytes);
let registers = match self.data.get(&data_k)? {
Some(v) => v,
None => return Ok(0),
};
return match meta.encode_type {
HllEncodeType::Dense => Ok(hll_dense_estimate(®isters)),
HllEncodeType::Sparse => Ok(hll_sparse_estimate(®isters)
.unwrap_or_else(|_| hll_dense_estimate(®isters))),
};
}
let mut seen = HashSet::default();
let mut merged = vec![0u8; HLL_DENSE_SIZE];
let mut has_any = false;
for k in keys {
let k_bytes = k.as_ref();
if !seen.insert(k_bytes) {
continue;
}
let meta_k = compose_hll_meta_key(&kc, k_bytes);
let meta = match self.get_hll_meta_checked(&kc, k_bytes, &meta_k, now_ms)? {
Some(meta) => meta,
None => continue,
};
let data_k = compose_hll_data_key(&kc, k_bytes);
if let Some(reg) = self.data.get(&data_k)? {
match meta.encode_type {
HllEncodeType::Dense => {
hll_merge_bytes(&mut merged, ®);
}
HllEncodeType::Sparse => {
hll_merge_sparse_into_dense(&mut merged, ®);
}
}
has_any = true;
}
}
if !has_any {
return Ok(0);
}
Ok(hll_dense_estimate(&merged))
}
#[inline]
pub fn pfcount<K: AsRef<[u8]>>(&self, keys: &[K]) -> Result<u64> {
self.pfcount_ns("default", keys)
}
pub fn pfmerge_ns<K: AsRef<[u8]>>(&self, ns: &str, dest: K, sources: &[K]) -> Result<()> {
if sources.is_empty() {
return Ok(());
}
let kc = KeyComposer::new(ns);
let dest_bytes = dest.as_ref();
let dest_meta_k = compose_hll_meta_key(&kc, dest_bytes);
let dest_data_k = compose_hll_data_key(&kc, dest_bytes);
let now_ms = current_now_ms();
let (mut dest_meta, dest_valid) =
match self.get_hll_meta_checked(&kc, dest_bytes, &dest_meta_k, now_ms)? {
Some(meta) => (meta, true),
None => (HyperLogLogMeta::new_with_version(0), false),
};
let mut merged = if dest_valid {
let data = self
.data
.get(&dest_data_k)?
.map(|v| v.to_vec())
.unwrap_or_else(|| vec![0u8; HLL_DENSE_SIZE]);
if dest_meta.encode_type == HllEncodeType::Sparse {
let mut dense_buf = vec![0u8; HLL_DENSE_SIZE];
if hll_sparse_to_dense(&data, &mut dense_buf).is_ok() {
dense_buf
} else {
data
}
} else {
data
}
} else {
vec![0u8; HLL_DENSE_SIZE]
};
if merged.len() < HLL_DENSE_SIZE {
merged.resize(HLL_DENSE_SIZE, 0);
}
let mut seen = HashSet::default();
seen.insert(dest_bytes);
for k in sources {
let k_bytes = k.as_ref();
if !seen.insert(k_bytes) {
continue;
}
let meta_k = compose_hll_meta_key(&kc, k_bytes);
let meta = match self.get_hll_meta_checked(&kc, k_bytes, &meta_k, now_ms)? {
Some(meta) => meta,
None => continue,
};
let data_k = compose_hll_data_key(&kc, k_bytes);
if let Some(reg) = self.data.get(&data_k)? {
match meta.encode_type {
HllEncodeType::Dense => {
hll_merge_bytes(&mut merged, ®);
}
HllEncodeType::Sparse => {
hll_merge_sparse_into_dense(&mut merged, ®);
}
}
}
}
dest_meta.base.size = HLL_DENSE_SIZE as u64;
dest_meta.encode_type = HllEncodeType::Dense;
let mut batch = self.db.batch();
batch.insert(&self.data, &dest_data_k, &merged);
batch.insert(&self.meta, &dest_meta_k, dest_meta.encode());
batch.commit()?;
Ok(())
}
#[inline]
pub fn pfmerge<K: AsRef<[u8]>>(&self, dest: K, sources: &[K]) -> Result<()> {
self.pfmerge_ns("default", dest, sources)
}
#[inline]
pub fn pfselftest(&self) -> bool {
HyperLogLog::selftest()
}
}