NAG CL Interfaces10abc (sinh)

Settings help

CL Name Style:

1Purpose

s10abc returns the value of the hyperbolic sine, $\mathrm{sinh}x$.

2Specification

 #include
 double s10abc (double x, NagError *fail)
The function may be called by the names: s10abc, nag_specfun_sinh or nag_sinh.

3Description

s10abc calculates an approximate value for the hyperbolic sine of its argument, $\mathrm{sinh}x$.
For $|x|\le 1$ it uses the Chebyshev expansion
 $sinh⁡x=x×y(t)=x∑′r=0arTr(t)$
where $t=2{x}^{2}-1$.
For $1<|x|\le {E}_{1}\text{, }\mathrm{sinh}x=\frac{1}{2}\left({e}^{x}-{e}^{-x}\right)$
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 function fails owing to the danger of setting overflow in calculating ${e}^{x}$. The result returned for such calls is $\mathrm{sinh}\left(\mathrm{sign}x{E}_{1}\right)$, i.e., it returns the result for the nearest valid argument.
NIST Digital Library of Mathematical Functions

5Arguments

1: $\mathbf{x}$double Input
On entry: the argument $x$ of the function.
2: $\mathbf{fail}$NagError * Input/Output
The NAG error argument (see Section 7 in the Introduction to the NAG Library CL Interface).

6Error Indicators and Warnings

NE_ALLOC_FAIL
Dynamic memory allocation failed.
See Section 3.1.2 in the Introduction to the NAG Library CL Interface for further information.
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.
See Section 7.5 in the Introduction to the NAG Library CL Interface for further information.
NE_NO_LICENCE
Your licence key may have expired or may not have been installed correctly.
See Section 8 in the Introduction to the NAG Library CL Interface for further information.
NE_REAL_ARG_GT
On entry, ${\mathbf{x}}=⟨\mathit{\text{value}}⟩$.
Constraint: $|{\mathbf{x}}|\le {E}_{1}$.
The function has been called with an argument too large in absolute magnitude. There is a danger of overflow. The result returned is the value of $\mathrm{sinh}x$ at the closest argument for which a valid call could be made.

7Accuracy

If $\delta$ and $\epsilon$ are the relative errors in the argument and result, respectively, then in principle
 $|ε|≃ |xcoth⁡x×δ|.$
That is the relative error in the argument, $x$, is amplified by a factor, approximately $x\mathrm{coth}x$. The equality should hold if $\delta$ is greater than the machine precision ($\delta$ is a result of data errors etc.) but, if $\delta$ 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|\ge 2$
 $ε∼xδ=Δ$
where $\Delta$ is the absolute error in the argument.

8Parallelism and Performance

s10abc is not threaded in any implementation.

None.

10Example

This example reads values of the argument $x$ from a file, evaluates the function at each value of $x$ and prints the results.

10.1Program Text

Program Text (s10abce.c)

10.2Program Data

Program Data (s10abce.d)

10.3Program Results

Program Results (s10abce.r)