Uses of Interface
ai.timefold.solver.core.preview.api.domain.metamodel.PlanningListVariableMetaModel

Packages that use PlanningListVariableMetaModel

Package	Description
ai.timefold.solver.core.impl.domain.solution.descriptor
ai.timefold.solver.core.impl.domain.variable.descriptor
ai.timefold.solver.core.impl.move
ai.timefold.solver.core.impl.neighborhood.stream
ai.timefold.solver.core.preview.api.domain.metamodel	This package contains classes and interfaces that represent the metamodel of the domain.
ai.timefold.solver.core.preview.api.move	This package contains classes and interfaces that are used to write moves to explore the neighborhood of a PlanningSolution.
ai.timefold.solver.core.preview.api.move.builtin
ai.timefold.solver.core.preview.api.neighborhood.stream

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.impl.domain.solution.descriptor

Classes in ai.timefold.solver.core.impl.domain.solution.descriptor that implement PlanningListVariableMetaModel

Modifier and Type	Class	Description
final record	DefaultPlanningListVariableMetaModel<Solution_,Entity_,Value_>

Methods in ai.timefold.solver.core.impl.domain.solution.descriptor that return PlanningListVariableMetaModel

Modifier and Type	Method	Description
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	DefaultGenuineEntityMetaModel.listVariable()
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	DefaultGenuineEntityMetaModel.listVariable(String variableName)
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	DefaultGenuineEntityMetaModel.listVariable(String variableName, Class<Value_> variableClass)

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.impl.domain.variable.descriptor

Methods in ai.timefold.solver.core.impl.domain.variable.descriptor that return PlanningListVariableMetaModel

Modifier and Type	Method	Description
<Entity_, Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	ListVariableDescriptor.getVariableMetaModel()

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.impl.move

Methods in ai.timefold.solver.core.impl.move with parameters of type PlanningListVariableMetaModel

Modifier and Type	Method	Description
final <Entity_, Value_> void	MoveDirector.assignValueAndAdd(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ planningValue, Entity_ destinationEntity, int destinationIndex)
final <Entity_, Value_> void	MoveDirector.assignValueAndSet(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ planningValue, Entity_ destinationEntity, int destinationIndex)
<Entity_, Value_> int	MoveDirector.countValues(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity)
protected static <Solution_, Entity_, Value_> ElementPosition	MoveDirector.getPositionOf(InnerScoreDirector<Solution_,?> scoreDirector, PlanningListVariableMetaModel<Solution_,Entity_,Value_> listVariableDescriptor, Value_ value)
<Entity_, Value_> ElementPosition	MoveDirector.getPositionOf(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)
final <Entity_, Value_> Value_	MoveDirector.getValueAtIndex(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int index)
protected static <Solution_> ListVariableDescriptor<Solution_>	AbstractMove.getVariableDescriptor(PlanningListVariableMetaModel<Solution_,?,?> variableMetaModel)
<Entity_, Value_> boolean	MoveDirector.isPinned(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @Nullable Value_ value)
final <Entity_, Value_> Value_	MoveDirector.moveValueBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, Entity_ destinationEntity, int destinationIndex)
final <Entity_, Value_> Value_	MoveDirector.moveValueInList(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, int destinationIndex)
<Entity_, Value_> Value_	MoveDirector.shiftValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, int offset)
<Entity_, Value_> void	MoveDirector.swapValuesBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ leftEntity, int leftIndex, Entity_ rightEntity, int rightIndex)
<Entity_, Value_> void	MoveDirector.swapValuesInList(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int leftIndex, int rightIndex)
<Entity_, Value_> Value_	MoveDirector.unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int index)
<Entity_, Value_> void	MoveDirector.unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.impl.neighborhood.stream

Methods in ai.timefold.solver.core.impl.neighborhood.stream that return PlanningListVariableMetaModel

Modifier and Type	Method	Description
PlanningListVariableMetaModel<Solution_,Entity_,Value_>	DefaultMoveStreamFactory.ListVariableNodeSharingSupportFunctions.variableMetaModel()	Returns the value of the variableMetaModel record component.

Methods in ai.timefold.solver.core.impl.neighborhood.stream with parameters of type PlanningListVariableMetaModel

