Clarified spec

This commit is contained in:
Davis King 2014-02-22 17:35:48 -05:00
parent 85b6a50a9d
commit b0cdcd82a9
1 changed files with 5 additions and 1 deletions

View File

@ -387,7 +387,9 @@ namespace dlib
ensures ensures
- Takes an input sequence and returns a list of detected segments within - Takes an input sequence and returns a list of detected segments within
that sequence. that sequence.
- returns a std::vector Y of segments such that: - None of the returned segments will overlap.
- The returned segments are listed in the order they appeared in the input sequence.
- To be precise, this function returns a std::vector Y of segments such that:
- Y.size() == the number of segments detected in the input sequence x. - Y.size() == the number of segments detected in the input sequence x.
- for all valid i: - for all valid i:
- Y[i].first == the start of the i-th segment. - Y[i].first == the start of the i-th segment.
@ -398,6 +400,8 @@ namespace dlib
- Y[i].second <= x.size() - Y[i].second <= x.size()
- Y[i].first < Y[i].second - Y[i].first < Y[i].second
(i.e. This function never outputs empty segments) (i.e. This function never outputs empty segments)
- Y[i].second <= Y[i+1].first
(i.e. the segments are listed in order of appearance and do not overlap)
!*/ !*/
void segment_sequence ( void segment_sequence (