math.atanh() function

Warning! This page documents an earlier version of Flux, which is no longer actively developed. Flux v0.36 is the most recent stable version of Flux.

The math.atanh() function returns the inverse hyperbolic tangent of x.

Output data type: Float

import "math"

math.atanh(x: 0.22)

// Returns 0.22365610902183242

Parameters

x

The value used in the operation. x should be greater than -1 and less than 1. Otherwise, the operation will return NaN.

Data type: Float

Special cases

math.atanh(x: 1)   // Returns +Inf
math.atanh(x: ±0)  // Returns ±0
math.atanh(x: -1)  // Returns -Inf
math.atanh(x: <-1) // Returns NaN
math.atanh(x: >1)  // Returns NaN
math.atanh(x: NaN) // Returns NaN