Package ai.timefold.solver.constraint.streams.bavet.common

Class AbstractConcatNode<LeftTuple_ extends AbstractTuple,RightTuple_ extends AbstractTuple,OutTuple_ extends AbstractTuple>

java.lang.Object

ai.timefold.solver.constraint.streams.bavet.common.AbstractNode

ai.timefold.solver.constraint.streams.bavet.common.AbstractConcatNode<LeftTuple_,RightTuple_,OutTuple_>

All Implemented Interfaces:

LeftTupleLifecycle<LeftTuple_>, RightTupleLifecycle<RightTuple_>

public abstract class AbstractConcatNode<LeftTuple_ extends AbstractTuple,RightTuple_ extends AbstractTuple,OutTuple_ extends AbstractTuple>
extends AbstractNode
implements LeftTupleLifecycle<LeftTuple_>, RightTupleLifecycle<RightTuple_>

Implements the concat operation. Concat cannot be implemented as a pass-through operation because of two caveats:

• It is possible to have the same TupleSource for both parent streams, in which case the exact same tuple can be inserted twice. Such a tuple should be counted twice downstream, and thus need to be cloned.
• Because concat has two parent nodes, it must be a TupleSource (since all nodes have exactly one TupleSource, and the source tuple can come from either parent). TupleSource must produce new tuples and not reuse them, since if tuples are reused, the stores inside them get corrupted.

The AbstractConcatNode works by creating a copy of the source tuple and putting it into the tuple's store. If the same tuple is inserted twice (i.e. when the left and right parent have the same TupleSource), it creates another clone.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	outputStoreSize

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConcatNode(TupleLifecycle<OutTuple_> nextNodesTupleLifecycle, int leftSourceTupleCloneStoreIndex, int rightSourceTupleCloneStoreIndex, int outputStoreSize)

Method Summary

Modifier and Type	Method	Description
protected abstract OutTuple_	getOutTupleFromLeft(LeftTuple_ leftTuple)
protected abstract OutTuple_	getOutTupleFromRight(RightTuple_ rightTuple)
Propagator	getPropagator()	Instead of calling the propagation directly from here, we export the propagation queue and allow BavetConstraintSession to call it.
final void	insertLeft(LeftTuple_ tuple)
final void	insertRight(RightTuple_ tuple)
final void	retractLeft(LeftTuple_ tuple)
final void	retractRight(RightTuple_ tuple)
final void	updateLeft(LeftTuple_ tuple)
protected abstract void	updateOutTupleFromLeft(LeftTuple_ leftTuple, OutTuple_ outTuple)
protected abstract void	updateOutTupleFromRight(RightTuple_ rightTuple, OutTuple_ outTuple)
final void	updateRight(RightTuple_ tuple)

Methods inherited from class ai.timefold.solver.constraint.streams.bavet.common.AbstractNode

getLayerIndex, setId, setLayerIndex, toString

Methods inherited from class java.lang.Object

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

Field Details

outputStoreSize

protected final int outputStoreSize

Constructor Details

AbstractConcatNode

protected AbstractConcatNode(TupleLifecycle<OutTuple_> nextNodesTupleLifecycle,
 int leftSourceTupleCloneStoreIndex,
 int rightSourceTupleCloneStoreIndex,
 int outputStoreSize)

Method Details

getOutTupleFromLeft

protected abstract OutTuple_ getOutTupleFromLeft(LeftTuple_ leftTuple)

getOutTupleFromRight

protected abstract OutTuple_ getOutTupleFromRight(RightTuple_ rightTuple)

updateOutTupleFromLeft

protected abstract void updateOutTupleFromLeft(LeftTuple_ leftTuple,
 OutTuple_ outTuple)

updateOutTupleFromRight

protected abstract void updateOutTupleFromRight(RightTuple_ rightTuple,
 OutTuple_ outTuple)

insertLeft

public final void insertLeft(LeftTuple_ tuple)

Specified by:

insertLeft in interface LeftTupleLifecycle<LeftTuple_ extends AbstractTuple>

updateLeft

public final void updateLeft(LeftTuple_ tuple)

Specified by:

updateLeft in interface LeftTupleLifecycle<LeftTuple_ extends AbstractTuple>

retractLeft

public final void retractLeft(LeftTuple_ tuple)

Specified by:

retractLeft in interface LeftTupleLifecycle<LeftTuple_ extends AbstractTuple>

insertRight

public final void insertRight(RightTuple_ tuple)

Specified by:

insertRight in interface RightTupleLifecycle<LeftTuple_ extends AbstractTuple>

updateRight

public final void updateRight(RightTuple_ tuple)

Specified by:

updateRight in interface RightTupleLifecycle<LeftTuple_ extends AbstractTuple>

retractRight

public final void retractRight(RightTuple_ tuple)

Specified by:

retractRight in interface RightTupleLifecycle<LeftTuple_ extends AbstractTuple>

getPropagator

public Propagator getPropagator()

Description copied from class: AbstractNode

Instead of calling the propagation directly from here, we export the propagation queue and allow BavetConstraintSession to call it. This is done with the idea that Propagator only has two implementations (unlike AbstractNode with myriad implementations) and therefore JVM call site optimizations will kick in to make the method dispatch faster.

Specified by:

getPropagator in class AbstractNode

Returns:

never null; the PropagationQueue in use by this node