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

Interface SolutionManager<Solution_,Score_ extends Score<Score_>>

Type Parameters:

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

Score_ - the actual score type

All Known Implementing Classes:

DefaultSolutionManager

public interface SolutionManager<Solution_,Score_ extends Score<Score_>>

A stateless service to help calculate Score, ConstraintMatchTotal, Indictment, etc.

To create a SolutionManager instance, use create(SolverFactory).

These methods are thread-safe unless explicitly stated otherwise.

Method Summary

Modifier and Type	Method	Description
static <Solution_,Score_ extends Score<Score_>> SolutionManager<Solution_,Score_>	create(SolverFactory<Solution_> solverFactory)	Uses a SolverFactory to build a SolutionManager.
static <Solution_,Score_ extends Score<Score_>,ProblemId_> SolutionManager<Solution_,Score_>	create(SolverManager<Solution_,ProblemId_> solverManager)	Uses a SolverManager to build a SolutionManager.
default ScoreExplanation<Solution_,Score_>	explain(Solution_ solution)	As defined by explain(Object), using SolutionUpdatePolicy.UPDATE_ALL.
ScoreExplanation<Solution_,Score_>	explain(Solution_ solution, SolutionUpdatePolicy solutionUpdatePolicy)	Calculates and retrieves ConstraintMatchTotals and Indictments necessary for describing the quality of a particular solution.
default Score_	update(Solution_ solution)	As defined by update(Object, SolutionUpdatePolicy), using SolutionUpdatePolicy.UPDATE_ALL.
Score_	update(Solution_ solution, SolutionUpdatePolicy solutionUpdatePolicy)	Updates the given solution according to the SolutionUpdatePolicy.

Method Detail

create

static <Solution_,Score_ extends Score<Score_>> SolutionManager<Solution_,Score_> create(SolverFactory<Solution_> solverFactory)

Uses a SolverFactory to build a SolutionManager.

Type Parameters:

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

Score_ - the actual score type

Parameters:

solverFactory - never null

Returns:

never null

create

static <Solution_,Score_ extends Score<Score_>,ProblemId_> SolutionManager<Solution_,Score_> create(SolverManager<Solution_,ProblemId_> solverManager)

Uses a SolverManager to build a SolutionManager.

Type Parameters:

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

Score_ - the actual score type

ProblemId_ - the ID type of a submitted problem, such as Long or UUID

Parameters:

solverManager - never null

Returns:

never null

update

default Score_ update(Solution_ solution)

As defined by update(Object, SolutionUpdatePolicy), using SolutionUpdatePolicy.UPDATE_ALL.

update

Score_ update(Solution_ solution,
              SolutionUpdatePolicy solutionUpdatePolicy)

Updates the given solution according to the SolutionUpdatePolicy.

Parameters:

solution - never null

solutionUpdatePolicy - never null; if unsure, pick SolutionUpdatePolicy.UPDATE_ALL

Returns:

possibly null if already null and SolutionUpdatePolicy didn't cause its update

See Also:

Description of individual policies with respect to performance trade-offs.

explain

default ScoreExplanation<Solution_,Score_> explain(Solution_ solution)

As defined by explain(Object), using SolutionUpdatePolicy.UPDATE_ALL.

explain

ScoreExplanation<Solution_,Score_> explain(Solution_ solution,
                                                 SolutionUpdatePolicy solutionUpdatePolicy)

Calculates and retrieves ConstraintMatchTotals and Indictments necessary for describing the quality of a particular solution.

Parameters:

solution - never null

solutionUpdatePolicy - never null; if unsure, pick SolutionUpdatePolicy.UPDATE_ALL

Returns:

never null

Throws:

IllegalStateException - when constraint matching is disabled or not supported by the underlying score calculator, such as EasyScoreCalculator.

See Also:

Description of individual policies with respect to performance trade-offs.