NumericalIndefiniteIntegral.cpp

Go to the documentation of this file.

// ============================================================================
// Include
// ============================================================================
// STD & STL
// ============================================================================
#include <algorithm>
#include <vector>
// ============================================================================
// GSL
// ============================================================================
#include "gsl/gsl_errno.h"
#include "gsl/gsl_integration.h"
// ============================================================================
// GaudiMath
// ============================================================================
#include "GaudiMath/NumericalDerivative.h"
#include "GaudiMath/NumericalIndefiniteIntegral.h"
// ============================================================================
// GaudiKernel
// ============================================================================
#include "GaudiKernel/GaudiException.h"
// ============================================================================
// local
// ============================================================================
#include "Helpers.h"
// ============================================================================

// ============================================================================
// ============================================================================

#ifdef __ICC
// disable icc remark #1572: floating-point equality and inequality comparisons are unreliable
//   The comparison are meant
#  pragma warning( disable : 1572 )
#endif
#ifdef WIN32
// Disable the warning
//    C4996: 'std::copy': Function call with parameters that may be unsafe
// The parameters are checked
#  pragma warning( disable : 4996 )
#endif

namespace Genfun {
  namespace GaudiMathImplementation {

    struct NumericalIndefiniteIntegral::_Function {
      gsl_function* fn;
    };

    // ========================================================================

    // ========================================================================
    // ========================================================================
    NumericalIndefiniteIntegral::NumericalIndefiniteIntegral( const AbsFunction& function, const size_t index,
                                                              const double a, const GaudiMath::Integration::Limit limit,
                                                              const GaudiMath::Integration::Type        type,
                                                              const GaudiMath::Integration::KronrodRule rule,
                                                              const double epsabs, const double epsrel,
                                                              const size_t size )
        : AbsFunction()
        , m_function( function.clone() )
        , m_DIM( function.dimensionality() )
        , m_index( index )
        , m_a( a )
        , m_limit( limit )
        , m_type( type )
        , m_category( GaudiMath::Integration::Finite )
        , m_rule( rule )
        //
        , m_epsabs( epsabs )
        , m_epsrel( epsrel )
        //
        , m_size( size )
        , m_argument( function.dimensionality() ) {
      if ( GaudiMath::Integration::Fixed == m_rule ) { m_rule = GaudiMath::Integration::Default; }
      if ( m_index >= m_DIM ) { Exception( "::constructor: invalid variable index" ); }
    }
    // ========================================================================

    NumericalIndefiniteIntegral::NumericalIndefiniteIntegral( const AbsFunction& function, const size_t index,
                                                              const double a, const Points& points,
                                                              const GaudiMath::Integration::Limit limit,
                                                              const double epsabs, const double epsrel,
                                                              const size_t size )
        : AbsFunction()
        , m_function( function.clone() )
        , m_DIM( function.dimensionality() )
        , m_index( index )
        , m_a( a )
        , m_limit( limit )
        , m_type( GaudiMath::Integration::Other )
        , m_category( GaudiMath::Integration::Singular )
        , m_rule( GaudiMath::Integration::Fixed )
        , m_points( points )
        , m_epsabs( epsabs )
        , m_epsrel( epsrel )
        //
        , m_size( size )
        , m_argument( function.dimensionality() ) {
      if ( m_index >= m_DIM ) { Exception( "::constructor: invalid variable index" ); }
      m_points.push_back( a );
      std::sort( m_points.begin(), m_points.end() );
      m_points.erase( std::unique( m_points.begin(), m_points.end() ), m_points.end() );
    }

    // ========================================================================
    // ========================================================================
    NumericalIndefiniteIntegral::NumericalIndefiniteIntegral( const AbsFunction& function, const size_t index,
                                                              const GaudiMath::Integration::Limit limit,
                                                              const double epsabs, const double epsrel,
                                                              const size_t size )
        : AbsFunction()
        , m_function( function.clone() )
        , m_DIM( function.dimensionality() )
        , m_index( index )
        , m_a( GSL_NEGINF ) // should not be used!
        , m_limit( limit )
        , m_type( GaudiMath::Integration::Other )
        , m_category( GaudiMath::Integration::Infinite )
        , m_rule( GaudiMath::Integration::Fixed )
        , m_epsabs( epsabs )
        , m_epsrel( epsrel )
        , m_size( size )
        , m_argument( function.dimensionality() ) {
      if ( m_index >= m_DIM ) { Exception( "::constructor: invalid variable index" ); }
    }
    // ========================================================================

    // ========================================================================
    // ========================================================================
    NumericalIndefiniteIntegral::NumericalIndefiniteIntegral( const NumericalIndefiniteIntegral& right )
        : AbsFunction()
        , m_function( right.m_function->clone() )
        , m_DIM( right.m_DIM )
        , m_index( right.m_index )
        , m_a( right.m_a )
        , m_limit( right.m_limit )
        , m_type( right.m_type )
        , m_category( right.m_category )
        , m_rule( right.m_rule )
        , m_points( right.m_points )
        , m_epsabs( right.m_epsabs )
        , m_epsrel( right.m_epsrel )
        , m_size( right.m_size )
        , m_argument( right.m_argument ) {}
    // ========================================================================

