Package smile.anomaly

Record Class IsolationForest.Options

java.lang.Object

java.lang.Record

smile.anomaly.IsolationForest.Options

Record Components:

ntrees - the number of trees.

maxDepth - the maximum depth of the tree.

subsample - the sampling rate for training tree.

extensionLevel - the extension level.

Enclosing class:

IsolationForest

public static record IsolationForest.Options(int ntrees, int maxDepth, double subsample, int extensionLevel)
extends Record

Isolation Forest hyperparameters.

Constructor Summary

Constructors

Constructor	Description
Options()	Constructor.
Options(int ntrees, int maxDepth, double subsample, int extensionLevel)	Constructor.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	extensionLevel()	Returns the value of the extensionLevel record component.
final int	hashCode()	Returns a hash code value for this object.
int	maxDepth()	Returns the value of the maxDepth record component.
int	ntrees()	Returns the value of the ntrees record component.
static IsolationForest.Options	of(Properties props)	Returns the options from properties.
double	subsample()	Returns the value of the subsample record component.
Properties	toProperties()	Returns the persistent set of hyperparameters.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Options

public Options(int ntrees,
 int maxDepth,
 double subsample,
 int extensionLevel)

Constructor.

Options

public Options()

Constructor.

Method Details

toProperties

public Properties toProperties()

Returns the persistent set of hyperparameters.

Returns:

the persistent set.

of

public static IsolationForest.Options of(Properties props)

Returns the options from properties.

Parameters:

props - the hyperparameters.

Returns:

the options.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

ntrees

public int ntrees()

Returns the value of the ntrees record component.

Returns:

the value of the ntrees record component

maxDepth

public int maxDepth()

Returns the value of the maxDepth record component.

Returns:

the value of the maxDepth record component

subsample

public double subsample()

Returns the value of the subsample record component.

Returns:

the value of the subsample record component

extensionLevel

public int extensionLevel()

Returns the value of the extensionLevel record component.

Returns:

the value of the extensionLevel record component