[Boost-bugs] [Boost C++ Libraries] #9225: Document the max_iter parameter in math::tools::newton_raphson_iterate and others

Subject: [Boost-bugs] [Boost C++ Libraries] #9225: Document the max_iter parameter in math::tools::newton_raphson_iterate and others
From: Boost C++ Libraries (noreply_at_[hidden])
Date: 2013-10-10 21:49:13

#9225: Document the max_iter parameter in math::tools::newton_raphson_iterate and
others
------------------------------+-------------------------
 Reporter:  eu@…              |      Owner:  johnmaddock
     Type:  Bugs              |     Status:  new
Milestone:  To Be Determined  |  Component:  math
  Version:  Boost 1.55.0      |   Severity:  Cosmetic
 Keywords:                    |
------------------------------+-------------------------
 The max_iter parameter is passed as (non-const) `boost::uintmat_t &
 max_iter`. This number is subtracted from in every iteration in the
 solver. By subtracting initial minus final values, the number of steps
 necessary for convergence can be determined. As this information is vital
 for profiling the code, this use of the parameter should be clearly
 documented.

-- 
Ticket URL: <https://svn.boost.org/trac/boost/ticket/9225>
Boost C++ Libraries <http://www.boost.org/>
Boost provides free peer-reviewed portable C++ source libraries.