ROOT
ROOT project
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ConfigBase Class Reference

Base (shared) configuration (data) class for root-finding methods. More...

#include <config.hpp>

Inheritance diagram for ConfigBase:
Inheritance graph
Collaboration diagram for ConfigBase:
Collaboration graph

Public Member Functions

virtual ~ConfigBase ()
 Virtual destructor required for downcasting objects to derived class types (using dynamic_cast).
 

Public Attributes

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

Base (shared) configuration (data) class for root-finding methods.

This class serves as the base for all specific root-finding method configurations, encapsulating common parameters such as tolerance, maximum iterations, and the function.

Constructor & Destructor Documentation

◆ ~ConfigBase()

virtual ConfigBase::~ConfigBase ( )
inlinevirtual

Virtual destructor required for downcasting objects to derived class types (using dynamic_cast).

Member Data Documentation

◆ aitken

bool ConfigBase::aitken

Indicates whether Aitken acceleration is enabled.

◆ function

std::function<double(double)> ConfigBase::function

The function for which the root is to be found.

◆ max_iterations

int ConfigBase::max_iterations

The maximum number of iterations allowed.

◆ method

Method ConfigBase::method

The root-finding method to be used.

◆ tolerance

double ConfigBase::tolerance

The tolerance for convergence.

◆ verbose

bool ConfigBase::verbose

Indicates whether verbose output is enabled.


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