/usr/include/root/Math/GSLRootFinderDeriv.h is in libroot-math-mathmore-dev 5.34.30-0ubuntu8.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | // @(#)root/mathmore:$Id$
// Authors: 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 GSLRootFinderDeriv
//
// Created by: moneta at Sun Nov 21 16:26:03 2004
//
// Last update: Sun Nov 21 16:26:03 2004
//
#ifndef ROOT_Math_GSL_RootFinderDeriv
#define ROOT_Math_GSL_RootFinderDeriv
#ifndef ROOT_Math_GSLFunctionAdapter
#include "Math/GSLFunctionAdapter.h"
#endif
#ifndef ROOT_Math_IFunctionfwd
#include "Math/IFunctionfwd.h"
#endif
#ifndef ROOT_Math_IFunction
#include "Math/IFunction.h"
#endif
#ifndef ROOT_Math_IRootFinderMethod
#include "Math/IRootFinderMethod.h"
#endif
#include <iostream>
namespace ROOT {
namespace Math {
class GSLRootFdFSolver;
class GSLFunctionDerivWrapper;
//_____________________________________________________________________________________
/**
Base class for GSL Root-Finding algorithms for one dimensional functions which use function derivatives.
For finding the roots users should not use this class directly but instantiate the derived classes,
for example ROOT::Math::Roots::Newton for using the Newton algorithm.
All the classes defining the alhorithms are defined in the header Math/RootFinderAlgorithm.h
They possible types implementing root bracketing algorithms which use function
derivatives are:
<ul>
<li>ROOT::Math::Roots::Newton
<li>ROOT::Math::Roots::Secant
<li>ROOT::Math::Roots::Steffenson
</ul>
See also those classes for the documentation.
See the GSL <A HREF="http://www.gnu.org/software/gsl/manual/html_node/Root-Finding-Algorithms-using-Derivatives.html"> online manual</A> for
information on the GSL Root-Finding algorithms
@ingroup RootFinders
*/
class GSLRootFinderDeriv: public IRootFinderMethod {
public:
GSLRootFinderDeriv();
virtual ~GSLRootFinderDeriv();
private:
// usually copying is non trivial, so we make this unaccessible
GSLRootFinderDeriv(const GSLRootFinderDeriv &);
GSLRootFinderDeriv & operator = (const GSLRootFinderDeriv &);
public:
#if defined(__MAKECINT__) || defined(G__DICTIONARY)
bool SetFunction( const IGenFunction & , double , double ) {
std::cerr <<"GSLRootFinderDeriv - Error : Algorithm requirs derivatives" << std::endl;
return false;
}
#endif
bool SetFunction( const IGradFunction & f, double xstart) {
const void * p = &f;
return SetFunction( &GSLFunctionAdapter<IGradFunction>::F, &GSLFunctionAdapter<IGradFunction>::Df, &GSLFunctionAdapter<IGradFunction>::Fdf, const_cast<void *>(p), xstart );
}
typedef double ( * GSLFuncPointer ) ( double, void *);
typedef void ( * GSLFdFPointer ) ( double, void *, double *, double *);
bool SetFunction( GSLFuncPointer f, GSLFuncPointer df, GSLFdFPointer fdf, void * p, double Root );
using IRootFinderMethod::SetFunction;
/// iterate (return GSL_SUCCESS in case of successful iteration)
int Iterate();
double Root() const;
/// Find the root (return false if failed)
bool Solve( int maxIter = 100, double absTol = 1E-8, double relTol = 1E-10);
/// Return number of iterations
int Iterations() const {
return fIter;
}
/// Return the status of last root finding
int Status() const { return fStatus; }
const char * Name() const;
protected:
void SetSolver ( GSLRootFdFSolver * s );
void FreeSolver();
private:
GSLFunctionDerivWrapper * fFunction;
GSLRootFdFSolver * fS;
mutable double fRoot;
mutable double fPrevRoot;
int fIter;
int fStatus;
bool fValidPoint;
};
} // namespace Math
} // namespace ROOT
#endif /* ROOT_Math_GSL_RootFinderDeriv */
|