ContextQMD
Back to Influxdb

math.tanh() function

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

latest3.0 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#L2166-L2166 Contributing to Flux: https://github.com/influxdata/flux#contributing Fluxdoc syntax: https://github.com/influxdata/flux/blob/master/docs/fluxdoc.md ------------------------------------------------------------------------------->

math.tanh() returns the 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.

Examples

Return the hyperbolic tangent of a value

js
import "math"

math.tanh(x: 1.23)// 0.8425793256589296

Use math.tanh in map

js
import "math"
import "sampledata"

sampledata.float()
    |> map(fn: (r) => ({r with _value: math.tanh(x: r._value)}))

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

Input data

_time*tag_value
2021-01-01T00:00:00Zt1-2.18
2021-01-01T00:00:10Zt110.92
2021-01-01T00:00:20Zt17.35
2021-01-01T00:00:30Zt117.53
2021-01-01T00:00:40Zt115.23
2021-01-01T00:00:50Zt14.43
_time*tag_value
2021-01-01T00:00:00Zt219.85
2021-01-01T00:00:10Zt24.97
2021-01-01T00:00:20Zt2-3.75
2021-01-01T00:00:30Zt219.77
2021-01-01T00:00:40Zt213.86
2021-01-01T00:00:50Zt21.86

Output data

_time_value*tag
2021-01-01T00:00:00Z-0.9747656786413226t1
2021-01-01T00:00:10Z0.9999999993453058t1
2021-01-01T00:00:20Z0.9999991741504578t1
2021-01-01T00:00:30Z0.9999999999999988t1
2021-01-01T00:00:40Z0.9999999999998819t1
2021-01-01T00:00:50Z0.9997161301684341t1
_time_value*tag
2021-01-01T00:00:00Z1t2
2021-01-01T00:00:10Z0.9999035900383996t2
2021-01-01T00:00:20Z-0.9988944427261528t2
2021-01-01T00:00:30Z1t2
2021-01-01T00:00:40Z0.9999999999981702t2
2021-01-01T00:00:50Z0.9526788436890776t2

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