Package com.graphhopper.jsprit.core.algorithm.listener.events

Record Class IterationStarted

java.lang.Object
java.lang.Record
com.graphhopper.jsprit.core.algorithm.listener.events.IterationStarted
Record Components:
iteration - The iteration number (1-based)
timestamp - When the event occurred
currentBestCost - The cost of the current best solution
All Implemented Interfaces:
AlgorithmEvent
public record IterationStarted(int iteration, long timestamp, double currentBestCost) extends Record implements AlgorithmEvent
Event emitted when an iteration starts.

  • Constructor Summary

    Constructors
    Constructor
    Description
    IterationStarted(int iteration, long timestamp, double currentBestCost)
    Creates an instance of a IterationStarted record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    currentBestCost()
    Returns the value of the currentBestCost 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.
    int
    iteration()
    Returns the value of the iteration record component.
    long
    timestamp()
    Returns the value of the timestamp record component.
    final 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

    • IterationStarted

      public IterationStarted(int iteration, long timestamp, double currentBestCost)
      Creates an instance of a IterationStarted record class.
      Parameters:
      iteration - the value for the iteration record component
      timestamp - the value for the timestamp record component
      currentBestCost - the value for the currentBestCost 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. All components in this record class 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.

    • iteration

      public int iteration()
      Returns the value of the iteration record component.
      Specified by:
      iteration in interface AlgorithmEvent
      Returns:
      the value of the iteration record component

    • timestamp

      public long timestamp()
      Returns the value of the timestamp record component.
      Specified by:
      timestamp in interface AlgorithmEvent
      Returns:
      the value of the timestamp record component

    • currentBestCost

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