Gaudi Framework, version v23r5

Home   Generated: Wed Nov 28 2012
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
IEqSolver Class Referenceabstract

Interface file for multidimensional root-finding (solving nonlinear system with n equations in n unknowns) More...

#include <GaudiGSL/IEqSolver.h>

Inheritance diagram for IEqSolver:
Inheritance graph
[legend]
Collaboration diagram for IEqSolver:
Collaboration graph
[legend]

Public Types

typedef Genfun::AbsFunction GenFunc
 Function (.
 
typedef std::vector< const
GenFunc * > 
Equations
 Vector of the function "GenFunc" which we solver.
 
typedef Genfun::Argument Arg
 Argument of function "GenFunc" (.
 

Public Member Functions

 DeclareInterfaceID (IEqSolver, 2, 0)
 InterfaceID.
 
virtual StatusCode solver (const Equations &equations, Arg &solution) const =0
 Do Multidimensional Root-finding.
 
- Public Member Functions inherited from IAlgTool
 DeclareInterfaceID (IAlgTool, 3, 0)
 InterfaceID.
 
virtual ~IAlgTool ()
 Virtual destructor.
 
virtual const std::stringtype () const =0
 The type of an AlgTool, meaning the concrete AlgTool class.
 
virtual const IInterfaceparent () 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::stringname () 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::stringgetInterfaceNames () 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 InterfaceIDinterfaceID ()
 Return an instance of InterfaceID identifying the interface.
 

Detailed Description

Interface file for multidimensional root-finding (solving nonlinear system with n equations in n unknowns)

Author
Kirill Miklyaev kiril.nosp@m.lm@i.nosp@m.ris1..nosp@m.itep.nosp@m..ru
Date
2003-07-07

Definition at line 26 of file IEqSolver.h.

Member Typedef Documentation

typedef Genfun::Argument IEqSolver::Arg

Argument of function "GenFunc" (.

See Also
CLHEP/GenericFunctions/Argument.hh)

Definition at line 36 of file IEqSolver.h.

Vector of the function "GenFunc" which we solver.

Definition at line 34 of file IEqSolver.h.

typedef Genfun::AbsFunction IEqSolver::GenFunc

Function (.

See Also
CLHEP/GenericFunctions/AbsFunction.hh)

Definition at line 32 of file IEqSolver.h.

Member Function Documentation

IEqSolver::DeclareInterfaceID ( IEqSolver  ,
,
 
)
virtual StatusCode IEqSolver::solver ( const Equations equations,
Arg solution 
) const
pure virtual

Do Multidimensional Root-finding.

Solving nonlinear system with N equations in N unknowns of the function "GenFunc"

Parameters
equations- vector of functions
See Also
CLHEP/GenericFunctions/AbsFunction.hh
Parameters
solution- argument
See Also
CLHEP/GenericFunctions/Argument.hh
Returns
StatusCode

Implemented in EqSolver.


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

Generated at Wed Nov 28 2012 12:17:30 for Gaudi Framework, version v23r5 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004