2015-02-09 21:43:00 +01:00

46 lines
1021 B
Markdown

# Function tanh
Calculate the hyperbolic tangent of a value,
defined as `tanh(x) = (exp(2 * x) - 1) / (exp(2 * x) + 1)`.
For matrices, the function is evaluated element wise.
## Syntax
```js
math.tanh(x)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | Number | BigNumber | Boolean | Complex | Unit | Array | Matrix | null | Function input
### Returns
Type | Description
---- | -----------
Number | BigNumber | Complex | Array | Matrix | Hyperbolic tangent of x
## Examples
```js
// tanh(x) = sinh(x) / cosh(x) = 1 / coth(x)
math.tanh(0.5); // returns 0.46211715726000974
math.sinh(0.5) / math.cosh(0.5); // returns 0.46211715726000974
1 / math.coth(0.5); // returns 0.46211715726000974
```
## See also
[sinh](sinh.md),
[cosh](cosh.md),
[coth](coth.md)
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->