Package ai.timefold.solver.core.impl.bavet.common

Class AbstractJoinNode<LeftTuple_ extends Tuple,Right_,OutTuple_ extends Tuple>

java.lang.Object

ai.timefold.solver.core.impl.bavet.common.AbstractNode

ai.timefold.solver.core.impl.bavet.common.AbstractTwoInputNode<LeftTuple_,UniTuple<Right_>>

ai.timefold.solver.core.impl.bavet.common.AbstractJoinNode<LeftTuple_,Right_,OutTuple_>

Type Parameters:

LeftTuple_ -

Right_ -

All Implemented Interfaces:

LeftTupleLifecycle<LeftTuple_>, RightTupleLifecycle<UniTuple<Right_>>

Direct Known Subclasses:

AbstractIndexedJoinNode, AbstractUnindexedJoinNode

public abstract class AbstractJoinNode<LeftTuple_ extends Tuple,Right_,OutTuple_ extends Tuple>
extends AbstractTwoInputNode<LeftTuple_,UniTuple<Right_>>

This class has two direct children: AbstractIndexedJoinNode and AbstractUnindexedJoinNode. The logic in either is identical, except that the latter removes all indexing work. Therefore any time that one of the classes changes, the other should be inspected if it could benefit from applying the change there too.

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	inputStoreIndexLeftOutTupleList
protected final int	inputStoreIndexRightOutTupleList
protected final OutTupleStorePositionTracker	outputStoreSizeTracker

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractJoinNode(TupleLifecycle<OutTuple_> nextNodesTupleLifecycle, boolean isFiltering, InOutTupleStorePositionTracker tupleStorePositionTracker)

Method Summary

Modifier and Type	Method	Description
protected abstract OutTuple_	createOutTuple(LeftTuple_ leftTuple, UniTuple<Right_> rightTuple)
Propagator	getPropagator()	Instead of calling the propagation directly from here, we export the propagation queue and allow BavetConstraintSession to call it.
StreamKind	getStreamKind()
protected final void	innerUpdateLeft(LeftTuple_ leftTuple, Consumer<Consumer<UniTuple<Right_>>> rightTupleConsumer)
protected final void	innerUpdateRight(UniTuple<Right_> rightTuple, Consumer<Consumer<LeftTuple_>> leftTupleConsumer)
protected final void	insertOutTuple(LeftTuple_ leftTuple, UniTuple<Right_> rightTuple)
protected final void	insertOutTupleFiltered(LeftTuple_ leftTuple, UniTuple<Right_> rightTuple)
protected final void	insertOutTupleFilteredFromLeft(LeftTuple_ leftTuple, UniTuple<Right_> rightTuple)
protected abstract void	setOutTupleLeftFacts(OutTuple_ outTuple, LeftTuple_ leftTuple)
protected abstract void	setOutTupleRightFact(OutTuple_ outTuple, UniTuple<Right_> rightTuple)
protected abstract boolean	testFiltering(LeftTuple_ leftTuple, UniTuple<Right_> rightTuple)

Methods inherited from class ai.timefold.solver.core.impl.bavet.common.AbstractNode

addLocationSet, getId, getLayerIndex, getLocationSet, setId, setLayerIndex, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.impl.bavet.common.tuple.LeftTupleLifecycle

insertLeft, retractLeft, updateLeft

Methods inherited from interface ai.timefold.solver.core.impl.bavet.common.tuple.RightTupleLifecycle

insertRight, retractRight, updateRight

Field Details

inputStoreIndexLeftOutTupleList

protected final int inputStoreIndexLeftOutTupleList

inputStoreIndexRightOutTupleList

protected final int inputStoreIndexRightOutTupleList

outputStoreSizeTracker

protected final OutTupleStorePositionTracker outputStoreSizeTracker

Constructor Details

AbstractJoinNode

protected AbstractJoinNode(TupleLifecycle<OutTuple_> nextNodesTupleLifecycle,
 boolean isFiltering,
 InOutTupleStorePositionTracker tupleStorePositionTracker)

Method Details

getStreamKind

public StreamKind getStreamKind()

Specified by:

getStreamKind in class AbstractNode

createOutTuple

protected abstract OutTuple_ createOutTuple(LeftTuple_ leftTuple,
 UniTuple<Right_> rightTuple)

setOutTupleLeftFacts

protected abstract void setOutTupleLeftFacts(OutTuple_ outTuple,
 LeftTuple_ leftTuple)

setOutTupleRightFact

protected abstract void setOutTupleRightFact(OutTuple_ outTuple,
 UniTuple<Right_> rightTuple)

testFiltering

protected abstract boolean testFiltering(LeftTuple_ leftTuple,
 UniTuple<Right_> rightTuple)

insertOutTuple

protected final void insertOutTuple(LeftTuple_ leftTuple,
 UniTuple<Right_> rightTuple)

insertOutTupleFilteredFromLeft

protected final void insertOutTupleFilteredFromLeft(LeftTuple_ leftTuple,
 UniTuple<Right_> rightTuple)

insertOutTupleFiltered

protected final void insertOutTupleFiltered(LeftTuple_ leftTuple,
 UniTuple<Right_> rightTuple)

innerUpdateLeft

protected final void innerUpdateLeft(LeftTuple_ leftTuple,
 Consumer<Consumer<UniTuple<Right_>>> rightTupleConsumer)

innerUpdateRight

protected final void innerUpdateRight(UniTuple<Right_> rightTuple,
 Consumer<Consumer<LeftTuple_>> leftTupleConsumer)

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