Package ai.timefold.solver.core.api.domain.solution

Annotation Interface PlanningSolution

@Target(TYPE)
@Retention(RUNTIME)
public @interface PlanningSolution

Specifies that the class is a planning solution. A solution represents a problem and a possible solution of that problem. A possible solution does not need to be optimal or even feasible. A solution's planning variables might not be initialized (especially when delivered as a problem).

A solution is mutable. For scalability reasons (to facilitate incremental score calculation), the same solution instance (called the working solution per move thread) is continuously modified. It's cloned to recall the best solution.

Each planning solution must have exactly 1 PlanningScore property.

Each planning solution must have at least 1 PlanningEntityCollectionProperty or PlanningEntityProperty property.

Each planning solution is recommended to have 1 ConstraintWeightOverrides property too. This will make it easy for a solution to override constraint weights provided in ConstraintProvider, in turn making it possible to run different solutions with a different balance of constraint weights.

Each planning solution used with ConstraintStream score calculation must have at least 1 ProblemFactCollectionProperty or ProblemFactProperty property.

The class should have a public no-arg constructor, so it can be cloned (unless the solutionCloner() is specified).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PlanningSolution.NullSolutionCloner	Workaround for annotation limitation in solutionCloner().

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
@NonNull AutoDiscoverMemberType	autoDiscoverMemberType	Enable reflection through the members of the class to automatically assume PlanningScore, PlanningEntityCollectionProperty, PlanningEntityProperty, ProblemFactCollectionProperty, ProblemFactProperty and ConstraintWeightOverrides annotations based on the member type.
@NonNull LookUpStrategyType	lookUpStrategyType	Deprecated, for removal: This API element is subject to removal in a future version. When multi-threaded solving, ensure your domain classes use @PlanningId instead.
Class<? extends SolutionCloner>	solutionCloner	Overrides the default SolutionCloner to implement a custom PlanningSolution cloning implementation.

Element Details

autoDiscoverMemberType

@NonNull AutoDiscoverMemberType autoDiscoverMemberType

Enable reflection through the members of the class to automatically assume PlanningScore, PlanningEntityCollectionProperty, PlanningEntityProperty, ProblemFactCollectionProperty, ProblemFactProperty and ConstraintWeightOverrides annotations based on the member type.

This feature is not supported under Quarkus. When using Quarkus, setting this to anything other than AutoDiscoverMemberType.NONE will result in a build-time exception.

Default:

NONE

solutionCloner

Class<? extends SolutionCloner> solutionCloner

Overrides the default SolutionCloner to implement a custom PlanningSolution cloning implementation.

If this is not specified, then the default reflection-based SolutionCloner is used, so you don't have to worry about it.

Returns:

PlanningSolution.NullSolutionCloner when it is null (workaround for annotation limitation)

Default:

ai.timefold.solver.core.api.domain.solution.PlanningSolution.NullSolutionCloner.class

lookUpStrategyType

@Deprecated(forRemoval=true,
            since="1.10.0")
@NonNull LookUpStrategyType lookUpStrategyType

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

When multi-threaded solving, ensure your domain classes use @PlanningId instead.

Default:

PLANNING_ID_OR_NONE