Package ai.timefold.solver.core.impl.score.stream.bavet

Class BavetConstraintFactory<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.score.stream.common.InnerConstraintFactory<Solution_,BavetConstraint<Solution_>>

ai.timefold.solver.core.impl.score.stream.bavet.BavetConstraintFactory<Solution_>

All Implemented Interfaces:

ConstraintFactory

public final class BavetConstraintFactory<Solution_>
extends InnerConstraintFactory<Solution_,BavetConstraint<Solution_>>

Constructor Summary

Constructors

Constructor	Description
BavetConstraintFactory(SolutionDescriptor<Solution_> solutionDescriptor, EnvironmentMode environmentMode)

Method Summary

Modifier and Type	Method	Description
<A> @NonNull UniConstraintStream<A>	forEach(@NonNull Class<A> sourceClass)	Start a ConstraintStream of all instances of the sourceClass that are known as problem facts or planning entities.
<A> @NonNull UniConstraintStream<A>	forEachIncludingUnassigned(@NonNull Class<A> sourceClass)	As defined by ConstraintFactory.forEach(Class), but without any filtering of unassigned planning entities (for PlanningVariable.allowsUnassigned()) or shadow entities not assigned to any applicable list variable (for PlanningListVariable.allowsUnassignedValues()).
<A> @NonNull UniConstraintStream<A>	from(@NonNull Class<A> fromClass)	This method is deprecated.
<A> @NonNull UniConstraintStream<A>	fromUnfiltered(@NonNull Class<A> fromClass)	This method is deprecated.
@NonNull String	getDefaultConstraintPackage()
EnvironmentMode	getEnvironmentMode()
SolutionDescriptor<Solution_>	getSolutionDescriptor()
<Stream_ extends BavetAbstractConstraintStream<Solution_>> Stream_	share(Stream_ stream)
<Stream_ extends BavetAbstractConstraintStream<Solution_>> Stream_	share(Stream_ stream, Consumer<Stream_> consumer)	Enables node sharing.

Methods inherited from class ai.timefold.solver.core.impl.score.stream.common.InnerConstraintFactory

assertValidFromType, buildConstraints, forEachUniquePair, fromUniquePair

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.api.score.stream.ConstraintFactory

forEachIncludingNullVars, forEachUniquePair, forEachUniquePair, forEachUniquePair, forEachUniquePair, forEachUniquePair, fromUniquePair, fromUniquePair, fromUniquePair, fromUniquePair, fromUniquePair

Constructor Details

BavetConstraintFactory

public BavetConstraintFactory(SolutionDescriptor<Solution_> solutionDescriptor,
 EnvironmentMode environmentMode)

Method Details

share

public <Stream_ extends BavetAbstractConstraintStream<Solution_>>
Stream_ share(Stream_ stream)

share

public <Stream_ extends BavetAbstractConstraintStream<Solution_>>
Stream_ share(Stream_ stream,
 Consumer<Stream_> consumer)

Enables node sharing. If a constraint already exists in this factory, it replaces it with the old copy. BavetAbstractConstraintStream implement equals/hashcode ignoring child streams.

BavetConstraintSessionFactory.buildSession(Object, ConstraintMatchPolicy, boolean, Consumer) needs this to happen for all streams.

This must be called before the stream receives child streams.

Type Parameters:

Stream_ - the BavetAbstractConstraintStream subclass

Parameters:

stream - never null

consumer - never null

Returns:

never null

forEach

public <A> @NonNull UniConstraintStream<A> forEach(@NonNull Class<A> sourceClass)

Description copied from interface: ConstraintFactory

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 for which each genuine PlanningVariable (of the sourceClass or a superclass thereof) has a non-null value.

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, and if that list variable allows unassigned values, then this stream will filter out all sourceClass instances which are not present in any instances of that list variable. This is achieved in one of two ways:

• If the sourceClass has InverseRelationShadowVariable field referencing instance of an entity with the list variable, the value of that field will be used to determine if the value is assigned. Null in that field means the instance of sourceClass is unassigned.
• As fallback, the value is considered assigned if there exists an instance of the entity where its list variable contains the value. This will perform significantly worse and only exists so that using the InverseRelationShadowVariable can remain optional. Adding the field is strongly recommended.

Type Parameters:

A - the type of the matched problem fact or planning entity

forEachIncludingUnassigned

public <A> @NonNull UniConstraintStream<A> forEachIncludingUnassigned(@NonNull Class<A> sourceClass)

Description copied from interface: ConstraintFactory

As defined by ConstraintFactory.forEach(Class), but without any filtering of unassigned planning entities (for PlanningVariable.allowsUnassigned()) or shadow entities not assigned to any applicable list variable (for PlanningListVariable.allowsUnassignedValues()).

Type Parameters:

A - the type of the matched problem fact or planning entity

from

public <A> @NonNull UniConstraintStream<A> from(@NonNull Class<A> fromClass)

Description copied from interface: ConstraintFactory

This method is deprecated. Migrate uses of this method to ConstraintFactory.forEach(Class), but first understand this:

• If none of your planning variables allow unassigned values, then the replacement by ConstraintFactory.forEach(Class) has little to no impact. Subsequent conditional propagation calls (UniConstraintStream.ifExists(java.lang.Class<B>, ai.timefold.solver.core.api.score.stream.bi.BiJoiner<A, B>) etc.) will now also filter out planning entities with null variables, consistently with ConstraintFactory.forEach(Class) family of methods and with joining.
• If any of your planning variables allow unassigned values, then there is severe impact. Calls to the ConstraintFactory.forEach(Class) family of methods will now filter out planning entities with null variables, so most constraints no longer need to do null checks, but the constraint that penalizes unassigned entities (typically a medium constraint) must now use ConstraintFactory.forEachIncludingUnassigned(Class) instead. Subsequent joins and conditional propagation calls will now also consistently filter out planning entities with null variables.

The original Javadoc of this method follows:

Start a ConstraintStream of all instances of the fromClass that are known as problem facts or planning entities.

If the fromClass is a PlanningEntity, then it is automatically filtered to only contain fully initialized entities, for which each genuine PlanningVariable (of the fromClass or a superclass thereof) is initialized. This filtering will NOT automatically apply to genuine planning variables of subclass planning entities of the fromClass.

Type Parameters:

A - the type of the matched problem fact or planning entity

fromUnfiltered

public <A> @NonNull UniConstraintStream<A> fromUnfiltered(@NonNull Class<A> fromClass)

Description copied from interface: ConstraintFactory

This method is deprecated. Migrate uses of this method to ConstraintFactory.forEachIncludingUnassigned(Class), but first understand that subsequent joins and conditional propagation calls (UniConstraintStream.ifExists(java.lang.Class<B>, ai.timefold.solver.core.api.score.stream.bi.BiJoiner<A, B>) etc.) will now also consistently filter out planning entities with null variables.

The original Javadoc of this method follows:

As defined by ConstraintFactory.from(Class), but without any filtering of uninitialized planning entities.

Type Parameters:

A - the type of the matched problem fact or planning entity

getSolutionDescriptor

public SolutionDescriptor<Solution_> getSolutionDescriptor()

Specified by:

getSolutionDescriptor in class InnerConstraintFactory<Solution_,BavetConstraint<Solution_>>

Returns:

never null

getEnvironmentMode

public EnvironmentMode getEnvironmentMode()

getDefaultConstraintPackage

public @NonNull String getDefaultConstraintPackage()