made specs more clear

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403608
This commit is contained in:
Davis King 2010-05-14 00:53:04 +00:00
parent ef6d71c436
commit f50b21eaf0
2 changed files with 3 additions and 3 deletions

View File

@ -33,7 +33,7 @@ namespace dlib
- num > 0 - num > 0
- random_seed must be convertible to a string by dlib::cast_to_string() - random_seed must be convertible to a string by dlib::cast_to_string()
- dist_funct(samples[i], samples[j]) must be a valid expression that evaluates - dist_funct(samples[i], samples[j]) must be a valid expression that evaluates
to a floating point number to a floating point number >= 0
ensures ensures
- This function randomly samples the space of pairs of integers between - This function randomly samples the space of pairs of integers between
0 and samples.size()-1 inclusive. For each of these pairs, (i,j), a 0 and samples.size()-1 inclusive. For each of these pairs, (i,j), a
@ -68,7 +68,7 @@ namespace dlib
- samples.size() > k - samples.size() > k
- k > 0 - k > 0
- dist_funct(samples[i], samples[j]) must be a valid expression that evaluates - dist_funct(samples[i], samples[j]) must be a valid expression that evaluates
to a floating point number to a floating point number >= 0
ensures ensures
- #out == a set of sample_pair objects that represent all the k nearest - #out == a set of sample_pair objects that represent all the k nearest
neighbors in samples according to the given distance function dist_funct. neighbors in samples according to the given distance function dist_funct.

View File

@ -16,7 +16,7 @@ namespace dlib
/*! /*!
WHAT THIS OBJECT REPRESENTS WHAT THIS OBJECT REPRESENTS
This object is intended to represent an edge in an undirected graph This object is intended to represent an edge in an undirected graph
that has data samples in its vertices. So it contains two integers which has data samples at its vertices. So it contains two integers
(index1 and index2) which represent the identifying indices of (index1 and index2) which represent the identifying indices of
the samples at the ends of an edge. Note that this object enforces the samples at the ends of an edge. Note that this object enforces
the constraint that index1 <= index2. This has the effect of the constraint that index1 <= index2. This has the effect of