MathF.Atanh(Single) Method

Definition

Namespace:

System

Assembly:

System.Runtime.dll

Source:

MathF.cs

Returns the angle whose hyperbolic tangent is the specified number.

public:
 static float Atanh(float x);

public static float Atanh (float x);

static member Atanh : single -> single

Public Shared Function Atanh (x As Single) As Single

Parameters

x

Single

A number representing a hyperbolic tangent, where x must be greater than or equal to -1, but less than or equal to 1.

Returns

Single

An angle, θ, measured in radians, such that -∞ < θ <-1, or 1 < θ < ∞.

-or-

NaN if x < -1 or x > 1 or x equals NaN.

Remarks

Multiply the return value by 180/MathF.PI to convert from radians to degrees.

This method calls into the underlying C runtime, and the exact result or valid input range may differ between different operating systems or architectures.