Struct Depletion 

pub struct Depletion { /* private fields */ }

Predicts how soon a falling level will reach a threshold.

This is the primitive behind “warn before a tank runs dry”. Feed it successive level readings and it estimates how many more samples remain before the level reaches a low mark, so an alert can fire with time to act on it. The technique one layer down is a linear extrapolation of the most recent rate of fall, so it reacts to noise and pairs well with a Smoother on the input.

Examples

use pamoja_kit::Depletion;

let mut tank = Depletion::new(0.0);
assert_eq!(tank.update(10.0), None); // first reading: no rate is known yet
assert_eq!(tank.update(8.0), Some(4)); // falling 2 per sample, 4 until empty

Implementations

impl Depletion

pub fn new(threshold: f32) -> Self

Creates a predictor that warns as the level approaches threshold.

Arguments

• threshold - the low level to predict reaching, such as an empty tank.

Returns

A predictor awaiting its first two readings.

pub fn update(&mut self, level: f32) -> Option<u32>

Records a reading and estimates the samples until the threshold is reached.

Arguments

• level - the latest measured level.

Returns

Some(0) if the level is already at or below the threshold; Some(n) for the estimated number of samples until it is reached at the current rate of fall; or None if the level is steady or rising, or if this is the first reading and no rate is known yet.

Trait Implementations

impl Clone for Depletion

fn clone(&self) -> Depletion

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Depletion

impl Debug for Depletion

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

Formats the value using the given formatter.

impl PartialEq for Depletion

fn eq(&self, other: &Depletion) -> 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 Depletion