    // ========================================================================
    // throw the exception
    // ========================================================================
    StatusCode NumericalIndefiniteIntegral::Exception( const std::string& message, const StatusCode& sc ) const {
      throw GaudiException( "NumericalIndefiniteIntegral::" + message, "*GaudiMath*", sc );
      return sc;
    }
    // ========================================================================

    // ========================================================================
    // ========================================================================
    double NumericalIndefiniteIntegral::operator()( const double argument ) const {
      // reset the result and the error
      m_result = GSL_NEGINF;
      m_error  = GSL_POSINF;

      // check the argument
      if ( 1 != m_DIM ) { Exception( "operator(): invalid argument size " ); };

      m_argument[0] = argument;
      return ( *this )( m_argument );
    }
    // ========================================================================

    // ========================================================================
    // ========================================================================
    Genfun::Derivative NumericalIndefiniteIntegral::partial( unsigned int idx ) const {
      if ( idx >= m_DIM ) { Exception( "::partial(i): invalid variable index " ); };
      if ( idx != m_index ) {
        const AbsFunction& aux = NumericalDerivative( *this, idx );
        return Genfun::FunctionNoop( &aux );
      } else if ( GaudiMath::Integration::VariableLowLimit == limit() ) {
        const AbsFunction& aux = -1 * function();
        return Genfun::FunctionNoop( &aux );
      }
      const AbsFunction& aux = function();
      return Genfun::FunctionNoop( &aux );
    }

    // ========================================================================
    // ========================================================================
    double NumericalIndefiniteIntegral::operator()( const Argument& argument ) const {
      // reset the result and the error
      m_result = GSL_NEGINF;
      m_error  = GSL_POSINF;

      // check the argument
      if ( argument.dimension() != m_DIM ) { Exception( "operator(): invalid argument size " ); };

      // copy the argument
      for ( size_t i = 0; i < m_DIM; ++i ) { m_argument[i] = argument[i]; }

      // create the helper object
      GSL_Helper helper( *m_function, m_argument, m_index );

      // use GSL to evaluate the numerical derivative
      gsl_function F;
      F.function = &GSL_Adaptor;
      F.params   = &helper;
      _Function F1;
      F1.fn = &F;

      switch ( category() ) {
      case GaudiMath::Integration::Infinite:
        return QAGI( &F1 );
      case GaudiMath::Integration::Singular:
        return QAGP( &F1 );
      case GaudiMath::Integration::Finite:
        switch ( type() ) {
        case GaudiMath::Integration::NonAdaptive:
          return QNG( &F1 );
        case GaudiMath::Integration::Adaptive:
          return QAG( &F1 );
        case GaudiMath::Integration::AdaptiveSingular:
          return QAGS( &F1 );
        default:
          Exception( "::operator(): invalid type " );
        }
        break;
      default:
        Exception( "::operator(): invalid category " );
      }
      return 0;
    }
    // ========================================================================

    // ========================================================================
    // ========================================================================
    NumericalIndefiniteIntegral::_Workspace* NumericalIndefiniteIntegral::allocate() const {
      if ( !m_ws ) {
        m_ws.reset( new _Workspace() );
        m_ws->ws = gsl_integration_workspace_alloc( size() );
        if ( !m_ws->ws ) { Exception( "allocate()::invalid workspace" ); };
      }
      return m_ws.get();
    }
    // ========================================================================

    // ========================================================================
    // adaptive integration on infinite interval
    // ========================================================================
    double NumericalIndefiniteIntegral::QAGI( _Function* F ) const {
      // check the argument
      if ( !F ) { Exception( "::QAGI: invalid function" ); }

      const double x = m_argument[m_index];

      // allocate workspace
      allocate();

      int ierror = 0;
      switch ( limit() ) {
      case GaudiMath::Integration::VariableLowLimit:
        ierror = gsl_integration_qagiu( F->fn, x, m_epsabs, m_epsrel, size(), ws()->ws, &m_result, &m_error );
        break;
      case GaudiMath::Integration::VariableHighLimit:
        ierror = gsl_integration_qagil( F->fn, x, m_epsabs, m_epsrel, size(), ws()->ws, &m_result, &m_error );
        break;
      default:
        Exception( "::QAGI: invalid mode" );
      };

      if ( ierror ) { gsl_error( "NumericalIndefiniteIntegral::QAGI", __FILE__, __LINE__, ierror ); }

      return m_result;
    }
    // ========================================================================

