Configuration for bounded 1D optimization and root finding. Extends Config with interval bounds. More...

#include <MathUtils_Config.hxx>

Inheritance diagram for MathUtils::BoundedConfig:

Public Member Functions
	BoundedConfig ()=default
	Default constructor.

	BoundedConfig (double theLower, double theUpper, double theTolerance=1.0e-10, int theMaxIter=100)
	Constructor with bounds.

Public Member Functions inherited from MathUtils::Config
	Config ()=default
	Default constructor with standard tolerances.

	Config (double theTolerance, int theMaxIter=100)
	Constructor with custom tolerance (sets all tolerances to same value).

Data Fields
double	LowerBound = -std::numeric_limits<double>::max()
	Lower bound of search interval.

double	UpperBound = std::numeric_limits<double>::max()
	Upper bound of search interval.

Data Fields inherited from MathUtils::Config
int	MaxIterations = 100
	Maximum number of iterations allowed.

double	Tolerance = 1.0e-10
	General convergence tolerance.

double	XTolerance = 1.0e-10
	Tolerance for solution change \|x_{n+1} - x_n\|.

double	FTolerance = 1.0e-10
	Tolerance for function value \|f(x)\|.

double	StepMin = std::numeric_limits<double>::epsilon()
	Minimum step size before declaring convergence or failure.

Detailed Description

Configuration for bounded 1D optimization and root finding. Extends Config with interval bounds.

Constructor & Destructor Documentation

MathUtils::BoundedConfig::BoundedConfig ( )

default

Default constructor.

MathUtils::BoundedConfig::BoundedConfig	(	double	theLower,
		double	theUpper,
		double	theTolerance = 1.0e-10,
		int	theMaxIter = 100 )

inline

Constructor with bounds.

Parameters

double MathUtils::BoundedConfig::LowerBound = -std::numeric_limits<double>::max()

Lower bound of search interval.

double MathUtils::BoundedConfig::UpperBound = std::numeric_limits<double>::max()

Upper bound of search interval.

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