Struct ClippedMean 

pub struct ClippedMean { /* private fields */ }

Exact online mean after clipping each observation to fixed bounds.

Implementations

impl ClippedMean

pub fn new(lower: f64, upper: f64) -> Result<Self, RillError>

Create a clipped mean with finite bounds satisfying lower <= upper.

pub const fn lower(&self) -> f64

Fixed lower clipping bound.

pub const fn upper(&self) -> f64

Fixed upper clipping bound.

pub const fn value(&self) -> f64

Current exact mean of clipped observations, or 0.0 when empty.

Trait Implementations

impl Clone for ClippedMean

fn clone(&self) -> ClippedMean

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClippedMean

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

Formats the value using the given formatter.

impl OnlineStatistic for ClippedMean

fn update(&mut self, value: f64) -> Result<(), RillError>

Update the statistic with a new observation.

fn samples_seen(&self) -> u64

How many observations have been incorporated.

fn reset(&mut self)

Reset the statistic.

impl PartialEq for ClippedMean

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ClippedMean

impl ValidateState for ClippedMean

fn validate_state(&self) -> Result<(), RillError>

Validate the in-memory state of this type.