Struct IsolationForest 

pub struct IsolationForest<F> {
    pub n_estimators: usize,
    pub max_samples: usize,
    pub contamination: f64,
    pub random_state: Option<u64>,
    /* private fields */
}

Isolation forest anomaly detector.

Builds an ensemble of isolation trees, each trained on a random subsample. Anomaly scores are derived from the average path length: points that are isolated in fewer splits are more anomalous.

Type Parameters

• F: The floating-point type (f32 or f64).

Fields

n_estimators: usize

Number of isolation trees in the forest.

max_samples: usize

Number of samples to draw for each tree.

contamination: f64

Proportion of anomalies in the dataset, used to set the decision threshold.

random_state: Option<u64>

Random seed for reproducibility. None means non-deterministic.

Implementations

impl<F: Float> IsolationForest<F>

pub fn new() -> Self

Create a new IsolationForest with default settings.

Defaults: n_estimators = 100, max_samples = 256, contamination = 0.1, random_state = None.

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

Set the number of isolation trees.

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

Set the number of samples to draw for each tree.

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

Set the contamination fraction (proportion of anomalies).

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

Set the random seed for reproducibility.

Trait Implementations

impl<F: Clone> Clone for IsolationForest<F>

fn clone(&self) -> IsolationForest<F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for IsolationForest<F>

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

Formats the value using the given formatter.

impl<F: Float> Default for IsolationForest<F>

fn default() -> Self

Returns the “default value” for a type.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<F: Float + Send + Sync + 'static> Fit<ArrayBase<OwnedRepr<F>, Dim<[usize; 2]>>, ()> for IsolationForest<F>

fn fit( &self, x: &Array2<F>, _y: &(), ) -> Result<FittedIsolationForest<F>, FerroError>

Fit the isolation forest on the training data.

Errors

Returns FerroError::InsufficientSamples if there are no samples. Returns FerroError::InvalidParameter if hyperparameters are invalid.

type Fitted = FittedIsolationForest<F>

The fitted model type returned by fit.

type Error = FerroError

The error type returned by fit.

impl<F> Serialize for IsolationForest<F>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.