UNPKG

mathjs/docs/reference/functions/sech.md

Version:

817 BMarkdownView Raw

1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function sech
4
5Calculate the hyperbolic secant of a value,
6defined as `sech(x) = 1 / cosh(x)`.
7
8For matrices, the function is evaluated element wise.
9
10
11## Syntax
12
13```js
14math.sech(x)
15```
16
17### Parameters
18
19Parameter | Type | Description
20--------- | ---- | -----------
21`x` | number &#124; Complex &#124; Unit &#124; Array &#124; Matrix | Function input
22
23### Returns
24
25Type | Description
26---- | -----------
27number &#124; Complex &#124; Array &#124; Matrix | Hyperbolic secant of x
28
29
30## Examples
31
32```js
33// sech(x) = 1/ cosh(x)
34math.sech(0.5)       // returns 0.886818883970074
351 / math.cosh(0.5)   // returns 0.886818883970074
36```
37
38
39## See also
40
41[cosh](cosh.md),
42[csch](csch.md),
43[coth](coth.md)

1	`<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->`
2
3	`# Function sech`
4
5	`Calculate the hyperbolic secant of a value,`
6	defined as `sech(x) = 1 / cosh(x)`.
7
8	`For matrices, the function is evaluated element wise.`
9
10
11	`## Syntax`
12
13	```js
14	`math.sech(x)`
15	```
16
17	`### Parameters`
18
19	`Parameter \| Type \| Description`
20	`--------- \| ---- \| -----------`
21	`x` \| number \| Complex \| Unit \| Array \| Matrix \| Function input
22
23	`### Returns`
24
25	`Type \| Description`
26	`---- \| -----------`
27	`number \| Complex \| Array \| Matrix \| Hyperbolic secant of x`
28
29
30	`## Examples`
31
32	```js
33	`// sech(x) = 1/ cosh(x)`
34	`math.sech(0.5) // returns 0.886818883970074`
35	`1 / math.cosh(0.5) // returns 0.886818883970074`
36	```
37
38
39	`## See also`
40
41	`[cosh](cosh.md),`
42	`[csch](csch.md),`
43	`[coth](coth.md)`