Gaudi Framework, version v23r0

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

Genfun::GaudiMathImplementation::GSLSplineInteg Class Reference

#include <Splines.h>

Collaboration diagram for Genfun::GaudiMathImplementation::GSLSplineInteg:
Collaboration graph
[legend]

List of all members.

Public Types

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

Public Member Functions

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

Private Member Functions

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

Private Attributes

SplineBase m_spline
double m_low

Detailed Description

Definition at line 558 of file Splines.h.


Member Typedef Documentation

Definition at line 561 of file Splines.h.

Definition at line 562 of file Splines.h.


Constructor & Destructor Documentation

Genfun::GaudiMathImplementation::GSLSplineInteg::GSLSplineInteg ( const Data1D x,
const Data1D y,
const GaudiMath::Interpolation::Type  type,
const double  low = 0 
)

mandatory macro from CLHEP/GenericFunctions

constructor from vectors and type

constructor from vectors and type

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

   const AbsFunction& func =
    GSLSplineInteg( x , y , GaudiMath::Interpolation::Cspline , -1 ) ;

   const double value = 1 ;
   const double result = func( value ) ;
Parameters:
xvector of x
yvector of y
typeinterpolation type
lowlow integration limit
   Data1D x = .. ;
   Data1D y = .. ;

   const AbsFunction& func =
        GSLSplineInteg( x , y , GaudiMath::Interpolation::Cspline , -1 ) ;

   const double value = 1 ;
   const double result = func( value ) ;
Parameters:
xvector of x
yvector of y
typeinterpolation type

Definition at line 553 of file Splines.cpp.

      : AbsFunction (      )
      , m_spline    ( x    , y , type )
      , m_low       ( low  )
    {}
Genfun::GaudiMathImplementation::GSLSplineInteg::GSLSplineInteg ( const Data2D data,
const GaudiMath::Interpolation::Type  type,
const double  low = 0 
)

constructor from data vector

   Data2D data = ... ;

   const AbsFunction& func =
        GSLSplineInteg( data , GaudiMath::Interpolation::Cspline , -1 );

   const double value = 1 ;
   const double result = func( value ) ;
Parameters:
datavector of (x,y) pairs
typeinterpolation type
lowlow integration limit
   Data2D data = ... ;

   const AbsFunction& func =
        GSLSplineInteg( data , GaudiMath::Interpolation::Cspline , -1 );

   const double value = 1 ;
   const double result = func( value ) ;
Parameters:
datavector of (x,y) pairs
typeinterpolation type

Definition at line 584 of file Splines.cpp.

      : AbsFunction ()
      , m_spline    ( data , type )
      , m_low       ( low  )
    {}
template<class DATAX , class DATAY >
Genfun::GaudiMathImplementation::GSLSplineInteg::GSLSplineInteg ( const GaudiMath::Interpolation::Type  type,
DATAX  begin_x,
DATAX  end_x,
DATAY  begin_y,
const double  low 
) [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_xbegin of X-sequence
end_xend of X-sequence
begin_Ybegin of Y-sequence
typeinterpolation type
lowlow integration limit

Definition at line 644 of file Splines.h.

        : AbsFunction (      )
        , m_spline    ( type , begin_x , end_x , begin_y )
        , m_low       ( low  )
      {}
template<class DATA >
Genfun::GaudiMathImplementation::GSLSplineInteg::GSLSplineInteg ( const GaudiMath::Interpolation::Type  type,
DATA  begin,
DATA  end,
const double  low 
) [inline]

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

Parameters:
beginbegin of sequence of pairs
endend of sequence of pairs
typeinterpolation type
lowlow integration limit

Definition at line 667 of file Splines.h.

        : AbsFunction (      )
        , m_spline    ( type , begin , end )
        , m_low       ( low  )
      {}
Genfun::GaudiMathImplementation::GSLSplineInteg::GSLSplineInteg ( const SplineBase right,
const double  low = 0 
)

constructor from base

constructor from SplineBase

Definition at line 597 of file Splines.cpp.

      : AbsFunction ()
      , m_spline    ( right )
      , m_low       ( low   )
    {}
Genfun::GaudiMathImplementation::GSLSplineInteg::GSLSplineInteg ( const GSLSplineInteg right )

copy constructor

Definition at line 609 of file Splines.cpp.

      : AbsFunction ()
      , m_spline    ( right       )
      , m_low       ( right.m_low )
    {}
Genfun::GaudiMathImplementation::GSLSplineInteg::~GSLSplineInteg (  ) [virtual]

destructor

Definition at line 619 of file Splines.cpp.

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

default construtor is desabled ;


Member Function Documentation

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

Definition at line 687 of file Splines.h.

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

Does this function have an analytic derivative?

Definition at line 689 of file Splines.h.

{ return true ; }
Genfun::GaudiMathImplementation::GSLSplineInteg::operator const SplineBase & (  ) const [inline]

cast operator to the spline function

Definition at line 696 of file Splines.h.

{ return spline() ; }
double Genfun::GaudiMathImplementation::GSLSplineInteg::operator() ( const Argument &  x ) const [virtual]

main method: evaluate the function

Definition at line 626 of file Splines.cpp.

    { return m_spline.integ ( m_low , x[0] ) ; }
double Genfun::GaudiMathImplementation::GSLSplineInteg::operator() ( double  a ) const [virtual]

main method: evaluate the function

Definition at line 623 of file Splines.cpp.

    { return m_spline.integ ( m_low , x    ) ; }
GSLSplineInteg& Genfun::GaudiMathImplementation::GSLSplineInteg::operator= ( const GSLSplineInteg  ) [private]

assignement operator is desabled ;

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

Derivatives.

Definition at line 633 of file Splines.cpp.

    {
      if ( i >= 1 )
      {
        const AbsFunction& aux = GaudiMath::Constant( 0.0 , 1 ) ;
        return Genfun::FunctionNoop( &aux ) ;
      }
      const AbsFunction& aux = GSLSpline( *this ) ;
      return Genfun::FunctionNoop( &aux ) ;
    }
const SplineBase& Genfun::GaudiMathImplementation::GSLSplineInteg::spline (  ) const [inline]

acess to the spline function

Definition at line 694 of file Splines.h.

{ return m_spline ; }

Member Data Documentation

Definition at line 705 of file Splines.h.

Definition at line 704 of file Splines.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