Package smile.clustering

Record Class DENCLUE.Options

java.lang.Object
java.lang.Record
smile.clustering.DENCLUE.Options
Record Components:
sigma - the smooth parameter in the Gaussian kernel. The user can choose sigma such that number of density attractors is constant for a long interval of sigma.
m - the number of selected samples used in the iteration. This number should be much smaller than the number of observations to speed up the algorithm. It should also be large enough to capture the sufficient information of underlying distribution.
minPts - the minimum number of neighbors for a core attractor.
tol - the tolerance of hill-climbing procedure.
Enclosing class:
DENCLUE
public static record DENCLUE.Options(double sigma, int m, int minPts, double tol) extends Record
DENCLUE hyperparameters.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options(double sigma, int m)
    Constructor.
    Options(double sigma, int m, int minPts, double tol)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    m()
    Returns the value of the m record component.
    int
    minPts()
    Returns the value of the minPts record component.
    static DENCLUE.Options
    of(Properties props)
    Returns the options from properties.
    double
    sigma()
    Returns the value of the sigma record component.
    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 java.lang.Object

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

  • Constructor Details

    • Options

      public Options(double sigma, int m, int minPts, double tol)
      Constructor.

    • Options

      public Options(double sigma, int m)
      Constructor.
      Parameters:
      sigma - the smooth parameter in the Gaussian kernel.
      m - the number of selected samples used in the iteration.

  • Method Details

    • toProperties

      public Properties toProperties()
      Returns the persistent set of hyperparameters.
      Returns:
      the persistent set.

    • of

      public static DENCLUE.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.

    • sigma

      public double sigma()
      Returns the value of the sigma record component.
      Returns:
      the value of the sigma record component

    • m

      public int m()
      Returns the value of the m record component.
      Returns:
      the value of the m record component

    • minPts

      public int minPts()
      Returns the value of the minPts record component.
      Returns:
      the value of the minPts record component

    • tol

      public double tol()
      Returns the value of the tol record component.
      Returns:
      the value of the tol record component