Configuration (data) class for the Newton method. More...

#include <config.hpp>

Inheritance diagram for NewtonConfig:

Collaboration diagram for NewtonConfig:

Public Member Functions
	NewtonConfig (double tolerance, int max_iterations, bool aitken, std::function< double(double)> function, std::function< double(double)> derivative, double initial_guess, bool verbose)
	Constructor for NewtonConfig.

Public Member Functions inherited from ConfigBase
virtual	~ConfigBase ()
	Virtual destructor required for downcasting objects to derived class types (using dynamic_cast).

Public Attributes
double	initial_guess
	The initial guess for the root.

std::function< double(double)>	derivative
	The derivative of the function.

Public Attributes inherited from ConfigBase
Method	method
	The root-finding method to be used.

double	tolerance
	The tolerance for convergence.

int	max_iterations
	The maximum number of iterations allowed.

bool	aitken
	Indicates whether Aitken acceleration is enabled.

bool	verbose
	Indicates whether verbose output is enabled.

std::function< double(double)>	function
	The function for which the root is to be found.

Detailed Description

Configuration (data) class for the Newton method.

This class extends ConfigBase and includes specific parameters for the Newton method, such as the initial guess and the derivative of the function.

Constructor & Destructor Documentation

inline

Constructor for NewtonConfig.

Parameters

tolerance	The tolerance for convergence.
max_iterations	The maximum number of iterations allowed.
aitken	Indicates whether Aitken acceleration is enabled.
function	The function for which the root is to be found.
derivative	The derivative of the function.
initial_guess	The initial guess for the root.

std::function<double(double)> NewtonConfig::derivative

The derivative of the function.

double NewtonConfig::initial_guess

The initial guess for the root.

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