Modifier and Type	Method	Description
<Entity_, Value_> UniEnumeratingStream<Solution_,ElementPosition>	DefaultMoveStreamFactory.forEachAssignablePosition(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
<Entity_, Value_> UniEnumeratingStream<Solution_,Value_>	DefaultMoveStreamFactory.forEachAssignedValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
<Entity_, Value_> UniEnumeratingStream<Solution_,Value_>	DefaultMoveStreamFactory.forEachAssignedValueUnfiltered(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
<Entity_, Value_> UniEnumeratingStream<Solution_,PositionInList>	DefaultMoveStreamFactory.forEachDestination(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
<Entity_, Value_> UniEnumeratingStream<Solution_,ElementPosition>	DefaultMoveStreamFactory.forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
<Entity_, Value_> DefaultMoveStreamFactory.ListVariableNodeSharingSupportFunctions<Solution_,Entity_,Value_>	DefaultMoveStreamFactory.getNodeSharingSupportFunctions(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

Constructors in ai.timefold.solver.core.impl.neighborhood.stream with parameters of type PlanningListVariableMetaModel

Modifier	Constructor	Description
	ListVariableNodeSharingSupportFunctions(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
	ListVariableNodeSharingSupportFunctions(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, UniNeighborhoodsPredicate<Solution_,Value_> unpinnedValueFilter, UniNeighborhoodsPredicate<Solution_,Value_> assignedValueOrNullFilter, UniNeighborhoodsPredicate<Solution_,Value_> assignedValueFilter, BiNeighborhoodsPredicate<Solution_,Entity_,Value_> valueInRangeFilter, BiNeighborhoodsMapper<Solution_,Entity_,Value_,ElementPosition> toElementPositionMapper, BiNeighborhoodsMapper<Solution_,Entity_,Value_,PositionInList> toPositionInListMapper)	Creates an instance of a ListVariableNodeSharingSupportFunctions record class.

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.preview.api.domain.metamodel

Methods in ai.timefold.solver.core.preview.api.domain.metamodel that return PlanningListVariableMetaModel

Modifier and Type	Method	Description
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	GenuineEntityMetaModel.listVariable()	As defined by GenuineEntityMetaModel.genuineVariable(), but only succeeds if the variable is a planning list variable.
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	GenuineEntityMetaModel.listVariable(String variableName)	As defined by PlanningEntityMetaModel.variable(String), but only succeeds if the variable is a planning list variable.
<Value_> PlanningListVariableMetaModel<Solution_,Entity_,Value_>	GenuineEntityMetaModel.listVariable(String variableName, Class<Value_> variableClass)	As defined by GenuineEntityMetaModel.listVariable(String), but only succeeds if the variable is of a given type.

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.preview.api.move

Methods in ai.timefold.solver.core.preview.api.move with parameters of type PlanningListVariableMetaModel

Modifier and Type	Method	Description
default <Entity_, Value_> void	MutableSolutionView.assignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, Entity_ destinationEntity, int destinationIndex)	Deprecated, for removal: This API element is subject to removal in a future version. Use MutableSolutionView.assignValueAndAdd(PlanningListVariableMetaModel, Object, Object, int) instead.
default <Entity_, Value_> void	MutableSolutionView.assignValueAndAdd(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, PositionInList destination)	As defined by MutableSolutionView.assignValueAndAdd(PlanningListVariableMetaModel, Object, Object, int), but using PositionInList to specify the position.
<Entity_, Value_> void	MutableSolutionView.assignValueAndAdd(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, Entity_ destinationEntity, int destinationIndex)	Puts a given value at a particular index in a given entity's planning list variable.
default <Entity_, Value_> void	MutableSolutionView.assignValueAndSet(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, PositionInList destination)	As defined by MutableSolutionView.assignValueAndSet(PlanningListVariableMetaModel, Object, Object, int), but using PositionInList to specify the position.
<Entity_, Value_> void	MutableSolutionView.assignValueAndSet(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, Entity_ destinationEntity, int destinationIndex)	Puts a given value at a particular index in a given entity's planning list variable, much like List.set(int, Object).
<Entity_, Value_> int	SolutionView.countValues(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity)	Reads the value of a list planning variable and returns its length.
<Entity_, Value_> ElementPosition	SolutionView.getPositionOf(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)	Locates a given value in any list planning variable.
<Entity_, Value_> Value_	SolutionView.getValueAtIndex(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int index)	Reads the value of a list planning variable of a given entity at a specific index.
<Entity_, Value_> boolean	SolutionView.isPinned(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, @Nullable Value_ value)	Checking if a PlanningListVariable's value is pinned requires checking: the entity's PlanningPin field, the entity's PlanningPinToIndex field, and the value's position in the list variable. As this is complex, this method is provided as a convenience.
default <Entity_, Value_> Value_	MutableSolutionView.moveValueBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, PositionInList source, PositionInList destination)	As defined by MutableSolutionView.moveValueBetweenLists(PlanningListVariableMetaModel, Object, int, Object, int), but using PositionInList to specify the source and destination positions.
<Entity_, Value_> Value_	MutableSolutionView.moveValueBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, Entity_ destinationEntity, int destinationIndex)	Moves a value from one entity's planning list variable to another.
<Entity_, Value_> Value_	MutableSolutionView.moveValueInList(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, int destinationIndex)	Moves a value within one entity's planning list variable.
default <Entity_, Value_> Value_	MutableSolutionView.shiftValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, PositionInList positionInList, int offset)	As defined by MutableSolutionView.shiftValue(PlanningListVariableMetaModel, Object, int, int), but using PositionInList to specify the source position.
<Entity_, Value_> Value_	MutableSolutionView.shiftValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, int offset)	Moves a value within one entity's planning list variable, by the given offset.
<Entity_, Value_> void	MutableSolutionView.swapValuesBetweenLists(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ leftEntity, int leftIndex, Entity_ rightEntity, int rightIndex)	Swaps two values between two entities' planning list variable.
<Entity_, Value_> void	MutableSolutionView.swapValuesInList(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int leftIndex, int rightIndex)	Swaps two values within one entity's planning list variable.
default <Entity_, Value_> Value_	MutableSolutionView.unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, PositionInList destination)	As defined by MutableSolutionView.unassignValue(PlanningListVariableMetaModel, Object, int), but using PositionInList to specify the position.
<Entity_, Value_> Value_	MutableSolutionView.unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int index)	Removes a value from a given entity's planning list variable at a given index.
<Entity_, Value_> void	MutableSolutionView.unassignValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value)	Removes a given value from the planning list variable that it's part of.

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.preview.api.move.builtin

