Package ai.timefold.solver.core.api.solver.event

Class BestSolutionChangedEvent<Solution_>

java.lang.Object

ai.timefold.solver.core.api.solver.event.BestSolutionChangedEvent<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

Direct Known Subclasses:

DefaultBestSolutionChangedEvent

public class BestSolutionChangedEvent<Solution_>
extends Object

Delivered when the best solution changes during solving. Delivered in the solver thread (which is the thread that calls Solver.solve(Solution_)).

Constructor Summary

Constructors

Constructor	Description
BestSolutionChangedEvent(@NonNull Solver<Solution_> solver, long timeMillisSpent, @NonNull Solution_ newBestSolution, @NonNull Score newBestScore)	Deprecated, for removal: This API element is subject to removal in a future version. Users should not manually construct instances of this event.
BestSolutionChangedEvent(@NonNull Solver<Solution_> solver, long timeMillisSpent, @NonNull Solution_ newBestSolution, @NonNull Score newBestScore, boolean isNewBestSolutionInitialized)	Deprecated, for removal: This API element is subject to removal in a future version. Users should not manually construct instances of this event.
BestSolutionChangedEvent(@NonNull Solver<Solution_> solver, EventProducerId producerId, long timeMillisSpent, @NonNull Solution_ newBestSolution, @NonNull Score newBestScore, boolean isNewBestSolutionInitialized)	Deprecated, for removal: This API element is subject to removal in a future version. Users should not manually construct instances of this event.

Method Summary

Modifier and Type	Method	Description
@NonNull Score	getNewBestScore()	Returns the Score of the getNewBestSolution().
@NonNull Solution_	getNewBestSolution()	Note that: In real-time planning, not all ProblemChanges might be processed: check isEveryProblemFactChangeProcessed(). this PlanningSolution might be uninitialized: check isNewBestSolutionInitialized(). this PlanningSolution might be infeasible: check Score.isFeasible().
EventProducerId	getProducerId()
long	getTimeMillisSpent()
boolean	isEveryProblemChangeProcessed()
boolean	isEveryProblemFactChangeProcessed()	Deprecated, for removal: This API element is subject to removal in a future version. Prefer isEveryProblemChangeProcessed().
boolean	isNewBestSolutionInitialized()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BestSolutionChangedEvent

@Deprecated(forRemoval=true,
            since="1.22.0")
public BestSolutionChangedEvent(@NonNull Solver<Solution_> solver,
 long timeMillisSpent,
 @NonNull Solution_ newBestSolution,
 @NonNull Score newBestScore)

Deprecated, for removal: This API element is subject to removal in a future version.

Users should not manually construct instances of this event.

Parameters:

timeMillisSpent - >= 0L

BestSolutionChangedEvent

@Deprecated(forRemoval=true,
            since="1.23.0")
public BestSolutionChangedEvent(@NonNull Solver<Solution_> solver,
 long timeMillisSpent,
 @NonNull Solution_ newBestSolution,
 @NonNull Score newBestScore,
 boolean isNewBestSolutionInitialized)

Deprecated, for removal: This API element is subject to removal in a future version.

Users should not manually construct instances of this event.

Parameters:

timeMillisSpent - >= 0L

BestSolutionChangedEvent

@Deprecated(forRemoval=true,
            since="1.28.0")
public BestSolutionChangedEvent(@NonNull Solver<Solution_> solver,
 EventProducerId producerId,
 long timeMillisSpent,
 @NonNull Solution_ newBestSolution,
 @NonNull Score newBestScore,
 boolean isNewBestSolutionInitialized)

Deprecated, for removal: This API element is subject to removal in a future version.

Users should not manually construct instances of this event.

Parameters:

timeMillisSpent - >= 0L

Method Details

getTimeMillisSpent

public long getTimeMillisSpent()

Returns:

>= 0, the amount of millis spent since the Solver started until getNewBestSolution() was found

getProducerId

public EventProducerId getProducerId()

Returns:

A EventProducerId identifying what generated the event

getNewBestSolution

public @NonNull Solution_ getNewBestSolution()

Note that:

• In real-time planning, not all ProblemChanges might be processed: check isEveryProblemFactChangeProcessed().
• this PlanningSolution might be uninitialized: check isNewBestSolutionInitialized().
• this PlanningSolution might be infeasible: check Score.isFeasible().

getNewBestScore

public @NonNull Score getNewBestScore()

Returns the Score of the getNewBestSolution().

This is useful for generic code, which doesn't know the type of the PlanningSolution to retrieve the Score from the getNewBestSolution() easily.

isNewBestSolutionInitialized

public boolean isNewBestSolutionInitialized()

Returns:

True if getNewBestSolution() is initialized.

isEveryProblemFactChangeProcessed

@Deprecated(forRemoval=true)
public boolean isEveryProblemFactChangeProcessed()

Deprecated, for removal: This API element is subject to removal in a future version.

Prefer isEveryProblemChangeProcessed().

This method is deprecated.

Returns:

As defined by Solver.isEveryProblemFactChangeProcessed()

See Also:

• Solver.isEveryProblemFactChangeProcessed()

isEveryProblemChangeProcessed

public boolean isEveryProblemChangeProcessed()

Returns:

As defined by Solver.isEveryProblemChangeProcessed()

See Also:

• Solver.isEveryProblemChangeProcessed()