Struct tdigest_ch::TDigestBuilder

pub struct TDigestBuilder { /* private fields */ }

A TDigestBuilder can be used to create a TDigest with custom configuration.

Examples

use tdigest_ch::TDigestBuilder;

let mut builder = TDigestBuilder::new();
builder.max_centroids(1024);
builder.max_unmerged(1024);

let digest = builder.build();

Implementations

impl TDigestBuilder

pub fn new() -> Self

Constructs a new TDigestBuilder.

This is the same as TDigest::builder().

pub fn build(self) -> TDigest

Returns a TDigest that uses this TDigestBuilder configuration.

pub fn epsilon(&mut self, epsilon: f32) -> &mut Self

Sets the compression parameter of the TDigest. Defaults to 0.01.

pub fn max_centroids(&mut self, max_centroids: usize) -> &mut Self

Sets the maximum number of centroids that the TDigest will store. Defaults to 2048.

pub fn max_unmerged(&mut self, max_unmerged: usize) -> &mut Self

Sets the maximum number of unmerged centroids that the TDigest will store. Defaults to 2048.

Trait Implementations

impl Debug for TDigestBuilder

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

Formats the value using the given formatter.

impl Default for TDigestBuilder

fn default() -> Self

Returns the “default value” for a type.