jiangchengfeiyi-xiaochengxu/node_modules/mathjs/lib/cjs/function/complex/im.js
2025-01-02 11:13:50 +08:00

48 lines
1.4 KiB
JavaScript

"use strict";
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.createIm = void 0;
var _factory = require("../../utils/factory.js");
var _collection = require("../../utils/collection.js");
const name = 'im';
const dependencies = ['typed'];
const createIm = exports.createIm = /* #__PURE__ */(0, _factory.factory)(name, dependencies, _ref => {
let {
typed
} = _ref;
/**
* 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 => (0, _collection.deepMap)(x, self))
});
});