123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051 |
- import { deepMap } from '../../utils/collection.js';
- import { factory } from '../../utils/factory.js';
- import { isNegativeNumber } from '../../plain/number/index.js';
- var name = 'isNegative';
- var dependencies = ['typed'];
- export var createIsNegative = /* #__PURE__ */factory(name, dependencies, _ref => {
- var {
- typed
- } = _ref;
- /**
- * Test whether a value is negative: smaller than zero.
- * The function supports types `number`, `BigNumber`, `Fraction`, and `Unit`.
- *
- * The function is evaluated element-wise in case of Array or Matrix input.
- *
- * Syntax:
- *
- * math.isNegative(x)
- *
- * Examples:
- *
- * math.isNegative(3) // returns false
- * math.isNegative(-2) // returns true
- * math.isNegative(0) // returns false
- * math.isNegative(-0) // returns false
- * math.isNegative(math.bignumber(2)) // returns false
- * math.isNegative(math.fraction(-2, 5)) // returns true
- * math.isNegative('-2') // returns true
- * math.isNegative([2, 0, -3]) // returns [false, false, true]
- *
- * See also:
- *
- * isNumeric, isPositive, isZero, isInteger
- *
- * @param {number | BigNumber | Fraction | Unit | Array | Matrix} x Value to be tested
- * @return {boolean} Returns true when `x` is larger than zero.
- * Throws an error in case of an unknown data type.
- */
- return typed(name, {
- number: isNegativeNumber,
- BigNumber: function BigNumber(x) {
- return x.isNeg() && !x.isZero() && !x.isNaN();
- },
- Fraction: function Fraction(x) {
- return x.s < 0; // It's enough to decide on the sign
- },
- Unit: typed.referToSelf(self => x => typed.find(self, x.valueType())(x.value)),
- 'Array | Matrix': typed.referToSelf(self => x => deepMap(x, self))
- });
- });
|