Gobelijn API documentation  - generated for commit a0cbea7
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
UA_CoMP::Num::Integral< QuadAlgorithm, Integrand > Class Template Reference

Wrap a quadrature algoritm and a functor to produce an integral. More...

#include <Integral.h>

Inheritance diagram for UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >:
Inheritance graph
Collaboration diagram for UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >:
Collaboration graph

Public Member Functions

 Integral (QuadAlgorithm const &quad, Integrand const &ftor)
 Constructor initializes all datamembers. More...
 
Integral::result_type operator() (typename Integral::first_argument_type l, typename Integral::first_argument_type r) const
 Evaluates integral from l to r. More...
 

Private Attributes

QuadAlgorithm fQuadAlgorithm
 
Integrand fIntegrand
 

Detailed Description

template<typename QuadAlgorithm, typename Integrand>
class UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >

Wrap a quadrature algoritm and a functor to produce an integral.

The integral is a function of its lower and upper integration boundaries. It models the adaptable binary function concept.

Definition at line 19 of file Integral.h.

Constructor & Destructor Documentation

template<typename QuadAlgorithm, typename Integrand>
UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >::Integral ( QuadAlgorithm const &  quad,
Integrand const &  ftor 
)
inline

Constructor initializes all datamembers.

Parameters
quadQuadrature algorithm that computes the integral.
ftorFunctor that get integrated.

Definition at line 28 of file Integral.h.

Member Function Documentation

template<typename QuadAlgorithm, typename Integrand>
Integral::result_type UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >::operator() ( typename Integral< QuadAlgorithm, Integrand >::first_argument_type  l,
typename Integral< QuadAlgorithm, Integrand >::first_argument_type  r 
) const
inline

Evaluates integral from l to r.

Returns
Value of the integral.
Parameters
lLeft integration boundary.
rRight integration boundary.

Definition at line 36 of file Integral.h.

References UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >::fIntegrand, and UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >::fQuadAlgorithm.

Member Data Documentation

template<typename QuadAlgorithm, typename Integrand>
QuadAlgorithm UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >::fQuadAlgorithm
private
template<typename QuadAlgorithm, typename Integrand>
Integrand UA_CoMP::Num::Integral< QuadAlgorithm, Integrand >::fIntegrand
private

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