Class DurationSegment

pyvrp/cpp/DurationSegment.h:50–185

* DurationSegment( * duration: int = 0, * time_warp: int = 0, * start_early: int = 0, * start_late: int = np.iinfo(np.int64).max, * release_time: int = 0, * cum_duration: int = 0, * cum_time_warp: int = 0, * prev_end_late: int = np.iinfo(np.int64).max, * ) * * Creates a duration segment. * * Duration segments can be efficiently concatenated, and track s

 *     Latest end time of the previous trip, if any. Default unconstrained.
 */
class DurationSegment
{
    Duration duration_ = 0;    // of current trip
    Duration timeWarp_ = 0;    // of current trip
    Duration startEarly_ = 0;  // of current trip
    Duration startLate_
        = std::numeric_limits<Duration>::max();  // of current trip
    Duration releaseTime_ = 0;                   // of current trip
    Duration cumDuration_ = 0;  // cumulative, excl. current trip
    Duration cumTimeWarp_ = 0;  // cumulative, excl. current trip
    Duration prevEndLate_
        = std::numeric_limits<Duration>::max();  // of prev trip

public:
    [[nodiscard]] static inline DurationSegment
    merge(Duration const edgeDuration,
          DurationSegment const &first,
          DurationSegment const &second);

    [[nodiscard]] static inline DurationSegment  // convenient helper
    merge(DurationSegment const &first, DurationSegment const &second);

    /**
     * Finalises this segment towards the back (at the end of the segment),
     * and returns a new segment where release times have been reset, and all
     * other statistics have been suitably adjusted. This is useful with
     * multiple trips because the finalised segment can be concatenated with
     * segments of later trips.
     */
    [[nodiscard]] inline DurationSegment finaliseBack() const;

    /**
     * Finalises this segment towards the front (at the start of the segment),
     * and returns a new segment where release times have been reset, and all
     * other statistics have been suitably adjusted. This is useful with
     * multiple trips because the finalised segment can be concatenated with
     * segments of earlier trips.
     */
    [[nodiscard]] inline DurationSegment finaliseFront() const;

    /**
     * The total duration of the whole segment.
     */
    [[nodiscard]] inline Duration duration() const;

    /**
     * Returns the time warp on this whole segment. Additionally, any time warp
     * incurred by violating the maximum duration argument is also counted.
     *
     * Parameters
     * ----------
     * max_duration
     *     Maximum allowed duration, if provided. If the segment's duration
     *     exceeds this value, any excess duration is counted as time warp.
     *     Default unconstrained.
     *
     * Returns
     * -------