NAG Library Routine Document

S10ABF

▸▿ 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

S10ABF returns the value of the hyperbolic sine,

\sinh x

, via the function name.

2 Specification

FUNCTION S10ABF (

X, IFAIL)

REAL (KIND=nag_wp) S10ABF

INTEGER	IFAIL
REAL (KIND=nag_wp)	X

3 Description

S10ABF calculates an approximate value for the hyperbolic sine of its argument,

\sinh x

For

|x| \leq 1

it uses the Chebyshev expansion

\sinh x = x \times y (t) = x \underset{r = 0}{\sum^{'}} a_{r} T_{r} (t)

where

t = 2 x^{2} - 1

For

1 < |x| \leq E_{1}, \sinh x = \frac{1}{2} (e^{x} - e^{- x})

where

E_{1}

is a machine-dependent constant, details of which are given in the Users' Note for your implementation.

For

|x| > E_{1}

, the routine fails owing to the danger of setting overflow in calculating

e^{x}

. The result returned for such calls is

\sinh (sign x E_{1})

, i.e., it returns the result for the nearest valid argument.

4 References

Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications

5 Parameters

1: $X$ – REAL (KIND=nag_wp)Input: On entry: the argument $x$ of the function.
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$: The routine has been called with an argument too large in absolute magnitude. There is a danger of setting overflow. The result is the value of $\sinh x$ at the closest argument for which a valid call could be made. (See Section 3 and the Users' Note for your implementation.)

$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

δ

and

ε

are the relative errors in the argument and result, respectively, then in principle

|ε| ≃ |x \coth x \times δ| .

That is the relative error in the argument,

x

, is amplified by a factor, approximately

x \coth x

. The equality should hold if

δ

is greater than the machine precision (

δ

is a result of data errors etc.) but, if

δ

is simply a result of round-off in the machine representation of

x

, then it is possible that an extra figure may be lost in internal calculation round-off.

The behaviour of the error amplification factor can be seen in the following graph:

Figure 1

It should be noted that for

|x| \geq 2

ε \sim x δ = Δ

where

Δ

is the absolute error in the argument.

8 Parallelism and Performance

Not applicable.

9 Further Comments

None.

10 Example

This example reads values of the argument

x

from a file, evaluates the function at each value of

x

and prints the results.

NAG Library Routine DocumentS10ABF

▸▿ 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

NAG Library Routine Document

S10ABF