From: Jean-Philippe ARGAUD Date: Sun, 18 Nov 2012 21:18:11 +0000 (+0100) Subject: Documenting default ProjectedGradientTolerance X-Git-Tag: V6_6_0~3 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=ad835462644874fdbb569728b238721e25d4d47f;p=modules%2Fadao.git Documenting default ProjectedGradientTolerance --- diff --git a/doc/reference.rst b/doc/reference.rst index d316761..e1adc70 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -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