s11aa returns the value of the inverse hyperbolic tangent, .
Syntax
C# |
---|
public static double s11aa( double x, out int ifail ) |
Visual Basic |
---|
Public Shared Function s11aa ( _ x As Double, _ <OutAttribute> ByRef ifail As Integer _ ) As Double |
Visual C++ |
---|
public: static double s11aa( double x, [OutAttribute] int% ifail ) |
F# |
---|
static member s11aa : x : float * ifail : int byref -> float |
Parameters
- x
- Type: System..::..DoubleOn entry: the argument of the function.Constraint: .
- ifail
- Type: System..::..Int32%On exit: unless the method detects an error or a warning has been flagged (see [Error Indicators and Warnings]).
Return Value
s11aa returns the value of the inverse hyperbolic tangent, .
Description
s11aa calculates an approximate value for the inverse hyperbolic tangent of its argument, .
For it is based on the Chebyshev expansion
where , , .
For , it uses
For , the method fails as is undefined.
References
Abramowitz M and Stegun I A (1972) Handbook of Mathematical Functions (3rd Edition) Dover Publications
Error Indicators and Warnings
Errors or warnings detected by the method:
- The method has been called with an argument greater than or equal to in magnitude, for which is not defined. On failure, the result is returned as zero.
Accuracy
If and are the relative errors in the argument and result, respectively, then in principle
That is, the relative error in the argument, , is amplified by at least a factor in the result. The equality should hold if is greater than the machine precision ( due to data errors etc.) but if is simply due to round-off in the machine representation then it is possible that an extra figure may be lost in internal calculation round-off.
The factor is not significantly greater than one except for arguments close to . However in the region where is close to one, , the above analysis is inapplicable since is bounded by definition, . In this region where arctanh is tending to infinity we have
which implies an obvious, unavoidable serious loss of accuracy near , e.g., if and agree to significant figures, the result for would be correct to at most about one figure.
Parallelism and Performance
None.
Further Comments
None.
Example
This example reads values of the argument from a file, evaluates the function at each value of and prints the results.
Example program (C#): s11aae.cs