ROOT
master
Reference Guide
FCNGradientBase.h
Go to the documentation of this file.
1
// @(#)root/minuit2:$Id$
2
// Authors: M. Winkler, F. James, L. Moneta, A. Zsenei 2003-2005
3
4
/**********************************************************************
5
* *
6
* Copyright (c) 2005 LCG ROOT Math team, CERN/PH-SFT *
7
* *
8
**********************************************************************/
9
10
#ifndef ROOT_Minuit2_FCNGradientBase
11
#define ROOT_Minuit2_FCNGradientBase
12
13
#include "
Minuit2/FCNBase.h
"
14
15
#include <vector>
16
17
namespace
ROOT
{
18
19
namespace
Minuit2 {
20
21
//________________________________________________________________________
22
/** Extension of the FCNBase for providing the analytical Gradient of the
23
function. The user-Gradient is checked at the beginning of the
24
minimization against the Minuit internal numerical Gradient in order to
25
spot problems in the analytical Gradient calculation. This can be turned
26
off by overriding CheckGradient() to make it return "false".
27
The size of the output Gradient vector must be equal to the size of the
28
input Parameter vector.
29
Minuit does a check of the user Gradient at the beginning, if this is not
30
wanted the method "CheckGradient()" has to be overridden to return
31
"false".
32
*/
33
34
class
FCNGradientBase
:
public
FCNBase
{
35
36
public
:
37
virtual
~FCNGradientBase
() {}
38
39
virtual
std::vector<double>
Gradient
(
const
std::vector<double> &)
const
= 0;
40
41
virtual
bool
CheckGradient
()
const
{
return
true
; }
42
};
43
44
}
// namespace Minuit2
45
46
}
// namespace ROOT
47
48
#endif
// ROOT_Minuit2_FCNGradientBase
ROOT::Minuit2::FCNBase
Interface (abstract class) defining the function to be minimized, which has to be implemented by the ...
Definition:
FCNBase.h:45
ROOT::Minuit2::FCNGradientBase::CheckGradient
virtual bool CheckGradient() const
Definition:
FCNGradientBase.h:41
ROOT::Minuit2::FCNGradientBase::Gradient
virtual std::vector< double > Gradient(const std::vector< double > &) const =0
ROOT::Minuit2::FCNGradientBase
Extension of the FCNBase for providing the analytical Gradient of the function.
Definition:
FCNGradientBase.h:34
FCNBase.h
ROOT::Minuit2::FCNGradientBase::~FCNGradientBase
virtual ~FCNGradientBase()
Definition:
FCNGradientBase.h:37
ROOT
tbb::task_arena is an alias of tbb::interface7::task_arena, which doesn't allow to forward declare tb...
Definition:
EExecutionPolicy.hxx:4
math
minuit2
inc
Minuit2
FCNGradientBase.h
ROOT master - Reference Guide Generated on Thu Mar 4 2021 12:28:22 (GVA Time) using Doxygen 1.9.0