Methods in ai.timefold.solver.core.preview.api.move.builtin that return types with arguments of type PlanningListVariableMetaModel

Modifier and Type	Method	Description
List<PlanningListVariableMetaModel<Solution_,Entity_,Value_>>	ListAssignMove.variableMetaModels()
List<PlanningListVariableMetaModel<Solution_,Entity_,Value_>>	ListChangeMove.variableMetaModels()
List<PlanningListVariableMetaModel<Solution_,Entity_,Value_>>	ListSwapMove.variableMetaModels()
List<PlanningListVariableMetaModel<Solution_,Entity_,Value_>>	ListUnassignMove.variableMetaModels()

Methods in ai.timefold.solver.core.preview.api.move.builtin with parameters of type PlanningListVariableMetaModel

Modifier and Type	Method	Description
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.assign(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, PositionInList targetPosition)	Creates a move that assigns a value to a list variable at a specified position.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.assign(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Value_ value, Entity_ entity, int index)	As defined by Moves.assign(PlanningListVariableMetaModel, Object, PositionInList), but with explicit entity and index parameters.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.change(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, PositionInList source, PositionInList destination)	Creates a move that moves an element from one position in a list variable to another position.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.change(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, Entity_ destinationEntity, int destinationIndex)	As defined by Moves.change(PlanningListVariableMetaModel, PositionInList, PositionInList), but with explicit entity and index parameters.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.swap(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, PositionInList left, PositionInList right)	Creates a move that swaps two elements between positions in list variables.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.swap(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ leftEntity, int leftIndex, Entity_ rightEntity, int rightIndex)	As defined by Moves.swap(PlanningListVariableMetaModel, PositionInList, PositionInList), but with explicit entity and index parameters.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.unassign(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, PositionInList targetPosition)	Creates a move that unassigns a value from a list variable at a specified position.
static <Solution_, Entity_, Value_> Move<Solution_>	Moves.unassign(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ entity, int index)	As defined by Moves.unassign(PlanningListVariableMetaModel, PositionInList), but with explicit entity and index parameters.

Constructors in ai.timefold.solver.core.preview.api.move.builtin with parameters of type PlanningListVariableMetaModel

Modifier	Constructor	Description
protected	ListChangeMove(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ sourceEntity, int sourceIndex, Entity_ destinationEntity, int destinationIndex)	The move removes a planning value element from sourceEntity.listVariable[sourceIndex] and inserts the planning value at destinationEntity.listVariable[destinationIndex].
	ListChangeMoveProvider(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)
protected	ListSwapMove(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel, Entity_ leftEntity, int leftIndex, Entity_ rightEntity, int rightIndex)	Create a move that swaps a list variable element at leftEntity.listVariable[leftIndex] with rightEntity.listVariable[rightIndex].
	ListSwapMoveProvider(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

Uses of PlanningListVariableMetaModel in ai.timefold.solver.core.preview.api.neighborhood.stream

Methods in ai.timefold.solver.core.preview.api.neighborhood.stream with parameters of type PlanningListVariableMetaModel

Modifier and Type	Method	Description
<Entity_, Value_> UniEnumeratingStream<Solution_,ElementPosition>	MoveStreamFactory.forEachAssignablePosition(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Deprecated, for removal: This API element is subject to removal in a future version. Use MoveStreamFactory.forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel) instead, or see if MoveStreamFactory.forEachDestination(PlanningListVariableMetaModel) or MoveStreamFactory.forEachAssignedValue(PlanningListVariableMetaModel) fits your needs better.
<Entity_, Value_> UniEnumeratingStream<Solution_,Value_>	MoveStreamFactory.forEachAssignedValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Enumerate all values assigned to any entity's PlanningListVariable.
<Entity_, Value_> UniEnumeratingStream<Solution_,Value_>	MoveStreamFactory.forEachAssignedValueUnfiltered(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Enumerate all values assigned to any entity's PlanningListVariable.
<Entity_, Value_> UniEnumeratingStream<Solution_,PositionInList>	MoveStreamFactory.forEachDestination(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Enumerate all possible positions of a list variable to which a value can be assigned.
<Entity_, Value_> UniEnumeratingStream<Solution_,ElementPosition>	MoveStreamFactory.forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	As defined by MoveStreamFactory.forEachDestination(PlanningListVariableMetaModel), but also includes a single UnassignedElement position if the list variable allows unassigned values.