Skip to main content

HalfSpaceTree

Struct HalfSpaceTree 

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

A Half-Space Trees ensemble for streaming anomaly detection.

§Example

use irithyll::anomaly::hst::{HalfSpaceTree, HSTConfig};

let config = HSTConfig::new(3).n_trees(25).window_size(100);
let mut hst = HalfSpaceTree::new(config);

// Feed normal data to build a reference profile
for i in 0..200 {
    let features = vec![i as f64 * 0.01, 0.5, 0.3];
    hst.update(&features);
}

// Score a point
let result = hst.score(&[0.5, 0.5, 0.3]);
println!("anomaly score: {:.3}, is_anomaly: {}", result.score, result.is_anomaly);

Implementations§

Source§

impl HalfSpaceTree

Source

pub fn new(config: HSTConfig) -> Self

Create a new Half-Space Tree ensemble.

Source

pub fn with_ranges(config: HSTConfig, ranges: &[(f64, f64)]) -> Self

Create a new ensemble with explicit working ranges per feature.

ranges should contain (min, max) for each feature dimension. This improves partitioning quality when feature ranges are known.

Source

pub fn update(&mut self, features: &[f64])

Feed a sample to the ensemble, updating mass profiles.

When window_size samples have been seen, the latest profile rotates to become the reference and counting restarts.

Source

pub fn score(&self, features: &[f64]) -> AnomalyScore

Score a sample for anomalousness.

Returns an AnomalyScore with a normalized score in [0, 1] (inverted so higher = more anomalous) and an is_anomaly flag.

Source

pub fn score_and_update(&mut self, features: &[f64]) -> AnomalyScore

Combined update + score in one pass.

The sample is scored BEFORE being incorporated into the mass profile, so the score reflects how anomalous it is relative to past data.

Source

pub fn reset(&mut self)

Reset all mass profiles to zero.

Source

pub fn samples_seen(&self) -> u64

Total samples processed.

Source

pub fn windows_completed(&self) -> u64

Number of complete window rotations performed.

Source

pub fn threshold(&self) -> f64

The configured threshold.

Trait Implementations§

Source§

impl Clone for HalfSpaceTree

Source§

fn clone(&self) -> HalfSpaceTree

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HalfSpaceTree

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

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,