Record Class ICA.Options

java.lang.Object

java.lang.Record

smile.ica.ICA.Options

Record Components:

contrast - the contrast function which is capable of separating or extracting independent sources from a linear mixture. It must be a non-quadratic non-linear function that has second-order derivative.

maxIter - the maximum number of iterations.

tol - the tolerance of convergence test.

Enclosing class:

ICA

public static record ICA.Options(DifferentiableFunction contrast, int maxIter, double tol)
extends Record

ICA hyperparameters.

Constructor Summary

Constructors

Constructor	Description
Options(String contrast, int maxIter)	Constructor.
Options(DifferentiableFunction contrast, int maxIter)	Constructor.
Options(DifferentiableFunction contrast, int maxIter, double tol)	Constructor.

Method Summary

Modifier and Type	Method	Description
DifferentiableFunction	contrast()	Returns the value of the contrast record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	maxIter()	Returns the value of the maxIter record component.
static ICA.Options	of(Properties props)	Returns the options from properties.
double	tol()	Returns the value of the tol 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 Object

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

Constructor Details

Options

public Options(DifferentiableFunction contrast,
 int maxIter,
 double tol)

Constructor.

Options

public Options(DifferentiableFunction contrast,
 int maxIter)

Constructor.

Parameters:

contrast - the contrast function which is capable of separating or extracting independent sources from a linear mixture. It must be a non-quadratic non-linear function that has second-order derivative.

maxIter - the maximum number of iterations.

Options

public Options(String contrast,
 int maxIter)

Constructor.

Parameters:

contrast - the name of contrast function, "LogCosh" or "Gaussian".

maxIter - the maximum number of iterations.

Method Details

toProperties

public Properties toProperties()

Returns the persistent set of hyperparameters.

Returns:

the persistent set.

of

public static ICA.Options of(Properties props)
                      throws ReflectiveOperationException

Returns the options from properties.

Parameters:

props - the hyperparameters.

Returns:

the options.

Throws:

ReflectiveOperationException - if fail to create contrast function.

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

contrast

public DifferentiableFunction contrast()

Returns the value of the contrast record component.

Returns:

the value of the contrast record component

maxIter

public int maxIter()

Returns the value of the maxIter record component.

Returns:

the value of the maxIter record component

tol

public double tol()

Returns the value of the tol record component.

Returns:

the value of the tol record component