mathjs
Version:
Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser with support for symbolic computation, comes with a large set of built-in functions and constants, and offers an integrated solution to work with dif
69 lines (46 loc) • 1.94 kB
Markdown
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
# Function unequal
Test whether two values are unequal.
The function tests whether the relative difference between x and y is
larger than the configured epsilon. The function cannot be used to compare
values smaller than approximately 2.22e-16.
For matrices, the function is evaluated element wise.
In case of complex numbers, x.re must unequal y.re, or x.im must unequal y.im.
Strings are compared by their numerical value.
Values `null` and `undefined` are compared strictly, thus `null` is unequal
with everything except `null`, and `undefined` is unequal with everything
except `undefined`.
## Syntax
```js
math.unequal(x, y)
```
### Parameters
Parameter | Type | Description
--------- | ---- | -----------
`x` | number | BigNumber | Fraction | boolean | Complex | Unit | string | Array | Matrix | undefined | First value to compare
`y` | number | BigNumber | Fraction | boolean | Complex | Unit | string | Array | Matrix | undefined | Second value to compare
### Returns
Type | Description
---- | -----------
boolean | Array | Matrix | Returns true when the compared values are unequal, else returns false
## Examples
```js
math.unequal(2 + 2, 3) // returns true
math.unequal(2 + 2, 4) // returns false
const a = math.unit('50 cm')
const b = math.unit('5 m')
math.unequal(a, b) // returns false
const c = [2, 5, 1]
const d = [2, 7, 1]
math.unequal(c, d) // returns [false, true, false]
math.deepEqual(c, d) // returns false
math.unequal(0, null) // returns true
```
## See also
[equal](equal.md),
[deepEqual](deepEqual.md),
[smaller](smaller.md),
[smallerEq](smallerEq.md),
[larger](larger.md),
[largerEq](largerEq.md),
[compare](compare.md)