The simplest concrete implementation of IFuncMinimum interface. More...

#include <src/Components/FuncMinimum.h>

Inheritance diagram for FuncMinimum:

Collaboration diagram for FuncMinimum:

Classes
class	FuncMinimumMisc

Public Types
typedef std::vector< const GenFunc * >	Gradient

Public Types inherited from extends1< GaudiTool, IFuncMinimum >
typedef extends1	base_class
	Typedef to this class. More...

typedef extend_interfaces1 < IFuncMinimum >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from AlgTool
typedef Gaudi::PluginService::Factory3 < IAlgTool , const std::string &, const std::string &, const IInterface >	Factory

Public Types inherited from implements3< IAlgTool, IProperty, IStateful >
typedef implements3	base_class
	Typedef to this class. More...

typedef extend_interfaces3 < IAlgTool, IProperty, IStateful >	extend_interfaces_base
	Typedef to the base of this class. More...

typedef extend_interfaces_base::ext_iids	interfaces
	MPL set of all the implemented interfaces. More...

Public Types inherited from extend_interfaces3< IAlgTool, IProperty, IStateful >
typedef mpl::fold< typename IAlgTool::iid::iids::type, typename mpl::fold< typename IProperty::iid::iids::type, typename IStateful::iid::iids::type, mpl::insert< mpl::_1, mpl::_2 > >::type, mpl::insert< mpl::_1, mpl::_2 > >::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IInterface
enum	Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
	Return status. More...

typedef Gaudi::InterfaceId < IInterface, 0, 0 >	iid
	Interface ID. More...

typedef mpl::set1< iid >	ext_iids
	Extra interfaces. More...

Public Types inherited from extend_interfaces1< IFuncMinimum >
typedef IFuncMinimum::iid::iids::type	ext_iids
	MPL set of interfaces extended by this one. More...

