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 (const GSLMultiMinimizer &)=delete
	GSLMultiMinimizer (GSLMultiMinimizer &&)=delete
	GSLMultiMinimizer (ROOT::Math::EGSLMinimizerType type)
	Default constructor.
	~GSLMultiMinimizer ()
	Destructor.
void	CreateMinimizer (unsigned int n)
	create the minimizer from the type and size
double *	Gradient () const
	gradient value at the minimum
int	Iterate ()
double	Minimum () const
	function value at the minimum
std::string	Name () const
GSLMultiMinimizer &	operator= (const GSLMultiMinimizer &rhs)=delete
GSLMultiMinimizer &	operator= (GSLMultiMinimizer &&rhs)=delete
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)
double *	X () const
	x values at the minimum

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

#include </home/sftnight/build/workspace/root-makedoc-master/rootspi/rdoc/src/master/math/mathmore/src/GSLMultiMinimizer.h>

Constructor & Destructor Documentation

GSLMultiMinimizer() [1/3]

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/3]

ROOT::Math::GSLMultiMinimizer::GSLMultiMinimizer ( const GSLMultiMinimizer &  )

delete

GSLMultiMinimizer() [3/3]

ROOT::Math::GSLMultiMinimizer::GSLMultiMinimizer ( GSLMultiMinimizer &&  )

delete

Member Function Documentation

CreateMinimizer()

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

inline

create the minimizer from the type and size

Definition at line 130 of file GSLMultiMinimizer.h.

Gradient()

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

inline

gradient value at the minimum

Definition at line 159 of file GSLMultiMinimizer.h.

Iterate()

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

inline

Definition at line 140 of file GSLMultiMinimizer.h.

Minimum()

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

inline

function value at the minimum

Definition at line 153 of file GSLMultiMinimizer.h.

Name()

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

inline

Definition at line 135 of file GSLMultiMinimizer.h.

operator=() [1/2]

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

delete

operator=() [2/2]

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

delete

Restart()

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

inline

restart minimization from current point

Definition at line 166 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 115 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 179 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 172 of file GSLMultiMinimizer.h.

X()

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

inline

x values at the minimum

Definition at line 146 of file GSLMultiMinimizer.h.

Member Data Documentation

fFunc

GSLMultiMinDerivFunctionWrapper ROOT::Math::GSLMultiMinimizer::fFunc

private

Definition at line 191 of file GSLMultiMinimizer.h.

fMinimizer

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

private

Definition at line 190 of file GSLMultiMinimizer.h.

fType

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

private

Definition at line 192 of file GSLMultiMinimizer.h.

fVec

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

mutableprivate

Definition at line 194 of file GSLMultiMinimizer.h.