diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/README.md b/lib/node_modules/@stdlib/assert/is-same-booleanarray/README.md new file mode 100644 index 000000000000..b069aecf20d7 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/README.md @@ -0,0 +1,102 @@ + + +# isSameBooleanArray + +> Test if two arguments are both [BooleanArrays][@stdlib/array/bool] and have the [same values][@stdlib/assert/is-same-value]. + +
+ +## Usage + +```javascript +var isSameBooleanArray = require( '@stdlib/assert/is-same-booleanarray' ); +``` + +#### isSameBooleanArray( v1, v2 ) + +Tests if two arguments are both [BooleanArrays][@stdlib/array/bool] and have the [same values][@stdlib/assert/is-same-value]. + +```javascript +var BooleanArray = require( '@stdlib/array/bool' ); + +var x = new BooleanArray( [ true, false ] ); +var y = new BooleanArray( [ true, false ] ); +var bool = isSameBooleanArray( x, y ); +// returns true + +bool = isSameBooleanArray( x, [ true, false ] ); +// returns false +``` + +
+ + + +
+ +
+ + + +
+ +## Examples + + + +```javascript +var BooleanArray = require( '@stdlib/array/bool' ); +var isSameBooleanArray = require( '@stdlib/assert/is-same-booleanarray' ); + +var x = new BooleanArray( [ true, false, false, true ] ); +var y = new BooleanArray( [ true, false, false, true ] ); +var out = isSameBooleanArray( x, y ); +// returns true + +x = new BooleanArray( [ true, false, false, true ] ); +y = new BooleanArray( [ true, true, false, false ] ); +out = isSameBooleanArray( x, y ); +// returns false +``` + +
+ + + + + +
+ +
+ + + + + +
+ +[@stdlib/array/bool]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/bool + +[@stdlib/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-same-value + +
+ + diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/benchmark/benchmark.length.js b/lib/node_modules/@stdlib/assert/is-same-booleanarray/benchmark/benchmark.length.js new file mode 100644 index 000000000000..82a55c1b563d --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/benchmark/benchmark.length.js @@ -0,0 +1,106 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var bench = require( '@stdlib/bench' ); +var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive; +var pow = require( '@stdlib/math/base/special/pow' ); +var Boolean = require( '@stdlib/boolean/ctor' ); +var BooleanArray = require( '@stdlib/array/bool' ); +var pkg = require( './../package.json' ).name; +var isSameBooleanArray = require( './../lib' ); + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var x; + var y; + var i; + + x = []; + for ( i = 0; i < len; i++ ) { + x.push( Boolean( i%2 ) ); + } + x = new BooleanArray( x ); + y = new BooleanArray( x ); + + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var bool; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + bool = isSameBooleanArray( x, y ); + if ( typeof bool !== 'boolean' ) { + b.fail( 'should return a boolean' ); + } + } + b.toc(); + if ( !isBoolean( bool ) ) { + b.fail( 'should return a boolean' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( pkg+':len='+len, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/repl.txt b/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/repl.txt new file mode 100644 index 000000000000..9ed0fbe15ef8 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/repl.txt @@ -0,0 +1,32 @@ + +{{alias}}( v1, v2 ) + Tests if two arguments are both BooleanArrays and have the same values. + + Parameters + ---------- + v1: any + First input value. + + v2: any + Second input value. + + Returns + ------- + bool: boolean + Boolean indicating whether two arguments are the same. + + Examples + -------- + > var x = new {{alias:@stdlib/array/bool}}( [ true, false, false, true ] ); + > var y = new {{alias:@stdlib/array/bool}}( [ true, false, false, true ] ); + > var bool = {{alias}}( x, y ) + true + + > x = new {{alias:@stdlib/array/bool}}( [ true, false, false, true ] ); + > y = new {{alias:@stdlib/array/bool}}( [ true, true, false, false ] ); + > bool = {{alias}}( x, y ) + false + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/types/index.d.ts b/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/types/index.d.ts new file mode 100644 index 000000000000..cc768f78a9ef --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/types/index.d.ts @@ -0,0 +1,51 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +// TypeScript Version: 4.1 + +/** +* Tests if two arguments are both BooleanArrays and have the same values. +* +* @param v1 - first input value +* @param v2 - second input value +* @returns boolean indicating whether two arguments are the same +* +* @example +* var BooleanArray = require( '@stdlib/array/bool' ); +* +* var x = new BooleanArray( [ true, false, false, true ] ); +* var y = new BooleanArray( [ true, false, false, true ] ); +* +* var out = isSameBooleanArray( x, y ); +* // returns true +* +* @example +* var BooleanArray = require( '@stdlib/array/bool' ); +* +* var x = new BooleanArray( [ true, false, false, true ] ); +* var y = new BooleanArray( [ true, true, false, false ] ); +* +* var out = isSameBooleanArray( x, y ); +* // returns false +*/ +declare function isSameBooleanArray( v1: any, v2: any ): boolean; + + +// EXPORTS // + +export = isSameBooleanArray; diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/types/test.ts b/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/types/test.ts new file mode 100644 index 000000000000..27aec976ac81 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/docs/types/test.ts @@ -0,0 +1,36 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +import isSameBooleanArray = require( './index' ); + + +// TESTS // + +// The function returns a boolean... +{ + isSameBooleanArray( true, true ); // $ExpectType boolean + isSameBooleanArray( null, null ); // $ExpectType boolean + isSameBooleanArray( 'beep', 'boop' ); // $ExpectType boolean +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + isSameBooleanArray(); // $ExpectError + isSameBooleanArray( 3.14 ); // $ExpectError + isSameBooleanArray( 'beep', 'beep', 3.14 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/examples/index.js b/lib/node_modules/@stdlib/assert/is-same-booleanarray/examples/index.js new file mode 100644 index 000000000000..e0899ff43005 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/examples/index.js @@ -0,0 +1,34 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +var BooleanArray = require( '@stdlib/array/bool' ); +var isSameBooleanArray = require( './../lib' ); + +var x = new BooleanArray( [ true, false, false, true ] ); +var y = new BooleanArray( [ true, false, false, true ] ); +var out = isSameBooleanArray( x, y ); +console.log( out ); +// => true + +x = new BooleanArray( [ true, false, false, true ] ); +y = new BooleanArray( [ true, true, false, false ] ); +out = isSameBooleanArray( x, y ); +console.log( out ); +// => false diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/lib/index.js b/lib/node_modules/@stdlib/assert/is-same-booleanarray/lib/index.js new file mode 100644 index 000000000000..0620d6d52255 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/lib/index.js @@ -0,0 +1,54 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +/** +* Test if two arguments are both BooleanArrays and have the same values. +* +* @module @stdlib/assert/is-same-booleanarray +* +* @example +* var BooleanArray = require( '@stdlib/array/bool' ); +* var isSameBooleanArray = require( '@stdlib/assert/is-same-booleanarray' ); +* +* var x = new BooleanArray( [ true, false, false, true ] ); +* var y = new BooleanArray( [ true, false, false, true ] ); +* +* var out = isSameBooleanArray( x, y ); +* // returns true +* +* @example +* var BooleanArray = require( '@stdlib/array/bool' ); +* var isSameBooleanArray = require( '@stdlib/assert/is-same-booleanarray' ); +* +* var x = new BooleanArray( [ true, false, false, true ] ); +* var y = new BooleanArray( [ true, true, false, false ] ); +* +* var out = isSameBooleanArray( x, y ); +* // returns false +*/ + +// MODULES // + +var main = require( './main.js' ); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/lib/main.js b/lib/node_modules/@stdlib/assert/is-same-booleanarray/lib/main.js new file mode 100644 index 000000000000..ca2162e2a5aa --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/lib/main.js @@ -0,0 +1,64 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var isBooleanArray = require( '@stdlib/assert/is-booleanarray' ); +var hasSameValues = require( '@stdlib/array/base/assert/has-same-values' ); + + +// MAIN // + +/** +* Tests if two arguments are both BooleanArrays and have the same values. +* +* @param {*} v1 - first value +* @param {*} v2 - second value +* @returns {boolean} boolean result +* +* @example +* var BooleanArray = require( '@stdlib/array/bool' ); +* +* var x = new BooleanArray( [ true, false, false, true ] ); +* var y = new BooleanArray( [ true, false, false, true ] ); +* +* var out = isSameBooleanArray( x, y ); +* // returns true +* +* @example +* var BooleanArray = require( '@stdlib/array/bool' ); +* +* var x = new BooleanArray( [ true, false, false, true ] ); +* var y = new BooleanArray( [ true, true, false, false ] ); +* +* var out = isSameBooleanArray( x, y ); +* // returns false +*/ +function isSameBooleanArray( v1, v2 ) { + if ( isBooleanArray( v1 ) && isBooleanArray( v2 ) ) { + return hasSameValues( v1, v2 ); + } + return false; +} + + +// EXPORTS // + +module.exports = isSameBooleanArray; diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/package.json b/lib/node_modules/@stdlib/assert/is-same-booleanarray/package.json new file mode 100644 index 000000000000..ff14fd60947c --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/package.json @@ -0,0 +1,77 @@ +{ + "name": "@stdlib/assert/is-same-booleanarray", + "version": "0.0.0", + "description": "Test if two arguments are both BooleanArrays and have the same values.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdassert", + "assertion", + "assert", + "utilities", + "utility", + "utils", + "util", + "equal", + "same", + "strict", + "is", + "issame", + "issamevalue", + "isequal", + "isstrictequal", + "type", + "check", + "valid", + "validate", + "test", + "typed", + "array", + "bool" + ] +} diff --git a/lib/node_modules/@stdlib/assert/is-same-booleanarray/test/test.js b/lib/node_modules/@stdlib/assert/is-same-booleanarray/test/test.js new file mode 100644 index 000000000000..4624cf3d3f86 --- /dev/null +++ b/lib/node_modules/@stdlib/assert/is-same-booleanarray/test/test.js @@ -0,0 +1,101 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 The Stdlib Authors. +* +* Licensed under the Apache License, Version 2.0 (the "License"); +* you may not use this file except in compliance with the License. +* You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +*/ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var typedarray = require( '@stdlib/array/typed' ); +var isSameBooleanArray = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof isSameBooleanArray, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function returns `true` if provided two BooleanArrays having the same values', function test( t ) { + var x; + var y; + + x = typedarray( [ 1, 0, 0, 1 ], 'bool' ); + t.strictEqual( isSameBooleanArray( x, x ), true, 'returns expected value' ); + + x = typedarray( [ 1, 0, 0, 1 ], 'bool' ); + y = typedarray( [ 1, 0, 0, 1 ], 'bool' ); + t.strictEqual( isSameBooleanArray( x, y ), true, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns `false` if not provided two BooleanArrays having the same values', function test( t ) { + var x; + var y; + var i; + + x = [ + '', + 'beep', + 5, + 3.14, + -3.14, + 0.0, + -0.0, + true, + false, + null, + void 0, + [], + {}, + function noop() {}, + typedarray( 10, 'float32' ), + typedarray( 10, 'int32' ), + typedarray( 10, 'bool' ), + typedarray( [ 1.0, 2.0, 3.0, 4.0 ], 'complex64' ), + typedarray( [ 0, 0, 0, 0 ], 'bool' ) + ]; + y = [ + 'abc', + 'boop', + -5, + -3.14, + 3.14, + -0.0, + 0.0, + false, + true, + void 0, + null, + [], + {}, + function noop() {}, + typedarray( 10, 'float32' ), + typedarray( 10, 'int32' ), + typedarray( 10, 'float32' ), + typedarray( [ 2.0, 4.0, 6.0, 8.0 ], 'complex64' ), + typedarray( [ 0, 0, 0, 1 ], 'bool' ) + ]; + for ( i = 0; i < x.length; i++ ) { + t.strictEqual( isSameBooleanArray( x[ i ], y[ i ] ), false, 'returns expected value when provided '+x[ i ]+' and '+y[ i ] ); + } + t.end(); +});