Euclid::MathUtils::SecantParams Struct Reference

#include <SecantMethod.h>

Collaboration diagram for Euclid::MathUtils::SecantParams:

Public Attributes
std::size_t	max_iter = 1000
	Maximum number of iterations. More...
double	atol = 1e-8
double	min = -std::numeric_limits<double>::infinity()
	If the gradient moves the next iteration below this limit, clip the result. More...
double	max = std::numeric_limits<double>::infinity()
	If the gradient moves the next iteration above this limit, clip the result. More...

Detailed Description

Definition at line 30 of file SecantMethod.h.

Member Data Documentation

double Euclid::MathUtils::SecantParams::atol = 1e-8

The method will finish once func(root) <= atol

Definition at line 32 of file SecantMethod.h.

Referenced by Euclid::MathUtils::secantMethod().

double Euclid::MathUtils::SecantParams::max = std::numeric_limits<double>::infinity()

If the gradient moves the next iteration above this limit, clip the result.

Definition at line 36 of file SecantMethod.h.

Referenced by Euclid::MathUtils::secantMethod().

std::size_t Euclid::MathUtils::SecantParams::max_iter = 1000

Maximum number of iterations.

Definition at line 31 of file SecantMethod.h.

Referenced by Euclid::MathUtils::secantMethod().

double Euclid::MathUtils::SecantParams::min = -std::numeric_limits<double>::infinity()

If the gradient moves the next iteration below this limit, clip the result.

Definition at line 34 of file SecantMethod.h.

Referenced by Euclid::MathUtils::secantMethod().

---

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

• MathUtils/MathUtils/root/SecantMethod.h