Gaudi Framework, version v21r11
Home   Generated: 30 Sep 2010

Genfun::GaudiMathImplementation::GSLSplineDeriv Class Reference

#include <Splines.h>

Collaboration diagram for Genfun::GaudiMathImplementation::GSLSplineDeriv:
[legend]

List of all members.

Public Types

typedef SplineBase::Data1D Data1D
typedef SplineBase::Data2D Data2D

Public Member Functions

 GSLSplineDeriv (const Data1D &x, const Data1D &y, const GaudiMath::Interpolation::Type type)
 mandatory macro from CLHEP/GenericFunctions
 GSLSplineDeriv (const Data2D &data, const GaudiMath::Interpolation::Type type)
 constructor from data vector
template<class DATAX, class DATAY>
 GSLSplineDeriv (const GaudiMath::Interpolation::Type type, DATAX begin_x, DATAX end_x, DATAY begin_y)
 templated constructor in the spirit of STL-algorithms
template<class DATA>
 GSLSplineDeriv (const GaudiMath::Interpolation::Type type, DATA begin, DATA end)
 templated constructor from the sequence of pairs as sequence of pairs the class TabulatedProperty can be used
 GSLSplineDeriv (const SplineBase &)
 constructor from base
 GSLSplineDeriv (const GSLSplineDeriv &)
 copy constructor
virtual ~GSLSplineDeriv ()
 destructor
virtual double operator() (double a) const
 main method: evaluate the function
virtual double operator() (const Argument &x) const
 main method: evaluate the function
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.
const SplineBase & spline () const
 acess to the spline function
 operator const SplineBase & () const
 cast operator to the spline function

Private Member Functions

 GSLSplineDeriv ()
 default construtor is desabled ;
GSLSplineDeriv & operator= (const GSLSplineDeriv &)
 assignement operator is desabled ;

Private Attributes

SplineBase m_spline

Detailed Description

Definition at line 279 of file Splines.h.

Member Typedef Documentation

typedef SplineBase::Data1D Genfun::GaudiMathImplementation::GSLSplineDeriv::Data1D

Definition at line 282 of file Splines.h.

typedef SplineBase::Data2D Genfun::GaudiMathImplementation::GSLSplineDeriv::Data2D

Definition at line 283 of file Splines.h.

Constructor & Destructor Documentation

Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv ( const Data1D &  x,
const Data1D &  y,
const GaudiMath::Interpolation::Type  type 
)

mandatory macro from CLHEP/GenericFunctions

constructor from vectors and type

constructor from vectors and type 

   Data1D x = .. ;
   Data1D y = .. ;

   const AbsFunction& func =
        GSLSplineDeriv( x , y , GaudiMath::Interpolation::Cspline ) ;

   const double value = 1 ;
   const double result = func( value ) ;

Parameters:
x vector of x
y vector of y
type interpolation type
   Data1D x = .. ; 
   Data1D y = .. ; 
  
   const AbsFunction& func = 
        GSLSplineDeriv( x , y , GaudiMath::Interpolation::Cspline ) ;
  
   const double value = 1 ;
   const double result = func( value ) ;

Parameters:
x vector of x
y vector of y
type interpolation type

Definition at line 315 of file Splines.cpp.

00318       : AbsFunction () 
00319       , m_spline ( x , y , type ) 
00320     {}

Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv ( const Data2D &  data,
const GaudiMath::Interpolation::Type  type 
)

constructor from data vector 

   Data2D data = ... ;

   const AbsFunction& func =
        GSLSpline( data , GaudiMath::Interpolation::Cspline );

   const double value = 1 ;
   const double result = func( value ) ;

Parameters:
data vector of (x,y) pairs
type interpolation type
   Data2D data = ... ; 
  
   const AbsFunction& func = 
        GSLSpline( data , GaudiMath::Interpolation::Cspline );
  
   const double value = 1 ;
   const double result = func( value ) ;

Parameters:
data vector of (x,y) pairs
type interpolation type

Definition at line 344 of file Splines.cpp.

00346       : AbsFunction () 
00347       , m_spline    ( data , type ) 
00348     {}

template<class DATAX, class DATAY>
Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv ( const GaudiMath::Interpolation::Type  type,
DATAX  begin_x,
DATAX  end_x,
DATAY  begin_y 
) [inline]

templated constructor in the spirit of STL-algorithms

It is assumed that vector "y" has tehlength AT LEAST as long as "x"

   SEQURNCE1 x = .. ;
   SEQUENCE2 y = .. ;

   const AbsFunction& func =
        GSLSpline( GaudiMath::Interpoaltion::Cspline ,
                   x.begin ()  ,
                   x.end   ()  ,
                   y.begin ()  );

   const double value = 1 ;
   const double result = func( value ) ;

Parameters:
begin_x begin of X-sequence
end_x end of X-sequence
begin_Y begin of Y-sequence
type interpolation type

Definition at line 361 of file Splines.h.

00365         : AbsFunction ( )
00366         , m_spline( type , begin_x , end_x , begin_y )
00367       {}

template<class DATA>
Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv ( const GaudiMath::Interpolation::Type  type,
DATA  begin,
DATA  end 
) [inline]

templated constructor from the sequence of pairs as sequence of pairs the class TabulatedProperty can be used 



Parameters:

  

    
begin begin of sequence of pairs 

    
end end of sequence of pairs 

    
type interpolation type 

  





Definition at line 381 of file Splines.h.


00384         : AbsFunction ( )
00385         , m_spline( type , begin , end )
00386       {}














      

        

          Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv           
          (
          const SplineBase & 
           right          
           ) 
          
        

      








constructor from base 


constructor from SplineBase 

Definition at line 355 of file Splines.cpp.


00356       : AbsFunction () 
00357       , m_spline    ( right ) 
00358     {}














      

        

          Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv           
          (
          const GSLSplineDeriv & 
           right          
           ) 
          
        

      








copy constructor 




Definition at line 365 of file Splines.cpp.


00366       : AbsFunction () 
00367       , m_spline    ( right  ) 
00368     {}














      

        

          Genfun::GaudiMathImplementation::GSLSplineDeriv::~GSLSplineDeriv           
          (
                    
           ) 
           [virtual]
        

      








destructor 




Definition at line 374 of file Splines.cpp.


00374 {}














      

        

          Genfun::GaudiMathImplementation::GSLSplineDeriv::GSLSplineDeriv           
          (
                    
           ) 
           [private]
        

      








default construtor is desabled ; 








Member Function Documentation






      

        

          double Genfun::GaudiMathImplementation::GSLSplineDeriv::operator()           
          (
          double 
           a          
           ) 
           const [virtual]
        

      








main method: evaluate the function 




Definition at line 378 of file Splines.cpp.


00379     { return m_spline.deriv ( x    ) ; }














      

        

          double Genfun::GaudiMathImplementation::GSLSplineDeriv::operator()           
          (
          const Argument & 
           x          
           ) 
           const [virtual]
        

      








main method: evaluate the function 




Definition at line 381 of file Splines.cpp.


00382     { return m_spline.deriv ( x[0] ) ; }














      

        

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

      










Definition at line 398 of file Splines.h.


00398 { return 1   ; }














      

        

          virtual bool Genfun::GaudiMathImplementation::GSLSplineDeriv::hasAnalyticDerivative           
          (
                    
           ) 
           const [inline, virtual]
        

      








Does this function have an analytic derivative? 




Definition at line 400 of file Splines.h.


00400 { return true ; }














      

        

          Genfun::Derivative Genfun::GaudiMathImplementation::GSLSplineDeriv::partial           
          (
          unsigned int 
           i          
           ) 
           const [virtual]
        

      








Derivatives. 




Definition at line 388 of file Splines.cpp.


00389     {
00390       if ( i >= 1 ) 
00391       {
00392         const AbsFunction& aux = GaudiMath::Constant( 0.0 , 1 ) ;
00393         return Genfun::FunctionNoop( &aux ) ;
00394       }
00395       const AbsFunction& aux = GSLSplineDeriv2( *this ) ;
00396       return Genfun::FunctionNoop( &aux ) ;
00397     }














      

        

          const SplineBase& Genfun::GaudiMathImplementation::GSLSplineDeriv::spline           
          (
                    
           ) 
           const [inline]
        

      








acess to the spline function 




Definition at line 405 of file Splines.h.


00405 { return m_spline ; }














      

        

          Genfun::GaudiMathImplementation::GSLSplineDeriv::operator const SplineBase &           
          (
                    
           ) 
           const [inline]
        

      








cast operator to the spline function 




Definition at line 407 of file Splines.h.


00407 { return spline() ; }














      

        

          GSLSplineDeriv& Genfun::GaudiMathImplementation::GSLSplineDeriv::operator=           
          (
          const GSLSplineDeriv & 
                    
           ) 
           [private]
        

      








assignement operator is desabled ; 








Member Data Documentation






      

        

          SplineBase Genfun::GaudiMathImplementation::GSLSplineDeriv::m_spline [private]          
        

      










Definition at line 415 of file Splines.h.







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



Generated at Thu Sep 30 09:59:04 2010 for Gaudi Framework, version v21r11 by

Doxygen version 1.5.6 written by Dimitri van Heesch,
 © 1997-2004