UNPKG

986 BMarkdownView Raw
1<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
2
3# Function re
4
5Get the real part of a complex number.
6For a complex number `a + bi`, the function returns `a`.
7
8For matrices, the function is evaluated element wise.
9
10
11## Syntax
12
13```js
14math.re(x)
15```
16
17### Parameters
18
19Parameter | Type | Description
20--------- | ---- | -----------
21`x` | number &#124; BigNumber &#124; Complex &#124; Array &#124; Matrix | A complex number or array with complex numbers
22
23### Returns
24
25Type | Description
26---- | -----------
27number &#124; BigNumber &#124; Array &#124; Matrix | The real part of x
28
29
30## Examples
31
32```js
33const a = math.complex(2, 3)
34math.re(a) // returns number 2
35math.im(a) // returns number 3
36
37math.re(math.complex('-5.2i')) // returns number 0
38math.re(math.complex(2.4)) // returns number 2.4
39```
40
41
42## See also
43
44[im](im.md),
45[conj](conj.md),
46[abs](abs.md),
47[arg](arg.md)