Skip to main content

EwmaDetector

Struct EwmaDetector 

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

EWMA-based anomaly detector

Uses exponentially weighted moving average and standard deviation for change point detection and anomaly flagging.

§Example

use alice_physics::anomaly::EwmaDetector;

let mut detector = EwmaDetector::new(0.1, 3.0);

// Feed normal values
for v in [10.0, 10.5, 9.5, 10.2, 9.8, 10.1] {
    detector.observe(v);
}

// Check for anomalies
assert!(!detector.is_anomaly(10.0));
assert!(detector.is_anomaly(50.0));

Implementations§

Source§

impl EwmaDetector

Source

pub fn new(alpha: f64, threshold_k: f64) -> Self

Create a new EWMA detector

§Arguments
  • alpha - Smoothing factor (0.0-1.0, higher = more reactive)
  • threshold_k - Number of standard deviations for anomaly threshold (a negative value is taken as 0)
Source

pub fn observe(&mut self, value: f64)

Observe a new value and update statistics

NaN is rejected: it is not counted and does not touch ewma / ewma_var, since a NaN sample would otherwise poison the running state for the life of the detector (every subsequent comparison against a NaN ewma is false, so the detector would silently stop flagging anything until Self::reset).

Source

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

Check if a value is an anomaly (without updating)

Source

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

Get anomaly score (number of standard deviations)

Source

pub const fn ewma(&self) -> f64

Get current EWMA

Source

pub fn std_dev(&self) -> f64

Get current standard deviation estimate

Source

pub const fn alpha(&self) -> f64

Get smoothing factor

Source

pub fn set_alpha(&mut self, alpha: f64)

Set smoothing factor

Source

pub const fn threshold_k(&self) -> f64

Get threshold multiplier

Source

pub fn set_threshold_k(&mut self, k: f64)

Set threshold multiplier

Source

pub const fn count(&self) -> u64

Get count of observations

Source

pub fn reset(&mut self)

Reset the detector

Trait Implementations§

Source§

impl Clone for EwmaDetector

Source§

fn clone(&self) -> Self

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 EwmaDetector

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.