Struct TimeHistogram 

pub struct TimeHistogram { /* private fields */ }

Number of messages per time.

Implementations

impl TimeHistogram

pub fn new(timeline: Timeline) -> Self

pub fn timeline(&self) -> Timeline

pub fn num_events(&self) -> u64

pub fn insert(&mut self, time: TimeInt, count: u64)

pub fn increment(&mut self, time: i64, n: u32)

pub fn decrement(&mut self, time: i64, n: u32)

pub fn min_opt(&self) -> Option<TimeInt>

pub fn min(&self) -> TimeInt

pub fn max_opt(&self) -> Option<TimeInt>

pub fn max(&self) -> TimeInt

pub fn full_range(&self) -> AbsoluteTimeRange

pub fn step_fwd_time(&self, time: TimeReal) -> TimeInt

pub fn step_back_time(&self, time: TimeReal) -> TimeInt

pub fn step_fwd_time_looped( &self, time: TimeReal, loop_range: &AbsoluteTimeRangeF, ) -> TimeReal

pub fn step_back_time_looped( &self, time: TimeReal, loop_range: &AbsoluteTimeRangeF, ) -> TimeReal

Methods from Deref<Target = Int64Histogram>

pub fn is_empty(&self) -> bool

Is the total count zero?

Note that incrementing a key with zero is a no-op and will leave an empty histogram still empty.

pub fn total_count(&self) -> u64

Total count of all the buckets.

NOTE: this is NOT the number of unique keys.

pub fn min_key(&self) -> Option<i64>

Lowest key with a non-zero count.

pub fn max_key(&self) -> Option<i64>

Highest key with a non-zero count.

pub fn range_count(&self, range: impl RangeBounds<i64>) -> u64

What is the count of all the buckets in the given range?

pub fn range(&self, range: impl RangeBounds<i64>, cutoff_size: u64) -> Iter<'_>

Iterate over a certain range, returning ranges that are at most cutoff_size long.

To get all individual entries, use cutoff_size<=1.

When cutoff_size > 1 you MAY get ranges which include keys that has no count. However, the ends (min/max) of all returned ranges will be keys with a non-zero count.

In other words, gaps in the key-space smaller than cutoff_size MAY be ignored by this iterator.

For example, inserting two elements at 10 and 15 and setting a cutoff_size=10 you may get a single range [10, 15] with the total count. You may also get two ranges of [10, 10] and [15, 15].

A larger cutoff_size will generally yield fewer ranges, and will be faster.

pub fn next_key_after(&self, time: i64) -> Option<i64>

Find the next key greater than the given time.

If found, returns that key. Otherwise wraps around and returns the minimum key. Returns None only if the histogram is empty.

pub fn prev_key_before(&self, time: i64) -> Option<i64>

Find the previous key less than the given time.

If found, returns that key. Otherwise wraps around and returns the maximum key. Returns None only if the histogram is empty.

Trait Implementations

impl Clone for TimeHistogram

fn clone(&self) -> TimeHistogram

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Deref for TimeHistogram

type Target = Int64Histogram

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.