Record Class WalkForwardAnalyzer.Fold

java.lang.Object
java.lang.Record
com.quantfinlib.backtest.validation.WalkForwardAnalyzer.Fold
Enclosing class:
WalkForwardAnalyzer
public static record WalkForwardAnalyzer.Fold(int trainFrom, int trainTo, int testFrom, int testTo, Map<String,Double> bestParams, double inSampleObjective, double outOfSampleObjective) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    Fold(int trainFrom, int trainTo, int testFrom, int testTo, Map<String,Double> bestParams, double inSampleObjective, double outOfSampleObjective)
    Creates an instance of a Fold record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Double>
    bestParams()
    Returns the value of the bestParams record component.
    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.
    double
    inSampleObjective()
    Returns the value of the inSampleObjective record component.
    double
    outOfSampleObjective()
    Returns the value of the outOfSampleObjective record component.
    int
    testFrom()
    Returns the value of the testFrom record component.
    int
    testTo()
    Returns the value of the testTo record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    trainFrom()
    Returns the value of the trainFrom record component.
    int
    trainTo()
    Returns the value of the trainTo record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Fold

      public Fold(int trainFrom, int trainTo, int testFrom, int testTo, Map<String,Double> bestParams, double inSampleObjective, double outOfSampleObjective)
      Creates an instance of a Fold record class.
      Parameters:
      trainFrom - the value for the trainFrom record component
      trainTo - the value for the trainTo record component
      testFrom - the value for the testFrom record component
      testTo - the value for the testTo record component
      bestParams - the value for the bestParams record component
      inSampleObjective - the value for the inSampleObjective record component
      outOfSampleObjective - the value for the outOfSampleObjective 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.

    • trainFrom

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

    • trainTo

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

    • testFrom

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

    • testTo

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

    • bestParams

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

    • inSampleObjective

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

    • outOfSampleObjective

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