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

Class AbstractForEachUniNode<A>

java.lang.Object

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

ai.timefold.solver.core.impl.bavet.uni.AbstractForEachUniNode<A>

Type Parameters:

A -

All Implemented Interfaces:

BavetRootNode<A>

Direct Known Subclasses:

ForEachFilteredUniNode, ForEachUnfilteredUniNode

@NullMarked
public abstract sealed class AbstractForEachUniNode<A>
extends AbstractNode
implements BavetRootNode<A>
permits ForEachFilteredUniNode<A>, ForEachUnfilteredUniNode<A>

Filtering nodes are expensive. Considering that most streams start with a nullity check on genuine planning variables, it makes sense to create a specialized version of the node for this case (ForEachFilteredUniNode), as opposed to forcing an extra filter node on the generic case (ForEachUnfilteredUniNode).

Nested Class Summary

Nested classes/interfaces inherited from interface ai.timefold.solver.core.impl.bavet.common.BavetRootNode

BavetRootNode.LifecycleOperation

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<A,UniTuple<A>>	tupleMap

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractForEachUniNode(Class<A> forEachClass, TupleLifecycle<UniTuple<A>> nextNodesTupleLifecycle, int outputStoreSize)

Method Summary

Modifier and Type	Method	Description
boolean	allowsInstancesOf(Class<?> clazz)
final Class<A>	getForEachClass()
Propagator	getPropagator()	Instead of calling the propagation directly from here, we export the propagation queue and allow BavetConstraintSession to call it.
Class<?>[]	getSourceClasses()
StreamKind	getStreamKind()
void	insert(@Nullable A a)
void	retract(@Nullable A a)
protected void	retractExisting(@Nullable A a, UniTuple<A> tuple)
final String	toString()
protected final void	updateExisting(@Nullable A a, UniTuple<A> tuple)

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

addLocationSet, getId, getLayerIndex, getLocationSet, setId, setLayerIndex

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.BavetRootNode

supports, update

Field Details

tupleMap

protected final Map<A,UniTuple<A>> tupleMap

Constructor Details

AbstractForEachUniNode

protected AbstractForEachUniNode(Class<A> forEachClass,
 TupleLifecycle<UniTuple<A>> nextNodesTupleLifecycle,
 int outputStoreSize)

Method Details

getStreamKind

public StreamKind getStreamKind()

Specified by:

getStreamKind in class AbstractNode

allowsInstancesOf

public boolean allowsInstancesOf(Class<?> clazz)

Specified by:

allowsInstancesOf in interface BavetRootNode<A>

getSourceClasses

public Class<?>[] getSourceClasses()

Specified by:

getSourceClasses in interface BavetRootNode<A>

insert

public void insert(@Nullable A a)

Specified by:

insert in interface BavetRootNode<A>

updateExisting

protected final void updateExisting(@Nullable A a,
 UniTuple<A> tuple)

retract

public void retract(@Nullable A a)

Specified by:

retract in interface BavetRootNode<A>

retractExisting

protected void retractExisting(@Nullable A a,
 UniTuple<A> 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

getForEachClass

public final Class<A> getForEachClass()

toString

public final String toString()

Overrides:

toString in class AbstractNode