NAG FL Interface
s15ddf (erfc_complex)
1
Purpose
s15ddf computes values of the function , for complex .
2
Specification
Fortran Interface
| Complex (Kind=nag_wp) |
:: |
s15ddf |
| Integer, Intent (Inout) |
:: |
ifail |
| Complex (Kind=nag_wp), Intent (In) |
:: |
z |
|
C Header Interface
|
#include <nag.h>
| Complex |
s15ddf_ (const Complex *z, Integer *ifail) |
|
C++ Header Interface
|
#include <nag.h> extern "C" {
| Complex |
s15ddf_ (const Complex &z, Integer &ifail) |
}
|
The routine may be called by the names s15ddf or nagf_specfun_erfc_complex.
3
Description
s15ddf computes values of the function
, where
is the complementary error function
for complex
. The method used is that in
Gautschi (1970) for
in the first quadrant of the complex plane, and is extended for
in other quadrants via the relations
and
. Following advice in
Gautschi (1970) and
van der Laan and Temme (1984), the code in
Gautschi (1969) has been adapted to work in various precisions up to
decimal places. The real part of
is sometimes known as the Voigt function.
4
References
Gautschi W (1969) Algorithm 363: Complex error function Comm. ACM 12 635
Gautschi W (1970) Efficient computation of the complex error function SIAM J. Numer. Anal. 7 187–198
van der Laan C G and Temme N M (1984) Calculation of special functions: the gamma function, the exponential integrals and error-like functions CWI Tract 10 Centre for Mathematics and Computer Science, Amsterdam
5
Arguments
-
1:
– Complex (Kind=nag_wp)
Input
-
On entry: the argument of the function.
-
2:
– Integer
Input/Output
-
On entry:
ifail must be set to
,
or
to set behaviour on detection of an error; these values have no effect when no error is detected.
A value of causes the printing of an error message and program execution will be halted; otherwise program execution continues. A value of means that an error message is printed while a value of means that it is not.
If halting is not appropriate, the value
or
is recommended. If message printing is undesirable, then the value
is recommended. Otherwise, the value
is recommended.
When the value or is used it is essential to test the value of ifail on exit.
On exit:
unless the routine detects an error or a warning has been flagged (see
Section 6).
6
Error Indicators and Warnings
If on entry
or
, explanatory error messages are output on the current error message unit (as defined by
x04aaf).
Errors or warnings detected by the routine:
-
Real part of result overflows when entered with argument .
-
Imaginary part of result overflows when entered with argument .
-
Both real and imaginary parts of result overflow when entered with argument .
-
Result has less than half precision when entered with argument .
-
Result has no precision when entered with argument .
An unexpected error has been triggered by this routine. Please
contact
NAG.
See
Section 7 in the Introduction to the NAG Library FL Interface for further information.
Your licence key may have expired or may not have been installed correctly.
See
Section 8 in the Introduction to the NAG Library FL Interface for further information.
Dynamic memory allocation failed.
See
Section 9 in the Introduction to the NAG Library FL Interface for further information.
7
Accuracy
The accuracy of the returned result depends on the argument
. If
lies in the first or second quadrant of the complex plane (i.e.,
is greater than or equal to zero), the result should be accurate almost to
machine precision, except that there is a limit of about
decimal places on the achievable accuracy because constants in the routine are given to this precision. With such arguments,
ifail can only return as
.
If however, is less than zero, accuracy may be lost in two ways; firstly, in the evaluation of , if is large, in which case a warning will be issued through or ; and secondly, near the zeros of the required function, where precision is lost due to cancellation, in which case no warning is given – the result has absolute accuracy rather than relative accuracy. Note also that in this half-plane, one or both parts of the result may overflow – this is signalled through , or .
8
Parallelism and Performance
s15ddf is not threaded in any implementation.
The time taken for a call of s15ddf depends on the argument , the time increasing as .
s15ddf may be used to compute values of
and
for complex
by the relations
,
. (For real arguments,
s15adf and
s15aef should be used.)
10
Example
This example reads values of the argument from a file, evaluates the function at each value of and prints the results.
10.1
Program Text
10.2
Program Data
10.3
Program Results