mathjs/docs/reference/functions/deepEqual.md

Math.js is an extensive math library for JavaScript and Node.js. It features a flexible expression parser and offers an integrated solution to work with numbers, big numbers, complex numbers, units, and matrices.

# Function deepEqual

Test element wise whether two matrices are equal.
The function accepts both matrices and scalar values.


## Syntax

```js
math.deepEqual(x, y)
```

### Parameters

Parameter | Type | Description
--------- | ---- | -----------
`x` | Number | BigNumber | Boolean | Complex | Unit | Array | Matrix | null | First matrix to compare
`y` | Number | BigNumber | Boolean | Complex | Unit | Array | Matrix | null | Second matrix to compare

### Returns

Type | Description
---- | -----------
Number | BigNumber | Complex | Unit | Array | Matrix |  Returns true when the input matrices have the same size and each of their elements is equal.


## Examples

```js
math.deepEqual(2, 4);   // returns false

a = [2, 5, 1];
b = [2, 7, 1];

math.deepEqual(a, b);   // returns false
math.equal(a, b);       // returns [true, false, true]
```


## See also

[equal](equal.md),
[unequal](unequal.md)


<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->