Logo ROOT  
Reference Guide
 
Loading...
Searching...
No Matches
ROOT::Math::GSLMultiMinimizer Class Reference

GSLMultiMinimizer class , for minimizing multi-dimensional function using derivatives.

Definition at line 54 of file GSLMultiMinimizer.h.

Public Member Functions

 GSLMultiMinimizer (ROOT::Math::EGSLMinimizerType type)
 Default constructor.
 
 ~GSLMultiMinimizer ()
 Destructor.
 
void CreateMinimizer (unsigned int n)
 create the minimizer from the type and size
 
doubleGradient () const
 gradient value at the minimum
 
int Iterate ()
 
double Minimum () const
 function value at the minimum
 
std::string Name () const
 
int Restart ()
 restart minimization from current point
 
int Set (const ROOT::Math::IMultiGradFunction &func, const double *x, double stepSize, double tol)
 set the function to be minimize the initial minimizer parameters, step size and tolerance in the line search
 
int TestGradient (const double *g, double absTol) const
 test gradient (require a vector gradient)
 
int TestGradient (double absTol) const
 test gradient (ask from minimizer gradient vector)
 
doubleX () const
 x values at the minimum
 

Private Member Functions

 GSLMultiMinimizer (const GSLMultiMinimizer &)
 Copy constructor.
 
GSLMultiMinimizeroperator= (const GSLMultiMinimizer &rhs)
 Assignment operator.
 

Private Attributes

GSLMultiMinDerivFunctionWrapper fFunc
 
gsl_multimin_fdfminimizer * fMinimizer
 
const gsl_multimin_fdfminimizer_type * fType
 
gsl_vector * fVec
 

#include </home/sftnight/build/workspace/root-makedoc-v626/rootspi/rdoc/src/v6-26-00-patches/math/mathmore/src/GSLMultiMinimizer.h>

Constructor & Destructor Documentation

◆ GSLMultiMinimizer() [1/2]

ROOT::Math::GSLMultiMinimizer::GSLMultiMinimizer ( ROOT::Math::EGSLMinimizerType  type)
inline

Default constructor.

Definition at line 61 of file GSLMultiMinimizer.h.

◆ ~GSLMultiMinimizer()

ROOT::Math::GSLMultiMinimizer::~GSLMultiMinimizer ( )
inline

Destructor.

Definition at line 99 of file GSLMultiMinimizer.h.

◆ GSLMultiMinimizer() [2/2]

ROOT::Math::GSLMultiMinimizer::GSLMultiMinimizer ( const GSLMultiMinimizer )
inlineprivate

Copy constructor.

Definition at line 111 of file GSLMultiMinimizer.h.

Member Function Documentation

◆ CreateMinimizer()

void ROOT::Math::GSLMultiMinimizer::CreateMinimizer ( unsigned int  n)
inline

create the minimizer from the type and size

Definition at line 142 of file GSLMultiMinimizer.h.

◆ Gradient()

double * ROOT::Math::GSLMultiMinimizer::Gradient ( ) const
inline

gradient value at the minimum

Definition at line 171 of file GSLMultiMinimizer.h.

◆ Iterate()

int ROOT::Math::GSLMultiMinimizer::Iterate ( )
inline

Definition at line 152 of file GSLMultiMinimizer.h.

◆ Minimum()

double ROOT::Math::GSLMultiMinimizer::Minimum ( ) const
inline

function value at the minimum

Definition at line 165 of file GSLMultiMinimizer.h.

◆ Name()

std::string ROOT::Math::GSLMultiMinimizer::Name ( ) const
inline

Definition at line 147 of file GSLMultiMinimizer.h.

◆ operator=()

GSLMultiMinimizer & ROOT::Math::GSLMultiMinimizer::operator= ( const GSLMultiMinimizer rhs)
inlineprivate

Assignment operator.

Definition at line 116 of file GSLMultiMinimizer.h.

◆ Restart()

int ROOT::Math::GSLMultiMinimizer::Restart ( )
inline

restart minimization from current point

Definition at line 178 of file GSLMultiMinimizer.h.

◆ Set()

int ROOT::Math::GSLMultiMinimizer::Set ( const ROOT::Math::IMultiGradFunction func,
const double x,
double  stepSize,
double  tol 
)
inline

set the function to be minimize the initial minimizer parameters, step size and tolerance in the line search

Definition at line 127 of file GSLMultiMinimizer.h.

◆ TestGradient() [1/2]

int ROOT::Math::GSLMultiMinimizer::TestGradient ( const double g,
double  absTol 
) const
inline

test gradient (require a vector gradient)

Definition at line 191 of file GSLMultiMinimizer.h.

◆ TestGradient() [2/2]

int ROOT::Math::GSLMultiMinimizer::TestGradient ( double  absTol) const
inline

test gradient (ask from minimizer gradient vector)

Definition at line 184 of file GSLMultiMinimizer.h.

◆ X()

double * ROOT::Math::GSLMultiMinimizer::X ( ) const
inline

x values at the minimum

Definition at line 158 of file GSLMultiMinimizer.h.

Member Data Documentation

◆ fFunc

GSLMultiMinDerivFunctionWrapper ROOT::Math::GSLMultiMinimizer::fFunc
private

Definition at line 203 of file GSLMultiMinimizer.h.

◆ fMinimizer

gsl_multimin_fdfminimizer* ROOT::Math::GSLMultiMinimizer::fMinimizer
private

Definition at line 202 of file GSLMultiMinimizer.h.

◆ fType

const gsl_multimin_fdfminimizer_type* ROOT::Math::GSLMultiMinimizer::fType
private

Definition at line 204 of file GSLMultiMinimizer.h.

◆ fVec

gsl_vector* ROOT::Math::GSLMultiMinimizer::fVec
mutableprivate

Definition at line 206 of file GSLMultiMinimizer.h.

  • math/mathmore/src/GSLMultiMinimizer.h