Record Class TickBacktester.TickBacktestResult

java.lang.Object
java.lang.Record
com.quantfinlib.backtest.tick.TickBacktester.TickBacktestResult
Enclosing class:
TickBacktester
public static record TickBacktester.TickBacktestResult(String strategyName, List<Execution> fills, double[] sampledEquity, double finalEquity, long ticksProcessed, PerformanceMetrics metrics) extends Record

  • Constructor Details

    • TickBacktestResult

      public TickBacktestResult(String strategyName, List<Execution> fills, double[] sampledEquity, double finalEquity, long ticksProcessed, PerformanceMetrics metrics)
      Creates an instance of a TickBacktestResult record class.
      Parameters:
      strategyName - the value for the strategyName record component
      fills - the value for the fills record component
      sampledEquity - the value for the sampledEquity record component
      finalEquity - the value for the finalEquity record component
      ticksProcessed - the value for the ticksProcessed record component
      metrics - the value for the metrics 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.

    • strategyName

      public String strategyName()
      Returns the value of the strategyName record component.
      Returns:
      the value of the strategyName record component

    • fills

      public List<Execution> fills()
      Returns the value of the fills record component.
      Returns:
      the value of the fills record component

    • sampledEquity

      public double[] sampledEquity()
      Returns the value of the sampledEquity record component.
      Returns:
      the value of the sampledEquity record component

    • finalEquity

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

    • ticksProcessed

      public long ticksProcessed()
      Returns the value of the ticksProcessed record component.
      Returns:
      the value of the ticksProcessed record component

    • metrics

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