/usr/include/root/Math/GSLMinimizer.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 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | // @(#)root/mathmore:$Id$
// Author: L. Moneta Wed Oct 18 11:48:00 2006
/**********************************************************************
* *
* Copyright (c) 2006 LCG ROOT Math Team, 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 GSLMinimizer
#ifndef ROOT_Math_GSLMinimizer
#define ROOT_Math_GSLMinimizer
#ifndef ROOT_Math_Minimizer
#include "Math/Minimizer.h"
#endif
#ifndef ROOT_Math_IFunctionfwd
#include "Math/IFunctionfwd.h"
#endif
#ifndef ROOT_Math_IParamFunctionfwd
#include "Math/IParamFunctionfwd.h"
#endif
#ifndef ROOT_Math_BasicMinimizer
#include "Math/BasicMinimizer.h"
#endif
#include <vector>
#include <map>
#include <string>
namespace ROOT {
namespace Math {
/**
enumeration specifying the types of GSL minimizers
@ingroup MultiMin
*/
enum EGSLMinimizerType {
kConjugateFR,
kConjugatePR,
kVectorBFGS,
kVectorBFGS2,
kSteepestDescent
};
class GSLMultiMinimizer;
class MinimTransformFunction;
//_____________________________________________________________________________________
/**
GSLMinimizer class.
Implementation of the ROOT::Math::Minimizer interface using the GSL multi-dimensional
minimization algorithms.
See <A HREF="http://www.gnu.org/software/gsl/manual/html_node/Multidimensional-Minimization.html">GSL doc</A>
from more info on the GSL minimization algorithms.
The class implements the ROOT::Math::Minimizer interface and can be instantiated using the
ROOT plugin manager (plugin name is "GSLMultiMin"). The varius minimization algorithms
(conjugatefr, conjugatepr, bfgs, etc..) can be passed as enumerations and also as a string.
The default algorithm is conjugatefr (Fletcher-Reeves conjugate gradient algorithm).
@ingroup MultiMin
*/
class GSLMinimizer : public ROOT::Math::BasicMinimizer {
public:
/**
Default constructor
*/
GSLMinimizer (ROOT::Math::EGSLMinimizerType type = ROOT::Math::kConjugateFR );
/**
Constructor with a string giving name of algorithm
*/
GSLMinimizer (const char * type );
/**
Destructor
*/
virtual ~GSLMinimizer ();
private:
// usually copying is non trivial, so we make this unaccessible
/**
Copy constructor
*/
GSLMinimizer(const GSLMinimizer &) : BasicMinimizer() {}
/**
Assignment operator
*/
GSLMinimizer & operator = (const GSLMinimizer & rhs) {
if (this == &rhs) return *this; // time saving self-test
return *this;
}
public:
/// set the function to minimize
virtual void SetFunction(const ROOT::Math::IMultiGenFunction & func);
/// set the function to minimize
virtual void SetFunction(const ROOT::Math::IMultiGradFunction & func) { BasicMinimizer::SetFunction(func);}
/// method to perform the minimization
virtual bool Minimize();
/// return expected distance reached from the minimum
virtual double Edm() const { return 0; } // not impl. }
/// return pointer to gradient values at the minimum
virtual const double * MinGradient() const;
/// number of function calls to reach the minimum
virtual unsigned int NCalls() const;
/// minimizer provides error and error matrix
virtual bool ProvidesError() const { return false; }
/// return errors at the minimum
virtual const double * Errors() const {
return 0;
}
/** return covariance matrices elements
if the variable is fixed the matrix is zero
The ordering of the variables is the same as in errors
*/
virtual double CovMatrix(unsigned int , unsigned int ) const { return 0; }
protected:
private:
ROOT::Math::GSLMultiMinimizer * fGSLMultiMin;
double fLSTolerance; // Line Search Tolerance
};
} // end namespace Fit
} // end namespace ROOT
#endif /* ROOT_Math_GSLMinimizer */
|