Package ai.timefold.solver.core.impl.score.stream.collector.consecutive

Class ConsecutiveSetTree<Value_,Point_ extends Comparable<Point_>,Difference_ extends Comparable<Difference_>>

java.lang.Object

ai.timefold.solver.core.impl.score.stream.collector.consecutive.ConsecutiveSetTree<Value_,Point_,Difference_>

Type Parameters:

Value_ - The type of value stored (examples: shifts)

Point_ - The type of the point (examples: int, LocalDateTime)

Difference_ - The type of the difference (examples: int, Duration)

All Implemented Interfaces:

SequenceChain<Value_,Difference_>

public final class ConsecutiveSetTree<Value_,Point_ extends Comparable<Point_>,Difference_ extends Comparable<Difference_>>
extends Object
implements SequenceChain<Value_,Difference_>

A ConsecutiveSetTree determines what values are consecutive. A sequence x₁, x₂, x₃, ..., x_n is understood to be consecutive by d iff x₂ − x₁ ≤ d, x₃ − x₂ ≤ d, ..., x_n − x_n-1 ≤ d. This data structure can be thought as an interval tree that maps the point p to the interval [p, p + d].

Constructor Summary

Constructors

Constructor	Description
ConsecutiveSetTree(BiFunction<Point_,Point_,Difference_> differenceFunction, BinaryOperator<Difference_> sumFunction, Difference_ maxDifference, Difference_ zeroDifference)

Method Summary

Modifier and Type	Method	Description
boolean	add(Value_ value, Point_ valueIndex)
@NonNull Collection<Break<Value_,Difference_>>	getBreaks()
@NonNull Collection<Sequence<Value_,Difference_>>	getConsecutiveSequences()
@Nullable Break<Value_,Difference_>	getFirstBreak()	Returns the first break between two consecutive sequences of values.
@Nullable Sequence<Value_,Difference_>	getFirstSequence()	Returns the first sequence of consecutive values.
@Nullable Break<Value_,Difference_>	getLastBreak()	Returns the last break between two consecutive sequences of values.
@Nullable Sequence<Value_,Difference_>	getLastSequence()	Returns the last sequence of consecutive values.
boolean	remove(Value_ value)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ConsecutiveSetTree

public ConsecutiveSetTree(BiFunction<Point_,Point_,Difference_> differenceFunction,
 BinaryOperator<Difference_> sumFunction,
 Difference_ maxDifference,
 Difference_ zeroDifference)

Method Details

getConsecutiveSequences

public @NonNull Collection<Sequence<Value_,Difference_>> getConsecutiveSequences()

Specified by:

getConsecutiveSequences in interface SequenceChain<Value_,Point_ extends Comparable<Point_>>

Returns:

the sequences contained in the collection in ascending order.

getBreaks

public @NonNull Collection<Break<Value_,Difference_>> getBreaks()

Specified by:

getBreaks in interface SequenceChain<Value_,Point_ extends Comparable<Point_>>

Returns:

the breaks contained in the collection in ascending order.

getFirstSequence

public @Nullable Sequence<Value_,Difference_> getFirstSequence()

Description copied from interface: SequenceChain

Returns the first sequence of consecutive values.

Specified by:

getFirstSequence in interface SequenceChain<Value_,Point_ extends Comparable<Point_>>

Returns:

null if there are no sequences

getLastSequence

public @Nullable Sequence<Value_,Difference_> getLastSequence()

Description copied from interface: SequenceChain

Returns the last sequence of consecutive values.

Specified by:

getLastSequence in interface SequenceChain<Value_,Point_ extends Comparable<Point_>>

Returns:

null if there are no sequences

getFirstBreak

public @Nullable Break<Value_,Difference_> getFirstBreak()

Description copied from interface: SequenceChain

Returns the first break between two consecutive sequences of values.

Specified by:

getFirstBreak in interface SequenceChain<Value_,Point_ extends Comparable<Point_>>

Returns:

null if there are less than two sequences

getLastBreak

public @Nullable Break<Value_,Difference_> getLastBreak()

Description copied from interface: SequenceChain

Returns the last break between two consecutive sequences of values.

Specified by:

getLastBreak in interface SequenceChain<Value_,Point_ extends Comparable<Point_>>

Returns:

null if there are less than two sequences

add

public boolean add(Value_ value,
 Point_ valueIndex)

remove

public boolean remove(Value_ value)

toString

public String toString()

Overrides:

toString in class Object