Package ai.timefold.solver.core.impl.domain.valuerange.descriptor

Class CompositeValueRangeDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor<Solution_>

ai.timefold.solver.core.impl.domain.valuerange.descriptor.CompositeValueRangeDescriptor<Solution_>

Type Parameters:

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

All Implemented Interfaces:

ValueRangeDescriptor<Solution_>

@NullMarked
public final class CompositeValueRangeDescriptor<Solution_>
extends AbstractValueRangeDescriptor<Solution_>

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor

variableDescriptor

Constructor Summary

Constructors

Constructor	Description
CompositeValueRangeDescriptor(int ordinal, GenuineVariableDescriptor<Solution_> variableDescriptor, List<ValueRangeDescriptor<Solution_>> childValueRangeDescriptorList)

Method Summary

Modifier and Type	Method	Description
boolean	canExtractValueRangeFromSolution()	Returns true if the value range is defined at the solution level and can be directly extracted from the solution; otherwise, it returns false, as the value range can only be extracted or computed from the entities.
<T> ValueRange<T>	extractAllValues(Solution_ solution)	Extracts the ValueRange from the solution or, if the value range is defined at the entity level, extracts a composite ValueRange from all entities in the solution.
<T> ValueRange<T>	extractValuesFromEntity(Solution_ solution, Object entity)	Extracts the ValueRange from the planning entity.
int	getValueRangeCount()
boolean	isCountable()
boolean	isGenericTypeImmutable()

Methods inherited from class ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor

getOrdinal, getVariableDescriptor, mightContainEntity, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.timefold.solver.core.impl.domain.valuerange.descriptor.ValueRangeDescriptor

acceptsNullInValueRange

Constructor Details

CompositeValueRangeDescriptor

public CompositeValueRangeDescriptor(int ordinal,
 GenuineVariableDescriptor<Solution_> variableDescriptor,
 List<ValueRangeDescriptor<Solution_>> childValueRangeDescriptorList)

Method Details

isGenericTypeImmutable

public boolean isGenericTypeImmutable()

Returns:

true if the value range generic type is immutable.

getValueRangeCount

public int getValueRangeCount()

canExtractValueRangeFromSolution

public boolean canExtractValueRangeFromSolution()

Description copied from interface: ValueRangeDescriptor

Returns true if the value range is defined at the solution level and can be directly extracted from the solution; otherwise, it returns false, as the value range can only be extracted or computed from the entities.

isCountable

public boolean isCountable()

Returns:

true if the ValueRange is countable (for example a double value range between 1.2 and 1.4 is not countable)

extractAllValues

public <T> ValueRange<T> extractAllValues(Solution_ solution)

Description copied from interface: ValueRangeDescriptor

Extracts the ValueRange from the solution or, if the value range is defined at the entity level, extracts a composite ValueRange from all entities in the solution.

The method should not be invoked directly by selectors or other components of the solver. The ValueRangeManager.getFromSolution(ValueRangeDescriptor, Object) and ValueRangeManager.getFromEntity(ValueRangeDescriptor, Object) serve as the single source of truth for managing value ranges and should be used by outer components.

Calling this method outside ValueRangeManager may lead to unnecessary recomputation of ranges.

extractValuesFromEntity

public <T> ValueRange<T> extractValuesFromEntity(Solution_ solution,
 Object entity)

Description copied from interface: ValueRangeDescriptor

Extracts the ValueRange from the planning entity. If the value range is defined at the solution level instead, this method reads the value range from there.

The method should not be invoked directly by selectors or other components of the solver. The ValueRangeManager.getFromSolution(ValueRangeDescriptor, Object) and ValueRangeManager.getFromEntity(ValueRangeDescriptor, Object) serve as the single source of truth for managing value ranges and should be used by outer components.

Calling this method outside ValueRangeManager may lead to unnecessary recomputation of ranges.