clarified spec

This commit is contained in:
Davis King 2012-11-07 22:22:10 -05:00
parent dd97e3b4cc
commit f827c493a1

View File

@ -95,8 +95,9 @@ namespace dlib
- T is a type with an interface compatible with sample_pair. - T is a type with an interface compatible with sample_pair.
ensures ensures
- provides a total ordering of sample_pair objects that will cause pairs that are - provides a total ordering of sample_pair objects that will cause pairs that are
equal to be adjacent when sorted. This function can be used with std::sort() to equal to be adjacent when sorted. So for example, this function can be used
first sort sequences of sample_pair objects and then find duplicate edges. with std::sort() to first sort a sequence of sample_pair objects and then
find duplicate edges.
!*/ !*/
template <typename T> template <typename T>
@ -110,7 +111,7 @@ namespace dlib
ensures ensures
- provides a total ordering of sample_pair objects that causes pairs with - provides a total ordering of sample_pair objects that causes pairs with
smallest distance to be the first in a sorted list. This function can be smallest distance to be the first in a sorted list. This function can be
used with std::sort() used with std::sort().
!*/ !*/
template <typename T> template <typename T>
@ -125,7 +126,7 @@ namespace dlib
- provides a total ordering of sample_pair objects that causes pairs with - provides a total ordering of sample_pair objects that causes pairs with
smallest distance to be the first in a sorted list but also orders samples smallest distance to be the first in a sorted list but also orders samples
with equal distances according to order_by_index(). This function can be with equal distances according to order_by_index(). This function can be
used with std::sort() used with std::sort().
!*/ !*/
// ---------------------------------------------------------------------------------------- // ----------------------------------------------------------------------------------------