Skip to content

Commit beebea8

Browse files
committed
chore: address comments
1 parent 7913c89 commit beebea8

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

core/src/main/java/ai/timefold/solver/core/api/domain/common/SorterWeightFactory.java

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import ai.timefold.solver.core.api.domain.entity.PlanningEntity;
44
import ai.timefold.solver.core.api.domain.solution.PlanningSolution;
5+
import ai.timefold.solver.core.config.constructionheuristic.ConstructionHeuristicPhaseConfig;
6+
import ai.timefold.solver.core.config.heuristic.selector.entity.EntitySelectorConfig;
7+
import ai.timefold.solver.core.config.heuristic.selector.value.ValueSelectorConfig;
58
import ai.timefold.solver.core.impl.heuristic.move.Move;
69
import ai.timefold.solver.core.impl.heuristic.selector.Selector;
710

@@ -12,13 +15,22 @@
1215
* (a selection is a {@link PlanningEntity}, a planningValue, a {@link Move} or a {@link Selector}).
1316
* The selections are then sorted by their weight,
1417
* normally ascending unless it's configured descending.
15-
*
18+
* The property {@code sortManner},
19+
* present in the selector configurations such as {@link ValueSelectorConfig} and {@link EntitySelectorConfig},
20+
* specifies how the data will be sorted.
21+
* Additionally,
22+
* the property {@code constructionHeuristicType} from {@link ConstructionHeuristicPhaseConfig} can also configure how entities
23+
* and values are sorted.
1624
* <p>
1725
* Implementations are expected to be stateless.
1826
* The solver may choose to reuse instances.
1927
*
2028
* @param <Solution_> the solution type, the class with the {@link PlanningSolution} annotation
2129
* @param <T> the selection type
30+
*
31+
* @see ValueSelectorConfig
32+
* @see EntitySelectorConfig
33+
* @see ConstructionHeuristicPhaseConfig
2234
*/
2335
@NullMarked
2436
@FunctionalInterface

0 commit comments

Comments
 (0)