Skip to content

Commit 4cdf27e

Browse files
kgrytekgryte
committed
feat: add array/base/assert/has-equal-values 
1 parent a4c2f06 commit 4cdf27e

File tree

10 files changed

+1143
-0
lines changed

10 files changed

+1143
-0
lines changed

‎lib/node_modules/@stdlib/array/base/assert/has-equal-values/README.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# hasEqualValues
22+
23+
> Test if two arrays have equal values.
24+
25+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
26+
27+
<section class="intro">
28+
29+
</section>
30+
31+
<!-- /.intro -->
32+
33+
<!-- Package usage documentation. -->
34+
35+
<section class="usage">
36+
37+
## Usage
38+
39+
```javascript
40+
var hasEqualValues = require( '@stdlib/array/base/assert/has-equal-values' );
41+
```
42+
43+
#### hasEqualValues( x, y )
44+
45+
Tests if two arrays have equal values.
46+
47+
```javascript
48+
var x = [ 0, 0, 1, 0 ];
49+
var y = [ 0, 0, 1, 0 ];
50+
51+
var bool = hasEqualValues( x, y );
52+
// returns true
53+
```
54+
55+
</section>
56+
57+
<!-- /.usage -->
58+
59+
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
60+
61+
<section class="notes">
62+
63+
## Notes
64+
65+
- If provided arrays of unequal length, the function returns `false`.
66+
- The function performs **strict** equality comparison.
67+
- The function does **not** skip `undefined` elements and is thus not optimized for sparse arrays.
68+
69+
</section>
70+
71+
<!-- /.notes -->
72+
73+
<!-- Package usage examples. -->
74+
75+
<section class="examples">
76+
77+
## Examples
78+
79+
<!-- eslint no-undef: "error" -->
80+
81+
```javascript
82+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
83+
var Complex128Array = require( '@stdlib/array/complex128' );
84+
var hasEqualValues = require( '@stdlib/array/base/assert/has-equal-values' );
85+
86+
var buf = discreteUniform( 10, 0, 10 );
87+
// returns <Float64Array>
88+
89+
var x = new Complex128Array( buf );
90+
// returns <Complex128Array>
91+
92+
var y = new Complex128Array( buf );
93+
// returns <Complex128Array>
94+
95+
var out = hasEqualValues( x, y );
96+
// returns true
97+
```
98+
99+
</section>
100+
101+
<!-- /.examples -->
102+
103+
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
104+
105+
<section class="references">
106+
107+
</section>
108+
109+
<!-- /.references -->
110+
111+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
112+
113+
<section class="related">
114+
115+
</section>
116+
117+
<!-- /.related -->
118+
119+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
120+
121+
<section class="links">
122+
123+
</section>
124+
125+
<!-- /.links -->

‎lib/node_modules/@stdlib/array/base/assert/has-equal-values/benchmark/benchmark.length.js

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var bench = require( '@stdlib/bench' );
24+
var pow = require( '@stdlib/math/base/special/pow' );
25+
var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
26+
var zeros = require( '@stdlib/array/base/zeros' );
27+
var pkg = require( './../package.json' ).name;
28+
var hasEqualValues = require( './../lib' );
29+
30+
31+
// FUNCTIONS //
32+
33+
/**
34+
* Creates a benchmark function.
35+
*
36+
* @private
37+
* @param {PositiveInteger} len - array length
38+
* @returns {Function} benchmark function
39+
*/
40+
function createBenchmark( len ) {
41+
var x = zeros( len );
42+
return benchmark;
43+
44+
/**
45+
* Benchmark function.
46+
*
47+
* @private
48+
* @param {Benchmark} b - benchmark instance
49+
*/
50+
function benchmark( b ) {
51+
var out;
52+
var i;
53+
54+
b.tic();
55+
for ( i = 0; i < b.iterations; i++ ) {
56+
out = hasEqualValues( x, x );
57+
if ( typeof out !== 'boolean' ) {
58+
b.fail( 'should return a boolean' );
59+
}
60+
}
61+
b.toc();
62+
if ( !isBoolean( out ) ) {
63+
b.fail( 'should return a boolean' );
64+
}
65+
b.pass( 'benchmark finished' );
66+
b.end();
67+
}
68+
}
69+
70+
71+
// MAIN //
72+
73+
/**
74+
* Main execution sequence.
75+
*
76+
* @private
77+
*/
78+
function main() {
79+
var len;
80+
var min;
81+
var max;
82+
var f;
83+
var i;
84+
85+
min = 1; // 10^min
86+
max = 6; // 10^max
87+
88+
for ( i = min; i <= max; i++ ) {
89+
len = pow( 10, i );
90+
91+
f = createBenchmark( len );
92+
bench( pkg+':dtype=generic,len='+len, f );
93+
}
94+
}
95+
96+
main();

‎lib/node_modules/@stdlib/array/base/assert/has-equal-values/docs/repl.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
2+
{{alias}}( x, y )
3+
Tests if two arrays have equal values.
4+
5+
If provided arrays of unequal length, the function returns `false`.
6+
7+
Parameters
8+
----------
9+
x: Array|TypedArray|Object
10+
First input array.
11+
12+
y: Array|TypedArray|Object
13+
Second input array.
14+
15+
Returns
16+
-------
17+
bool: boolean
18+
The function returns `true` if both arrays have equal values; otherwise,
19+
the function returns `false`.
20+
21+
Examples
22+
--------
23+
> var x = [ 0, 0, 1, 0 ];
24+
> var y = [ 0, 0, 1, 0 ];
25+
> var out = {{alias}}( x, y )
26+
true
27+
28+
See Also
29+
--------
30+

‎lib/node_modules/@stdlib/array/base/assert/has-equal-values/docs/types/index.d.ts

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/// <reference types="@stdlib/types"/>
22+
23+
import { Collection, AccessorArrayLike } from '@stdlib/types/array';
24+
25+
/**
26+
* Tests if two arrays have equal values.
27+
*
28+
* ## Notes
29+
*
30+
* - If provided arrays of unequal length, the function returns `false`.
31+
*
32+
* @param x - first input array
33+
* @param y - second input array
34+
* @returns boolean indicating whether both arrays have equal values
35+
*
36+
* @example
37+
* var x = [ 0, 0, 1, 0 ];
38+
* var y = [ 0, 0, 1, 0 ];
39+
*
40+
* var out = hasEqualValues( x, y );
41+
* // returns true
42+
*/
43+
declare function hasEqualValues<T = unknown, U = unknown>( x: Collection<T> | AccessorArrayLike<T>, y: Collection<U> | AccessorArrayLike<U> ): boolean;
44+
45+
46+
// EXPORTS //
47+
48+
export = hasEqualValues;

‎lib/node_modules/@stdlib/array/base/assert/has-equal-values/docs/types/test.ts

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
20+
import hasEqualValues = require( './index' );
21+
22+
23+
// TESTS //
24+
25+
// The function returns a boolean...
26+
{
27+
const x = [ 1, 2, 3 ];
28+
29+
hasEqualValues( x, x ); // $ExpectType boolean
30+
hasEqualValues( new Float64Array( x ), new Float64Array( x ) ); // $ExpectType boolean
31+
hasEqualValues( new Float32Array( x ), new Float32Array( x ) ); // $ExpectType boolean
32+
hasEqualValues( new Int32Array( x ), new Int32Array( x ) ); // $ExpectType boolean
33+
hasEqualValues( new Int16Array( x ), new Int16Array( x ) ); // $ExpectType boolean
34+
hasEqualValues( new Int8Array( x ), new Int8Array( x ) ); // $ExpectType boolean
35+
hasEqualValues( new Uint32Array( x ), new Uint32Array( x ) ); // $ExpectType boolean
36+
hasEqualValues( new Uint16Array( x ), new Uint16Array( x ) ); // $ExpectType boolean
37+
hasEqualValues( new Uint8Array( x ), new Uint8Array( x ) ); // $ExpectType boolean
38+
hasEqualValues( new Uint8ClampedArray( x ), new Uint8ClampedArray( x ) ); // $ExpectType boolean
39+
hasEqualValues( toAccessorArray( x ), toAccessorArray( x ) ); // $ExpectType boolean
40+
}
41+
42+
// The compiler throws an error if the function is provided a first argument which is not a collection...
43+
{
44+
const x = [ 1, 2, 3 ];
45+
46+
hasEqualValues( 2, x ); // $ExpectError
47+
hasEqualValues( false, x ); // $ExpectError
48+
hasEqualValues( true, x ); // $ExpectError
49+
hasEqualValues( {}, x ); // $ExpectError
50+
}
51+
52+
// The compiler throws an error if the function is provided a second argument which is not a collection...
53+
{
54+
const x = [ 1, 2, 3 ];
55+
56+
hasEqualValues( x, 2 ); // $ExpectError
57+
hasEqualValues( x, false ); // $ExpectError
58+
hasEqualValues( x, true ); // $ExpectError
59+
hasEqualValues( x, {} ); // $ExpectError
60+
}
61+
62+
// The compiler throws an error if the function is provided an unsupported number of arguments...
63+
{
64+
const x = [ 1, 2, 3 ];
65+
66+
hasEqualValues(); // $ExpectError
67+
hasEqualValues( x ); // $ExpectError
68+
hasEqualValues( x, x, x ); // $ExpectError
69+
}

0 commit comments

Comments
 (0)