ROOT logo
// @(#)root/mathmore:$Id: GSLRootFinder.h 22522 2008-03-07 16:07:51Z moneta $
// Author: L. Moneta, A. Zsenei   08/2005 

 /**********************************************************************
  *                                                                    *
  * Copyright (c) 2004 ROOT Foundation,  CERN/PH-SFT                   *
  *                                                                    *
  * This library is free software; you can redistribute it and/or      *
  * modify it under the terms of the GNU General Public License        *
  * as published by the Free Software Foundation; either version 2     *
  * of the License, or (at your option) any later version.             *
  *                                                                    *
  * This library is distributed in the hope that it will be useful,    *
  * but WITHOUT ANY WARRANTY; without even the implied warranty of     *
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU   *
  * General Public License for more details.                           *
  *                                                                    *
  * You should have received a copy of the GNU General Public License  *
  * along with this library (see file COPYING); if not, write          *
  * to the Free Software Foundation, Inc., 59 Temple Place, Suite      *
  * 330, Boston, MA 02111-1307 USA, or contact the author.             *
  *                                                                    *
  **********************************************************************/

// Header file for class GSLRootFinder
// 
// Created by: moneta  at Sun Nov 14 11:27:11 2004
// 
// Last update: Sun Nov 14 11:27:11 2004
// 
#ifndef ROOT_Math_GSLRootFinder
#define ROOT_Math_GSLRootFinder


#ifndef ROOT_Math_GSLFunctionAdapter
#include "Math/GSLFunctionAdapter.h"
#endif

#ifndef ROOT_Math_IFunctionfwd
#include "Math/IFunctionfwd.h"
#endif

#ifndef ROOT_Math_IRootFinderMethod
#include "Math/IRootFinderMethod.h"
#endif

#include <iostream>

namespace ROOT {
namespace Math {


   class GSLRootFSolver; 
   class GSLFunctionWrapper; 


//________________________________________________________________________________________________________
  /**
     Base class for GSL Root-Finding algorithms for one dimensional functions which do not use function derivatives. 
     For finding the roots users should not use this class directly but instantiate the template 
     ROOT::Math::RootFinder class with the corresponding algorithms. 
     For example the ROOT::Math::RootFinder<ROOT::Math::Roots::Brent> for using the Brent algorithm. See that class also 
     for the documentation. 
     See the GSL <A HREF="http://www.gnu.org/software/gsl/manual/html_node/Root-Bracketing-Algorithms.html"> online manual</A> for 
     information on the GSL Root-Finding algorithms

     @ingroup RootFinders
  */


   class GSLRootFinder: public IRootFinderMethod {
     
   public: 
     GSLRootFinder(); 
     virtual ~GSLRootFinder(); 
     
   private:
     // usually copying is non trivial, so we make this unaccessible
     GSLRootFinder(const GSLRootFinder &); 
     GSLRootFinder & operator = (const GSLRootFinder &); 
     
   public: 
     

#if defined(__MAKECINT__) || defined(G__DICTIONARY)  
      int SetFunction( const IGradFunction & , double ) { 
         std::cerr <<"GSLRootFinder - Error : this method must be used with a Root Finder algorithm using derivatives" << std::endl;  
         return -1;
      }
#endif
   
     int SetFunction( const IGenFunction & f, double xlow, double xup);

     typedef double ( * GSLFuncPointer ) ( double, void *);
     int SetFunction( GSLFuncPointer  f, void * params, double xlow, double xup); 

     using IRootFinderMethod::SetFunction;

     int Iterate(); 

     double Root() const; 

     //double XLower() const; 

     //double XUpper() const; 

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

     int Iterations() const {
       return fIter; 
     }

     const char * Name() const;  

     
   protected:
     

     void SetSolver (  GSLRootFSolver * s ); 

     void FreeSolver(); 
     
   private: 
     
     GSLFunctionWrapper * fFunction;     
     GSLRootFSolver * fS; 
  
   protected: 



   private: 

     double fRoot; 
     double fXlow;
     double fXup; 
     int fIter; 
     bool fValidInterval;

   }; 

} // namespace Math
} // namespace ROOT


