ROOT: ROOT::Math::GSLMultiMinimizer Class Reference

ROOT 6.06/09

Reference Guide

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

Definition at line 53 of file GSLMultiMinimizer.h.

Public Member Functions
	GSLMultiMinimizer (ROOT::Math::EGSLMinimizerType type)
	Default constructor. More...

	~GSLMultiMinimizer ()
	Destructor. More...

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 More...

void	CreateMinimizer (unsigned int n)
	create the minimizer from the type and size More...

std::string	Name () const

int	Iterate ()

double *	X () const
	x values at the minimum More...

double	Minimum () const
	function value at the minimum More...

double *	Gradient () const
	gradient value at the minimum More...

int	Restart ()
	restart minimization from current point More...

int	TestGradient (double absTol) const
	test gradient (ask from minimizer gradient vector) More...

int	TestGradient (const double *g, double absTol) const
	test gradient (require a vector gradient) More...

Private Member Functions
	GSLMultiMinimizer (const GSLMultiMinimizer &)
	Copy constructor. More...

GSLMultiMinimizer &	operator= (const GSLMultiMinimizer &rhs)
	Assignment operator. More...

Private Attributes
gsl_multimin_fdfminimizer *	fMinimizer

GSLMultiMinDerivFunctionWrapper	fFunc

const gsl_multimin_fdfminimizer_type *	fType

gsl_vector *	fVec

#include </mnt/vdb/lsf/workspace/root-makedoc-v606/rootspi/rdoc/src/v6-06-00-patches/math/mathmore/src/GSLMultiMinimizer.h>

Collaboration diagram for ROOT::Math::GSLMultiMinimizer:

Constructor & Destructor Documentation

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

inline

Default constructor.

Definition at line 60 of file GSLMultiMinimizer.h.

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

inline

Destructor.

Definition at line 98 of file GSLMultiMinimizer.h.

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

inlineprivate

Copy constructor.

Definition at line 110 of file GSLMultiMinimizer.h.

Member Function Documentation

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

inline

create the minimizer from the type and size

Definition at line 141 of file GSLMultiMinimizer.h.

Referenced by Set().

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

inline

gradient value at the minimum

Definition at line 170 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::MinGradient(), and ROOT::Math::GSLMinimizer::Minimize().

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

inline

Definition at line 151 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::Minimize().

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

inline

function value at the minimum

Definition at line 164 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::Minimize().

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

inline

Definition at line 146 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::Minimize().

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

inlineprivate

Assignment operator.

Definition at line 115 of file GSLMultiMinimizer.h.

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

inline

restart minimization from current point

Definition at line 177 of file GSLMultiMinimizer.h.

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 126 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::Minimize().

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

inline

test gradient (ask from minimizer gradient vector)

Definition at line 183 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::Minimize().

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

inline

test gradient (require a vector gradient)

Definition at line 190 of file GSLMultiMinimizer.h.

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

inline

x values at the minimum

Definition at line 157 of file GSLMultiMinimizer.h.

Referenced by ROOT::Math::GSLMinimizer::Minimize().

Member Data Documentation

GSLMultiMinDerivFunctionWrapper ROOT::Math::GSLMultiMinimizer::fFunc

private

Definition at line 202 of file GSLMultiMinimizer.h.

Referenced by Set().

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

private

Definition at line 201 of file GSLMultiMinimizer.h.

Referenced by CreateMinimizer(), Gradient(), Iterate(), Minimum(), Name(), Restart(), Set(), TestGradient(), X(), and ~GSLMultiMinimizer().

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

private

Definition at line 203 of file GSLMultiMinimizer.h.

Referenced by CreateMinimizer(), and GSLMultiMinimizer().

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

mutableprivate

Definition at line 205 of file GSLMultiMinimizer.h.

Referenced by Set(), TestGradient(), and ~GSLMultiMinimizer().

The documentation for this class was generated from the following file:

math/mathmore/src/GSLMultiMinimizer.h