Skip to main content

TDigest

Struct TDigest 

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

A digest of a distribution of numbers, for its quantiles: it keeps roughly compression centroids, and buffers up to eight times as many values between merges.

Reading it (quantile, count, to_json, …) merges the buffered values first, as in JS, so those take &self.

Implementations§

Source§

impl TDigest

Source

pub fn new(compression: f64) -> Self

An empty digest. JS’s default compression, 100, keeps p50, p95 and p99 within about 0.5%.

Source

pub fn from_json(data: &[f64]) -> Result<Self, String>

The digest of its JSON form, [compression, mean, weight, ...] (TDigest.fromJSON).

Source

pub fn from_json_value(v: &Value) -> Result<Self, String>

from_json of a JSON value: an array of numbers.

Source

pub fn compression(&self) -> f64

The compression the digest was made with.

Source

pub fn reset(&mut self)

Empties the digest.

Source

pub fn add(&mut self, mean: f64, weight: f64)

Adds a value with a weight (1 in JS by default). A weight that isn’t positive and finite is ignored, as is a NaN mean.

Source

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

Adds each of other’s centroids (merge).

Source

pub fn centroids(&self) -> Vec<(f64, f64)>

The processed centroids, as (mean, weight), ascending.

Source

pub fn count(&self) -> f64

The total weight of the values added.

Source

pub fn to_vec(&self) -> Vec<f64>

The JSON form, [compression, mean, weight, ...] (toJSON).

Source

pub fn to_json(&self) -> Value

to_vec as a JSON value.

Source

pub fn quantile(&self, q: f64) -> f64

The (approximate) value at quantile q, between 0 and 1. NaN when the digest is empty or q is out of range.

Source

pub fn cdf(&self, x: f64) -> f64

The (approximate) fraction of the values at or below x.

Trait Implementations§

Source§

impl Clone for TDigest

Source§

fn clone(&self) -> Self

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
Source§

impl Default for TDigest

Source§

fn default() -> Self

A digest of compression 100, JS’s default.

Source§

impl PartialEq for TDigest

Source§

fn eq(&self, other: &Self) -> bool

Digests are equal when their JSON forms are.

1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. 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> Same for T

Source§

type Output = T

Should always be Self
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.