org.optaplanner.examples.common.experimental.api.IntervalBreak Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of optaplanner-examples Show documentation

OptaPlanner solves planning problems. This lightweight, embeddable planning engine implements powerful and scalable algorithms to optimize business resource scheduling and planning. This module contains the examples which demonstrate how to use it in a normal Java application.

There is a newer version: 9.44.0.Final

Show newest version

package org.optaplanner.examples.common.experimental.api;

/**
 * An IntervalBreak is a gap between two consecutive interval clusters. For instance,
 * the list [(1,3),(2,4),(3,5),(7,8)] has a break of length 2 between 5 and 7.
 *
 * @param  The type of value in the sequence
 * @param  The type of difference between values in the sequence
 */
public interface IntervalBreak, Difference_ extends Comparable> {
    /**
     * @return never null, the interval cluster leading directly into this
     */
    IntervalCluster getPreviousIntervalCluster();

    /**
     * @return never null, the interval cluster immediately following this
     */
    IntervalCluster getNextIntervalCluster();

    /**
     * Return the end of the sequence before this break. For the
     * break between 6 and 10, this will return 6.
     *
     * @return never null, the item this break is directly after
     */
    default Point_ getPreviousIntervalClusterEnd() {
        return getPreviousIntervalCluster().getEnd();
    };

    /**
     * Return the start of the sequence after this break. For the
     * break between 6 and 10, this will return 10.
     *
     * @return never null, the item this break is directly before
     */
    default Point_ getNextIntervalClusterStart() {
        return getNextIntervalCluster().getStart();
    }

    /**
     * Return the length of the break, which is the difference
     * between {@link #getNextIntervalClusterStart()} and {@link #getPreviousIntervalClusterEnd()}. For the
     * break between 6 and 10, this will return 4.
     *
     * @return never null, the length of this break
     */
    Difference_ getLength();
}