Back to Influxdb

math.atanh() function

content/flux/v0/stdlib/math/atanh.md

latest3.3 KB
Original Source
<!------------------------------------------------------------------------------ IMPORTANT: This page was generated from comments in the Flux source code. Any edits made directly to this page will be overwritten the next time the documentation is generated. To make updates to this documentation, update the function comments above the function definition in the Flux source code: https://github.com/influxdata/flux/blob/master/stdlib/math/math.flux#L363-L363 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

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

Function type signature
js
(x: float) => float

{{% caption %}} For more information, see Function type signatures. {{% /caption %}}

Parameters

x

({{< req >}}) Value to operate on.

x should be greater than -1 and less than 1. Otherwise the operation will return NaN.

Examples

Return the hyperbolic tangent of a value

js
import "math"

math.atanh(x: 0.22)// 0.22365610902183242


Use math.atanh in map

js
import "math"

data
    |> map(fn: (r) => ({r with _value: math.atanh(x: r._value)}))

{{< expand-wrapper >}} {{% expand "View example input and output" %}}

Input data

_time*tag_value
2021-01-01T00:00:00Zt1-0.021800000000000003
2021-01-01T00:00:10Zt10.1092
2021-01-01T00:00:20Zt10.0735
2021-01-01T00:00:30Zt10.1753
2021-01-01T00:00:40Zt10.15230000000000002
2021-01-01T00:00:50Zt10.0443
_time*tag_value
2021-01-01T00:00:00Zt20.1985
2021-01-01T00:00:10Zt20.0497
2021-01-01T00:00:20Zt2-0.0375
2021-01-01T00:00:30Zt20.1977
2021-01-01T00:00:40Zt20.1386
2021-01-01T00:00:50Zt20.018600000000000002

Output data

_time_value*tag
2021-01-01T00:00:00Z-0.021803454395720394t1
2021-01-01T00:00:10Z0.10963718917920522t1
2021-01-01T00:00:20Z0.07363278579671062t1
2021-01-01T00:00:30Z0.17712951464974935t1
2021-01-01T00:00:40Z0.1534942122028045t1
2021-01-01T00:00:50Z0.04432901360668446t1
_time_value*tag
2021-01-01T00:00:00Z0.2011705409124157t2
2021-01-01T00:00:10Z0.049740981912241244t2
2021-01-01T00:00:20Z-0.037517592971457035t2
2021-01-01T00:00:30Z0.20033786359692538t2
2021-01-01T00:00:40Z0.13949787194848565t2
2021-01-01T00:00:50Z0.01860214539735061t2

{{% /expand %}} {{< /expand-wrapper >}}