Record Class PurgedKFold.Split

java.lang.Object
java.lang.Record
com.quantfinlib.backtest.validation.PurgedKFold.Split
Enclosing class:
PurgedKFold
public static record PurgedKFold.Split(int fold, int testFrom, int testTo, int[] trainIndices) extends Record
One fold: test on [testFrom, testTo), train on trainIndices (ascending, purged and embargoed).

  • Constructor Summary

    Constructors
    Constructor
    Description
    Split(int fold, int testFrom, int testTo, int[] trainIndices)
    Creates an instance of a Split record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    fold()
    Returns the value of the fold record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    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[]
    trainIndices()
    Returns the value of the trainIndices record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Split

      public Split(int fold, int testFrom, int testTo, int[] trainIndices)
      Creates an instance of a Split record class.
      Parameters:
      fold - the value for the fold record component
      testFrom - the value for the testFrom record component
      testTo - the value for the testTo record component
      trainIndices - the value for the trainIndices 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.

    • fold

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

    • trainIndices

      public int[] trainIndices()
      Returns the value of the trainIndices record component.
      Returns:
      the value of the trainIndices record component