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

Class AbstractGroupNode<InTuple_ extends AbstractTuple,OutTuple_ extends AbstractTuple,GroupKey_,ResultContainer_,Result_>

java.lang.Object

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

ai.timefold.solver.core.impl.bavet.common.AbstractGroupNode<InTuple_,OutTuple_,GroupKey_,ResultContainer_,Result_>

All Implemented Interfaces:

TupleLifecycle<InTuple_>

Direct Known Subclasses:

Group0Mapping1CollectorBiNode, Group0Mapping1CollectorQuadNode, Group0Mapping1CollectorTriNode, Group0Mapping1CollectorUniNode, Group0Mapping2CollectorBiNode, Group0Mapping2CollectorQuadNode, Group0Mapping2CollectorTriNode, Group0Mapping2CollectorUniNode, Group0Mapping3CollectorBiNode, Group0Mapping3CollectorQuadNode, Group0Mapping3CollectorTriNode, Group0Mapping3CollectorUniNode, Group0Mapping4CollectorBiNode, Group0Mapping4CollectorQuadNode, Group0Mapping4CollectorTriNode, Group0Mapping4CollectorUniNode, Group1Mapping0CollectorBiNode, Group1Mapping0CollectorQuadNode, Group1Mapping0CollectorTriNode, Group1Mapping0CollectorUniNode, Group1Mapping1CollectorBiNode, Group1Mapping1CollectorQuadNode, Group1Mapping1CollectorTriNode, Group1Mapping1CollectorUniNode, Group1Mapping2CollectorBiNode, Group1Mapping2CollectorQuadNode, Group1Mapping2CollectorTriNode, Group1Mapping2CollectorUniNode, Group1Mapping3CollectorBiNode, Group1Mapping3CollectorQuadNode, Group1Mapping3CollectorTriNode, Group1Mapping3CollectorUniNode, Group2Mapping0CollectorBiNode, Group2Mapping0CollectorQuadNode, Group2Mapping0CollectorTriNode, Group2Mapping0CollectorUniNode, Group2Mapping1CollectorBiNode, Group2Mapping1CollectorQuadNode, Group2Mapping1CollectorTriNode, Group2Mapping1CollectorUniNode, Group2Mapping2CollectorBiNode, Group2Mapping2CollectorQuadNode, Group2Mapping2CollectorTriNode, Group2Mapping2CollectorUniNode, Group3Mapping0CollectorBiNode, Group3Mapping0CollectorQuadNode, Group3Mapping0CollectorTriNode, Group3Mapping0CollectorUniNode, Group3Mapping1CollectorBiNode, Group3Mapping1CollectorQuadNode, Group3Mapping1CollectorTriNode, Group3Mapping1CollectorUniNode, Group4Mapping0CollectorBiNode, Group4Mapping0CollectorQuadNode, Group4Mapping0CollectorTriNode, Group4Mapping0CollectorUniNode

public abstract class AbstractGroupNode<InTuple_ extends AbstractTuple,OutTuple_ extends AbstractTuple,GroupKey_,ResultContainer_,Result_>
extends AbstractNode
implements TupleLifecycle<InTuple_>

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractGroupNode(int groupStoreIndex, int undoStoreIndex, Function<InTuple_,GroupKey_> groupKeyFunction, Supplier<ResultContainer_> supplier, Function<ResultContainer_,Result_> finisher, TupleLifecycle<OutTuple_> nextNodesTupleLifecycle, EnvironmentMode environmentMode)
protected	AbstractGroupNode(int groupStoreIndex, Function<InTuple_,GroupKey_> groupKeyFunction, TupleLifecycle<OutTuple_> nextNodesTupleLifecycle, EnvironmentMode environmentMode)

Method Summary

Modifier and Type	Method	Description
protected abstract Runnable	accumulate(ResultContainer_ resultContainer, InTuple_ tuple)
protected abstract OutTuple_	createOutTuple(GroupKey_ groupKey)
Propagator	getPropagator()	Instead of calling the propagation directly from here, we export the propagation queue and allow BavetConstraintSession to call it.
final void	insert(InTuple_ tuple)
final void	retract(InTuple_ tuple)
final void	update(InTuple_ tuple)
protected abstract void	updateOutTupleToResult(OutTuple_ outTuple, Result_ result)

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

getId, getLayerIndex, setId, setLayerIndex, toString

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractGroupNode

protected AbstractGroupNode(int groupStoreIndex,
 int undoStoreIndex,
 Function<InTuple_,GroupKey_> groupKeyFunction,
 Supplier<ResultContainer_> supplier,
 Function<ResultContainer_,Result_> finisher,
 TupleLifecycle<OutTuple_> nextNodesTupleLifecycle,
 EnvironmentMode environmentMode)

AbstractGroupNode

protected AbstractGroupNode(int groupStoreIndex,
 Function<InTuple_,GroupKey_> groupKeyFunction,
 TupleLifecycle<OutTuple_> nextNodesTupleLifecycle,
 EnvironmentMode environmentMode)

Method Details

insert

public final void insert(InTuple_ tuple)

Specified by:

insert in interface TupleLifecycle<InTuple_ extends AbstractTuple>

update

public final void update(InTuple_ tuple)

Specified by:

update in interface TupleLifecycle<InTuple_ extends AbstractTuple>

retract

public final void retract(InTuple_ tuple)

Specified by:

retract in interface TupleLifecycle<InTuple_ extends AbstractTuple>

accumulate

protected abstract Runnable accumulate(ResultContainer_ resultContainer,
 InTuple_ tuple)

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

createOutTuple

protected abstract OutTuple_ createOutTuple(GroupKey_ groupKey)

Parameters:

groupKey - null if the node only has one group

Returns:

never null

updateOutTupleToResult

protected abstract void updateOutTupleToResult(OutTuple_ outTuple,
 Result_ result)