NAG Library Function Document
nag_quad_1d_fin_gonnet_vec (d01rgc)
1 Purpose
nag_quad_1d_fin_gonnet_vec (d01rgc) is a general purpose integrator which calculates an approximation to the integral of a function
over a finite interval
:
The function is suitable as a general purpose integrator, and can be used when the integrand has singularities and infinities. In particular, the function can continue if the function
f explicitly returns a quiet or signalling NaN or a signed infinity.
2 Specification
#include <nag.h> |
#include <nagd01.h> |
void |
nag_quad_1d_fin_gonnet_vec (double a,
double b,
void |
(*f)(const double x[],
Integer nx,
double fv[],
Integer *iflag,
Nag_Comm *comm),
|
|
double epsabs,
double epsrel,
double *dinest,
double *errest,
Integer *nevals,
Nag_Comm *comm,
NagError *fail) |
|
3 Description
nag_quad_1d_fin_gonnet_vec (d01rgc) uses the algorithm described in
Gonnet (2010). It is an adaptive algorithm, similar to the QUADPACK routine QAGS (see
Piessens et al. (1983), see also
nag_quad_1d_gen_vec_multi_rcomm (d01rac)) but includes significant differences regarding how the integrand is represented, how the integration error is estimated and how singularities and divergent integrals are treated. The local error estimation is described in
Gonnet (2010).
nag_quad_1d_fin_gonnet_vec (d01rgc) requires a function to evaluate the integrand at an array of different points and is therefore amenable to parallel execution.
4 References
Gonnet P (2010) Increasing the reliability of adaptive quadrature using explicit interpolants ACM Trans. Math. software 37 26
Piessens R, de Doncker–Kapenga E, Überhuber C and Kahaner D (1983) QUADPACK, A Subroutine Package for Automatic Integration Springer–Verlag
5 Arguments
- 1:
a – doubleInput
On entry: , the lower limit of integration.
- 2:
b – doubleInput
On entry:
, the upper limit of integration. It is not necessary that
.
Note: if , the function will immediately return , and .
- 3:
f – function, supplied by the userExternal Function
f must return the value of the integrand
at a set of points.
The specification of
f is:
void |
f (const double x[],
Integer nx,
double fv[],
Integer *iflag,
Nag_Comm *comm)
|
|
- 1:
x[nx] – const doubleInput
On entry: the abscissae,
, for , at which function values are required.
- 2:
nx – IntegerInput
On entry: the number of abscissae at which a function value is required.
- 3:
fv[nx] – doubleOutput
On exit:
fv must contain the values of the integrand
.
for all
.
- 4:
iflag – Integer *Input/Output
On entry: .
On exit: set
to force an immediate exit with
NE_USER_STOP.
- 5:
comm – Nag_Comm *
Pointer to structure of type Nag_Comm; the following members are relevant to
f.
- user – double *
- iuser – Integer *
- p – Pointer
The type Pointer will be
void *. Before calling nag_quad_1d_fin_gonnet_vec (d01rgc) you may allocate memory and initialize these pointers with various quantities for use by
f when called from nag_quad_1d_fin_gonnet_vec (d01rgc) (see
Section 3.2.1.1 in the Essential Introduction).
- 4:
epsabs – doubleInput
On entry: the absolute accuracy required.
If
epsabs is negative,
is used. See
Section 7.
If , only the relative error will be used.
- 5:
epsrel – doubleInput
On entry: the relative accuracy required.
If
epsrel is negative,
is used. See
Section 7.
If
, only the absolute error will be used otherwise the actual value of
epsrel used by nag_quad_1d_fin_gonnet_vec (d01rgc) is
.
Constraint:
at least one of
epsabs and
epsrel must be nonzero.
- 6:
dinest – double *Output
On exit: the estimate of the definite integral
f.
- 7:
errest – double *Output
On exit: the error estimate of the definite integral
f.
- 8:
nevals – Integer *Output
On exit: the total number of points at which the integrand, , has been evaluated.
- 9:
comm – Nag_Comm *Communication Structure
-
The NAG communication argument (see
Section 3.2.1.1 in the Essential Introduction).
- 10:
fail – NagError *Input/Output
-
The NAG error argument (see
Section 3.6 in the Essential Introduction).
6 Error Indicators and Warnings
- NE_ACCURACY
-
The requested accuracy was not achieved.
Consider using larger values of
epsabs and
epsrel.
- NE_ALLOC_FAIL
-
Dynamic memory allocation failed.
- NE_BAD_PARAM
-
On entry, argument had an illegal value.
- NE_CONVERGENCE
-
The integral is probably divergent or slowly convergent.
- NE_INTERNAL_ERROR
-
An internal error has occurred in this function. Check the function call and any array sizes. If the call is correct then please contact
NAG for assistance.
- NE_TOO_SMALL
-
Both and .
- NE_USER_STOP
-
Exit requested from
f with
.
7 Accuracy
nag_quad_1d_fin_gonnet_vec (d01rgc) cannot guarantee, but in practice usually achieves, the following accuracy:
where
and
epsabs and
epsrel are user-specified absolute and relative error tolerances. Moreover, it returns the quantity
errest which, in normal circumstances, satisfies
8 Parallelism and Performance
nag_quad_1d_fin_gonnet_vec (d01rgc) is currently neither directly nor indirectly threaded. In particular, the user-supplied function
f is not called from within a parallel region initialized inside nag_quad_1d_fin_gonnet_vec (d01rgc).
The user-supplied function
f uses a vectorized interface, allowing for the required vector of function values to be evaluated in parallel; for example by placing appropriate OpenMP directives in the code for the user-supplied function
f.
The time taken by nag_quad_1d_fin_gonnet_vec (d01rgc) depends on the integrand and the accuracy required.
nag_quad_1d_fin_gonnet_vec (d01rgc) is suitable for evaluating integrals that have singularities within the requested interval.
In particular, nag_quad_1d_fin_gonnet_vec (d01rgc) accepts non-finite values on return from the user-supplied function
f, and will adapt the integration rule accordingly to eliminate such points. Non-finite values include NaNs and infinities.
10 Example
10.1 Program Text
Program Text (d01rgce.c)
10.2 Program Data
None.
10.3 Program Results
Program Results (d01rgce.r)