Record Class IterationContext<S extends Solution<S>>

java.lang.Object
java.lang.Record
io.github.nhtc2005.alns.core.IterationContext<S>
Type Parameters:
S - the solution type
Record Components:
iteration - the one-based index of the completed iteration
elapsedNanos - the elapsed search time in nanoseconds before this callback
status - the candidate outcome
isRewardEligible - whether the configured outcome score may be applied; otherwise the rejected-outcome score applies
operatorSelection - the operator pair used in this iteration
candidateSolution - the candidate after repair and optional local search, even if rejected
currentSolution - the current feasible solution after evaluating the candidate
bestSolution - the best feasible solution found so far

public record IterationContext<S extends Solution<S>>(long iteration, long elapsedNanos, SolutionStatus status, boolean isRewardEligible, OperatorSelection operatorSelection, S extends Solution<S> candidateSolution, S extends Solution<S> currentSolution, S extends Solution<S> bestSolution) extends Record
Provides the search state after a completed ALNS iteration.

Solutions are shared references, not snapshots, and must not be modified by the callback.

  • Constructor Details

    • IterationContext

      public IterationContext(long iteration, long elapsedNanos, SolutionStatus status, boolean isRewardEligible, OperatorSelection operatorSelection, S candidateSolution, S currentSolution, S bestSolution)
      Creates an instance of a IterationContext record class.
      Parameters:
      iteration - the value for the iteration record component
      elapsedNanos - the value for the elapsedNanos record component
      status - the value for the status record component
      isRewardEligible - the value for the isRewardEligible record component
      operatorSelection - the value for the operatorSelection record component
      candidateSolution - the value for the candidateSolution record component
      currentSolution - the value for the currentSolution record component
      bestSolution - the value for the bestSolution 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 '=='.
      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 long iteration()
      Returns the value of the iteration record component.
      Returns:
      the value of the iteration record component
    • elapsedNanos

      public long elapsedNanos()
      Returns the value of the elapsedNanos record component.
      Returns:
      the value of the elapsedNanos record component
    • status

      public SolutionStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component
    • isRewardEligible

      public boolean isRewardEligible()
      Returns the value of the isRewardEligible record component.
      Returns:
      the value of the isRewardEligible record component
    • operatorSelection

      public OperatorSelection operatorSelection()
      Returns the value of the operatorSelection record component.
      Returns:
      the value of the operatorSelection record component
    • candidateSolution

      public S candidateSolution()
      Returns the value of the candidateSolution record component.
      Returns:
      the value of the candidateSolution record component
    • currentSolution

      public S currentSolution()
      Returns the value of the currentSolution record component.
      Returns:
      the value of the currentSolution record component
    • bestSolution

      public S bestSolution()
      Returns the value of the bestSolution record component.
      Returns:
      the value of the bestSolution record component