| # Gaudi Framework, version v23r0 |

Home |  | Generated: Mon Jan 30 2012

Public Types | Public Member Functions | Private Member Functions | Private Attributes

# Genfun::GaudiMathImplementation::GSLSpline Class Reference

`#include <Splines.h>`

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

List of all members.

## Public Types
typedef SplineBase::Data1D | Data1D
typedef SplineBase::Data2D | Data2D
## Public Member Functions
| GSLSpline (const Data1D &x, const Data1D &y, const GaudiMath::Interpolation::Type type)
| mandatory macro from CLHEP/GenericFunctions
| GSLSpline (const Data2D &data, const GaudiMath::Interpolation::Type type)
| constructor from data vector
template<class DATAX , class DATAY >
| GSLSpline (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 >
| GSLSpline (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
| GSLSpline (const SplineBase &)
| constructor from base
| GSLSpline (const GSLSpline &)
| copy constructor
virtual | ~GSLSpline ()
| destructor
virtual double | operator() (double a) const
| main methgod: evaluate teh function
virtual double | operator() (const Argument &x) const
| main methgod: evaluate teh 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
| GSLSpline ()
| default construtor is desabled ;
GSLSpline & | operator= (const GSLSpline &)
| assignement operator is desabled ;
## Private Attributes
SplineBase | m_spline

## Detailed Description

Definition at line 140 of file Splines.h.

## Member Typedef Documentation

typedef SplineBase::Data1D Genfun::GaudiMathImplementation::GSLSpline::Data1D

Definition at line 143 of file Splines.h.

typedef SplineBase::Data2D Genfun::GaudiMathImplementation::GSLSpline::Data2D

Definition at line 144 of file Splines.h.

## Constructor & Destructor Documentation

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | 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 =
            GSLSpline( 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 =
            GSLSpline( 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 216 of file Splines.cpp.

          : AbsFunction ()
          , m_spline ( x , y , type )
        {}

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | 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

Definition at line 245 of file Splines.cpp.

          : AbsFunction ()
          , m_spline    ( data , type )
        {}

template<class DATAX , class DATAY >

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | 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 222 of file Splines.h.

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

template<class DATA >

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | 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 242 of file Splines.h.

            : AbsFunction ( )
            , m_spline( type , begin , end )
          {}

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | const SplineBase & | right ) |

constructor from base

constructor from SplineBase

Definition at line 256 of file Splines.cpp.

          : AbsFunction ()
          , m_spline    ( right )
        {}

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | const GSLSpline & | right ) |

copy constructor

Definition at line 266 of file Splines.cpp.

          : AbsFunction ()
          , m_spline    ( right  )
        {}

Genfun::GaudiMathImplementation::GSLSpline::~GSLSpline | ( | ) | `[virtual]`

destructor

Definition at line 275 of file Splines.cpp.

    {}

Genfun::GaudiMathImplementation::GSLSpline::GSLSpline | ( | ) | `[private]`

default construtor is desabled ;

## Member Function Documentation

virtual unsigned int Genfun::GaudiMathImplementation::GSLSpline::dimensionality | ( | ) | const`[inline, virtual]`

Definition at line 259 of file Splines.h.

    { return 1   ; }

virtual bool Genfun::GaudiMathImplementation::GSLSpline::hasAnalyticDerivative | ( | ) | const`[inline, virtual]`

Does this function have an analytic derivative?

Definition at line 261 of file Splines.h.

    { return true ; }

Genfun::GaudiMathImplementation::GSLSpline::operator const SplineBase & | ( | ) | const`[inline]`

cast operator to the spline function

Definition at line 268 of file Splines.h.

    { return spline() ; }

double Genfun::GaudiMathImplementation::GSLSpline::operator() | ( | const Argument & | x ) | const`[virtual]`

main methgod: evaluate teh function

Definition at line 282 of file Splines.cpp.

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

double Genfun::GaudiMathImplementation::GSLSpline::operator() | ( | double | a ) | const`[virtual]`

main methgod: evaluate teh function

Definition at line 279 of file Splines.cpp.

        { return m_spline.eval( x    ) ; }

GSLSpline& Genfun::GaudiMathImplementation::GSLSpline::operator= | ( | const GSLSpline & | ) | `[private]`

assignement operator is desabled ;

Genfun::Derivative Genfun::GaudiMathImplementation::GSLSpline::partial | ( | unsigned int | i ) | const`[virtual]`

Derivatives.

Definition at line 289 of file Splines.cpp.

        {
          if ( i >= 1 )
          {
            const AbsFunction& aux = GaudiMath::Constant( 0.0 , 1 ) ;
            return Genfun::FunctionNoop( &aux ) ;
          }
          const AbsFunction& aux = GSLSplineDeriv( *this ) ;
          return Genfun::FunctionNoop( &aux ) ;
        }

const SplineBase& Genfun::GaudiMathImplementation::GSLSpline::spline | ( | ) | const`[inline]`

acess to the spline function

Definition at line 266 of file Splines.h.

    { return m_spline ; }

## Member Data Documentation

SplineBase Genfun::GaudiMathImplementation::GSLSpline::m_spline`[private]`

Definition at line 276 of file Splines.h.

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

- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiGSL/GaudiMath/Splines.h
- /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiGSL/src/Lib/Splines.cpp

All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines