Public Member Functions | Public Attributes | List of all members
nmx::gsl::FDFSolver Class Reference

The FDFSolver class Nullstellensuche Funktion und ihre Ableitung werden benötigt. More...

#include <xroot.h>

Public Member Functions

template<typename T >
 FDFSolver (T &obj, const gsl_root_fdfsolver_type *type=gsl_root_fdfsolver_newton)
 FDFSolver Konstruktor. More...
 
 ~FDFSolver ()
 
const char * method_used () const
 method_used More...
 
bool converged () const
 converged Status der Nullstellensuche More...
 
double result () const
 getRoot Abfrage der gefundenen Nullstelle More...
 
auto apply (double startval, double epsabs=0, double epsrel=1e-3)
 apply Nullstellensuche More...
 
template<class FN >
auto apply (double startval, FN fn, double epsabs=0, double epsrel=1e-3)
 apply Nullstellensuche More...
 

Public Attributes

size_t MAX_STEPS = 100
 

Detailed Description

The FDFSolver class Nullstellensuche Funktion und ihre Ableitung werden benötigt.

Definition at line 175 of file xroot.h.

Constructor & Destructor Documentation

◆ FDFSolver()

template<typename T >
nmx::gsl::FDFSolver::FDFSolver ( T &  obj,
const gsl_root_fdfsolver_type *  type = gsl_root_fdfsolver_newton 
)
inline

FDFSolver Konstruktor.

Parameters
objenthält Funktion und ihre Ableitung

Definition at line 224 of file xroot.h.

◆ ~FDFSolver()

nmx::gsl::FDFSolver::~FDFSolver ( )
inline

Destruktor

Definition at line 248 of file xroot.h.

Member Function Documentation

◆ apply() [1/2]

auto nmx::gsl::FDFSolver::apply ( double  startval,
double  epsabs = 0,
double  epsrel = 1e-3 
)
inline

apply Nullstellensuche

Parameters
startvalStartwert
epsabsabsoluter Fehler (optional)
epsrelrelativer Fehler (optional)
Returns
gefundene Nullstelle

Definition at line 285 of file xroot.h.

◆ apply() [2/2]

template<class FN >
auto nmx::gsl::FDFSolver::apply ( double  startval,
FN  fn,
double  epsabs = 0,
double  epsrel = 1e-3 
)
inline

apply Nullstellensuche

Parameters
startvalStartwert
epsabsabsoluter Fehler (optional)
epsrelrelativer Fehler (optional)
Returns
gefundene Nullstelle

Definition at line 303 of file xroot.h.

◆ converged()

bool nmx::gsl::FDFSolver::converged ( ) const
inline

converged Status der Nullstellensuche

Returns
true wenn eine Nullstelle gefunden wurde

Definition at line 266 of file xroot.h.

◆ method_used()

const char* nmx::gsl::FDFSolver::method_used ( ) const
inline

method_used

Returns
Name des Algorithmus

Definition at line 258 of file xroot.h.

◆ result()

double nmx::gsl::FDFSolver::result ( ) const
inline

getRoot Abfrage der gefundenen Nullstelle

Returns
gesuchte Nullstelle

Definition at line 272 of file xroot.h.

Member Data Documentation

◆ MAX_STEPS

size_t nmx::gsl::FDFSolver::MAX_STEPS = 100

Definition at line 194 of file xroot.h.


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