Public Types inherited from IFuncMinimum
typedef Genfun::AbsFunction	GenFunc
	Function which we minimize (. More...

typedef Genfun::Argument	Arg
	Argument of function "GenFunc" (. More...

typedef CLHEP::HepSymMatrix	Covariance
	Covariance matrix (matrix of error) (. More...

Public Member Functions
virtual StatusCode	minimum (const GenFunc &func, Arg &arg) const
	Find minimum of the function "GenFunc". More...

virtual StatusCode	minimum (const GenFunc &func, Arg &arg, Covariance &covar) const
	Find minimum of the function "GenFunc". More...

virtual StatusCode	initialize ()
	Overriding initialize. More...

virtual StatusCode	finalize ()
	standard finalization method More...

virtual	~FuncMinimum ()
	Destructor. More...

	FuncMinimum (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...

Public Member Functions inherited from extends1< GaudiTool, IFuncMinimum >
	extends1 (A1 a1, A2 a2, A3 a3)
	Templated constructor with 3 arguments. More...

	extends1 (A1 a1, A2 a2)
	Templated constructor with 2 arguments. More...

	extends1 (A1 a1)
	Templated constructor with 1 argument. More...

	extends1 ()
	Default constructor. More...

virtual void *	i_cast (const InterfaceID &tid) const
	Implementation of IInterface::i_cast. More...

virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)
	Implementation of IInterface::queryInterface. More...

virtual std::vector< std::string >	getInterfaceNames () const
	Implementation of IInterface::getInterfaceNames. More...

virtual	~extends1 ()
	Virtual destructor. More...

Public Member Functions inherited from GaudiTool
INTupleSvc *	ntupleSvc () const
	Access the standard N-Tuple. More...

INTupleSvc *	evtColSvc () const
	Access the standard event collection service. More...

IDataProviderSvc *	detSvc () const
	accessor to detector service More...

IDataProviderSvc *	evtSvc () const
	accessor to event service service More...

IIncidentSvc *	incSvc () const
	accessor to Incident Service More...

IChronoStatSvc *	chronoSvc () const
	accessor to Chrono & Stat Service More...

IHistogramSvc *	histoSvc () const
	acessor to the histogram service More...

IAlgContextSvc *	contextSvc () const
	acessor to the Algorithm Context Service More...

DataObject *	put (IDataProviderSvc svc, DataObject object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

DataObject *	put (DataObject *object, const std::string &address, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE > ::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE > ::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE > ::return_type	get (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data from Gaudi Event Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE > ::return_type	getIfExists (const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

template<class TYPE >
TYPE *	getDet (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE > ::return_type	getDetIfExists (IDataProviderSvc *svc, const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
TYPE *	getDet (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
Gaudi::Utils::GetData< TYPE > ::return_type	getDetIfExists (const std::string &location) const
	Templated access to the detector data from the Gaudi Detector Transient Store. More...

template<class TYPE >
bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

template<class TYPE >
bool	exist (const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

template<class TYPE >
bool	existDet (IDataProviderSvc *svc, const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...

template<class TYPE >
bool	existDet (const std::string &location) const
	Check the existence of detector objects in the Gaudi Transient Detector Store. More...

template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE > ::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

template<class TYPE , class TYPE2 >
Gaudi::Utils::GetData< TYPE > ::return_type	getOrCreate (const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

Public Member Functions inherited from GaudiCommon< AlgTool >
Gaudi::Utils::GetData< TYPE > ::return_type	get (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Templated access to the data in Gaudi Transient Store. More...

Gaudi::Utils::GetData< TYPE > ::return_type	getIfExists (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Quicker version of the get function which bypasses the check on the retrieved data. More...

bool	exist (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Check the existence of a data object or container in the Gaudi Transient Event Store. More...

Gaudi::Utils::GetData< TYPE > ::return_type	getOrCreate (IDataProviderSvc *svc, const std::string &location, const bool useRootInTES=true) const
	Get the existing data object from Gaudi Event Transient store. More...

DataObject *	put (IDataProviderSvc svc, DataObject object, const std::string &location, const bool useRootInTES=true) const
	Register a data object or container into Gaudi Event Transient Store. More...

TOOL *	tool (const std::string &type, const std::string &name, const IInterface *parent=0, bool create=true) const
	Useful method for the easy location of tools. More...

TOOL *	tool (const std::string &type, const IInterface *parent=0, bool create=true) const
	A useful method for the easy location of tools. More...

SmartIF< SERVICE >	svc (const std::string &name, const bool create=true) const
	A useful method for the easy location of services. More...

IUpdateManagerSvc *	updMgrSvc () const
	Short-cut to locate the Update Manager Service. More...

StatusCode	Error (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the error message and return with the given StatusCode. More...

StatusCode	Warning (const std::string &msg, const StatusCode st=StatusCode::FAILURE, const size_t mx=10) const
	Print the warning message and return with the given StatusCode. More...

StatusCode	Info (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const size_t mx=10) const
	Print the info message and return with the given StatusCode. More...

StatusCode	Print (const std::string &msg, const StatusCode st=StatusCode::SUCCESS, const MSG::Level lev=MSG::INFO) const
	Print the message and return with the given StatusCode. More...

void	Assert (const bool ok, const std::string &message="", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...

void	Assert (const bool ok, const char *message, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Assertion - throw exception if the given condition is not fulfilled. More...

void	Exception (const std::string &msg, const GaudiException &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given GaudiException. More...

void	Exception (const std::string &msg, const std::exception &exc, const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and (re)-throw a given exception. More...

void	Exception (const std::string &msg="no message", const StatusCode sc=StatusCode(StatusCode::FAILURE, true)) const
	Create and throw an exception with the given message. More...

MsgStream &	msgStream (const MSG::Level level) const
	Predefined configurable message stream for the efficient printouts. More...

MsgStream &	always () const
	shortcut for the method msgStream ( MSG::ALWAYS ) More...

MsgStream &	fatal () const
	shortcut for the method msgStream ( MSG::FATAL ) More...

MsgStream &	err () const
	shortcut for the method msgStream ( MSG::ERROR ) More...

MsgStream &	error () const
	shortcut for the method msgStream ( MSG::ERROR ) More...

MsgStream &	warning () const
	shortcut for the method msgStream ( MSG::WARNING ) More...

MsgStream &	info () const
	shortcut for the method msgStream ( MSG::INFO ) More...

MsgStream &	debug () const
	shortcut for the method msgStream ( MSG::DEBUG ) More...

MsgStream &	verbose () const
	shortcut for the method msgStream ( MSG::VERBOSE ) More...

MsgStream &	msg () const
	shortcut for the method msgStream ( MSG::INFO ) More...

const Statistics &	counters () const
	accessor to all counters More...

StatEntity &	counter (const std::string &tag) const
	accessor to certain counter by name More...

MSG::Level	msgLevel () const
	The current message service output level. More...

bool	msgLevel (const MSG::Level level) const
	Test the output level. More...

void	resetMsgStream () const
	Reset (delete) the current message stream object. More...

bool	typePrint () const
	Insert the actual C++ type of the algorithm/tool in the messages ? More...

bool	propsPrint () const
	Print properties at initialization ? More...

bool	statPrint () const
	Print statistical counters at finalization ? More...

bool	errorsPrint () const
	Print error counters at finalization ? More...

long	printStat (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of statistical counters More...

long	printErrors (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of error counters More...

long	printProps (const MSG::Level level=MSG::ALWAYS) const
	perform the actual printout of properties More...

void	registerCondition (const std::string &condition, StatusCode(CallerClass::*mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

void	registerCondition (const std::string &condition, CondType &condPtrDest, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

void	registerCondition (char condition, StatusCode(CallerClass::mf)()=NULL)
	just to avoid conflicts with the version using a pointer to a template class. More...

void	registerCondition (TargetClass condition, StatusCode(CallerClass::mf)()=NULL)
	register the current instance to the UpdateManagerSvc as a consumer for a condition. More...

StatusCode	runUpdate ()
	asks the UpdateManagerSvc to perform an update of the instance (if needed) without waiting the next BeginEvent incident. More...

	GaudiCommon (const std::string &name, ISvcLocator *pSvcLocator)
	Algorithm constructor. More...

	GaudiCommon (const std::string &type, const std::string &name, const IInterface *parent)
	Tool constructor. More...

StatusCode	release (const IInterface *interface) const
	Manual forced (and 'safe') release of the active tool or service. More...

virtual unsigned long	release ()
	Un-hide IInterface::release (ICC warning #1125) More...

const AlgTools &	tools () const
	get the list of aquired tools More...

const Services &	services () const
	get the list of aquired services More...

const std::string &	context () const
	Returns the "context" string. Used to identify different processing states. More...

const std::string &	rootInTES () const
	Returns the "rootInTES" string. More...

double	globalTimeOffset () const
	Returns the "globalTimeOffset" double. More...

const std::string	fullTESLocation (const std::string &location, const bool useRootInTES) const
	Returns the full correct event location given the rootInTes settings. More...

Public Member Functions inherited from AlgTool
virtual const std::string &	name () const
	Retrieve full identifying name of the concrete tool object. More...

virtual const std::string &	type () const
	Retrieve type (concrete class) of the sub-algtool. More...

virtual const IInterface *	parent () const
	Retrieve parent of the sub-algtool. More...

virtual StatusCode	configure ()
	Configuration (from OFFLINE to CONFIGURED). More...

virtual StatusCode	start ()
	Start (from INITIALIZED to RUNNING). More...

virtual StatusCode	stop ()
	Stop (from RUNNING to INITIALIZED). More...

virtual StatusCode	terminate ()
	Initialization (from CONFIGURED to OFFLINE). More...

virtual StatusCode	reinitialize ()
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED). More...

virtual StatusCode	restart ()
	Initialization (from RUNNING to RUNNING, via INITIALIZED). More...

virtual Gaudi::StateMachine::State	FSMState () const
	Get the current state. More...

virtual Gaudi::StateMachine::State	targetFSMState () const
	When we are in the middle of a transition, get the state where the transition is leading us. More...

virtual StatusCode	sysInitialize ()
	Initialize AlgTool. More...

virtual StatusCode	sysStart ()
	Start AlgTool. More...

virtual StatusCode	sysStop ()
	Stop AlgTool. More...

virtual StatusCode	sysFinalize ()
	Finalize AlgTool. More...

virtual StatusCode	sysReinitialize ()
	Initialize AlgTool. More...

virtual StatusCode	sysRestart ()
	Start AlgTool. More...

virtual StatusCode	setProperty (const Property &p)
	Default implementations for IProperty interface. More...

virtual StatusCode	setProperty (const std::string &s)
	Set the property by string. More...

virtual StatusCode	setProperty (const std::string &n, const std::string &v)
	Set the property by std::string. More...

virtual StatusCode	getProperty (Property *p) const
	Get the property by property. More...

virtual const Property &	getProperty (const std::string &name) const
	Get the property by name. More...

virtual StatusCode	getProperty (const std::string &n, std::string &v) const
	Get the property by std::string. More...

virtual const std::vector < Property * > &	getProperties () const
	Get list of properties. More...

PropertyMgr *	getPropertyMgr ()

template<class TYPE >
StatusCode	setProperty (const std::string &name, const TYPE &value)
	set the property form the value More...

	AlgTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard Constructor. More...

ISvcLocator *	serviceLocator () const
	Retrieve pointer to service locator. More...

ISvcLocator *	svcLoc () const
	shortcut for the method service locator More...

IMessageSvc *	msgSvc () const
	Retrieve pointer to message service. More...

IToolSvc *	toolSvc () const
	The standard ToolSvc service, Return a pointer to the service if present. More...

StatusCode	setProperties ()
	Method for setting declared properties to the values specified in the jobOptions via the job option service. More...

template<class T >
StatusCode	service (const std::string &name, T *&svc, bool createIf=true) const
	Access a service by name, creating it if it doesn't already exist. More...

template<class T >
StatusCode	service (const std::string &type, const std::string &name, T *&svc) const
	Access a service by name, type creating it if it doesn't already exist. More...

SmartIF< IService >	service (const std::string &name, const bool createIf=true, const bool quiet=false) const
	Return a pointer to the service identified by name (or "type/name") More...

void	declInterface (const InterfaceID &, void *)
	declare interface More...

template<class T >
Property *	declareProperty (const std::string &name, T &property, const std::string &doc="none") const
	Declare the named property. More...

Property *	declareRemoteProperty (const std::string &name, IProperty *rsvc, const std::string &rname="") const
	Declare remote named properties. More...

IAuditorSvc *	auditorSvc () const
	Access the auditor service. More...

IMonitorSvc *	monitorSvc () const
	Access the monitor service. More...

template<class T >
void	declareInfo (const std::string &name, const T &var, const std::string &desc) const
	Declare monitoring information. More...

void	declareInfo (const std::string &name, const std::string &format, const void *var, int size, const std::string &desc) const
	Declare monitoring information (special case) More...

Public Member Functions inherited from extend_interfaces3< IAlgTool, IProperty, IStateful >
virtual	~extend_interfaces3 ()
	Virtual destructor. More...

Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 3, 0)
	InterfaceID. More...

virtual	~IAlgTool ()
	Virtual destructor. More...

virtual unsigned long	refCount () const =0
	Current number of reference counts. More...

Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID. More...

virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes). More...

Public Member Functions inherited from IInterface
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance. More...

virtual	~IInterface ()
	Virtual destructor. More...

Public Member Functions inherited from IProperty
	DeclareInterfaceID (IProperty, 2, 0)
	InterfaceID. More...

Public Member Functions inherited from IStateful
	DeclareInterfaceID (IStateful, 1, 0)
	InterfaceID. More...

virtual	~IStateful ()

Public Member Functions inherited from extend_interfaces1< IFuncMinimum >
virtual	~extend_interfaces1 ()
	Virtual destructor. More...

Public Member Functions inherited from IFuncMinimum
	DeclareInterfaceID (IFuncMinimum, 2, 0)
	InterfaceID. More...

Private Member Functions
	FuncMinimum ()
	default constructor is private More...

	FuncMinimum (const FuncMinimum &)
	copy constructor is private More...

FuncMinimum &	operator= (const FuncMinimum &)
	assignment operator is More...

Private Attributes
std::string	m_algType

double	m_max_iter

double	m_norm_gradient

double	m_step_size

double	m_tol

const gsl_multimin_fdfminimizer_type *	m_type

Additional Inherited Members
Static Public Member Functions inherited from GaudiTool
static bool	enableSummary (bool)
	enable/disable summary More...

static bool	summaryEnabled ()
	is summary enabled? More...

Static Public Member Functions inherited from IInterface
static const InterfaceID &	interfaceID ()
	Return an instance of InterfaceID identifying the interface. More...

Protected Types inherited from GaudiCommon< AlgTool >
typedef std::map< std::string, StatEntity >	Statistics
	the actual type of general counters More...

typedef std::map< std::string, unsigned int >	Counter
	the actual type error/warning counter More...

typedef std::vector< IAlgTool * >	AlgTools
	storage for active tools More...

typedef GaudiUtils::HashMap < std::string, SmartIF < IService > >	Services
	storage for active services More...

Protected Member Functions inherited from GaudiTool
	GaudiTool (const std::string &type, const std::string &name, const IInterface *parent)
	Standard constructor. More...

virtual	~GaudiTool ()
	destructor, virtual and protected More...

Protected Member Functions inherited from GaudiCommon< AlgTool >
virtual	~GaudiCommon ()
	Destructor. More...

StatusCode	releaseTool (const IAlgTool *tool) const
	manual forced (and 'safe') release of the tool More...

StatusCode	releaseSvc (const IInterface *svc) const
	manual forced (and 'safe') release of the service More...

Protected Member Functions inherited from AlgTool
int	outputLevel () const
	get tool's output level More...

IntegerProperty &	outputLevelProperty ()
	Accessor for the Message level property. More...

void	initOutputLevel (Property &prop)
	callback for output level property More...

virtual	~AlgTool ()

Protected Attributes inherited from GaudiCommon< AlgTool >
ICounterSummarySvc *	m_counterSummarySvc
	a pointer to the CounterSummarySvc More...

std::vector< std::string >	m_counterList
	list of counters to declare. Set by property CounterList. This can be a regular expression. More...

std::vector< std::string >	m_statEntityList

Static Protected Attributes inherited from GaudiCommon< AlgTool >
static const bool	IgnoreRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

static const bool	UseRootInTES
	Simple definition to be used with the new useRootInTES argument get<TYPE> and put methods. More...

Detailed Description

The simplest concrete implementation of IFuncMinimum interface.

See also: GaudiGSL/IFuncMinimum.h

Author: Kirill Miklyaev kiril.nosp@m.lm@i.nosp@m.ris1..nosp@m.itep.nosp@m..ru

Date: 2002-09-14

Definition at line 26 of file FuncMinimum.h.

Member Typedef Documentation

typedef std::vector<const GenFunc*> FuncMinimum::Gradient

Definition at line 28 of file FuncMinimum.h.

Constructor & Destructor Documentation

FuncMinimum::~FuncMinimum ( )

virtual

Destructor.

Definition at line 356 of file FuncMinimum.cpp.

358 {}

FuncMinimum::FuncMinimum	(	const std::string &	type,
		const std::string &	name,
		const IInterface *	parent
	)

Standard constructor.

See also: GaudiTool

Parameters

type	tool type
name	tool name
parent	parent of the tool

declare type of the algorithm for multidimensional minimization

declare maximum of iteration

declare the absolute tolerance for the Euclidean norm of the gradient

declare the size of the first trial step

declare the accuracy of the line minimization

Definition at line 64 of file FuncMinimum.cpp.

   : base_class      ( type, name , parent )
   , m_algType       ( "conjugate_fr"      )
   , m_max_iter      ( 200                 )
   , m_norm_gradient ( 1.0e-10             )
   , m_step_size     ( 0.01                )
   , m_tol           ( 1e-10               )
   , m_type          ( 0                   )
 {
   declareProperty ( "Algorithm", m_algType       );
   declareProperty ( "Iteration", m_max_iter      );
   declareProperty ( "Gradient" , m_norm_gradient );
   declareProperty ( "Step_size", m_step_size     );
   declareProperty ( "Tol"      , m_tol           );
 }

FuncMinimum::FuncMinimum ( )

private

default constructor is private

FuncMinimum::FuncMinimum ( const FuncMinimum & )

private

copy constructor is private

Member Function Documentation

StatusCode FuncMinimum::finalize ( )

virtual

standard finalization method

See also: AlgTool; IAlgTool

Returns: status code

Reimplemented from GaudiTool.

Definition at line 343 of file FuncMinimum.cpp.

 {
   StatusCode sc = GaudiTool::finalize() ;
 
   MsgStream log( msgSvc() , name() ) ;
 
   if ( sc.isFailure() )
     {
       return Error("Could not finalize base class GaudiTool", sc);
     }
   return StatusCode::SUCCESS;
 }

StatusCode FuncMinimum::initialize ( )

virtual

Overriding initialize.

The algorithm for multidimensional minimization

Reimplemented from GaudiTool.

Definition at line 290 of file FuncMinimum.cpp.

 {
   StatusCode sc = GaudiTool::initialize() ;
 
   MsgStream log( msgSvc() , name() ) ;
 
   if ( sc.isFailure() )
     {
       return Error ("Could not initialize base class GaudiTool", sc);
     }
 
   if(       "conjugate_fr" == m_algType )
     {
       m_type = gsl_multimin_fdfminimizer_conjugate_fr     ;
       log << MSG::DEBUG
           << "Minimization algorithm to be used: "
           << "'gsl_multimin_fdfminimizer_conjugate_fr'"
           << endmsg;
     }
   else if ( "conjugate_pr" == m_algType )
     {
       m_type = gsl_multimin_fdfminimizer_conjugate_pr     ;
       log << MSG::DEBUG
           << "Minimization algorithm to be used: "
           << "'gsl_multimin_fdfminimizer_conjugate_pr'"
           << endmsg;
     }
   else if ( "vector_bfgs" == m_algType )
     {
       m_type = gsl_multimin_fdfminimizer_vector_bfgs      ;
       log << MSG::DEBUG
           << "Minimization algorithm to be used: " <<
           "'gsl_multimin_fdfminimizer_vector_bfgs'" << endmsg;
     }
   else if ( "steepest_descent" == m_algType )
     {
       m_type = gsl_multimin_fdfminimizer_steepest_descent ;
       log << MSG::DEBUG
           << "Minimization algorithm to be used: "
           << "'gsl_multimin_fdfminimizer_steepest_descent'"
           << endmsg;
     }
   else
     {
       return Error(" Unknown algorithm type '"
                    + std::string(m_algType) + "'");
     }
 
   return StatusCode::SUCCESS;
 }

StatusCode FuncMinimum::minimum	(	const GenFunc &	func,
		IFuncMinimum::Arg &	arg
	)		const

virtual

Find minimum of the function "GenFunc".

See also: IFuncMinimum.h

Returns: StatusCode

Implements IFuncMinimum.

Definition at line 151 of file FuncMinimum.cpp.

 {
   using namespace Genfun;
 
   gsl_vector_view vect = gsl_vector_view_array ( &arg[0] ,
                                                  arg.dimension() );
   MsgStream log( msgSvc(), name() );
 
   FuncMinimumMisc local (func, arg);
 
   gsl_multimin_function_fdf function;
 
   function.f = &fun_gsl;
   function.df = &dfun_gsl;
   function.fdf = &fdfun_gsl;
   function.n = vect.vector.size;
   function.params = (void*) &local;
 
   size_t iter   = 0 ;
   int    status = 0 ;
   const gsl_multimin_fdfminimizer_type *T = m_type ;
 
   gsl_multimin_fdfminimizer *s;
 
   s = gsl_multimin_fdfminimizer_alloc ( T, vect.vector.size);
 
   gsl_multimin_fdfminimizer_set ( s, &function,
                                   &vect.vector, m_step_size, m_tol);
 
   for( iter = 0 ; iter < m_max_iter ; ++iter )
     {
       status = gsl_multimin_fdfminimizer_iterate (s);
 
       if ( status )
         {
           return Error
             ("Error from gsl_multimin_fdfminimizer_iterate '"
              + std::string(gsl_strerror(status)) + "'") ;
         }
 
       status = gsl_multimin_test_gradient (s->gradient,
                                            m_norm_gradient);
 
 
       if ( status != GSL_CONTINUE ) { break; }
     }
 
   for (unsigned int i = 0; i < vect.vector.size; ++i)
     {
       gsl_vector_set (&vect.vector, i, gsl_vector_get (s->x, i));
     }
 
   if (status == GSL_SUCCESS)
     {
       log << MSG::DEBUG
           << "We stopped in the method on the " << iter
           << " iteration (we have maximum "     << m_max_iter
           << " iterations)"                     << endmsg;
 
       log << "The Euclidean norm of gradient = "
           << gsl_blas_dnrm2 (s->gradient)
           << " by the absolute tolerance = "
           << m_norm_gradient << endmsg;
     }
   else if (status == GSL_CONTINUE && iter <= m_max_iter )
     {
       return Error ( "Method finished with '"
                      + std::string(gsl_strerror(status))
                      +  "' error" );
     }
   else
     {
       return Error ( "Method finished with '" +
                      std::string(gsl_strerror(status))
                      +  "' error" );
     }
 
   gsl_multimin_fdfminimizer_free (s);
 
   if (status)
     {
       return Error ( "Method finished with '"
                      + std::string(gsl_strerror(status))
                      +  "' error" );
     }
 
   return StatusCode::SUCCESS;
 }

StatusCode FuncMinimum::minimum	(	const GenFunc &	func,
		IFuncMinimum::Arg &	arg,
		IFuncMinimum::Covariance &	covar
	)		const

virtual

Find minimum of the function "GenFunc".

See also: IFuncMinimum.h

Returns: StatusCode

Find minimum of our function

Implements IFuncMinimum.

Definition at line 247 of file FuncMinimum.cpp.

 {
   MsgStream log( msgSvc(), name() );
 
   StatusCode sc = minimum (func, arg) ;
 
   if (sc.isFailure())
     {
       std::ostringstream buffer;
       buffer << "MINIMUM IS NOT FOUND. StatusCode =  '" << sc.getCode() << '\'';
       return Error (buffer.str(), sc);
     }
   else
     {
       HepSymMatrix cov(arg.dimension(), 0);
       for (unsigned int i = 0; i < arg.dimension(); ++i)
         {
           Genfun::GENFUNCTION f = func.partial(i);
           for (unsigned int j = i; j < arg.dimension(); ++j)
             {
               Genfun::GENFUNCTION fij = f.partial(j);
               cov(i+1, j+1) = 0.5 * fij(arg);
             }
         }
 
       int inv;
       covar = cov.inverse(inv);
       if ( inv != 0)
         {
           return Error
             ("Matrix of Error is not complete successful");
         }
 
       return StatusCode::SUCCESS;
     }
 
 }

FuncMinimum& FuncMinimum::operator= ( const FuncMinimum & )

private

assignment operator is

Member Data Documentation

std::string FuncMinimum::m_algType

private

Definition at line 103 of file FuncMinimum.h.

double FuncMinimum::m_max_iter

private

Definition at line 104 of file FuncMinimum.h.

double FuncMinimum::m_norm_gradient

private

Definition at line 105 of file FuncMinimum.h.

double FuncMinimum::m_step_size

private

Definition at line 106 of file FuncMinimum.h.

double FuncMinimum::m_tol

private

Definition at line 107 of file FuncMinimum.h.

const gsl_multimin_fdfminimizer_type* FuncMinimum::m_type

private

Definition at line 108 of file FuncMinimum.h.

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

GaudiGSL/src/Components/FuncMinimum.h
GaudiGSL/src/Components/FuncMinimum.cpp

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation