Record Class GridSearchOptimizer.Candidate

java.lang.Object
java.lang.Record
com.quantfinlib.backtest.validation.GridSearchOptimizer.Candidate
Enclosing class:
GridSearchOptimizer
public static record GridSearchOptimizer.Candidate(Map<String,Double> params, PerformanceMetrics metrics, double objective) extends Record

  • Constructor Details

    • Candidate

      public Candidate(Map<String,Double> params, PerformanceMetrics metrics, double objective)
      Creates an instance of a Candidate record class.
      Parameters:
      params - the value for the params record component
      metrics - the value for the metrics record component
      objective - the value for the objective 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.

    • params

      public Map<String,Double> params()
      Returns the value of the params record component.
      Returns:
      the value of the params record component

    • metrics

      public PerformanceMetrics metrics()
      Returns the value of the metrics record component.
      Returns:
      the value of the metrics record component

    • objective

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