Skip to main content

ShardedCountMinSketch

Struct ShardedCountMinSketch 

Source
pub struct ShardedCountMinSketch { /* private fields */ }
Expand description

A CountMinSketch split into SHARDS independently locked pieces on one node-wide aging clock.

Every counter a given key touches lives in one shard, so an increment or an estimate takes exactly one shard lock and reads or writes ROWS counters. Halving is per shard and lazy: the shard is aged on its next touch by the number of node-wide windows that have elapsed since it last caught up. So the work is 1 / SHARDS of the array under one lock, while every counter is caught up to the node-wide clock at the moment it is read. A ranking pass reads each candidate separately, so it carries one halving of skew for every window boundary it crosses. A halving applied evenly across a pass cannot invert the ranking — it only creates ties — but candidates read on opposite sides of a boundary can misorder, and two whose estimates are within a factor of two can swap. The window is cols * 10 observations, so a sweep crossing even one boundary is already the uncommon case, and the next sweep re-reads both on one side of it.

The interior mutability is deliberate — the frequency estimator is shared by every serve completion and every fill-path admission read, so both take &self and neither can serialize on a single process-wide lock.

Implementations§

Source§

impl ShardedCountMinSketch

Source

pub fn new(cols: usize) -> Self

Build a sketch of cols total columns per row, spread over SHARDS shards. The per-shard width rounds up, so the realized total is at least cols.

A cols below SHARDS yields one shard per column, which is a degenerate sketch rather than a smaller one: at cols <= SHARDS every shard is one column wide, so all ROWS rows of a shard index the same counter and the min-over-rows stops discriminating between keys that share a shard. Callers wanting a small sketch should floor cols well above SHARDS, as super::tinylfu::TinyLfuEstimator::new does.

Source

pub fn increment(&self, key: &Hash)

Count one sighting of key, locking only its shard.

A poisoned shard recovers its inner sketch: the counters are approximate popularity evidence, and refusing to count into a shard would silently freeze the frequency of every key routed to it.

Source

pub fn estimate(&self, key: &Hash) -> u8

The count-min estimate for key, locking only its shard. An absent shard (only reachable from an empty sketch) reads as never seen.

Reading ages the shard too: a key in a shard that has seen no traffic for several windows must not read back at the value it held before those windows elapsed, or a cold key would outrank a warm one.

Trait Implementations§

Source§

impl Debug for ShardedCountMinSketch

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more