IFuncMinimum Class Referenceabstract

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 (. More...
 
typedef Genfun::Argument Arg
 Argument of function "GenFunc" (. More...
 
typedef CLHEP::HepSymMatrix Covariance
 Covariance matrix (matrix of error) (. More...
 
- Public Types inherited from IInterface
enum  Status { SUCCESS = 1, NO_INTERFACE, VERSMISMATCH, LAST_ERROR }
 Return status. More...
 
using iid = Gaudi::InterfaceId< IInterface, 0, 0 >
 Interface ID. More...
 
using ext_iids = Gaudi::interface_list< iid >
 Extra interfaces. More...
 

Public Member Functions

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

Additional Inherited Members

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

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 27 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 35 of file IFuncMinimum.h.

typedef CLHEP::HepSymMatrix IFuncMinimum::Covariance

Covariance matrix (matrix of error) (.

See also
CLHEP/Matrix/SymMatrix.h)

Definition at line 37 of file IFuncMinimum.h.

typedef Genfun::AbsFunction IFuncMinimum::GenFunc

Function which we minimize (.

See also
CLHEP/GenericFunctions/AbsFunction.hh)

Definition at line 33 of file IFuncMinimum.h.

Member Function Documentation

IFuncMinimum::DeclareInterfaceID ( IFuncMinimum  ,
,
 
)
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
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

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