Package org.ddolib.common.solver

Record Class SearchStatistics

java.lang.Object
java.lang.Record
org.ddolib.common.solver.SearchStatistics
public record SearchStatistics(SearchStatus status, int nbIterations, int queueMaxSize, long runTimeMs, double incumbent, double gap) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    SearchStatistics(SearchStatus status, int nbIterations, int queueMaxSize, long runTimeMs, double incumbent, double gap)
    Creates an instance of a SearchStatistics record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    double
    gap()
    Returns the value of the gap record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    incumbent()
    Returns the value of the incumbent record component.
    int
    nbIterations()
    Returns the value of the nbIterations record component.
    int
    queueMaxSize()
    Returns the value of the queueMaxSize record component.
    long
    runTimeMs()
    Returns the value of the runTimeMs record component.
    SearchStatus
    status()
    Returns the value of the status record component.
    String
    toCSV()
     
    String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • SearchStatistics

      public SearchStatistics(SearchStatus status, int nbIterations, int queueMaxSize, long runTimeMs, double incumbent, double gap)
      Creates an instance of a SearchStatistics record class.
      Parameters:
      status - the value for the status record component
      nbIterations - the value for the nbIterations record component
      queueMaxSize - the value for the queueMaxSize record component
      runTimeMs - the value for the runTimeMs record component
      incumbent - the value for the incumbent record component
      gap - the value for the gap record component

  • Method Details

    • toCSV

      public String toCSV()

    • toString

      public 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 '=='.
      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.

    • status

      public SearchStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • nbIterations

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

    • queueMaxSize

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

    • runTimeMs

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

    • incumbent

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

    • gap

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