class ROOT::Math::IRootFinderMethod


   Interface for finding function roots of one-dimensional functions

   @ingroup RootFinders

Function Members (Methods)

This is an abstract class, constructors will not be documented.
Look at the header to check for available constructors.

public:

virtual	~IRootFinderMethod()
virtual int	Iterate()
virtual int	Iterations() const
virtual const char*	Name() const
ROOT::Math::IRootFinderMethod&	operator=(const ROOT::Math::IRootFinderMethod&)
virtual double	Root() const
virtual int	SetFunction(const ROOT::Math::IGradFunction&, double)
virtual int	SetFunction(const ROOT::Math::IGenFunction&, double, double)
virtual int	Solve(int maxIter = 100, double absTol = 1E-3, double relTol = 1E-6)

Class Charts

Inheritance Inherited Members Includes Libraries

Function documentation

virtual ~IRootFinderMethod()

 Default Destructor.

{}

int SetFunction(const ROOT::Math::IGradFunction& , double )

 Common functionality
 Sets the function for algorithms using derivatives.

int SetFunction(const ROOT::Math::IGenFunction& , double , double )

 Sets the function for the rest of the algorithms.
The parameters set the interval where the root has to be calculated.

double Root()

 Returns the previously calculated root.

int Solve(int maxIter = 100, double absTol = 1E-3, double relTol = 1E-6)

 Methods to be Implemented in the derived classes
 Stimates the root for the function.
       \@param maxIter maximum number of iterations.
       \@param absTol desired absolute error in the minimum position.
       \@param absTol desired relative error in the minimum position.

const char* Name()

 Return name of root finder algorithm

int Iterate()

 This method is not implemented. They are here to accomplish with the GSLRootFinder
and GSLRootFinderDeriv classes and will return an error if it's not one of them.

int Iterations()

 This method is not implemented. They are here to accomplish with the GSLRootFinder
and GSLRootFinderDeriv classes and will return an error if it's not one of them.

Last change: root/mathcore:$Id: IRootFinderMethod.h 24477 2008-06-23 12:58:47Z moneta $
Last generated: 2008-06-25 08:29
Copyright (c) 2006 , LCG ROOT MathLib Team *

This page has been automatically generated. If you have any comments or suggestions about the page layout send a mail to ROOT support, or contact the developers with any questions or problems regarding ROOT.