]> SALOME platform Git repositories - modules/adao.git/commitdiff
Salome HOME
Documenting default ProjectedGradientTolerance
authorJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sun, 18 Nov 2012 21:18:11 +0000 (22:18 +0100)
committerJean-Philippe ARGAUD <jean-philippe.argaud@edf.fr>
Sun, 18 Nov 2012 21:18:11 +0000 (22:18 +0100)
doc/reference.rst

index d3167617ae62c5f959f71b52f44e21490a357fb4..e1adc70f020d7fc2253aa6d928d9c55b1e529a15 100644 (file)
@@ -354,10 +354,10 @@ in the :ref:`genindex` or the :ref:`section_glossary`.
     recommended to adapt it the needs on real problems.
 
   ProjectedGradientTolerance
-    This key indicates a limit value, leading to stop successfully the
-    iterative optimization process when all the components of the projected
-    gradient are under this limit. It is only used for constrained algorithms.
-    The default is -1, that is the internal default of each algorithm, and it
+    This key indicates a limit value, leading to stop successfully the iterative
+    optimization process when all the components of the projected gradient are
+    under this limit. It is only used for constrained algorithms. The default is
+    -1, that is the internal default of each algorithm (generally 1.e-5), and it
     is not recommended to change it.
 
   GradientNormTolerance
@@ -410,10 +410,10 @@ in the :ref:`genindex` or the :ref:`section_glossary`.
     recommended to adapt it the needs on real problems.
 
   ProjectedGradientTolerance
-    This key indicates a limit value, leading to stop successfully the
-    iterative optimization process when all the components of the projected
-    gradient are under this limit. It is only used for constrained algorithms.
-    The default is -1, that is the internal default of each algorithm, and it
+    This key indicates a limit value, leading to stop successfully the iterative
+    optimization process when all the components of the projected gradient are
+    under this limit. It is only used for constrained algorithms. The default is
+    -1, that is the internal default of each algorithm (generally 1.e-5), and it
     is not recommended to change it.
 
   GradientNormTolerance