From 9c8c179b7f84c17184cfc28117de889aea80372e Mon Sep 17 00:00:00 2001 From: Davis King Date: Mon, 5 Nov 2012 22:03:59 -0500 Subject: [PATCH] updated docs --- docs/docs/graph_tools.xml | 64 +++++++++++++++++++-------------------- docs/docs/term_index.xml | 10 +++--- 2 files changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/docs/graph_tools.xml b/docs/docs/graph_tools.xml index 6c01a25d4..83b3a8605 100644 --- a/docs/docs/graph_tools.xml +++ b/docs/docs/graph_tools.xml @@ -78,8 +78,8 @@ sample_pair - dlib/manifold_regularization.h - dlib/manifold_regularization/sample_pair_abstract.h + dlib/graph_utils.h + dlib/graph_utils/sample_pair_abstract.h This object is intended to represent an edge in an undirected graph which has data samples at its vertices. Therefore, it is the undirected version @@ -96,8 +96,8 @@ ordered_sample_pair - dlib/manifold_regularization.h - dlib/manifold_regularization/ordered_sample_pair_abstract.h + dlib/graph_utils.h + dlib/graph_utils/ordered_sample_pair_abstract.h This object is intended to represent an edge in a directed graph which has data samples at its vertices. Therefore, it is the directed version @@ -109,8 +109,8 @@ find_percent_shortest_edges_randomly - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This function is a simple approximate form of find_k_nearest_neighbors. Instead of checking all possible edges it randomly samples a large number of them and @@ -127,8 +127,8 @@ find_k_nearest_neighbors - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This is a function which finds all the k nearest neighbors of a set of points and outputs the result as a vector of sample_pair objects. It takes O(n^2) where @@ -142,8 +142,8 @@ find_approximate_k_nearest_neighbors - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This function is a simple approximate form of find_k_nearest_neighbors. Instead of checking all possible edges it randomly samples a large number of them and then performs @@ -155,8 +155,8 @@ remove_short_edges - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This is a simple function for removing edges with a small distance value from a vector of sample_pair or ordered_sample_pair objects. @@ -168,8 +168,8 @@ remove_duplicate_edges - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This is a simple function for removing duplicate edges (i.e. edges that compare equal according to ==) from @@ -181,8 +181,8 @@ remove_long_edges - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This is a simple function for removing edges with a large distance value from a vector of sample_pair or ordered_sample_pair objects. @@ -194,8 +194,8 @@ remove_percent_longest_edges - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This is a simple function for removing edges with a large distance value from a vector of sample_pair or ordered_sample_pair objects. @@ -207,8 +207,8 @@ remove_percent_shortest_edges - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This is a simple function for removing edges with a small distance value from a vector of sample_pair or ordered_sample_pair objects. @@ -220,8 +220,8 @@ squared_euclidean_distance - dlib/manifold_regularization.h - dlib/manifold_regularization/function_objects_abstract.h + dlib/graph_utils.h + dlib/graph_utils/function_objects_abstract.h This is a simple function object that computes squared euclidean distance between two matrix objects. @@ -236,8 +236,8 @@ use_weights_of_one - dlib/manifold_regularization.h - dlib/manifold_regularization/function_objects_abstract.h + dlib/graph_utils.h + dlib/graph_utils/function_objects_abstract.h This is a simple function object that takes a single argument and always returns 1 @@ -249,8 +249,8 @@ use_gaussian_weights - dlib/manifold_regularization.h - dlib/manifold_regularization/function_objects_abstract.h + dlib/graph_utils.h + dlib/graph_utils/function_objects_abstract.h This is a simple function object that takes a single argument which should be an object similar to sample_pair. @@ -265,8 +265,8 @@ is_ordered_by_index - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This function checks if a vector of sample_pair or ordered_sample_pair objects is in sorted @@ -278,8 +278,8 @@ find_neighbor_ranges - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This function takes a graph, defined by a vector of ordered_sample_pair objects, and finds the @@ -292,8 +292,8 @@ convert_unordered_to_ordered - dlib/manifold_regularization.h - dlib/manifold_regularization/graph_creation_abstract.h + dlib/graph_utils.h + dlib/graph_utils/edge_list_graphs_abstract.h This function takes a graph, defined by a vector of sample_pair objects and converts it into the equivalent diff --git a/docs/docs/term_index.xml b/docs/docs/term_index.xml index f3fcd9d00..313e9a8a4 100644 --- a/docs/docs/term_index.xml +++ b/docs/docs/term_index.xml @@ -220,9 +220,9 @@ - - - + + + @@ -234,9 +234,9 @@ - + - +