50 lines
869 B
Markdown
50 lines
869 B
Markdown
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
||
|
|
|
||
|
|
# Function sech
|
||
|
|
|
||
|
|
Calculate the hyperbolic secant of a value,
|
||
|
|
defined as `sech(x) = 1 / cosh(x)`.
|
||
|
|
|
||
|
|
For matrices, the function is evaluated element wise.
|
||
|
|
|
||
|
|
|
||
|
|
## Syntax
|
||
|
|
|
||
|
|
```js
|
||
|
|
math.sech(x)
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
Parameter | Type | Description
|
||
|
|
--------- | ---- | -----------
|
||
|
|
`x` | number | Complex | Unit | Array | Matrix | Function input
|
||
|
|
|
||
|
|
### Returns
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
number | Complex | Array | Matrix | Hyperbolic secant of x
|
||
|
|
|
||
|
|
|
||
|
|
### Throws
|
||
|
|
|
||
|
|
Type | Description
|
||
|
|
---- | -----------
|
||
|
|
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
```js
|
||
|
|
// sech(x) = 1/ cosh(x)
|
||
|
|
math.sech(0.5) // returns 0.886818883970074
|
||
|
|
1 / math.cosh(0.5) // returns 0.886818883970074
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## See also
|
||
|
|
|
||
|
|
[cosh](cosh.md),
|
||
|
|
[csch](csch.md),
|
||
|
|
[coth](coth.md)
|