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

Function isZero

Test whether a value is zero. The function can check for zero for types number, BigNumber, Fraction, Complex, and Unit.

The function is evaluated element-wise in case of Array or Matrix input.

Syntax

math.isZero(x)

Parameters

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

Returns

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

Throws

Type	Description

Examples

math.isZero(0)                     // returns true
math.isZero(2)                     // returns false
math.isZero(0.5)                   // returns false
math.isZero(math.bignumber(0))     // returns true
math.isZero(math.fraction(0))      // returns true
math.isZero(math.fraction(1,3))    // returns false
math.isZero(math.complex('2 - 4i') // returns false
math.isZero(math.complex('0i')     // returns true
math.isZero('0')                   // returns true
math.isZero('2')                   // returns false
math.isZero([2, 0, -3]')           // returns [false, true, false]

See also

isNumeric, isPositive, isNegative, isInteger