Struct sketches_ddsketch::Config

pub struct Config {
    pub max_num_bins: u32,
    pub gamma: f64,
    pub offset: i32,
    /* private fields */
}

The configuration struct for constructing a DDSketch

Fields

max_num_bins: u32

gamma: f64

offset: i32

Implementations

impl Config

pub fn new(alpha: f64, max_num_bins: u32, min_value: f64) -> Self

Construct a new Config struct with specific parameters. If you are unsure of how to configure this, the defaults method constructs a Config with built-in defaults.

max_num_bins is the max number of bins the DDSketch will grow to, in steps of 128 bins.

pub fn defaults() -> Self

Return a Config using built-in default settings

pub fn key(&self, v: f64) -> i32

pub fn value(&self, key: i32) -> f64

pub fn log_gamma(&self, value: f64) -> f64

pub fn pow_gamma(&self, key: i32) -> f64

pub fn min_possible(&self) -> f64

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Config

impl StructuralPartialEq for Config