updated the docs

--HG--
extra : convert_revision : svn%3Afdd8eb12-d10e-0410-9acb-85c331704f74/trunk%403200

docs/docs/algorithms.xml

@@ -45,6 +45,7 @@
                <item>bfgs_search_strategy</item>
                <item>lbfgs_search_strategy</item>
                <item>objective_delta_stop_strategy</item>
+               <item>gradient_norm_stop_strategy</item>
             </sub>
          </item>
          <item nolink="true">
@@ -283,6 +284,21 @@
                                  
       </component>
 
+   <!-- ************************************************************************* -->
+      
+      <component>
+         <name>gradient_norm_stop_strategy</name>
+         <file>dlib/optimization.h</file>
+         <spec_file link="true">dlib/optimization/optimization_stop_strategies_abstract.h</spec_file>
+         <description>
+                This object represents a strategy for deciding if an optimization
+                algorithm should terminate.   This particular object looks at the 
+                norm (i.e. the length) of the current gradient vector and
+                stops if it is smaller than a user given threshold.  
+         </description>
+                                 
+      </component>
+
    <!-- ************************************************************************* -->
       
       <component>

docs/docs/term_index.xml

@@ -38,6 +38,7 @@
          <term file="algorithms.html" name="find_max"/>
          <term file="algorithms.html" name="find_max_using_approximate_derivatives"/>
          <term file="algorithms.html" name="objective_delta_stop_strategy"/>
+         <term file="algorithms.html" name="gradient_norm_stop_strategy"/>
          <term file="algorithms.html" name="negate_function"/>
          <term file="algorithms.html" name="cg_search_strategy"/>
          <term file="algorithms.html" name="bfgs_search_strategy"/>