NextCloud/dlib
1
0
Fork 0
mirror of https://github.com/davisking/dlib.git synced 2024-11-01 10:14:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

updated the docs

Browse Source 
--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403230
This commit is contained in:
Davis King 2009-10-05 00:23:33 +00:00
parent 93bb778fc6
commit 93eda13be7
2 changed files with 59 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
docs/docs/algorithms.xml
View File

@ -35,11 +35,14 @@
<item>negate_function</item>
<item>make_line_search_function</item>
<item>poly_min_extrap</item>
<item>lagrange_poly_min_extrap</item>
<item>line_search</item>
<item>find_min</item>
<item>find_min_single_variable</item>
<item>find_min_using_approximate_derivatives</item>
<item>find_min_bobyqa</item>
<item>find_max</item>
<item>find_max_single_variable</item>
<item>find_max_using_approximate_derivatives</item>
<item>find_max_bobyqa</item>
@ -178,6 +181,19 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>lagrange_poly_min_extrap</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_line_search_abstract.h</spec_file>
<description>
This function finds the second order polynomial that interpolates a
set of points and returns you the minimum of that polynomial.
</description>
</component>
<!-- ************************************************************************* -->
<component>
@ -185,7 +201,7 @@
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_line_search_abstract.h</spec_file>
<description>
Performs a line search on a given function and returns the input
Performs a gradient based line search on a given function and returns the input
that makes the function significantly smaller.
</description>
@ -317,6 +333,19 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>find_min_single_variable</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_line_search_abstract.h</spec_file>
<description>
Performs a bound constrained minimization of a nonlinear function. The
function must be of a single variable. Derivatives are not required.
</description>
</component>
<!-- ************************************************************************* -->
<component>
@ -343,6 +372,13 @@
</blockquote>
</p>
<p>
Note that BOBYQA only works on functions of two or more variables. So if you need to perform
derivative-free optimization on a function of a single variable
then you should use the <a href="#find_min_single_variable">find_min_single_variable</a>
function.
</p>
</description>
<examples>
<example>optimization_ex.cpp.html</example>
@ -361,6 +397,12 @@
except that it negates the objective function before performing optimization.
Thus this function will attempt to find the maximizer of the objective rather than
the minimizer.
<p>
Note that BOBYQA only works on functions of two or more variables. So if you need to perform
derivative-free optimization on a function of a single variable
then you should use the <a href="#find_max_single_variable">find_max_single_variable</a>
function.
</p>
</description>
</component>
@ -396,6 +438,19 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>find_max_single_variable</name>
<file>dlib/optimization.h</file>
<spec_file link="true">dlib/optimization/optimization_line_search_abstract.h</spec_file>
<description>
Performs a bound constrained maximization of a nonlinear function. The
function must be of a single variable. Derivatives are not required.
</description>
</component>
<!-- ************************************************************************* -->
<component>

3
docs/docs/term_index.xml
View File

@ -32,12 +32,15 @@
<term file="algorithms.html" name="derivative"/>
<term file="algorithms.html" name="make_line_search_function"/>
<term file="algorithms.html" name="poly_min_extrap"/>
<term file="algorithms.html" name="lagrange_poly_min_extrap"/>
<term file="algorithms.html" name="line_search"/>
<term file="algorithms.html" name="find_min"/>
<term file="algorithms.html" name="find_min_single_variable"/>
<term file="algorithms.html" name="find_min_using_approximate_derivatives"/>
<term file="algorithms.html" name="find_min_bobyqa"/>
<term link="algorithms.html#find_min_bobyqa" name="BOBYQA"/>
<term file="algorithms.html" name="find_max"/>
<term file="algorithms.html" name="find_max_single_variable"/>
<term file="algorithms.html" name="find_max_using_approximate_derivatives"/>
<term file="algorithms.html" name="find_max_bobyqa"/>
<term file="algorithms.html" name="objective_delta_stop_strategy"/>