Skip to contents

Inverse Hyperbolic Tangent

Source: R/api.R, R/api-generics.R
nv_atanh.Rd

Element-wise inverse hyperbolic tangent. You can also use atanh().

Usage

nv_atanh(x)

Arguments

x

(arrayish)
One input. Can be any numeric data type: a float keeps its own, and an integer one is converted to the default float data type (see default_dtypes()). An R value materializes at its default data type and is converted in the same way.

Value

(arrayish)
Has the input's shape, and its data type – or the default float data type (see default_dtypes()) where the input was an integer one.

See also

prim_atanh() for the underlying primitive.

Examples

# the input's data type carries through
x <- nv_array(c(-0.5, 0, 0.5))
atanh(x)
#> AnvlArray
#>  -0.5493
#>   0.0000
#>   0.5493
#> [ CPUf32{3} ] 

# an R value materializes at its default data type
nv_atanh(0.5)
#> AnvlArray
#>  0.5493
#> [ CPUf32{} ]