Gaudi Framework, version v23r0

Home   Generated: Mon Jan 30 2012
Public Types | Public Member Functions | Private Member Functions | Private Attributes

Genfun::GaudiMathImplementation::Adapter3DoubleFunction Class Reference

constructor from the trivial function with two argument More...

#include <GaudiMath/Adapters.h>

List of all members.

Public Types

typedef double(* Function )(const double, const double, const double)
 the actual type of the function "to be adapted"

Public Member Functions

 Adapter3DoubleFunction (Function func)
 mandatory macro from CLHEP/GenericFunctions
 Adapter3DoubleFunction (const Adapter3DoubleFunction &)
 copy coinstructor
virtual ~Adapter3DoubleFunction ()
 virtual destructor
virtual double operator() (double x) const
virtual double operator() (const Argument &x) const
virtual unsigned int dimensionality () const
virtual bool hasAnalyticDerivative () const
 Does this function have an analytic derivative?
virtual Genfun::Derivative partial (unsigned int i) const
 Derivatives.
double operator() (const double x, const double y, const double z) const

Private Member Functions

 Adapter3DoubleFunction ()
Adapter3DoubleFunctionoperator= (const Adapter3DoubleFunction &)

Private Attributes

Function m_func

Detailed Description

constructor from the trivial function with two argument

  double func( const double , const double , const double ) ;

  const AbsFuction& fun = Adapter2DoubleFunction( fun ) ;

  // evaluate the function in point (1,2,3):
  Argument arg(3) ;
  arg[0] = 1 ;
  arg[1] = 2 ;
  arg[2] = 3 ;

  double value = fun( arg ) ;
Parameters:
funcpointer to trivial function
Author:
Kirill Miklyaev kirillm@iris1.itep.ru
Vanya BELYAEV Ivan.Belyaev@itep.ru
Date:
2003-08-03

Definition at line 154 of file FunAdapters.h.


Member Typedef Documentation

typedef double(* Genfun::GaudiMathImplementation::Adapter3DoubleFunction::Function)(const double, const double, const double)

the actual type of the function "to be adapted"

Definition at line 158 of file FunAdapters.h.


Constructor & Destructor Documentation

Genfun::GaudiMathImplementation::Adapter3DoubleFunction::Adapter3DoubleFunction ( Adapter3DoubleFunction::Function  func )

mandatory macro from CLHEP/GenericFunctions

constructor

Definition at line 105 of file Adapter.cpp.

      : AbsFunction (       )
      , m_func      ( func  )
    {}
Genfun::GaudiMathImplementation::Adapter3DoubleFunction::Adapter3DoubleFunction ( const Adapter3DoubleFunction right )

copy coinstructor

Definition at line 111 of file Adapter.cpp.

      : AbsFunction (              )
      , m_func      ( right.m_func )
    {}
Genfun::GaudiMathImplementation::Adapter3DoubleFunction::~Adapter3DoubleFunction (  ) [virtual]

virtual destructor

Definition at line 116 of file Adapter.cpp.

{}
Genfun::GaudiMathImplementation::Adapter3DoubleFunction::Adapter3DoubleFunction (  ) [private]

Member Function Documentation

virtual unsigned int Genfun::GaudiMathImplementation::Adapter3DoubleFunction::dimensionality (  ) const [inline, virtual]

Definition at line 176 of file FunAdapters.h.

{ return 3    ; }
virtual bool Genfun::GaudiMathImplementation::Adapter3DoubleFunction::hasAnalyticDerivative (  ) const [inline, virtual]

Does this function have an analytic derivative?

Definition at line 178 of file FunAdapters.h.

{ return true ; }
double Genfun::GaudiMathImplementation::Adapter3DoubleFunction::operator() ( const double  x,
const double  y,
const double  z 
) const

Definition at line 127 of file Adapter.cpp.

    { return m_func ( x , y , z ) ; }
virtual double Genfun::GaudiMathImplementation::Adapter3DoubleFunction::operator() ( const Argument &  x ) const [virtual]
double Genfun::GaudiMathImplementation::Adapter3DoubleFunction::operator() ( double  x ) const [virtual]

Definition at line 119 of file Adapter.cpp.

    { return m_func ( x , 0 , 0 ) ; }
Adapter3DoubleFunction& Genfun::GaudiMathImplementation::Adapter3DoubleFunction::operator= ( const Adapter3DoubleFunction  ) [private]
Genfun::Derivative Genfun::GaudiMathImplementation::Adapter3DoubleFunction::partial ( unsigned int  i ) const [virtual]

Derivatives.

Definition at line 133 of file Adapter.cpp.

    {
      if ( i >= 3  )
      {
        const AbsFunction& aux = GaudiMath::Constant( 0 , 3 ) ;
        return Genfun::FunctionNoop( &aux ) ;
      };
      const AbsFunction& aux = GaudiMath::Derivative( *this , i ) ;
      return Genfun::FunctionNoop ( &aux ) ;
    }

Member Data Documentation

Definition at line 191 of file FunAdapters.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines

Generated at Mon Jan 30 2012 13:53:35 for Gaudi Framework, version v23r0 by Doxygen version 1.7.2 written by Dimitri van Heesch, © 1997-2004