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

The RootBracketing class gsl-Klasse für das Bisektionsverfahren. More...

#include <xroot.h>

Public Member Functions

template<class T >
 RootBracketing (T &pobj, const gsl_root_fsolver_type *type=gsl_root_fsolver_bisection)
 RootBracketing Konstruktor. More...
 
 ~RootBracketing ()
 
bool converged () const
 converged Status der Nullstellensuche More...
 
auto xminmax () const
 xminmax obere und untere Intervallgrenze More...
 
const char * method_used () const
 method_used More...
 
template<class FN >
auto apply (double xmin, double xmax, FN fn, double epsabs, double epsrel)
 apply startet Nullstellensuche More...
 
auto apply (double xmin, double xmax, double epsabs, double epsrel)
 apply startet Nullstellensuche More...
 
double result () const
 result liefert die Nullstelle nur falls eine gefunden wurde, sonst wird eine Ausnahme ausgeworfen. More...
 

Detailed Description

The RootBracketing class gsl-Klasse für das Bisektionsverfahren.

Definition at line 14 of file xroot.h.

Constructor & Destructor Documentation

◆ RootBracketing()

template<class T >
nmx::gsl::RootBracketing::RootBracketing ( T &  pobj,
const gsl_root_fsolver_type *  type = gsl_root_fsolver_bisection 
)
inline

RootBracketing Konstruktor.

Parameters
pobjObjekt mit überladenem ()-operator oder lambda
typeAlgorithmus z.B. das klassische Bisektionsverfahren gsl_root_fsolver_bisection (default)

Definition at line 71 of file xroot.h.

◆ ~RootBracketing()

nmx::gsl::RootBracketing::~RootBracketing ( )
inline

Ressourcen werden freigegeben

Definition at line 88 of file xroot.h.

Member Function Documentation

◆ apply() [1/2]

template<class FN >
auto nmx::gsl::RootBracketing::apply ( double  xmin,
double  xmax,
FN  fn,
double  epsabs,
double  epsrel 
)
inline

apply startet Nullstellensuche

Parameters
xminuntere Intervallgrenze
xmaxobere Intervallgrenze
fnFunktion zum Aufzeichnen der Iterationsschritte
epsabsabsoluter Fehler
epsrelrelativer Fehler
Returns
gefundene Nullstelle

Definition at line 124 of file xroot.h.

◆ apply() [2/2]

auto nmx::gsl::RootBracketing::apply ( double  xmin,
double  xmax,
double  epsabs,
double  epsrel 
)
inline

apply startet Nullstellensuche

Parameters
xminuntere Intervallgrenze
xmaxobere Intervallgrenze
epsabsabsoluter Fehler
epsrelrelativer Fehler
Returns
gefundene Nullstelle

Definition at line 146 of file xroot.h.

◆ converged()

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

converged Status der Nullstellensuche

Returns
true wenn das Verfahren erfolgreich war

Definition at line 98 of file xroot.h.

◆ method_used()

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

method_used

Returns
Name des Algorithmus

Definition at line 110 of file xroot.h.

◆ result()

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

result liefert die Nullstelle nur falls eine gefunden wurde, sonst wird eine Ausnahme ausgeworfen.

Returns
gefundene Nullstelle

Definition at line 164 of file xroot.h.

◆ xminmax()

auto nmx::gsl::RootBracketing::xminmax ( ) const
inline

xminmax obere und untere Intervallgrenze

Returns
[xmin,xmax]

Definition at line 104 of file xroot.h.


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