Skip to main content

Adwin

Struct Adwin 

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

ADWIN (Adaptive Windowing) drift detector.

Maintains a variable-length window and detects distribution changes by comparing the means of the window’s two halves. See the module documentation for the algorithm.

§Examples

use rill_ml::drift::{Adwin, DriftDetector, DriftLevel};

let mut adwin = Adwin::default();

// Stable stream.
for _ in 0..100 {
    adwin.update(0.0).unwrap();
}
assert_eq!(adwin.level(), DriftLevel::None);

// Sudden shift. ADWIN's level is transient: after detecting drift and
// trimming the window, subsequent stable updates reset the level to
// None, so we check the level returned by each update.
let mut detected = false;
for _ in 0..100 {
    let level = adwin.update(5.0).unwrap();
    if level == DriftLevel::Drift {
        detected = true;
        break;
    }
}
assert!(detected);

Implementations§

Source§

impl Adwin

Source

pub fn new(config: AdwinConfig) -> Result<Self, RillError>

Create a new ADWIN detector with the given configuration.

Returns an error if:

  • delta is not in (0, 1).
  • warning_delta is not in (0, 1) or is less than delta.
  • max_window is zero.
  • min_samples is zero.
Source

pub fn window_size(&self) -> usize

The number of values currently in the window.

Source

pub fn window_mean(&self) -> f64

The mean of all values currently in the window, or 0.0 if empty.

Source

pub const fn config(&self) -> &AdwinConfig

The configuration of this detector.

Trait Implementations§

Source§

impl Clone for Adwin

Source§

fn clone(&self) -> Adwin

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 Adwin

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Adwin

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl DriftDetector for Adwin

Source§

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

Update the detector with a new scalar observation. Read more
Source§

fn detected(&self) -> bool

Returns true if the detector currently reports a confirmed drift.
Source§

fn warning(&self) -> bool

Returns true if the detector currently reports a warning.
Source§

fn level(&self) -> DriftLevel

The current drift level.
Source§

fn samples_seen(&self) -> u64

Number of observations incorporated so far.
Source§

fn reset(&mut self)

Reset the detector to its initial (no-data) state.
Source§

fn last_value(&self) -> f64

The detector-specific statistic value from the last update. Read more

Auto Trait Implementations§

§

impl Freeze for Adwin

§

impl RefUnwindSafe for Adwin

§

impl Send for Adwin

§

impl Sync for Adwin

§

impl Unpin for Adwin

§

impl UnsafeUnpin for Adwin

§

impl UnwindSafe for Adwin

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V