Commit e1307b31 authored by Davis King's avatar Davis King

updated docs

parent 7f22ec06
......@@ -79,6 +79,7 @@
<item>convert_unordered_to_ordered</item>
<item>order_by_index</item>
<item>order_by_distance</item>
<item>order_by_descending_distance</item>
<item>order_by_distance_and_index</item>
<item>contains_duplicate_pairs</item>
<item>max_index_plus_one</item>
......@@ -122,6 +123,20 @@
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>order_by_descending_distance</name>
<file>dlib/graph_utils.h</file>
<spec_file link="true">dlib/graph_utils/sample_pair_abstract.h</spec_file>
<description>
This function provides a total ordering of <a href="#sample_pair">sample_pair</a>
or <a href="#ordered_sample_pair">ordered_sample_pair</a> objects that causes
pairs with largest distance to be the first in a sorted list. This function
can be used with std::sort().
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
......@@ -272,6 +272,7 @@
<term file="graph_tools.html" name="ordered_sample_pair" include="dlib/graph_utils.h"/>
<term file="graph_tools.html" name="order_by_index" include="dlib/graph_utils.h"/>
<term file="graph_tools.html" name="order_by_distance" include="dlib/graph_utils.h"/>
<term file="graph_tools.html" name="order_by_descending_distance" include="dlib/graph_utils.h"/>
<term file="graph_tools.html" name="order_by_distance_and_index" include="dlib/graph_utils.h"/>
<term file="graph_tools.html" name="find_percent_shortest_edges_randomly" include="dlib/graph_utils.h"/>
<term file="graph_tools.html" name="find_k_nearest_neighbors" include="dlib/graph_utils.h"/>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment