Package ai.timefold.solver.core.preview.api.neighborhood.stream

Interface MoveStreamFactory<Solution_>

All Known Implementing Classes:

DefaultMoveStreamFactory

@NullMarked
public interface MoveStreamFactory<Solution_>

Method Summary

Modifier and Type	Method	Description
<A> UniEnumeratingStream<Solution_,A>	forEach(Class<A> sourceClass, boolean includeNull)	Start a EnumeratingStream of all instances of the sourceClass that are known as problem facts or planning entities.
<Entity_, Value_> UniEnumeratingStream<Solution_,ElementPosition>	forEachAssignablePosition(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Deprecated, for removal: This API element is subject to removal in a future version. Use forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel) instead, or see if forEachDestination(PlanningListVariableMetaModel) or forEachAssignedValue(PlanningListVariableMetaModel) fits your needs better.
<Entity_, Value_> UniEnumeratingStream<Solution_,Value_>	forEachAssignedValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Enumerate all values assigned to any entity's PlanningListVariable.
<Entity_, Value_> UniEnumeratingStream<Solution_,Value_>	forEachAssignedValueUnfiltered(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	Enumerate all values assigned to any entity's PlanningListVariable.
<Entity_, Value_> UniEnumeratingStream<Solution_,PositionInList>	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>	forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)	As defined by forEachDestination(PlanningListVariableMetaModel), but also includes a single UnassignedElement position if the list variable allows unassigned values.
<A> UniEnumeratingStream<Solution_,A>	forEachUnfiltered(Class<A> sourceClass, boolean includeNull)	Start a EnumeratingStream of all instances of the sourceClass that are known as problem facts or planning entities.
<A> UniSamplingStream<Solution_,A>	pick(UniEnumeratingStream<Solution_,A> enumeratingStream)

Method Details

forEach

<A> UniEnumeratingStream<Solution_,A> forEach(Class<A> sourceClass,
 boolean includeNull)

Start a EnumeratingStream of all instances of the sourceClass that are known as problem facts or planning entities.

If the sourceClass is a PlanningEntity, then it is automatically filtered to only contain entities which are not pinned.

If the sourceClass is a shadow entity (an entity without any genuine planning variables), and if there exists a genuine PlanningEntity with a PlanningListVariable which accepts instances of this shadow entity as values in that list, then this stream will filter out all sourceClass instances which are pinned in that list.

This stream returns genuine entities regardless of whether they have any null genuine planning variables. This stream returns shadow entities regardless of whether they are assigned to any genuine entity. They can easily be filtered out.

Parameters:

sourceClass - the class of the instances to enumerate

includeNull - if true, the stream will include a single null element

Returns:

A stream containing a tuple for each of the entities as described above.

See Also:

• An annotation to mark the entire entity as pinned.
• An annotation to specify only a portion of PlanningListVariable is pinned.
• Specialized method exists to automatically include pinned entities as well.

forEachUnfiltered

<A> UniEnumeratingStream<Solution_,A> forEachUnfiltered(Class<A> sourceClass,
 boolean includeNull)

Start a EnumeratingStream of all instances of the sourceClass that are known as problem facts or planning entities. If the sourceClass is a genuine or shadow entity, it returns instances regardless of their pinning status. Otherwise as defined by forEach(Class, boolean).

forEachAssignedValueUnfiltered

<Entity_,
Value_>
UniEnumeratingStream<Solution_,Value_> forEachAssignedValueUnfiltered(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

Enumerate all values assigned to any entity's PlanningListVariable. Unlike forEachAssignedValue(PlanningListVariableMetaModel), this will include pinned values. You can use SolutionView.getPositionOf(PlanningListVariableMetaModel, Object) later downstream to get the position of the value in an entity's list variable, if needed.

Parameters:

variableMetaModel - the meta model of the list variable to enumerate

Returns:

enumerating stream with all values as defined above

See Also:

• An annotation to mark the entire entity as pinned.
• An annotation to specify only a portion of PlanningListVariable is pinned.

forEachAssignedValue

<Entity_,
Value_>
UniEnumeratingStream<Solution_,Value_> forEachAssignedValue(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

Enumerate all values assigned to any entity's PlanningListVariable. This will not include any pinned positions or fully pinned entities. You can use SolutionView.getPositionOf(PlanningListVariableMetaModel, Object) later downstream to get the position of the value in an entity's list variable, if needed.

Parameters:

variableMetaModel - the meta model of the list variable to enumerate

Returns:

enumerating stream with all values as defined above

See Also:

• An annotation to mark the entire entity as pinned.
• An annotation to specify only a portion of PlanningListVariable is pinned.

forEachDestination

<Entity_,
Value_>
UniEnumeratingStream<Solution_,PositionInList> forEachDestination(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

Enumerate all possible positions of a list variable to which a value can be assigned. This will include one position past the current end of the list, allowing for assigning at the end of a list. It will not include any pinned positions or fully pinned entities, as well as UnassignedElement. To include UnassignedElement, use forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel) instead.

Parameters:

variableMetaModel - the meta model of the list variable to enumerate

Returns:

enumerating stream with positions as defined above

See Also:

• Read more about element positions.
• An annotation to mark the entire entity as pinned.
• An annotation to specify only a portion of PlanningListVariable is pinned.

forEachDestinationIncludingUnassigned

<Entity_,
Value_>
UniEnumeratingStream<Solution_,ElementPosition> forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

As defined by forEachDestination(PlanningListVariableMetaModel), but also includes a single UnassignedElement position if the list variable allows unassigned values. If the list variable does not allow unassigned values, then this method behaves exactly the same as forEachDestination(PlanningListVariableMetaModel).

pick

<A> UniSamplingStream<Solution_,A> pick(UniEnumeratingStream<Solution_,A> enumeratingStream)

forEachAssignablePosition

@Deprecated(forRemoval=true)
<Entity_,
Value_>
UniEnumeratingStream<Solution_,ElementPosition> forEachAssignablePosition(PlanningListVariableMetaModel<Solution_,Entity_,Value_> variableMetaModel)

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

Use forEachDestinationIncludingUnassigned(PlanningListVariableMetaModel) instead, or see if forEachDestination(PlanningListVariableMetaModel) or forEachAssignedValue(PlanningListVariableMetaModel) fits your needs better.

Enumerate all possible positions of a list variable to which a value can be assigned. This will eliminate all positions on pinned entities, as well as all pinned indexes. If the list variable allows unassigned values, the resulting stream will include a single instance of UnassignedElement instance.

Will be removed right before this API is moved out of preview.

Parameters:

variableMetaModel - the meta model of the list variable to enumerate

Returns:

enumerating stream with all assignable positions of a given list variable

See Also:

• Read more about element positions.