atanh

Description

Hyperbolic arc tangent. Returns the hyperbolic arc tangent of the specified value.

Signature

T atanh<T>(T x)
    where T : __BuiltinFloatingPointType;

vector<T, N> atanh<T, int N>(vector<T, N> x)
    where T : __BuiltinFloatingPointType;

matrix<T, N, M> atanh<T, int N, int M>(matrix<T, N, M> x)
    where T : __BuiltinFloatingPointType;

Generic Parameters

T: __BuiltinFloatingPointType

N : int

M : int

Parameters

x : T

The value.

x : vector<T, N>

The value.

x : matrix<T, N, M>

The value.

Return value

The hyperbolic arc tangent of the specified value.

Availability and Requirements

Defined for the following targets:

hlsl

Available in all stages.

glsl

Available in all stages.

cpp

Available in all stages.

cuda

Available in all stages.

metal

Available in all stages.

wgsl

Available in all stages.

spirv

Available in all stages.

llvm

Available in all stages.