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

Class DefaultMoveStreamFactory<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.move.streams.DefaultMoveStreamFactory<Solution_>

All Implemented Interfaces:

MoveStreamFactory<Solution_>

@NullMarked
public final class DefaultMoveStreamFactory<Solution_>
extends Object
implements MoveStreamFactory<Solution_>

Constructor Summary

Constructors

Constructor	Description
DefaultMoveStreamFactory(SolutionDescriptor<Solution_> solutionDescriptor)

Method Summary

Modifier and Type	Method	Description
DefaultMoveStreamSession<Solution_>	createSession(Solution_ workingSolution, SupplyManager supplyManager)
<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.
<Entity_, A> UniDataStream<Solution_,A>	enumeratePossibleValues(PlanningVariableMetaModel<Solution_,Entity_,A> variableMetaModel)	Enumerate possible values for a given basic variable.
SolutionDescriptor<Solution_>	getSolutionDescriptor()
<A> UniMoveStream<Solution_,A>	pick(UniDataStream<Solution_,A> dataStream)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.impl.move.streams.maybeapi.stream.MoveStreamFactory

enumeratePossiblePositions, pick

Constructor Details

DefaultMoveStreamFactory

public DefaultMoveStreamFactory(SolutionDescriptor<Solution_> solutionDescriptor)

Method Details

createSession

public DefaultMoveStreamSession<Solution_> createSession(Solution_ workingSolution,
 SupplyManager supplyManager)

enumerate

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

Description copied from interface: MoveStreamFactory

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.

Specified by:

enumerate in interface MoveStreamFactory<Solution_>

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

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

Description copied from interface: MoveStreamFactory

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 MoveStreamFactory.enumerate(Class).

Specified by:

enumerateIncludingPinned in interface MoveStreamFactory<Solution_>

enumeratePossibleValues

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

Description copied from interface: MoveStreamFactory

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

Specified by:

enumeratePossibleValues in interface MoveStreamFactory<Solution_>

Returns:

data stream with all possible values of a given variable

See Also:

• For list variables, use a specialized method.

pick

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

Specified by:

pick in interface MoveStreamFactory<Solution_>

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()