ABC for iteration classes to derive from.
More...
#include <Iteration.hpp>
Inherited by nc::roots::Bisection, nc::roots::Brent, nc::roots::Dekker, nc::roots::Newton, and nc::roots::Secant.
ABC for iteration classes to derive from.
◆ Iteration() [1/2]
nc::roots::Iteration::Iteration |
( |
double |
epsilon | ) |
|
|
inlineexplicitnoexcept |
◆ Iteration() [2/2]
nc::roots::Iteration::Iteration |
( |
double |
epsilon, |
|
|
uint32 |
maxNumIterations |
|
) |
| |
|
inlinenoexcept |
Constructor
- Parameters
-
epsilon | the epsilon value |
maxNumIterations | the maximum number of iterations to perform |
◆ ~Iteration()
virtual nc::roots::Iteration::~Iteration |
( |
| ) |
|
|
virtualdefaultnoexcept |
◆ incrementNumberOfIterations()
void nc::roots::Iteration::incrementNumberOfIterations |
( |
| ) |
|
|
inlineprotected |
Incraments the number of iterations
◆ numIterations()
uint32 nc::roots::Iteration::numIterations |
( |
| ) |
const |
|
inlinenoexcept |
Returns the number of iterations
- Returns
- : number of iterations
◆ resetNumberOfIterations()
void nc::roots::Iteration::resetNumberOfIterations |
( |
| ) |
|
|
inlineprotectednoexcept |
Resets the number of iterations
◆ epsilon_
const double nc::roots::Iteration::epsilon_ |
|
protected |
◆ maxNumIterations_
uint32 nc::roots::Iteration::maxNumIterations_ { 1000 } |
|
protected |
◆ numIterations_
uint32 nc::roots::Iteration::numIterations_ { 0 } |
|
protected |
The documentation for this class was generated from the following file: