@stdlib/assert-is-equal-array
v0.1.1
Published
Test if two arguments are both generic arrays and have equal values.
Readme
isEqualArray
Test if two arguments are both generic arrays and have equal values.
Installation
npm install @stdlib/assert-is-equal-arrayUsage
var isEqualArray = require( '@stdlib/assert-is-equal-array' );isEqualArray( v1, v2 )
Tests if two arguments are both generic arrays and have equal values.
var x = [ 1.0, 2.0 ];
var y = [ 1.0, 2.0 ];
var bool = isEqualArray( x, y );
// returns true
bool = isEqualArray( x, [ -1.0, 2.0 ] );
// returns falseNotes
- The function performs strict equality comparison; thus, the function treats
-0and+0as equal andNaNsas distinct.
Examples
var isEqualArray = require( '@stdlib/assert-is-equal-array' );
var x = [ 1.0, 2.0, 3.0 ];
var y = [ 1.0, 2.0, 3.0 ];
var out = isEqualArray( x, y );
// returns true
x = [ -0.0, 0.0, -0.0 ];
y = [ 0.0, -0.0, 0.0 ];
out = isEqualArray( x, y );
// returns true
x = [ NaN, NaN, NaN ];
y = [ NaN, NaN, NaN ];
out = isEqualArray( x, y );
// returns falseSee Also
@stdlib/assert-is-array: test if a value is an array.@stdlib/assert-is-same-array: test if two arguments are both generic arrays and have the same values.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.
