forked from josdejong/mathjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathim.js
More file actions
41 lines (39 loc) · 1.19 KB
/
im.js
File metadata and controls
41 lines (39 loc) · 1.19 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
import { factory } from '../../utils/factory.js'
import { deepMap } from '../../utils/collection.js'
const name = 'im'
const dependencies = ['typed']
export const createIm = /* #__PURE__ */ factory(name, dependencies, ({ typed }) => {
/**
* Get the imaginary part of a complex number.
* For a complex number `a + bi`, the function returns `b`.
*
* For matrices, the function is evaluated element wise.
*
* Syntax:
*
* math.im(x)
*
* Examples:
*
* const a = math.complex(2, 3)
* math.re(a) // returns number 2
* math.im(a) // returns number 3
*
* math.re(math.complex('-5.2i')) // returns number -5.2
* math.re(math.complex(2.4)) // returns number 0
*
* See also:
*
* re, conj, abs, arg
*
* @param {number | BigNumber | Complex | Array | Matrix} x
* A complex number or array with complex numbers
* @return {number | BigNumber | Array | Matrix} The imaginary part of x
*/
return typed(name, {
number: () => 0,
'BigNumber | Fraction': x => x.mul(0),
Complex: x => x.im,
'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
})
})