Record Class Clustering.Options

java.lang.Object
java.lang.Record
smile.clustering.Clustering.Options
Record Components:
k - the number of clusters.
maxIter - the maximum number of iterations.
tol - the tolerance of convergence test.
controller - the optional training controller.
Enclosing interface:
Clustering

public static record Clustering.Options(int k, int maxIter, double tol, IterativeAlgorithmController<AlgoStatus> controller) extends Record
Iterative clustering algorithm hyperparameters.
  • Constructor Details Link icon

    • Options Link icon

      public Options(int k, int maxIter, double tol, IterativeAlgorithmController<AlgoStatus> controller)
      Constructor.
    • Options Link icon

      public Options(int k, int maxIter)
      Constructor.
      Parameters:
      k - the number of clusters.
      maxIter - the maximum number of iterations.
  • Method Details Link icon

    • toProperties Link icon

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

      public static Clustering.Options of(Properties props)
      Returns the options from properties.
      Parameters:
      props - the hyperparameters.
      Returns:
      the options.
    • toString Link icon

      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 Link icon

      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 Link icon

      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 '=='.
      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.
    • k Link icon

      public int k()
      Returns the value of the k record component.
      Returns:
      the value of the k record component
    • maxIter Link icon

      public int maxIter()
      Returns the value of the maxIter record component.
      Returns:
      the value of the maxIter record component
    • tol Link icon

      public double tol()
      Returns the value of the tol record component.
      Returns:
      the value of the tol record component
    • controller Link icon

      Returns the value of the controller record component.
      Returns:
      the value of the controller record component