Skip to content

Compute inverse hyperbolic tangent

Source code

Description

Compute inverse hyperbolic tangent

Usage

<Expr>$arctanh()

Value

Expr

Examples

library("polars")

pl$DataFrame(a = c(-1, tanh(0.5), 0, 1, NA_real_))$
  with_columns(arctanh = pl$col("a")$arctanh())

#> shape: (5, 2)
#> ┌──────────┬─────────┐
#> │ a        ┆ arctanh │
#> │ ---      ┆ ---     │
#> │ f64      ┆ f64     │
#> ╞══════════╪═════════╡
#> │ -1.0     ┆ -inf    │
#> │ 0.462117 ┆ 0.5     │
#> │ 0.0      ┆ 0.0     │
#> │ 1.0      ┆ inf     │
#> │ null     ┆ null    │
#> └──────────┴─────────┘