Record Class SammonMapping.Options

java.lang.Object
java.lang.Record
smile.manifold.SammonMapping.Options
Record Components:
d - the dimension of the projection.
step - the initial step size in diagonal Newton method.
maxIter - the maximum number of iterations.
tol - the tolerance of convergence test.
stepTol - the tolerance of step size.
controller - the optional training controller.
Enclosing class:
SammonMapping
public static record SammonMapping.Options(int d, double step, int maxIter, double tol, double stepTol, IterativeAlgorithmController<AlgoStatus> controller) extends Record
Sammon's mapping hyperparameters.

  • Constructor Details

    • Options

      public Options(int d, double step, int maxIter, double tol, double stepTol, IterativeAlgorithmController<AlgoStatus> controller)
      Constructor.

    • Options

      public Options(int d, double step, int maxIter)
      Constructor.
      Parameters:
      d - the dimension of the projection.
      step - the initial step size in diagonal Newton method.
      maxIter - maximum number of iterations.

  • Method Details

    • toProperties

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

    • of

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

    • d

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

    • step

      public double step()
      Returns the value of the step record component.
      Returns:
      the value of the step 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

    • stepTol

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

    • controller

      public IterativeAlgorithmController<AlgoStatus> controller()
      Returns the value of the controller record component.
      Returns:
      the value of the controller record component