Logo ROOT  
Reference Guide
ROOT::Math::IMinimizer1D Class Referenceabstract

Interface class for numerical methods for one-dimensional minimization.

Definition at line 50 of file IMinimizer1D.h.

Public Member Functions

 IMinimizer1D ()
 
virtual ~IMinimizer1D ()
 
virtual double FValLower () const =0
 Return function value at current lower bound of the minimization interval. More...
 
virtual double FValMinimum () const =0
 Return function value at current estimate of the minimum. More...
 
virtual double FValUpper () const =0
 Return function value at current upper bound of the minimization interval. More...
 
virtual int Iterations () const =0
 Return number of iteration used to find minimum. More...
 
virtual bool Minimize (int maxIter, double absTol, double relTol)=0
 Find minimum position iterating until convergence specified by the absolute and relative tolerance or the maximum number of iteration is reached Return true if iterations converged successfully @param maxIter maximum number of iteration @param absTol desired absolute error in the minimum position @param absTol desired relative error in the minimum position. More...
 
virtual const char * Name () const =0
 Return name of minimization algorithm. More...
 
virtual int Status () const =0
 Returns the status of the previous estimate. More...
 
virtual double XLower () const =0
 Return current lower bound of the minimization interval. More...
 
virtual double XMinimum () const =0
 Return current estimate of the position of the minimum. More...
 
virtual double XUpper () const =0
 Return current upper bound of the minimization interval. More...
 

#include <Math/IMinimizer1D.h>

Inheritance diagram for ROOT::Math::IMinimizer1D:
[legend]

Constructor & Destructor Documentation

◆ IMinimizer1D()

ROOT::Math::IMinimizer1D::IMinimizer1D ( )
inline

Definition at line 54 of file IMinimizer1D.h.

◆ ~IMinimizer1D()

virtual ROOT::Math::IMinimizer1D::~IMinimizer1D ( )
inlinevirtual

Definition at line 55 of file IMinimizer1D.h.

Member Function Documentation

◆ FValLower()

virtual double ROOT::Math::IMinimizer1D::FValLower ( ) const
pure virtual

Return function value at current lower bound of the minimization interval.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ FValMinimum()

virtual double ROOT::Math::IMinimizer1D::FValMinimum ( ) const
pure virtual

Return function value at current estimate of the minimum.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ FValUpper()

virtual double ROOT::Math::IMinimizer1D::FValUpper ( ) const
pure virtual

Return function value at current upper bound of the minimization interval.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ Iterations()

virtual int ROOT::Math::IMinimizer1D::Iterations ( ) const
pure virtual

Return number of iteration used to find minimum.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ Minimize()

virtual bool ROOT::Math::IMinimizer1D::Minimize ( int  maxIter,
double  absTol,
double  relTol 
)
pure virtual

Find minimum position iterating until convergence specified by the absolute and relative tolerance or the maximum number of iteration is reached Return true if iterations converged successfully @param maxIter maximum number of iteration @param absTol desired absolute error in the minimum position @param absTol desired relative error in the minimum position.

Implemented in ROOT::Math::GSLMinimizer1D, and ROOT::Math::BrentMinimizer1D.

◆ Name()

virtual const char * ROOT::Math::IMinimizer1D::Name ( ) const
pure virtual

Return name of minimization algorithm.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ Status()

virtual int ROOT::Math::IMinimizer1D::Status ( ) const
pure virtual

Returns the status of the previous estimate.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ XLower()

virtual double ROOT::Math::IMinimizer1D::XLower ( ) const
pure virtual

Return current lower bound of the minimization interval.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ XMinimum()

virtual double ROOT::Math::IMinimizer1D::XMinimum ( ) const
pure virtual

Return current estimate of the position of the minimum.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.

◆ XUpper()

virtual double ROOT::Math::IMinimizer1D::XUpper ( ) const
pure virtual

Return current upper bound of the minimization interval.

Implemented in ROOT::Math::BrentMinimizer1D, and ROOT::Math::GSLMinimizer1D.


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