|
OptaPlanner core 6.1.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |
@Target(value=METHOD) @Retention(value=RUNTIME) public @interface PlanningVariable
Specifies that a bean property can be changed and should be optimized by the optimization algorithms.
It is specified on a getter of a java bean property of aPlanningEntity
class.
Optional Element Summary | |
---|---|
PlanningVariableGraphType |
graphType
In some use cases, such as Vehicle Routing, planning entities form a specific graph type, as specified by PlanningVariableGraphType . |
boolean |
nullable
A nullable planning variable will automatically add the planning value null to the ValueRangeProvider 's range. |
Class<? extends SelectionFilter> |
reinitializeVariableEntityFilter
Construction heuristics only change reinitializable planning variables. |
Class<? extends Comparator> |
strengthComparatorClass
Allows a collection of planning values for this variable to be sorted by strength. |
Class<? extends SelectionSorterWeightFactory> |
strengthWeightFactoryClass
The SelectionSorterWeightFactory alternative for strengthComparatorClass() . |
String[] |
valueRangeProviderRefs
Any ValueRangeProvider annotation on a PlanningSolution or PlanningEntity
will automatically be registered with it's ValueRangeProvider.id() . |
public abstract String[] valueRangeProviderRefs
ValueRangeProvider
annotation on a PlanningSolution
or PlanningEntity
will automatically be registered with it's ValueRangeProvider.id()
.
There should be at least 1 valueRangeRef.
ValueRangeProvider.id()
public abstract boolean nullable
ValueRangeProvider
's range.
In repeated planning use cases, it's recommended to specify a reinitializeVariableEntityFilter()
for every nullable planning variable too.
nullable()
true is not compatible with PlanningVariableGraphType.CHAINED
true.
nullable()
true is not compatible with a primitive property type.
public abstract Class<? extends SelectionFilter> reinitializeVariableEntityFilter
reinitializeVariableEntityFilter()
is specified,
the default considers an entity uninitialized for a variable if its value is null
(even if nullable()
is true).
The method SelectionFilter.accept(ScoreDirector, Object)
returns false if the selection entity should be reinitialized for this variable
and it returns true if the selection entity should not be reinitialized for this variable
PlanningVariable.NullReinitializeVariableEntityFilter
when it is null (workaround for annotation limitation)public abstract PlanningVariableGraphType graphType
PlanningVariableGraphType
.
PlanningVariableGraphType.NONE
public abstract Class<? extends Comparator> strengthComparatorClass
Comparator
should sort in ascending strength.
For example: sorting 3 computers on strength based on their RAM capacity:
Computer B (1GB RAM), Computer A (2GB RAM), Computer C (7GB RAM),
Do not use together with strengthWeightFactoryClass()
.
PlanningVariable.NullStrengthComparator
when it is null (workaround for annotation limitation)strengthWeightFactoryClass()
public abstract Class<? extends SelectionSorterWeightFactory> strengthWeightFactoryClass
SelectionSorterWeightFactory
alternative for strengthComparatorClass()
.
Do not use together with strengthComparatorClass()
.
PlanningVariable.NullStrengthWeightFactory
when it is null (workaround for annotation limitation)strengthComparatorClass()
|
OptaPlanner core 6.1.0.Final | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: REQUIRED | OPTIONAL | DETAIL: ELEMENT |