[Boost-commit] svn:boost r38635 - sandbox/math_toolkit/libs/math/doc

From: pbristow_at_[hidden]
Date: 2007-08-13 17:40:00

Author: pbristow
Date: 2007-08-13 17:40:00 EDT (Mon, 13 Aug 2007)
New Revision: 38635
URL: http://svn.boost.org/trac/boost/changeset/38635

Log:
update for polices
Text files modified: 
   sandbox/math_toolkit/libs/math/doc/roots_without_derivatives.qbk |     4 +++-                                    
   sandbox/math_toolkit/libs/math/doc/structure.qbk                 |    10 ++--------                              
   2 files changed, 5 insertions(+), 9 deletions(-)

Modified: sandbox/math_toolkit/libs/math/doc/roots_without_derivatives.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/roots_without_derivatives.qbk	(original)
+++ sandbox/math_toolkit/libs/math/doc/roots_without_derivatives.qbk	2007-08-13 17:40:00 EDT (Mon, 13 Aug 2007)
@@ -170,7 +170,9 @@
 [[min] [The left bracket of the interval known to contain the root.]]
 [[max] [The right bracket of the interval known to contain the root.
         It is a precondition that /min < max/ and /f(min)*f(max) <= 0/,
-        the function calls __logic_error if these preconditions are violated.]]
+        the function signals evaluation error if these preconditions are violated.
+        The action taken is controlled by the evaluation error policy.
+        A best guess may be returned, perhaps significantly wrong.]]
 [[tol]  [A binary functor that specifies the termination condition: the function
         will return the current brackets enclosing the root when /tol(min,max)/ becomes true.]]
 [[max_iter][The maximum number of invocations of /f(x)/ to make while searching for the root.]]

Modified: sandbox/math_toolkit/libs/math/doc/structure.qbk
==============================================================================
--- sandbox/math_toolkit/libs/math/doc/structure.qbk	(original)
+++ sandbox/math_toolkit/libs/math/doc/structure.qbk	2007-08-13 17:40:00 EDT (Mon, 13 Aug 2007)
@@ -67,14 +67,8 @@
 
 [h4 Configuration Policy Macros - Controlling Handling Arguments, Undefined Functions, Throwing of Exceptions, Accuracy, ]
 
-TODO: this is out of date, rewrite me!!
-
-* *BOOST_MATH_DOMAIN_ERROR_POLICY*
-
-See [link math_toolkit.special.error_handling Error handling]
-
-See [link math_toolkit.policy Error handling]
-and [@../../example/error_handling_example.cpp error_handling_example.cpp].
+See [link math_toolkit.policy Policy]
+on the default behaviour (that may well be suitable) and, if not, how to control it.
 
 [endsect][/sect:structure Getting About - Directory, Namespace & File structure]