Skip to main content

Hysteresis

Struct Hysteresis 

Source
pub struct Hysteresis { /* private fields */ }
Expand description

The hysteresis state of one pressure signal.

Deliberately a concrete, inspectable struct rather than a closure or a counter hidden inside the engine: §11.3 calls for hysteresis as behaviour that can be tested, and the tests in this file are what guarantee the radar is stable.

Implementations§

Source§

impl Hysteresis

Source

pub fn new(thresholds: &Thresholds) -> Self

Builds tracker state from sanitized thresholds.

thresholds must already be Thresholds::sanitized; the engine does that once at construction so every tracker inherits a window at least as wide as the sample count it needs.

Source

pub fn observe( &mut self, candidate: PressureState, elapsed: Duration, ) -> MetricState<PressureState>

Feeds one candidate state derived from the current sample.

elapsed is the measured interval since the previous sample (§8.1); it is only used to accumulate Self::held_for, never to decide a state.

Returns MetricState::WarmingUp until sustained_samples observations exist, because below that no sustained claim is possible (§11.3).

Source

pub fn reset(&mut self)

Discards every observation (§11.3: counter reset, sleep/wake).

Source

pub const fn held_for(&self) -> Option<Duration>

How long the current state has been held, once it means anything.

None while warming up: a duration for a state that has not been established would be a fabricated number.

Source

pub const fn state(&self) -> Option<PressureState>

The state currently held, or None while warming up.

Source

pub fn observations(&self) -> usize

How many observations are retained.

Source

pub fn remaining_samples(&self) -> usize

How many observations are still needed before a state can be derived.

Trait Implementations§

Source§

impl Clone for Hysteresis

Source§

fn clone(&self) -> Hysteresis

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Hysteresis

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.