Skip to main content

TDigest

Struct TDigest 

Source
pub struct TDigest {
    pub min: f64,
    pub max: f64,
    /* private fields */
}
Expand description

A t-digest for approximate quantile estimation over streaming data.

§Construction

use oximedia_analytics::quantile::TDigest;
let mut digest = TDigest::new(100.0);
for x in 0..1000 {
    digest.add(x as f64);
}
let p50 = digest.quantile(0.5).unwrap();

Fields§

§min: f64

Running min and max.

§max: f64

Implementations§

Source§

impl TDigest

Source

pub fn new(delta: f64) -> Self

Create a new t-digest with the given compression parameter.

Typical values: delta = 100 (moderate accuracy, few centroids) to delta = 1000 (high accuracy, more centroids).

Source

pub fn add(&mut self, value: f64)

Add a single data point with weight 1.

Source

pub fn add_weighted(&mut self, value: f64, weight: f64)

Add a data point with an explicit weight.

Source

pub fn add_all(&mut self, values: &[f64])

Add all values from a slice.

Source

pub fn merge(&mut self, other: &TDigest)

Merge another t-digest into this one.

Source

pub fn quantile(&mut self, q: f64) -> Result<f64, AnalyticsError>

Estimate the value at quantile q ∈ [0, 1].

Returns an error if the digest has no data or q is out of range.

Source

pub fn centroid_count(&self) -> usize

Number of centroids (compactness measure).

Source

pub fn total_weight(&self) -> f64

Total weight (number of points added, including buffered).

Trait Implementations§

Source§

impl Clone for TDigest

Source§

fn clone(&self) -> TDigest

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 Debug for TDigest

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> 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> 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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.