Package smile.glm

Record Class GLM.Options

java.lang.Object
java.lang.Record
smile.glm.GLM.Options
Record Components:
tol - the tolerance for stopping iterations.
maxIter - the maximum number of iterations.
Enclosing class:
GLM
public static record GLM.Options(double tol, int maxIter) extends Record
GLM hyperparameters.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Options()
    Constructor.
    Options(double tol, int maxIter)
    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
    maxIter()
    Returns the value of the maxIter record component.
    static GLM.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 java.lang.Object

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

  • Constructor Details

    • Options

      public Options(double tol, int maxIter)
      Constructor.

    • Options

      public Options()
      Constructor.

  • Method Details

    • toProperties

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

    • of

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

    • tol

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

    • maxIter

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