    // ========================================================================
    // adaptive integration with known singular points
    // ========================================================================
    double NumericalIndefiniteIntegral::QAGP( _Function* F ) const {
      if ( !F ) { Exception( "QAGP::invalid function" ); }

      const double x = m_argument[m_index];
      if ( m_a == x ) {
        m_result = 0;
        m_error  = 0; // EXACT !
        return m_result;
      }

      // no known singular points ?
      if ( points().empty() ) { return QAGS( F ); }

      // integration limits
      const auto limits = std::minmax( m_a, x );

      // "active" singular points
      auto lower = std::lower_bound( points().begin(), points().end(), limits.first );
      auto upper = std::upper_bound( points().begin(), points().end(), limits.second );

      Points pnts;
      pnts.reserve( std::distance( lower, upper ) );
      std::copy( lower, upper, std::back_inserter( pnts ) );
      if ( *lower != limits.first ) { pnts.insert( pnts.begin(), limits.first ); }
      if ( *upper != limits.second ) { pnts.insert( pnts.end(), limits.second ); }

      // use GSL
      int ierror = gsl_integration_qagp( F->fn, pnts.data(), pnts.size(), m_epsabs, m_epsrel, size(), ws()->ws,
                                         &m_result, &m_error );

      if ( ierror ) { gsl_error( "NumericalIndefiniteIntegral::QAGI ", __FILE__, __LINE__, ierror ); }

      // sign
      if ( GaudiMath::Integration::VariableHighLimit == limit() && x < m_a ) {
        m_result *= -1;
      } else if ( GaudiMath::Integration::VariableLowLimit == limit() && x > m_a ) {
        m_result *= -1;
      }

      return m_result;
    }
    // ========================================================================

    // ========================================================================
    // non-adaptive integration
    // ========================================================================
    double NumericalIndefiniteIntegral::QNG( _Function* F ) const {
      if ( !F ) { Exception( "QNG::invalid function" ); }

      const double x = m_argument[m_index];
      if ( m_a == x ) {
        m_result = 0;
        m_error  = 0; // EXACT !
        return m_result;
      }

      // integration limits
      const double a = std::min( m_a, x );
      const double b = std::max( m_a, x );

      size_t neval  = 0;
      int    ierror = gsl_integration_qng( F->fn, a, b, m_epsabs, m_epsrel, &m_result, &m_error, &neval );

      if ( ierror ) { gsl_error( "NumericalIndefiniteIntegral::QNG ", __FILE__, __LINE__, ierror ); }

      // sign
      if ( GaudiMath::Integration::VariableHighLimit == limit() && x < m_a ) {
        m_result *= -1;
      } else if ( GaudiMath::Integration::VariableLowLimit == limit() && x > m_a ) {
        m_result *= -1;
      }

      return m_result;
    }

    // ========================================================================
    // simple adaptive integration
    // ========================================================================
    double NumericalIndefiniteIntegral::QAG( _Function* F ) const {
      if ( !F ) { Exception( "QAG::invalid function" ); }

      const double x = m_argument[m_index];
      if ( m_a == x ) {
        m_result = 0;
        m_error  = 0; // EXACT !
        return m_result;
      }

      // allocate workspace
      allocate();

      // integration limits
      const auto limits = std::minmax( m_a, x );

      int ierror = gsl_integration_qag( F->fn, limits.first, limits.second, m_epsabs, m_epsrel, size(), (int)rule(),
                                        ws()->ws, &m_result, &m_error );

      if ( ierror ) { gsl_error( "NumericalIndefiniteIntegral::QAG ", __FILE__, __LINE__, ierror ); }

      // sign
      if ( GaudiMath::Integration::VariableHighLimit == limit() && x < m_a ) {
        m_result *= -1;
      } else if ( GaudiMath::Integration::VariableLowLimit == limit() && x > m_a ) {
        m_result *= -1;
      }

      return m_result;
    }
    // ========================================================================

    // ========================================================================
    // adaptive integration with singularities
    // ========================================================================
    double NumericalIndefiniteIntegral::QAGS( _Function* F ) const {
      if ( !F ) { Exception( "QAG::invalid function" ); }

      const double x = m_argument[m_index];
      if ( m_a == x ) {
        m_result = 0;
        m_error  = 0; // EXACT !
        return m_result;
      }

      // allocate workspace
      allocate();

      // integration limits
      const auto limits = std::minmax( m_a, x );

      int ierror = gsl_integration_qags( F->fn, limits.first, limits.second, m_epsabs, m_epsrel, size(), ws()->ws,
                                         &m_result, &m_error );

      if ( ierror ) { gsl_error( "NumericalIndefiniteIntegral::QAGS ", __FILE__, __LINE__, ierror ); }

      // sign
      if ( GaudiMath::Integration::VariableHighLimit == limit() && x < m_a ) {
        m_result *= -1;
      } else if ( GaudiMath::Integration::VariableLowLimit == limit() && x > m_a ) {
        m_result *= -1;
      }

      return m_result;
    }
    // ========================================================================
  } // end of namespace GaudiMathImplementation
} // end of namespace Genfun

// ============================================================================
// The END
// ============================================================================