NAG Library Routine Document

S01BAF

▸▿ Contents

1 Purpose

2 Specification

3 Description

4 References

5 Parameters

6 Error Indicators and Warnings

7 Accuracy

8 Parallelism and Performance

9 Further Comments

▸▿ 10 Example

10.1 Program Text

10.2 Program Data

10.3 Program Results

1 Purpose

S01BAF returns a value of the shifted logarithmic function,

\ln (1 + x)

, via the function name.

2 Specification

FUNCTION S01BAF (

X, IFAIL)

REAL (KIND=nag_wp) S01BAF

INTEGER	IFAIL
REAL (KIND=nag_wp)	X

3 Description

S01BAF computes values of

\ln (1 + x)

, retaining full relative precision even when

|x|

is small. The routine is based on the Chebyshev expansion

\ln \frac{1 + p^{2} + 2 p \bar{x}}{1 + p^{2} - 2 p \bar{x}} = 4 \sum_{k = 0}^{\infty} \frac{p^{2 k + 1}}{2 k + 1} T_{2 k + 1} (\bar{x}) .

Setting

\bar{x} = \frac{x (1 + p^{2})}{2 p (x + 2)}

, and choosing

p = \frac{q - 1}{q + 1}

q = \sqrt[4]{2}

the expansion is valid in the domain

x \in [\frac{1}{\sqrt{2}} - 1, \sqrt{2} - 1]

Outside this domain,

\ln (1 + x)

is computed by the standard logarithmic function.

4 References

Lyusternik L A, Chervonenkis O A and Yanpolskii A R (1965) Handbook for Computing Elementary Functions p. 57 Pergamon Press

5 Parameters

1: $X$ – REAL (KIND=nag_wp)Input: On entry: the argument $x$ of the function.

Constraint: $X > - 1.0$ .
2: $IFAIL$ – INTEGERInput/Output: On entry: IFAIL must be set to $0$ , $- 1 or 1$ . If you are unfamiliar with this parameter you should refer to Section 3.3 in the Essential Introduction for details.
For environments where it might be inappropriate to halt program execution when an error is detected, the value $- 1 or 1$ is recommended. If the output of error messages is undesirable, then the value $1$ is recommended. Otherwise, if you are not familiar with this parameter, the recommended value is $0$ . When the value $- 1 or 1$ is used it is essential to test the value of IFAIL on exit.

On exit: $IFAIL = 0$ unless the routine detects an error or a warning has been flagged (see Section 6).

6 Error Indicators and Warnings

If on entry

IFAIL = 0

- 1

, explanatory error messages are output on the current error message unit (as defined by X04AAF).

Errors or warnings detected by the routine:

$IFAIL = 1$: On entry, $X \leq - 1.0$ .

The result is returned as zero.

$IFAIL = - 99$: An unexpected error has been triggered by this routine. Please contact NAG.
See Section 3.8 in the Essential Introduction for further information.

$IFAIL = - 399$: Your licence key may have expired or may not have been installed correctly.
See Section 3.7 in the Essential Introduction for further information.

$IFAIL = - 999$: Dynamic memory allocation failed.
See Section 3.6 in the Essential Introduction for further information.

7 Accuracy

The returned result should be accurate almost to machine precision, with a limit of about

20

significant figures due to the precision of internal constants. Note however that if

x

lies very close to

- 1.0

and is not exact (for example if

x

is the result of some previous computation and has been rounded), then precision will be lost in the computation of

1 + x

, and hence

\ln (1 + x)

, in S01BAF.

8 Parallelism and Performance

Not applicable.

9 Further Comments

Empirical tests show that the time taken for a call of S01BAF usually lies between about

1.25

and

2.5

times the time for a call to the standard logarithm function.

10 Example

The example program reads values of the argument

x

from a file, evaluates the function at each value of

x

and prints the results.

NAG Library Routine DocumentS01BAF