Skip to content

GitLab

Commit b0b281cb authored by Davis King's avatar Davis King
Browse files

updated docs

parent f827c493
Show whitespace changes
Inline Side-by-side
Showing with 84 additions and 5 deletions
docs/docs/graph_tools.xml
View file @ b0b281cb
......@@ -64,6 +64,11 @@
<item>is_ordered_by_index</item>
<item>find_neighbor_ranges</item>
<item>convert_unordered_to_ordered</item>
<item>order_by_index</item>
<item>order_by_distance</item>
<item>order_by_distance_and_index</item>
<item>contains_duplicate_pairs</item>
<item>max_index_plus_one</item>
</section>
</top>
</menu>
......@@ -74,6 +79,80 @@
<components>
<!-- ************************************************************************* -->
<component>
<name>order_by_index</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 will cause pairs that represent the same edge to be adjacent
when sorted. So for example, this function can be used
with std::sort() to first sort a sequence of sample_pair objects and then
find duplicate edges.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>order_by_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 smallest distance to be the first in a sorted list. This function
can be used with std::sort().
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>order_by_distance_and_index</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 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 used with std::sort().
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>contains_duplicate_pairs</name>
<file>dlib/graph_utils.h</file>
<spec_file link="true">dlib/graph_utils/edge_list_graphs_abstract.h</spec_file>
<description>
This function checks if a std::vector of <a href="#sample_pair">sample_pair</a> or
<a href="#ordered_sample_pair">ordered_sample_pair</a> objects
contains any edge more than once.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>max_index_plus_one</name>
<file>dlib/graph_utils.h</file>
<spec_file link="true">dlib/graph_utils/edge_list_graphs_abstract.h</spec_file>
<description>
This function finds the number that is one greater than the largest index
value in a std::vector of <a href="#sample_pair">sample_pair</a> or
<a href="#ordered_sample_pair">ordered_sample_pair</a> objects. Therefore,
it is useful for finding out how many nodes are in an edge list graph (assuming
the graph contains all node indices from 0 to the largest index indicated
by an edge).
</description>
</component>
<!-- ************************************************************************* -->
<component>
......
docs/docs/term_index.xml
View file @ b0b281cb
......@@ -220,9 +220,9 @@
<term file="graph_tools.html" name="sample_pair"/>
<term file="graph_tools.html" name="ordered_sample_pair"/>
<term file="dlib/graph_utils/sample_pair_abstract.h.html" name="order_by_index"/>
<term file="dlib/graph_utils/sample_pair_abstract.h.html" name="order_by_distance"/>
<term file="dlib/graph_utils/sample_pair_abstract.h.html" name="order_by_distance_and_index"/>
<term file="graph_tools.html" name="order_by_index"/>
<term file="graph_tools.html" name="order_by_distance"/>
<term file="graph_tools.html" name="order_by_distance_and_index"/>
<term file="graph_tools.html" name="find_percent_shortest_edges_randomly"/>
<term file="graph_tools.html" name="find_k_nearest_neighbors"/>
<term file="graph_tools.html" name="remove_short_edges"/>
......@@ -234,9 +234,9 @@
<term file="graph_tools.html" name="remove_percent_longest_edges"/>
<term file="graph_tools.html" name="remove_percent_shortest_edges"/>
<term file="graph_tools.html" name="find_approximate_k_nearest_neighbors"/>
<term file="dlib/graph_utils/edge_list_graphs_abstract.h.html" name="contains_duplicate_pairs"/>
<term file="graph_tools.html" name="contains_duplicate_pairs"/>
<term name="max_index_plus_one">
<term link="dlib/graph_utils/edge_list_graphs_abstract.h.html#max_index_plus_one" name="for graphs"/>
<term link="graph_tools.html#max_index_plus_one" name="for graphs"/>
<term link="dlib/svm/sparse_vector_abstract.h.html#max_index_plus_one" name="for sparse vectors"/>
</term>
<term file="dlib/svm/sparse_vector_abstract.h.html" name="sparse_matrix_vector_multiply"/>
......
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