Struct Centroid 

pub struct Centroid {
    pub mean: f64,
    pub weight: f64,
}

Represents a centroid in the t-digest, which holds a mean value and an associated weight.

Examples

use tdigests::Centroid;

let centroid = Centroid::new(10.0, 5.0);
assert_eq!(centroid.mean, 10.0);
assert_eq!(centroid.weight, 5.0);

Fields

mean: f64

The mean value of the centroid.

weight: f64

The weight (number of observations) associated with the centroid.

Implementations

impl Centroid

pub fn new(mean: f64, weight: f64) -> Self

Creates a new centroid with the given mean and weight.

pub fn add(&mut self, other: &Centroid)

Adds another centroid to this one, updating the mean and weight.

Examples

use tdigests::Centroid;

let mut c1 = Centroid::new(10.0, 2.0);
let c2 = Centroid::new(20.0, 3.0);
c1.add(&c2);
assert_eq!(c1.mean, 16.0);
assert_eq!(c1.weight, 5.0);

Trait Implementations

impl Clone for Centroid

fn clone(&self) -> Centroid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Centroid

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

Formats the value using the given formatter.

impl PartialEq for Centroid

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for Centroid