test.js

/**
* @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 toAccessorArray = require( '@stdlib/array/base/to-accessor-array' );
var cartesianSquare = require( './../lib' );


// TESTS //

tape( 'main export is a function', function test( t ) {
	t.ok( true, __filename );
	t.strictEqual( typeof cartesianSquare, 'function', 'main export is a function' );
	t.end();
});

tape( 'the function throws an error if not provided a collection', function test( t ) {
	var values;
	var i;

	values = [
		'5',
		5,
		NaN,
		true,
		false,
		null,
		void 0,
		{},
		function noop() {}
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			cartesianSquare( value );
		};
	}
});

tape( 'the function returns the Cartesian square (indexed)', function test( t ) {
	var expected;
	var actual;

	actual = cartesianSquare( [ 1, 2 ] );
	expected = [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ];
	t.deepEqual( actual, expected, 'returns expected value' );

	actual = cartesianSquare( [ 1 ] );
	expected = [ [ 1, 1 ] ];
	t.deepEqual( actual, expected, 'returns expected value' );

	actual = cartesianSquare( [ 1, 2, 3 ] );
	expected = [
		[ 1, 1 ],
		[ 1, 2 ],
		[ 1, 3 ],
		[ 2, 1 ],
		[ 2, 2 ],
		[ 2, 3 ],
		[ 3, 1 ],
		[ 3, 2 ],
		[ 3, 3 ]
	];
	t.deepEqual( actual, expected, 'returns expected value' );

	t.end();
});

tape( 'the function returns the Cartesian square (accessors)', function test( t ) {
	var expected;
	var actual;

	actual = cartesianSquare( toAccessorArray( [ 1, 2 ] ) );
	expected = [ [ 1, 1 ], [ 1, 2 ], [ 2, 1 ], [ 2, 2 ] ];
	t.deepEqual( actual, expected, 'returns expected value' );

	actual = cartesianSquare( toAccessorArray( [ 1 ] ) );
	expected = [ [ 1, 1 ] ];
	t.deepEqual( actual, expected, 'returns expected value' );

	actual = cartesianSquare( toAccessorArray( [ 1, 2, 3 ] ) );
	expected = [
		[ 1, 1 ],
		[ 1, 2 ],
		[ 1, 3 ],
		[ 2, 1 ],
		[ 2, 2 ],
		[ 2, 3 ],
		[ 3, 1 ],
		[ 3, 2 ],
		[ 3, 3 ]
	];
	t.deepEqual( actual, expected, 'returns expected value' );

	t.end();
});

tape( 'the function returns an empty array if provided an empty array (indexed)', function test( t ) {
	var actual;

	actual = cartesianSquare( [] );
	t.deepEqual( actual, [], 'returns expected value' );

	t.end();
});

tape( 'the function returns an empty array if provided an empty array (accessors)', function test( t ) {
	var actual;

	actual = cartesianSquare( toAccessorArray( [] ) );
	t.deepEqual( actual, [], 'returns expected value' );

	t.end();
});