Package ai.timefold.solver.core.impl.phase.custom

Interface CustomPhaseCommand<Solution_>

All Superinterfaces:

PhaseCommand<Solution_>

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@NullMarked
@Deprecated(forRemoval=true,
            since="1.20.0")
public interface CustomPhaseCommand<Solution_>
extends PhaseCommand<Solution_>

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

Use PhaseCommand instead.

Method Summary

Modifier and Type	Method	Description
void	changeWorkingSolution(ScoreDirector<Solution_> scoreDirector)	Deprecated, for removal: This API element is subject to removal in a future version.
default void	changeWorkingSolution(ScoreDirector<Solution_> scoreDirector, BooleanSupplier isPhaseTerminated)	Deprecated, for removal: This API element is subject to removal in a future version. Changes working solution of ScoreDirector.getWorkingSolution().

Method Details

changeWorkingSolution

default void changeWorkingSolution(ScoreDirector<Solution_> scoreDirector,
 BooleanSupplier isPhaseTerminated)

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

Description copied from interface: PhaseCommand

Changes working solution of ScoreDirector.getWorkingSolution(). When the working solution is modified, the ScoreDirector must be correctly notified (through ScoreDirector.beforeVariableChanged(Object, String) and ScoreDirector.afterVariableChanged(Object, String)), otherwise calculated Scores will be corrupted.

Don't forget to call ScoreDirector.triggerVariableListeners() after each set of changes (especially before every InnerScoreDirector.calculateScore() call) to ensure all shadow variables are updated.

Specified by:

changeWorkingSolution in interface PhaseCommand<Solution_>

Parameters:

scoreDirector - the ScoreDirector that needs to get notified of the changes.

isPhaseTerminated - long-running command implementations should check this periodically and terminate early if it returns true. Otherwise the terminations configured by the user will have no effect, as the solver can only terminate itself when a command has ended.

changeWorkingSolution

void changeWorkingSolution(ScoreDirector<Solution_> scoreDirector)

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