Package ai.timefold.solver.core.impl.move.streams.maybeapi.stream

Interface MoveStreamFactory<Solution_>

All Known Implementing Classes:

DefaultMoveStreamFactory

@NullMarked
public interface MoveStreamFactory<Solution_>

Method Summary

Modifier and Type	Method	Description
<A> UniDataStream<Solution_,A>	enumerate(Class<A> sourceClass)	Start a ConstraintStream of all instances of the sourceClass that are known as problem facts or planning entities.
<A> UniDataStream<Solution_,A>	enumerateIncludingPinned(Class<A> sourceClass)	Start a ConstraintStream of all instances of the sourceClass that are known as problem facts or planning entities.
default <Entity_, A> UniDataStream<Solution_,A>	enumeratePossiblePositions(PlanningListVariableMetaModel<Solution_,Entity_,A> variableMetaModel)
<Entity_, A> UniDataStream<Solution_,A>	enumeratePossibleValues(PlanningVariableMetaModel<Solution_,Entity_,A> variableMetaModel)	Enumerate possible values for a given basic variable.
<A> UniMoveStream<Solution_,A>	pick(UniDataStream<Solution_,A> dataStream)
default <A> UniMoveStream<Solution_,A>	pick(Class<A> clz)

Method Details

enumerate

<A> UniDataStream<Solution_,A> enumerate(Class<A> sourceClass)

Start a ConstraintStream 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 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.

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.

enumerateIncludingPinned

<A> UniDataStream<Solution_,A> enumerateIncludingPinned(Class<A> sourceClass)

Start a ConstraintStream 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 enumerate(Class).

enumeratePossibleValues

<Entity_,
A> UniDataStream<Solution_,A> enumeratePossibleValues(PlanningVariableMetaModel<Solution_,Entity_,A> variableMetaModel)

Enumerate possible values for a given basic variable. If the variable allows unassigned values, the resulting stream will include a null value.

Returns:

data stream with all possible values of a given variable

Throws:

UnsupportedOperationException - If the variable in question is a list variable, or if the basic variable is chained.

See Also:

• For list variables, use a specialized method.

enumeratePossiblePositions

default <Entity_,
A> UniDataStream<Solution_,A> enumeratePossiblePositions(PlanningListVariableMetaModel<Solution_,Entity_,A> variableMetaModel)

pick

default <A> UniMoveStream<Solution_,A> pick(Class<A> clz)

pick

<A> UniMoveStream<Solution_,A> pick(UniDataStream<Solution_,A> dataStream)