Skip to content

D
dlib
Commit f79434b5 authored by Davis King's avatar Davis King
Browse files
Options

updated the docs 

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402267
parent 14bb3b36
Hide whitespace changes
Inline Side-by-side
Showing with 167 additions and 62 deletions
docs/docs/algorithms.xml
View file @ f79434b5
...@@ -23,17 +23,35 @@ ...@@ -23,17 +23,35 @@
<menu width="150"> <menu width="150">
<top> <top>
<section> <section>
<name>Objects</name> <name>Tools</name>
<item>bigint</item> <item>bigint</item>
<item>crc32</item> <item>crc32</item>
<item>rand</item> <item>rand</item>
<item>mlp</item> <item>mlp</item>
<item nolink="true">
<name>Optimization</name>
<sub>
<item>derivative</item>
<item>make_line_search_function</item>
<item>poly_min_extrap</item>
<item>line_search</item>
<item>find_min_quasi_newton</item>
<item>find_min_conjugate_gradient</item>
</sub>
</item>
<item nolink="true"> <item nolink="true">
<name>Geometry</name> <name>Geometry</name>
<sub> <sub>
<item>rectangle</item> <item>rectangle</item>
<item>vector</item> <item>vector</item>
<item>point</item> <item>point</item>
<item>centered_rect</item>
<item>translate_rect</item>
<item>resize_rect</item>
<item>resize_rect_width</item>
<item>resize_rect_height</item>
<item>move_rect</item>
<item>nearest_point</item>
</sub> </sub>
</item> </item>
<item nolink="true"> <item nolink="true">
...@@ -45,6 +63,41 @@ ...@@ -45,6 +63,41 @@
<item>bayes_node</item> <item>bayes_node</item>
<item>bayesian_network_gibbs_sampler</item> <item>bayesian_network_gibbs_sampler</item>
<item>bayesian_network_join_tree</item> <item>bayesian_network_join_tree</item>
<item nolink="true">
<name>Bayes Node Utilities</name>
<sub>
<item>set_node_value</item>
<item>node_value</item>
<item>node_is_evidence</item>
<item>set_node_as_evidence</item>
<item>set_node_as_nonevidence</item>
<item>set_node_num_values</item>
<item>node_num_values</item>
<item>node_probability</item>
<item>set_node_probability</item>
<item>node_first_parent_assignment</item>
<item>node_next_parent_assignment</item>
<item>node_cpt_filled_out</item>
</sub>
</item>
</sub>
</item>
<item nolink="true">
<name>Graph Utilities</name>
<sub>
<item>graph_contains_directed_cycle</item>
<item>graph_contains_undirected_cycle</item>
<item>create_moral_graph</item>
<item>triangulate_graph_and_find_cliques</item>
<item>graph_contains_length_one_cycle</item>
<item>find_connected_nodes</item>
<item>graph_is_connected</item>
<item>is_clique</item>
<item>is_maximal_clique</item>
<item>copy_graph_structure</item>
<item>edge</item>
<item>is_join_tree</item>
<item>create_join_tree</item>
</sub> </sub>
</item> </item>
<item nolink="true"> <item nolink="true">
...@@ -57,39 +110,19 @@ ...@@ -57,39 +110,19 @@
<item>probabilistic_decision_function</item> <item>probabilistic_decision_function</item>
<item>krls</item> <item>krls</item>
<item>kcentroid</item> <item>kcentroid</item>
<item>svm_nu_train</item>
<item>svm_nu_train_prob</item>
<item>svm_nu_cross_validate</item>
</sub> </sub>
</item> </item>
</section>
<section>
<name>Global Functions</name>
<item>randomize_samples</item> <item>randomize_samples</item>
<item>hsort_array</item> <item>hsort_array</item>
<item>isort_array</item> <item>isort_array</item>
<item>put_in_range</item>
<item>md5</item> <item>md5</item>
<item>median</item> <item>median</item>
<item>qsort_array</item> <item>qsort_array</item>
<item>square_root</item> <item>square_root</item>
<item nolink="true">
<name>Geometry</name>
<sub>
<item>centered_rect</item>
<item>translate_rect</item>
<item>resize_rect</item>
<item>resize_rect_width</item>
<item>resize_rect_height</item>
<item>move_rect</item>
<item>nearest_point</item>
</sub>
</item>
<item nolink="true">
<name>SVM Utilities</name>
<sub>
<item>svm_nu_train</item>
<item>svm_nu_train_prob</item>
<item>svm_nu_cross_validate</item>
</sub>
</item>
<item nolink="true"> <item nolink="true">
<name>Set Utilities</name> <name>Set Utilities</name>
<sub> <sub>
...@@ -99,44 +132,8 @@ ...@@ -99,44 +132,8 @@
<item>set_difference</item> <item>set_difference</item>
</sub> </sub>
</item> </item>
<item nolink="true">
<name>Graph Utilities</name>
<sub>
<item>graph_contains_directed_cycle</item>
<item>graph_contains_undirected_cycle</item>
<item>create_moral_graph</item>
<item>triangulate_graph_and_find_cliques</item>
<item>graph_contains_length_one_cycle</item>
<item>find_connected_nodes</item>
<item>graph_is_connected</item>
<item>is_clique</item>
<item>is_maximal_clique</item>
<item>copy_graph_structure</item>
<item>edge</item>
<item>is_join_tree</item>
<item>create_join_tree</item>
</sub>
</item>
<item nolink="true">
<name>Bayes Node Utilities</name>
<sub>
<item>set_node_value</item>
<item>node_value</item>
<item>node_is_evidence</item>
<item>set_node_as_evidence</item>
<item>set_node_as_nonevidence</item>
<item>set_node_num_values</item>
<item>node_num_values</item>
<item>node_probability</item>
<item>set_node_probability</item>
<item>node_first_parent_assignment</item>
<item>node_next_parent_assignment</item>
<item>node_cpt_filled_out</item>
</sub>
</item>
</section> </section>
</top> </top>
</menu> </menu>
...@@ -222,7 +219,88 @@ ...@@ -222,7 +219,88 @@
</description> </description>
</component> </component>
<!-- ************************************************************************* -->
<component>
<name>derivative</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_abstract.h</spec_file>
<description>
This is a function that takes another function as input and returns
a function object that numerically computes the derivative of the input function.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>make_line_search_function</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_abstract.h</spec_file>
<description>
This is a function that takes another function f(x) as input and returns
a function object l(z) = f(start + z*direction).
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>poly_min_extrap</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_abstract.h</spec_file>
<description>
This function finds the 3rd degree polynomial that interpolates a
set of points and returns you the minimum of that polynomial.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>line_search</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_abstract.h</spec_file>
<description>
Performs a line search on a given function and returns the input
that makes the function significantly smaller.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>find_min_quasi_newton</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_abstract.h</spec_file>
<description>
Performs an unconstrained minimization of the function f() using a
quasi newton method.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>find_min_conjugate_gradient</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_abstract.h</spec_file>
<description>
Performs an unconstrained minimization of the function f() using a
conjugate gradient method.
</description>
</component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component> <component>
...@@ -877,6 +955,20 @@ ...@@ -877,6 +955,20 @@
</component> </component>
<!-- ************************************************************************* -->
<component>
<name>put_in_range</name>
<file>dlib/algs.h</file>
<spec_file link="true">dlib/algs.h</spec_file>
<description>
This is a simple function that takes a range and a value and returns the given
value if it is within the range. If it isn't in the range then it returns the
end of range value that is closest.
</description>
</component>
<!-- ************************************************************************* --> <!-- ************************************************************************* -->
<component> <component>
......
docs/docs/term_index.xml
View file @ f79434b5
...@@ -312,6 +312,18 @@ ...@@ -312,6 +312,18 @@
<term link="dlib/geometry/rectangle_abstract.h.html#centered_rect" name="centered_rect"/> <term link="dlib/geometry/rectangle_abstract.h.html#centered_rect" name="centered_rect"/>
<term link="dlib/geometry/rectangle_abstract.h.html#nearest_point" name="nearest_point"/> <term link="dlib/geometry/rectangle_abstract.h.html#nearest_point" name="nearest_point"/>
<term link="dlib/optimization/optimization_abstract.h.html#central_differences" name="central_differences"/>
<term link="dlib/optimization/optimization_abstract.h.html#line_search_funct" name="line_search_funct"/>
<term link="algorithms.html#derivative" name="derivative"/>
<term link="algorithms.html#make_line_search_function" name="make_line_search_function"/>
<term link="algorithms.html#poly_min_extrap" name="poly_min_extrap"/>
<term link="algorithms.html#line_search" name="line_search"/>
<term link="algorithms.html#find_min_quasi_newton" name="find_min_quasi_newton"/>
<term link="algorithms.html#find_min_conjugate_gradient" name="find_min_conjugate_gradient"/>
<term link="algorithms.html#rectangle" name="rectangle"/> <term link="algorithms.html#rectangle" name="rectangle"/>
<term link="algorithms.html#set_node_value" name="set_node_value"/> <term link="algorithms.html#set_node_value" name="set_node_value"/>
<term link="algorithms.html#node_value" name="node_value"/> <term link="algorithms.html#node_value" name="node_value"/>
...@@ -343,6 +355,7 @@ ...@@ -343,6 +355,7 @@
<term link="algorithms.html#bigint" name="bigint"/> <term link="algorithms.html#bigint" name="bigint"/>
<term link="algorithms.html#crc32" name="crc32"/> <term link="algorithms.html#crc32" name="crc32"/>
<term link="algorithms.html#hsort_array" name="hsort_array"/> <term link="algorithms.html#hsort_array" name="hsort_array"/>
<term link="algorithms.html#put_in_range" name="put_in_range"/>
<term link="algorithms.html#isort_array" name="isort_array"/> <term link="algorithms.html#isort_array" name="isort_array"/>
<term link="algorithms.html#md5" name="md5"/> <term link="algorithms.html#md5" name="md5"/>
<term link="algorithms.html#median" name="median"/> <term link="algorithms.html#median" name="median"/>
......
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