74 lines
1.9 KiB
JavaScript
74 lines
1.9 KiB
JavaScript
import { factory } from '../../utils/factory.js';
|
|
import { deepMap } from '../../utils/collection.js';
|
|
var name = 'sqrt';
|
|
var dependencies = ['config', 'typed', 'Complex'];
|
|
export var createSqrt = /* #__PURE__ */factory(name, dependencies, _ref => {
|
|
var {
|
|
config,
|
|
typed,
|
|
Complex
|
|
} = _ref;
|
|
|
|
/**
|
|
* Calculate the square root of a value.
|
|
*
|
|
* For matrices, the function is evaluated element wise.
|
|
*
|
|
* Syntax:
|
|
*
|
|
* math.sqrt(x)
|
|
*
|
|
* Examples:
|
|
*
|
|
* math.sqrt(25) // returns 5
|
|
* math.square(5) // returns 25
|
|
* math.sqrt(-4) // returns Complex 2i
|
|
*
|
|
* See also:
|
|
*
|
|
* square, multiply, cube, cbrt, sqrtm
|
|
*
|
|
* @param {number | BigNumber | Complex | Array | Matrix | Unit} x
|
|
* Value for which to calculate the square root.
|
|
* @return {number | BigNumber | Complex | Array | Matrix | Unit}
|
|
* Returns the square root of `x`
|
|
*/
|
|
return typed('sqrt', {
|
|
number: _sqrtNumber,
|
|
Complex: function Complex(x) {
|
|
return x.sqrt();
|
|
},
|
|
BigNumber: function BigNumber(x) {
|
|
if (!x.isNegative() || config.predictable) {
|
|
return x.sqrt();
|
|
} else {
|
|
// negative value -> downgrade to number to do complex value computation
|
|
return _sqrtNumber(x.toNumber());
|
|
}
|
|
},
|
|
'Array | Matrix': function ArrayMatrix(x) {
|
|
// deep map collection, skip zeros since sqrt(0) = 0
|
|
return deepMap(x, this, true);
|
|
},
|
|
Unit: function Unit(x) {
|
|
// Someday will work for complex units when they are implemented
|
|
return x.pow(0.5);
|
|
}
|
|
});
|
|
/**
|
|
* Calculate sqrt for a number
|
|
* @param {number} x
|
|
* @returns {number | Complex} Returns the square root of x
|
|
* @private
|
|
*/
|
|
|
|
function _sqrtNumber(x) {
|
|
if (isNaN(x)) {
|
|
return NaN;
|
|
} else if (x >= 0 || config.predictable) {
|
|
return Math.sqrt(x);
|
|
} else {
|
|
return new Complex(x, 0).sqrt();
|
|
}
|
|
}
|
|
}); |