IFuncMinimum Class Reference

Interface file to find minimum of the function and compute covariance matrix (matrix of error) More...

#include <GaudiGSL/IFuncMinimum.h>

Inheritance diagram for IFuncMinimum:

Collaboration diagram for IFuncMinimum:

Public Types
typedef Genfun::AbsFunction	GenFunc
	Function which we minimize (.
typedef Genfun::Argument	Arg
	Argument of function "GenFunc" (.
typedef CLHEP::HepSymMatrix	Covariance
	Covariance matrix (matrix of error) (.

Public Member Functions
	DeclareInterfaceID (IFuncMinimum, 2, 0)
	InterfaceID.
virtual StatusCode	minimum (const GenFunc &fun, Arg &pars) const =0
	Do Multidimensional Minimization.
virtual StatusCode	minimum (const GenFunc &fun, Arg &pars, Covariance &covar) const =0
	Find minimum and gradient of the function "GenFunc".
Public Member Functions inherited from IAlgTool
	DeclareInterfaceID (IAlgTool, 3, 0)
	InterfaceID.
virtual	~IAlgTool ()
	Virtual destructor.
virtual const std::string &	type () const =0
	The type of an AlgTool, meaning the concrete AlgTool class.
virtual const IInterface *	parent () const =0
	The parent of the concrete AlgTool.
virtual StatusCode	configure ()=0
	Configuration (from OFFLINE to CONFIGURED).
virtual StatusCode	initialize ()=0
	Initialization (from CONFIGURED to INITIALIZED).
virtual StatusCode	start ()=0
	Start (from INITIALIZED to RUNNING).
virtual StatusCode	stop ()=0
	Stop (from RUNNING to INITIALIZED).
virtual StatusCode	finalize ()=0
	Finalize (from INITIALIZED to CONFIGURED).
virtual StatusCode	terminate ()=0
	Initialization (from CONFIGURED to OFFLINE).
virtual StatusCode	reinitialize ()=0
	Initialization (from INITIALIZED or RUNNING to INITIALIZED, via CONFIGURED).
virtual StatusCode	restart ()=0
	Initialization (from RUNNING to RUNNING, via INITIALIZED).
virtual Gaudi::StateMachine::State	FSMState () const =0
	Get the current state.
virtual StatusCode	sysInitialize ()=0
	Initialization of the Tool.
virtual StatusCode	sysStart ()=0
	Initialization of the Tool.
virtual StatusCode	sysStop ()=0
	Initialization of the Tool.
virtual StatusCode	sysFinalize ()=0
	Finalization of the Tool.
virtual StatusCode	sysReinitialize ()=0
	Initialization of the Tool.
virtual StatusCode	sysRestart ()=0
	Initialization of the Tool.
virtual unsigned long	refCount () const =0
	Current number of reference counts.
Public Member Functions inherited from INamedInterface
	DeclareInterfaceID (INamedInterface, 1, 0)
	InterfaceID.
virtual const std::string &	name () const =0
	Retrieve the name of the instance.
virtual	~INamedInterface ()
	Virtual destructor (always needed for abstract classes).
Public Member Functions inherited from IInterface
virtual void *	i_cast (const InterfaceID &) const =0
	main cast function
virtual std::vector< std::string >	getInterfaceNames () const =0
	Returns a vector of strings containing the names of all the implemented interfaces.
virtual unsigned long	addRef ()=0
	Increment the reference count of Interface instance.
virtual unsigned long	release ()=0
	Release Interface instance.
virtual StatusCode	queryInterface (const InterfaceID &ti, void **pp)=0
	Set the void** to the pointer to the requested interface of the instance.
virtual	~IInterface ()
	Virtual destructor.

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

Detailed Description

Interface file to find minimum of the function and compute covariance matrix (matrix of error)

Author

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

Date

2002-09-14

Definition at line 29 of file IFuncMinimum.h.

Member Typedef Documentation

typedef Genfun::Argument IFuncMinimum::Arg

Argument of function "GenFunc" (.

See Also

CLHEP/GenericFunctions/Argument.hh)

Definition at line 37 of file IFuncMinimum.h.

typedef CLHEP::HepSymMatrix IFuncMinimum::Covariance

Covariance matrix (matrix of error) (.

See Also

CLHEP/Matrix/SymMatrix.h)

Definition at line 39 of file IFuncMinimum.h.

typedef Genfun::AbsFunction IFuncMinimum::GenFunc

Function which we minimize (.

See Also

CLHEP/GenericFunctions/AbsFunction.hh)

Definition at line 35 of file IFuncMinimum.h.

Member Function Documentation

IFuncMinimum::DeclareInterfaceID	(	IFuncMinimum	,
		2	,
		0
	)

InterfaceID.

virtual StatusCode IFuncMinimum::minimum ( const GenFunc &  fun, Arg &  pars  ) const

pure virtual

Do Multidimensional Minimization.

Find minimum and gradient of the function "GenFunc"

Parameters

fun	- function

See Also

CLHEP/GenericFunctions/AbsFunction.hh

Parameters

pars	- argument

See Also

CLHEP/GenericFunctions/Argument.hh

Returns

StatusCode

Implemented in FuncMinimum.

virtual StatusCode IFuncMinimum::minimum ( const GenFunc &  fun, Arg &  pars, Covariance &  covar  ) const

pure virtual

Find minimum and gradient of the function "GenFunc".

Parameters

fun	- function

See Also

CLHEP/GenericFunctions/AbsFunction.hh

Parameters

pars	- argument

See Also

CLHEP/GenericFunctions/Argument.hh

Parameters

covar

- covariance matrix (matrix of error)

See Also

CLHEP/Matrix/SymMatrix.h

Returns

StatusCode

Implemented in FuncMinimum.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r6/GaudiGSL/GaudiGSL/IFuncMinimum.h