Record Class AlgoStatus

java.lang.Object
java.lang.Record
smile.util.AlgoStatus
Record Components:
iteration - the iteration index.
objective - the objective function value.
state - optional algorithm state information.
public record AlgoStatus(int iteration, double objective, Object state) extends Record
Iterative algorithm status.

  • Constructor Summary

    Constructors
    Constructor
    Description
    AlgoStatus(int iteration, double objective)
    Constructor.
    AlgoStatus(int iteration, double objective, Object state)
    Creates an instance of a AlgoStatus record class.

  • 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
    iteration()
    Returns the value of the iteration record component.
    double
    objective()
    Returns the value of the objective record component.
    Object
    state()
    Returns the value of the state record component.
    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

    • AlgoStatus

      public AlgoStatus(int iteration, double objective)
      Constructor.
      Parameters:
      iteration - the iteration index.
      objective - the objective function value.

    • AlgoStatus

      public AlgoStatus(int iteration, double objective, Object state)
      Creates an instance of a AlgoStatus record class.
      Parameters:
      iteration - the value for the iteration record component
      objective - the value for the objective record component
      state - the value for the state record component

  • Method Details

    • 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.

    • iteration

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

    • objective

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

    • state

      public Object state()
      Returns the value of the state record component.
      Returns:
      the value of the state record component