Skip to main content

SortedView

Struct SortedView 

Source
pub struct SortedView<T> { /* private fields */ }
Available on crate feature req only.
Expand description

An owned, sorted snapshot of a ReqSketch.

Obtain one with ReqSketch::sorted_view. The view is independent of the sketch: it can be queried (and sent to other threads) while the sketch keeps receiving updates, and it keeps answering from the state it was taken at. Building it costs O(retained · log retained); each subsequent query is O(log retained), so it is the right tool for repeated quantile/rank queries.

Implementations§

Source§

impl<T> SortedView<T>
where T: Clone + Ord,

Source

pub fn is_empty(&self) -> bool

Returns true if the sorted view is empty.

Source

pub fn len(&self) -> usize

Returns the number of distinct items in the sorted view.

Source

pub fn total_weight(&self) -> u64

Returns the total weight (stream length captured) of all items.

Source

pub fn rank(&self, item: &T, criteria: SearchCriteria) -> Result<f64, Error>

Returns the approximate normalized rank of item in [0.0, 1.0].

§Errors

Returns an error if the view is empty.

Source

pub fn quantile(&self, rank: f64, criteria: SearchCriteria) -> Result<T, Error>

Returns the approximate quantile at the given normalized rank.

§Errors

Returns an error if the view is empty or rank is outside [0.0, 1.0].

Source

pub fn pmf( &self, split_points: &[T], criteria: SearchCriteria, ) -> Result<Vec<f64>, Error>

Returns the probability mass function (PMF) over the given split points.

The result contains one more value than split_points.

§Errors

Returns an error if the view is empty or the split points are not strictly increasing.

Source

pub fn cdf( &self, split_points: &[T], criteria: SearchCriteria, ) -> Result<Vec<f64>, Error>

Returns the cumulative distribution function (CDF) over the given split points.

The result contains one more value than split_points and ends at 1.0.

§Errors

Returns an error if the view is empty or the split points are not strictly increasing.

Trait Implementations§

Source§

impl<T: Clone> Clone for SortedView<T>

Source§

fn clone(&self) -> SortedView<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for SortedView<T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for SortedView<T>
where Vec<T>: Freeze,

§

impl<T> RefUnwindSafe for SortedView<T>
where Vec<T>: RefUnwindSafe,

§

impl<T> Send for SortedView<T>
where Vec<T>: Send,

§

impl<T> Sync for SortedView<T>
where Vec<T>: Sync,

§

impl<T> Unpin for SortedView<T>
where Vec<T>: Unpin,

§

impl<T> UnsafeUnpin for SortedView<T>
where Vec<T>: UnsafeUnpin,

§

impl<T> UnwindSafe for SortedView<T>
where Vec<T>: UnwindSafe,

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.