IsolationForest

Struct IsolationForest 

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

Isolation Forest for anomaly detection.

Uses an ensemble of isolation trees to detect outliers based on path length. Anomalies are easier to isolate (shorter paths) than normal points.

§Algorithm

  1. Build N isolation trees on random subsamples
  2. Each tree recursively splits data by random feature + random threshold
  3. Compute average path length across all trees
  4. Convert to anomaly score (shorter path = more anomalous)
  5. Use contamination parameter to set classification threshold

§Examples

use aprender::prelude::*;

let data = Matrix::from_vec(
    6,
    2,
    vec![
        2.0, 2.0, 2.1, 2.0, 1.9, 2.1, 2.0, 1.9,  // Normal
        10.0, 10.0, -10.0, -10.0,                 // Outliers
    ],
)
.expect("Valid matrix dimensions and data length");

let mut iforest = IsolationForest::new()
    .with_contamination(0.3)
    .with_random_state(42);
iforest.fit(&data).expect("Fit succeeds with valid data");

// Predict returns 1 for normal, -1 for anomaly
let predictions = iforest.predict(&data);

// score_samples returns anomaly scores (lower = more anomalous)
let scores = iforest.score_samples(&data);

§Performance

  • Time complexity: O(n log m) where n=samples, m=max_samples
  • Space complexity: O(t * m) where t=n_estimators

Implementations§

Source§

impl IsolationForest

Source

pub fn new() -> Self

Create a new Isolation Forest with default parameters.

Default: 100 trees, auto max_samples, 0.1 contamination

Source

pub fn with_n_estimators(self, n_estimators: usize) -> Self

Set the number of trees in the ensemble.

Source

pub fn with_max_samples(self, max_samples: usize) -> Self

Set the number of samples to draw for each tree.

Source

pub fn with_contamination(self, contamination: f32) -> Self

Set the expected proportion of anomalies (0 to 0.5).

Source

pub fn with_random_state(self, seed: u64) -> Self

Set random seed for reproducibility.

Source

pub fn is_fitted(&self) -> bool

Check if model has been fitted.

Source

pub fn fit(&mut self, x: &Matrix<f32>) -> Result<()>

Fit the Isolation Forest on training data.

Source

pub fn score_samples(&self, x: &Matrix<f32>) -> Vec<f32>

Compute anomaly scores for samples.

Returns a vector of scores where lower scores indicate higher anomaly likelihood.

Source

pub fn predict(&self, x: &Matrix<f32>) -> Vec<i32>

Predict anomaly labels for samples.

Returns 1 for normal points and -1 for anomalies.

Trait Implementations§

Source§

impl Clone for IsolationForest

Source§

fn clone(&self) -> IsolationForest

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 IsolationForest

Source§

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

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

impl Default for IsolationForest

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for IsolationForest

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for IsolationForest

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. 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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,