hexed::math::Root_options Struct Reference

provides a convenient way to pass options to root-finding algorithms More...

#include <math.hpp>

Public Attributes
double	ftol = 0
	the algorithm should terminate if the absolute value of the residual (the value of the error function) is less than this
double	xtol = 0
	the algorithm should terminate if its best estimate of the error is less than this
int	max_iters = std::numeric_limits<int>::max()
	the algorithm should terminate if it exceeds this many iterations

Detailed Description

provides a convenient way to pass options to root-finding algorithms

Member Data Documentation

xtol

double hexed::math::Root_options::xtol = 0

the algorithm should terminate if its best estimate of the error is less than this

error is usually estimated by the distance between the solution guess at consecutive iterations

---

The documentation for this struct was generated from the following file:

• /home/micaiah/Desktop/hexed/include/math.hpp