Skip to contents

Hyperbolic Tangent

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

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

Usage

nv_tanh(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_tanh() for the underlying primitive.

Examples

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

# an R value materializes at its default data type
nv_tanh(1)
#> AnvlArray
#>  0.7616
#> [ CPUf32{} ]