OrgLion-ML
/
dlib
mirror of https://github.com/davisking/dlib.git
1
0
Fork 0
Code Issues Releases Wiki Activity

updated the docs 

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%402276
This commit is contained in:
Davis King 2008-05-26 03:59:19 +00:00
parent e996a133e8
commit 8bcd5d73f5
3 changed files with 64 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/docs/algorithms.xml
View File

@ -37,6 +37,8 @@
<item>line_search</item>
<item>find_min_quasi_newton</item>
<item>find_min_conjugate_gradient</item>
<item>find_min_quasi_newton2</item>
<item>find_min_conjugate_gradient2</item>
</sub>
</item>
<item nolink="true">
@ -301,6 +303,34 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>find_min_quasi_newton2</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. This version doesn't take a gradient function of f()
but instead numerically approximates the gradient.
</description>
</component>
<!-- ************************************************************************* -->
<component>
<name>find_min_conjugate_gradient2</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. This version doesn't take a gradient function of f()
but instead numerically approximates the gradient.
</description>
</component>
<!-- ************************************************************************* -->
<component>

31
docs/docs/metaprogramming.xml
View File

@ -32,6 +32,7 @@
<name>Objects</name>
<item>is_pointer_type</item>
<item>is_same_type</item>
<item>is_function</item>
<item>is_signed_type</item>
<item>is_unsigned_type</item>
<item>static_switch</item>
@ -57,6 +58,7 @@
<item>_dT</item>
<item>TIME_THIS</item>
<item>assign_zero_if_built_in_scalar_type</item>
<item>wrap_function</item>
</section>
<section>
@ -147,6 +149,19 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>is_function</name>
<file>dlib/algs.h</file>
<spec_file link="true">dlib/algs.h</spec_file>
<description>
This is a template where is_function&lt;T&gt;::value == true when T is
a function type.
</description>
</component>
<!-- ************************************************************************* -->
<component>
@ -416,7 +431,7 @@
<component>
<name>assign_zero_if_built_in_scalar_type</name>
<file>dlib/algs.h</file>
<spec_file>dlib/algs.h</spec_file>
<spec_file link="true">dlib/algs.h</spec_file>
<description>
<p>
This function assigns its argument the value of 0 if it is a built in scalar
@ -434,6 +449,20 @@
</component>
<!-- ************************************************************************* -->
<component>
<name>wrap_function</name>
<file>dlib/algs.h</file>
<spec_file link="true">dlib/algs.h</spec_file>
<description>
This is a template that allows you to turn a global function into a
function object. See the specs for more details.
</description>
</component>
<!-- ************************************************************************* -->
<component>

4
docs/docs/term_index.xml
View File

@ -322,6 +322,8 @@
<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#find_min_quasi_newton2" name="find_min_quasi_newton2"/>
<term link="algorithms.html#find_min_conjugate_gradient2" name="find_min_conjugate_gradient2"/>
<term link="algorithms.html#rectangle" name="rectangle"/>
@ -543,6 +545,8 @@
<term link="metaprogramming.html#_dT" name="_dT"/>
<term link="metaprogramming.html#is_pointer_type" name="is_pointer_type"/>
<term link="metaprogramming.html#is_same_type" name="is_same_type"/>
<term link="metaprogramming.html#is_function" name="is_function"/>
<term link="metaprogramming.html#wrap_function" name="wrap_function"/>
<term link="metaprogramming.html#is_signed_type" name="is_signed_type"/>
<term link="metaprogramming.html#is_unsigned_type" name="is_unsigned_type"/>
<term link="metaprogramming.html#noncopyable" name="noncopyable"/>