#endif /* ROOT_Math_GSLRootFinder */
 GSLRootFinder.h:1
 GSLRootFinder.h:2
 GSLRootFinder.h:3
 GSLRootFinder.h:4
 GSLRootFinder.h:5
 GSLRootFinder.h:6
 GSLRootFinder.h:7
 GSLRootFinder.h:8
 GSLRootFinder.h:9
 GSLRootFinder.h:10
 GSLRootFinder.h:11
 GSLRootFinder.h:12
 GSLRootFinder.h:13
 GSLRootFinder.h:14
 GSLRootFinder.h:15
 GSLRootFinder.h:16
 GSLRootFinder.h:17
 GSLRootFinder.h:18
 GSLRootFinder.h:19
 GSLRootFinder.h:20
 GSLRootFinder.h:21
 GSLRootFinder.h:22
 GSLRootFinder.h:23
 GSLRootFinder.h:24
 GSLRootFinder.h:25
 GSLRootFinder.h:26
 GSLRootFinder.h:27
 GSLRootFinder.h:28
 GSLRootFinder.h:29
 GSLRootFinder.h:30
 GSLRootFinder.h:31
 GSLRootFinder.h:32
 GSLRootFinder.h:33
 GSLRootFinder.h:34
 GSLRootFinder.h:35
 GSLRootFinder.h:36
 GSLRootFinder.h:37
 GSLRootFinder.h:38
 GSLRootFinder.h:39
 GSLRootFinder.h:40
 GSLRootFinder.h:41
 GSLRootFinder.h:42
 GSLRootFinder.h:43
 GSLRootFinder.h:44
 GSLRootFinder.h:45
 GSLRootFinder.h:46
 GSLRootFinder.h:47
 GSLRootFinder.h:48
 GSLRootFinder.h:49
 GSLRootFinder.h:50
 GSLRootFinder.h:51
 GSLRootFinder.h:52
 GSLRootFinder.h:53
 GSLRootFinder.h:54
 GSLRootFinder.h:55
 GSLRootFinder.h:56
 GSLRootFinder.h:57
 GSLRootFinder.h:58
 GSLRootFinder.h:59
 GSLRootFinder.h:60
 GSLRootFinder.h:61
 GSLRootFinder.h:62
 GSLRootFinder.h:63
 GSLRootFinder.h:64
 GSLRootFinder.h:65
 GSLRootFinder.h:66
 GSLRootFinder.h:67
 GSLRootFinder.h:68
 GSLRootFinder.h:69
 GSLRootFinder.h:70
 GSLRootFinder.h:71
 GSLRootFinder.h:72
 GSLRootFinder.h:73
 GSLRootFinder.h:74
 GSLRootFinder.h:75
 GSLRootFinder.h:76
 GSLRootFinder.h:77
 GSLRootFinder.h:78
 GSLRootFinder.h:79
 GSLRootFinder.h:80
 GSLRootFinder.h:81
 GSLRootFinder.h:82
 GSLRootFinder.h:83
 GSLRootFinder.h:84
 GSLRootFinder.h:85
 GSLRootFinder.h:86
 GSLRootFinder.h:87
 GSLRootFinder.h:88
 GSLRootFinder.h:89
 GSLRootFinder.h:90
 GSLRootFinder.h:91
 GSLRootFinder.h:92
 GSLRootFinder.h:93
 GSLRootFinder.h:94
 GSLRootFinder.h:95
 GSLRootFinder.h:96
 GSLRootFinder.h:97
 GSLRootFinder.h:98
 GSLRootFinder.h:99
 GSLRootFinder.h:100
 GSLRootFinder.h:101
 GSLRootFinder.h:102
 GSLRootFinder.h:103
 GSLRootFinder.h:104
 GSLRootFinder.h:105
 GSLRootFinder.h:106
 GSLRootFinder.h:107
 GSLRootFinder.h:108
 GSLRootFinder.h:109
 GSLRootFinder.h:110
 GSLRootFinder.h:111
 GSLRootFinder.h:112
 GSLRootFinder.h:113
 GSLRootFinder.h:114
 GSLRootFinder.h:115
 GSLRootFinder.h:116
 GSLRootFinder.h:117
 GSLRootFinder.h:118
 GSLRootFinder.h:119
 GSLRootFinder.h:120
 GSLRootFinder.h:121
 GSLRootFinder.h:122
 GSLRootFinder.h:123
 GSLRootFinder.h:124
 GSLRootFinder.h:125
 GSLRootFinder.h:126
 GSLRootFinder.h:127
 GSLRootFinder.h:128
 GSLRootFinder.h:129
 GSLRootFinder.h:130
 GSLRootFinder.h:131
 GSLRootFinder.h:132
 GSLRootFinder.h:133
 GSLRootFinder.h:134
 GSLRootFinder.h:135
 GSLRootFinder.h:136
 GSLRootFinder.h:137
 GSLRootFinder.h:138
 GSLRootFinder.h:139
 GSLRootFinder.h:140
 GSLRootFinder.h:141
 GSLRootFinder.h:142
 GSLRootFinder.h:143
 GSLRootFinder.h:144
 GSLRootFinder.h:145
 GSLRootFinder.h:146
 GSLRootFinder.h:147