mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-25 15:07:57 +00:00
80 lines
2.5 KiB
Markdown
80 lines
2.5 KiB
Markdown
---
|
|
layout: default
|
|
---
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|
|
|
|
<h1 id="function-equal">Function equal <a href="#function-equal" title="Permalink">#</a></h1>
|
|
|
|
Test whether two values are equal.
|
|
|
|
The function tests whether the relative difference between x and y is
|
|
smaller than the configured relTol and absTol. 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 equal y.re, and x.im must equal y.im.
|
|
|
|
Values `null` and `undefined` are compared strictly, thus `null` is only
|
|
equal to `null` and nothing else, and `undefined` is only equal to
|
|
`undefined` and nothing else. Strings are compared by their numerical value.
|
|
|
|
|
|
<h2 id="syntax">Syntax <a href="#syntax" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
math.equal(x, y)
|
|
```
|
|
|
|
<h3 id="parameters">Parameters <a href="#parameters" title="Permalink">#</a></h3>
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`x` | number | BigNumber | bigint | boolean | Complex | Unit | string | Array | Matrix | First value to compare
|
|
`y` | number | BigNumber | bigint | boolean | Complex | Unit | string | Array | Matrix | Second value to compare
|
|
|
|
<h3 id="returns">Returns <a href="#returns" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
boolean | Array | Matrix | Returns true when the compared values are equal, else returns false
|
|
|
|
|
|
<h3 id="throws">Throws <a href="#throws" title="Permalink">#</a></h3>
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
|
|
|
|
<h2 id="examples">Examples <a href="#examples" title="Permalink">#</a></h2>
|
|
|
|
```js
|
|
math.equal(2 + 2, 3) // returns false
|
|
math.equal(2 + 2, 4) // returns true
|
|
|
|
const a = math.unit('50 cm')
|
|
const b = math.unit('5 m')
|
|
math.equal(a, b) // returns true
|
|
|
|
const c = [2, 5, 1]
|
|
const d = [2, 7, 1]
|
|
|
|
math.equal(c, d) // returns [true, false, true]
|
|
math.deepEqual(c, d) // returns false
|
|
|
|
math.equal("1000", "1e3") // returns true
|
|
math.equal(0, null) // returns false
|
|
```
|
|
|
|
|
|
<h2 id="see-also">See also <a href="#see-also" title="Permalink">#</a></h2>
|
|
|
|
[unequal](unequal.html),
|
|
[smaller](smaller.html),
|
|
[smallerEq](smallerEq.html),
|
|
[larger](larger.html),
|
|
[largerEq](largerEq.html),
|
|
[compare](compare.html),
|
|
[deepEqual](deepEqual.html),
|
|
[equalText](equalText.html)
|