updated docs

8b6cd008 · Davis King · 7897b163 · 8b6cd008 · 8b6cd008 · 8b6cd008
Commit 8b6cd008 authored May 24, 2013 by Davis King
Show whitespace changes
Inline Side-by-side

Showing with 37 additions and 0 deletions

docs/docs/algorithms.xml docs/docs/algorithms.xml +22 -0

docs/docs/main_menu.xml docs/docs/main_menu.xml +4 -0

docs/docs/term_index.xml docs/docs/term_index.xml +11 -0

No files found.
--- a/docs/docs/algorithms.xml
+++ b/docs/docs/algorithms.xml
@@ -38,6 +38,7 @@
         <item>numeric_constants</item> 
         <item>put_in_range</item> 
         <item>qsort_array</item> 
+         <item>integrate_function_adapt_simp</item> 
         <item>square_root</item> 
         <item nolink="true">
            <name>Set Utilities</name>
@@ -654,6 +655,27 @@
      </component>
            
      
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>integrate_function_adapt_simp</name>
+         <file>dlib/numerical_integration.h</file>
+         <spec_file link="true">dlib/numerical_integration/integrate_function_adapt_simpson_abstract.h</spec_file>
+         <description>
+          Computes an approximation of the integral of a real valued function using the
+          adaptive Simpson method outlined in 
+          <blockquote>
+             Gander, W. and W. Gautshi, "Adaptive
+             Quadrature -- Revisited" BIT, Vol. 40, (2000), pp.84-101
+          </blockquote>
+         </description>
+         <examples>
+            <example>integrate_function_adapt_simp_ex.cpp.html</example>
+         </examples>
+                                 
+      </component>
+            
+      
   <!-- ************************************************************************* -->
      
      <component>

--- a/docs/docs/main_menu.xml
+++ b/docs/docs/main_menu.xml
@@ -133,6 +133,10 @@
                  <name>Parallel_For_Loops</name>
                  <link>parallel_for_ex.cpp.html</link>
               </item>
+               <item>
+                  <name>Numerical_Integration</name>
+                  <link>integrate_function_adapt_simp_ex.cpp.html</link>
+               </item>
               <item>
                  <name>SVM-Rank</name>
                  <link>svm_rank_ex.cpp.html</link>

--- a/docs/docs/term_index.xml
+++ b/docs/docs/term_index.xml
@@ -9,6 +9,8 @@
   <body>
      <term_list>

+         <term file="algorithms.html" name="integrate_function_adapt_simp"       include="dlib/numerical_integration.h"/>
+
         <term file="algorithms.html" name="numeric_constants"       include="dlib/numeric_constants.h"/>
         <term link="dlib/numeric_constants.h.html" name="pi"        include="dlib/numeric_constants.h"/>
         <term link="dlib/numeric_constants.h.html" name="e"         include="dlib/numeric_constants.h"/>
@@ -18,6 +20,15 @@
         <term link="dlib/numeric_constants.h.html" name="newton_G"  include="dlib/numeric_constants.h"/>
         <term link="dlib/numeric_constants.h.html" name="planck_cst" include="dlib/numeric_constants.h"/>

+         <term link="dlib/numeric_constants.h.html" name="log10_2"   include="dlib/numeric_constants.h"/>
+         <term link="dlib/numeric_constants.h.html" name="golden_ratio" include="dlib/numeric_constants.h"/>
+         <term link="dlib/numeric_constants.h.html" name="euler_gamma" include="dlib/numeric_constants.h"/>
+         <term link="dlib/numeric_constants.h.html" name="glaisher"  include="dlib/numeric_constants.h"/>
+         <term link="dlib/numeric_constants.h.html" name="catalan"   include="dlib/numeric_constants.h"/>
+         <term link="dlib/numeric_constants.h.html" name="khinchin"  include="dlib/numeric_constants.h"/>
+         <term link="dlib/numeric_constants.h.html" name="apery"     include="dlib/numeric_constants.h"/>
+
+

         <term link="compile.html" name="DLIB_REVISION"/>