simple-squiggle/node_modules/mathjs/docs/reference/functions/isPositive.md

1.5 KiB

Function isPositive

Test whether a value is positive: larger 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.isPositive(x)

Parameters

Parameter Type Description
x number | BigNumber | Fraction | Unit | Array | Matrix Value to be tested

Returns

Type Description
boolean Returns true when x is larger than zero. Throws an error in case of an unknown data type.

Throws

Type Description

Examples

math.isPositive(3)                     // returns true
math.isPositive(-2)                    // returns false
math.isPositive(0)                     // returns false
math.isPositive(-0)                    // returns false
math.isPositive(0.5)                   // returns true
math.isPositive(math.bignumber(2))     // returns true
math.isPositive(math.fraction(-2, 5))  // returns false
math.isPositive(math.fraction(1,3))    // returns false
math.isPositive('2')                   // returns true
math.isPositive([2, 0, -3])            // returns [true, false, false]

See also

isNumeric, isZero, isNegative, isInteger