Opened 9 years ago
Closed 9 years ago
#9225 closed Bugs (fixed)
Document the max_iter parameter in math::tools::newton_raphson_iterate and others
| Reported by: | Owned by: | John Maddock | |
|---|---|---|---|
| Milestone: | To Be Determined | Component: | math |
| Version: | Boost 1.55.0 | Severity: | Cosmetic |
| Keywords: | Cc: | pbristow@… |
Description
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.
Change History (3)
comment:1 by , 9 years ago
comment:2 by , 9 years ago
| Cc: | added |
|---|
Nod. We need to make these root finding algorithms first-class-citizens of the library and document them properly.
Note:
See TracTickets
for help on using tickets.
Sorry for confusion, the
max_iteris set to the actual number of iteration steps made.