Module livesplit_core::analysis::sum_of_segments
source · Expand description
Provides functionality for calculating the Sum of Best Segments and the Sum of Worst Segments for whole runs or specific parts. The Sum of Best Segments is the fastest time possible to complete a run of a category, based on information collected from all the previous attempts. This often matches up with the sum of the best segment times of all the segments, but that may not always be the case, as skipped segments may introduce combined segments that may be faster than the actual sum of their best segment times. The name is therefore a bit misleading, but sticks around for historical reasons.
Modules
Provides functionality for calculating the Sum of Best Segments for whole
Run
or specific parts. The Sum of Best Segments is the fastest
time possible to complete a run of a category, based on information collected
from all the previous attempts. This often matches up with the sum of the
best segment times of all the segments, but that may not always be the case,
as skipped segments may introduce combined segments that may be faster than
the actual sum of their best segment times. The name is therefore a bit
misleading, but sticks around for historical reasons.Provides functionality for calculating the Sum of Worst Segments for whole
Run
or specific parts. The Sum of Worst Segments is the
slowest time possible to complete a run of a category, based on information
collected from all the previous attempts. This obviously isn’t really the worst
possible time, but may be useful information regardless.Structs
Describes the shortest amount of time it takes to reach a certain segment.
Since there is the possibility that the shortest path is actually skipping
segments, there’s an additional predecessor index that describes the segment
this prediction is based on. By following all the predecessors backwards,
you can get access to the single fastest route.
Functions
Calculates the Sum of Best Segments for the timing method provided. This is
the fastest time possible to complete a run of a category, based on
information collected from all the previous attempts. This often matches up
with the sum of the best segment times of all the segments, but that may not
always be the case, as skipped segments may introduce combined segments that
may be faster than the actual sum of their best segment times. The name is
therefore a bit misleading, but sticks around for historical reasons. You
can choose to do a simple calculation instead, which excludes the Segment
History from the calculation process. If there’s an active attempt, you can
choose to take it into account as well.
Calculates the Sum of Worst Segments for the timing method provided. This is
the slowest time possible to complete a run of a category, based on
information collected from all the previous attempts. This obviously isn’t
really the worst possible time, but may be useful information regardless.
If there’s an active attempt, you can choose to take it into account as
well.
Follows a path starting from a certain segment in a certain attempt to the
next split that didn’t get skipped. Returns the index of the segment after
the segment that has the next split time and a sum of the combined segment
times and the current time provided. If the tracked attempt ends before a
split time is found, the index returned is 0.