diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/README.md b/lib/node_modules/@stdlib/iter/cartesian-square/README.md new file mode 100644 index 000000000000..530ba7ac8d9f --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/README.md @@ -0,0 +1,141 @@ + + +# iterCartesianSquare + +> Create an iterator which generates the Cartesian square of an input array-like object. + +
+ +
+ +
+ +## Usage + +```javascript +var iterCartesianSquare = require( '@stdlib/iter/cartesian-square' ); +``` + +#### iterCartesianSquare( x ) + +Returns an iterator which generates the Cartesian Square of an input array-like object. + +```javascript +var it = iterCartesianSquare( [ 1, 2, 3 ] ); + +var v = it.next().value; +// returns [1, 1] + +v = it.next().value; +// returns [1, 2] + +v = it.next().value; +// returns [1, 3] + +v = it.next().value; +// returns [2, 1] + +var bool = it.next().done; +// returns false + +``` + +
+ + + + + +
+ +
+ + + + + +
+ +## Examples + + + + +```javascript +var iterCartesianSquare = require( '@stdlib/iter/cartesian-square' ); + +// Example : Generating Cartesian square of an array +var x = [1, 2, 3]; +var cartesianSquare = iterCartesianSquare( x ); +var pair; + +pair = cartesianSquare.next(); +while ( !pair.done ) { + console.log( pair.value ); + pair = cartesianSquare.next(); +} + +// Output: +// [ 1, 1 ] +// [ 1, 2 ] +// [ 1, 3 ] +// [ 2, 1 ] +// [ 2, 2 ] +// [ 2, 3 ] +// [ 3, 1 ] +// [ 3, 2 ] +// [ 3, 3 ] + +``` + +
+ + + + + +
+ +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/benchmark/benchmark.js b/lib/node_modules/@stdlib/iter/cartesian-square/benchmark/benchmark.js new file mode 100644 index 000000000000..92d3a45e6a3a --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/benchmark/benchmark.js @@ -0,0 +1,61 @@ + +/** +* @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 ceil = require('@stdlib/math/base/special/ceil'); +var sqrt = require('@stdlib/math/base/special/sqrt'); +var pkg = require('./../package.json').name; +var iterCartesianSquare = require('./../lib'); + + +// MAIN // + +bench( pkg, function benchmark( b ) { + var iterator; + var arr; + var v; + var i; + + // Create an array with one more element than the square root of b.iterations: + arr = new Array( ceil(sqrt(b.iterations)) + 1 ).fill( 0 ); + + // Create the iterator: + iterator = iterCartesianSquare( arr ); + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + v = iterator.next(); + if ( v.done ) { + b.fail( 'should not exhaust the iterator' ); + break; + } + } + b.toc(); + + if ( v.done ) { + b.fail('should not exhaust the iterator'); + } else { + b.pass('benchmark finished'); + } + b.end(); +}); diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/docs/repl.txt b/lib/node_modules/@stdlib/iter/cartesian-square/docs/repl.txt new file mode 100644 index 000000000000..9ff1b460b088 --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/docs/repl.txt @@ -0,0 +1,35 @@ +{{alias}}( x ) + Returns an iterator which generates the Cartesian square of an input + array-like object. + + If an environment supports Symbol.iterator, the returned iterator is + iterable. + + Parameters + ---------- + x : ArrayLikeObject + Input array-like object. + + Returns + ------- + iterator: Object + Iterator. + + iterator.next(): Function + Returns an iterator protocol-compliant object containing the next + iterated value (if one exists) and a boolean flag indicating whether the + iterator is finished. + + iterator.return( [value] ): Function + Finishes an iterator and returns a provided value. + + Examples + -------- + > var it = {{alias}}( [ '1', '2', '3' ] ) + > var v = it.next().value + [ '1', '1' ] + > v = it.next().value + [ '1', '2' ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/docs/types/index.d.ts b/lib/node_modules/@stdlib/iter/cartesian-square/docs/types/index.d.ts new file mode 100644 index 000000000000..ac7576856fb0 --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/docs/types/index.d.ts @@ -0,0 +1,61 @@ +/* +* @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 + +/// + +import { Iterator as Iter, IterableIterator } from '@stdlib/types/iter'; +import { ArrayLike } from '@stdlib/types/array'; + +// Define a union type representing both iterable and non-iterable iterators: +type Iterator = Iter | IterableIterator; + +/** +* Returns an iterator which generates the Cartesian square of an input array-like object. +* +* @param x - Input array-like object. +* @throws {TypeError} first argument must be an array-like object +* @returns iterator +* +* @example +* var iterCartesianSquare = require( '@stdlib/iter/cartesian-square' ); +* +* var iterator = iterCartesianSquare( [ 'a', 'b', 'c' ] ); +* // returns +* +* var v = iterator.next().value; +* // returns [ 'a', 'a' ] +* +* v = iterator.next().value; +* // returns [ 'a', 'b' ] +* +* v = iterator.next().value; +* // returns [ 'a', 'c' ] +* +* // ... +* +* var bool = iterator.next().done; +* // returns true +*/ +declare function iterCartesianSquare( x: ArrayLike ): Iterator; + + +// EXPORTS // + +export = iterCartesianSquare; diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/docs/types/test.ts b/lib/node_modules/@stdlib/iter/cartesian-square/docs/types/test.ts new file mode 100644 index 000000000000..690a8d7fd55e --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/docs/types/test.ts @@ -0,0 +1,43 @@ +/* +* @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 iterCartesianSquare = require( './index' ); + +// TESTS // + +// The function returns an iterator... +{ + iterCartesianSquare( [ 'a', 'b', 'c' ] ); // $ExpectType Iterator + iterCartesianSquare( [ 1, 2, 3 ] ); // $ExpectType Iterator +} + +// The compiler throws an error if the function is provided an argument which is not an array-like object... +{ + iterCartesianSquare( 5 ); // $ExpectError + iterCartesianSquare( true ); // $ExpectError + iterCartesianSquare( false ); // $ExpectError + iterCartesianSquare( null ); // $ExpectError + iterCartesianSquare( {} ); // $ExpectError + iterCartesianSquare( ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided insufficient arguments... +{ + iterCartesianSquare(); // $ExpectError +} + diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/examples/index.js b/lib/node_modules/@stdlib/iter/cartesian-square/examples/index.js new file mode 100644 index 000000000000..a1aff130c192 --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/examples/index.js @@ -0,0 +1,35 @@ + +/** +* @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 iterCartesianSquare = require( './../lib' ); + +// Create an array: +var arr = [ 'a', 'b', 'c' ]; + +// Create an iterator: +var iter = iterCartesianSquare( arr ); + +// Iterate over the Cartesian square: +var v = iter.next(); +while ( !v.done ) { + console.log( v.value ); + v = iter.next(); +} diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/lib/index.js b/lib/node_modules/@stdlib/iter/cartesian-square/lib/index.js new file mode 100644 index 000000000000..db3130789d0a --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/lib/index.js @@ -0,0 +1,45 @@ +/** +* @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'; + +/** +* Create an iterator which returns Cartesian square. +* +* @module @stdlib/iter/cartesian-square +* +* @example +* var iterCartesianSquare = require( '@stdlib/iter/cartesian-square' ); +* +* var inputArray = [1, 2, 3]; +* var iterator = iterCartesianSquare( inputArray ); +* +* var result; +* while (!(result = iterator.next()).done) { +* console.log(result.value); +* } +*/ + +// MODULES // + +var main = require('./main.js'); + + +// EXPORTS // + +module.exports = main; diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/lib/main.js b/lib/node_modules/@stdlib/iter/cartesian-square/lib/main.js new file mode 100644 index 000000000000..61fb276f3cdd --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/lib/main.js @@ -0,0 +1,122 @@ +/** +* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var iteratorSymbol = require( '@stdlib/symbol/iterator' ); +var floor = require( '@stdlib/math/base/special/floor' ); +var isCollection = require('@stdlib/assert/is-collection'); +var resolveGetter = require( '@stdlib/array/base/resolve-getter' ); + + +// MAIN // + +/** +* Returns an iterator which generates the Cartesian square of an input array-like object. +* +* @param {Collection} arr - input array +* @throws {TypeError} must provide an array-like object +* @returns {Iterator} iterator +* +* @example +* var iter = iterCartesianSquare( [ 'a', 'b', 'c' ] ); +* +* var v = iter.next().value; +* // returns [ 'a', 'a' ] +* +* v = iter.next().value; +* // returns [ 'a', 'b' ] +* +* // ... +*/ +function iterCartesianSquare( arr ) { + var iter; + var FLG; + var get; + var i; + + if ( !isCollection( arr ) ) { + throw new TypeError( 'invalid argument. Must provide an array-like object. Value: `' + arr + '`.' ); + } + + get = resolveGetter( arr ); + + iter = {}; + FLG = false; + i = 0; + setReadOnly( iter, 'next', next ); + setReadOnly( iter, 'return', finish ); + + if ( iteratorSymbol ) { + setReadOnly( iter, iteratorSymbol, factory ); + } + return iter; + /** + * Returns an iterator protocol-compliant object containing the next iterated value. + * @private + * @returns {Object} iterator result + */ + function next() { + var v; + var N; + if ( FLG ) { + return { + 'done': true + }; + } + N = arr.length * arr.length; + v = [get(arr, floor(i / arr.length)), get(arr, i % arr.length)]; + i += 1; + if ( i >= N ) { + FLG = true; + } + return { + 'value': v, + 'done': false + }; + } + + /** + * Finishes an iterator. + * @private + * @returns {Object} iterator result + */ + function finish() { + FLG = true; + return { + 'done': true + }; + } + + /** + * Returns a new iterator. + * @private + * @returns {Iterator} iterator + */ + function factory() { + return iterCartesianSquare( arr ); + } +} + + +// EXPORTS // + +module.exports = iterCartesianSquare; diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/package.json b/lib/node_modules/@stdlib/iter/cartesian-square/package.json new file mode 100644 index 000000000000..22067bf53683 --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/package.json @@ -0,0 +1,70 @@ +{ + "name": "@stdlib/iter/cartesian-square", + "version": "0.0.0", + "description": "Create an iterator which generates the Cartesian square of an input array-like object.", + "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", + "stdutils", + "stdutil", + "utilities", + "utility", + "utils", + "util", + "linspace", + "linear", + "sequence", + "monotonic", + "arange", + "range", + "iterator", + "iterate", + "iteration", + "iter" + ] +} \ No newline at end of file diff --git a/lib/node_modules/@stdlib/iter/cartesian-square/test/test.js b/lib/node_modules/@stdlib/iter/cartesian-square/test/test.js new file mode 100644 index 000000000000..dfaa67e9b4ac --- /dev/null +++ b/lib/node_modules/@stdlib/iter/cartesian-square/test/test.js @@ -0,0 +1,133 @@ +/** +* @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 iterCartesianSquare = require( './../lib/main.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.equal( typeof iterCartesianSquare, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function throws an error if the first argument is not an array-like object', function test( t ) { + var values; + var i; + + values = [ + '5', + 5, + true, + false, + null, + undefined, + {}, + function namedFunction() {}, + NaN, + Infinity, + -Infinity + ]; + + function badValue(value) { + return function thrower() { + iterCartesianSquare(value); + }; + } + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue(values[i]), TypeError, 'throws an error when provided ' + values[i] ); + } + t.end(); +}); + +tape( 'the function returns an iterator which generates the Cartesian square of an input array', function test( t ) { + var expected; + var actual; + var iter; + + iter = iterCartesianSquare( [ 'a', 'b' ] ); + + expected = [ 'a', 'a' ]; + actual = iter.next().value; + t.deepEqual( actual, expected, 'returns expected value' ); + + expected = [ 'a', 'b' ]; + actual = iter.next().value; + t.deepEqual( actual, expected, 'returns expected value' ); + + expected = [ 'b', 'a' ]; + actual = iter.next().value; + t.deepEqual( actual, expected, 'returns expected value' ); + + expected = [ 'b', 'b' ]; + actual = iter.next().value; + t.deepEqual( actual, expected, 'returns expected value' ); + + t.strictEqual( iter.next().done, true, 'returns expected value' ); + + t.end(); +}); + +tape('the finish function returns an object with done property set to true', function test(t) { + var iterator = iterCartesianSquare([1, 2]); + var result; + iterator.next(); // consume a value to ensure the iterator is not at the start + result = iterator.return(); // call the finish function + t.deepEqual(result, { + 'done': true + }, 'returns expected value'); + t.end(); +}); + +tape('the factory function returns a new iterator', function test(t) { + var iterator1 = iterCartesianSquare([1, 2]); + var iterator2 = iterator1[Symbol.iterator](); // call the factory function + t.notEqual(iterator1, iterator2, 'returns new iterator'); + t.end(); +}); + +tape('the factory function returns an iterator that generates the same sequence', function test(t) { + var iterator1 = iterCartesianSquare([1, 2]); + var iterator2 = iterator1[Symbol.iterator](); // call the factory function + var result1 = []; + var result2 = []; + var next1; + var next2; + + next1 = iterator1.next(); + while (!next1.done) { + result1.push(next1.value); + next1 = iterator1.next(); + } + + next2 = iterator2.next(); + while (!next2.done) { + result2.push(next2.value); + next2 = iterator2.next(); + } + + t.deepEqual(result1, result2, 'returns iterator that generates the same sequence'); + t.end(); +});