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

Class StaticPropagationQueue<Tuple_ extends Tuple>

java.lang.Object

ai.timefold.solver.core.impl.bavet.common.StaticPropagationQueue<Tuple_>

Type Parameters:

Tuple_ -

All Implemented Interfaces:

PropagationQueue<Tuple_>, Propagator

public final class StaticPropagationQueue<Tuple_ extends Tuple>
extends Object
implements PropagationQueue<Tuple_>

The implementation moves tuples directly into an either retract, update or insert queue, without any option of moving between the queues. This is the most efficient implementation. It will throw exceptions if a tuple is in the wrong queue, based on its state.

Constructor Summary

Constructors

Constructor	Description
StaticPropagationQueue(TupleLifecycle<Tuple_> nextNodesTupleLifecycle)
StaticPropagationQueue(TupleLifecycle<Tuple_> nextNodesTupleLifecycle, int size)

Method Summary

Modifier and Type	Method	Description
void	insert(Tuple_ carrier)
void	propagateInserts()	Must by preceded by Propagator.propagateRetracts() and Propagator.propagateUpdates().
void	propagateRetracts()	Starts the propagation event.
void	propagateUpdates()	Must be preceded by Propagator.propagateRetracts() and followed by Propagator.propagateInserts().
void	retract(Tuple_ carrier, TupleState state)
void	update(Tuple_ carrier)	Double updates of the same item count as a single update.

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.impl.bavet.common.Propagator

propagateEverything

Constructor Details

StaticPropagationQueue

public StaticPropagationQueue(TupleLifecycle<Tuple_> nextNodesTupleLifecycle,
 int size)

StaticPropagationQueue

public StaticPropagationQueue(TupleLifecycle<Tuple_> nextNodesTupleLifecycle)

Method Details

insert

public void insert(Tuple_ carrier)

Specified by:

insert in interface PropagationQueue<Tuple_ extends Tuple>

update

public void update(Tuple_ carrier)

Description copied from interface: PropagationQueue

Double updates of the same item count as a single update.

Specified by:

update in interface PropagationQueue<Tuple_ extends Tuple>

Parameters:

carrier - the item to be updated in the propagation queue

retract

public void retract(Tuple_ carrier,
 TupleState state)

Specified by:

retract in interface PropagationQueue<Tuple_ extends Tuple>

propagateRetracts

public void propagateRetracts()

Description copied from interface: Propagator

Starts the propagation event. Must be followed by Propagator.propagateUpdates().

Specified by:

propagateRetracts in interface Propagator

propagateUpdates

public void propagateUpdates()

Description copied from interface: Propagator

Must be preceded by Propagator.propagateRetracts() and followed by Propagator.propagateInserts().

Specified by:

propagateUpdates in interface Propagator

propagateInserts

public void propagateInserts()

Description copied from interface: Propagator

Must by preceded by Propagator.propagateRetracts() and Propagator.propagateUpdates(). Ends the propagation event and clears the queue.

Specified by:

propagateInserts in interface Propagator