BigFloat.Atanh Method

Definition

Namespace: Numerics.NET
Assembly: Numerics.NET (in Numerics.NET.dll) Version: 9.0.0

Overload List

Atanh(BigFloat) Returns the inverse hyperbolic tangent of a number.
Atanh(BigFloat, AccuracyGoal) Returns the inverse hyperbolic tangent of a number with the specified accuracy.
Atanh(BigFloat, AccuracyGoal, RoundingMode) Returns the inverse hyperbolic tangent of a number with the specified accuracy.

Atanh(BigFloat)

Returns the inverse hyperbolic tangent of a number.
C# 
public static BigFloat Atanh(
	BigFloat value
)

Parameters

value  BigFloat
A BigFloat value.

Return Value

BigFloat
The inverse hyperbolic tangent of value.

Implements

IHyperbolicFunctions<TSelf>.Atanh(TSelf)

Remarks

The result has the same relative accuracy as value. Significant round-off error may occur for values close to 1 in absolute value.

Exceptions

ArgumentNullException

value is null.

Atanh(BigFloat, AccuracyGoal)

Returns the inverse hyperbolic tangent of a number with the specified accuracy.
C# 
public static BigFloat Atanh(
	BigFloat value,
	AccuracyGoal accuracyGoal
)

Parameters

value  BigFloat
A BigFloat value.
accuracyGoal  AccuracyGoal
An AccuracyGoal value that specifies the desired accuracy of the result.

Return Value

BigFloat
The inverse hyperbolic tangent of value with an accuracy within accuracyGoal.

Exceptions

ArgumentNullException

value is null.

Atanh(BigFloat, AccuracyGoal, RoundingMode)

Returns the inverse hyperbolic tangent of a number with the specified accuracy.
C# 
public static BigFloat Atanh(
	BigFloat value,
	AccuracyGoal accuracyGoal,
	RoundingMode roundingMode
)

Parameters

value  BigFloat
A BigFloat value.
accuracyGoal  AccuracyGoal
An AccuracyGoal value that specifies the desired accuracy of the result.
roundingMode  RoundingMode
A RoundingMode value that specifies how the result should be rounded.

Return Value

BigFloat
The inverse hyperbolic tangent of value with an accuracy within accuracyGoal.

Exceptions

ArgumentNullException

value is null.

See Also