Configuration (data) class for the Fixed Point method. More...

#include <config.hpp>

Inheritance diagram for FixedPointConfig:

Collaboration diagram for FixedPointConfig:

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

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)>	g_function
	The g function for the Fixed Point method.

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 Fixed Point method.

This class extends ConfigBase and includes specific parameters for the Fixed Point method, such as the initial guess and the g function.

Constructor & Destructor Documentation

FixedPointConfig::FixedPointConfig	(	double	tolerance,
		int	max_iterations,
		bool	aitken,
		std::function< double(double)>	function,
		double	initial_guess,
		std::function< double(double)>	g_function,
		bool	verbose
	)

inline

Constructor for FixedPointConfig.

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.
initial_guess	The initial guess for the root.
g_function	The g function for the Fixed Point method.

std::function<double(double)> FixedPointConfig::g_function

The g function for the Fixed Point method.

double FixedPointConfig::initial_guess

The initial guess for the root.

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