test.get.integer_array.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 hasProxySupport = require( '@stdlib/assert/has-proxy-support' );
var Int32Array = require( '@stdlib/array/int32' );
var array2fancy = require( './../lib' );


// VARIABLES //

var opts = {
	'skip': !hasProxySupport()
};


// TESTS //

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

tape( 'the function returns an array-like object supporting integer array indexing (generic)', opts, function test( t ) {
	var expected;
	var actual;
	var idx;
	var x;
	var y;

	x = [ 1, 2, 3, 4 ];
	y = array2fancy( x );

	idx = array2fancy.idx( [ 0, 1, 2, 3 ] );
	expected = [ 1, 2, 3, 4 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [ 3, 1, 2, 0, 0, 1 ] );
	expected = [ 4, 2, 3, 1, 1, 2 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [] );
	expected = [];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [] ) );
	expected = [];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [ 0, 1 ] );
	expected = [ 1, 2 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [ 1, 2 ] ) );
	expected = [ 2, 3 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [ 0, 2 ] ) );
	expected = [ 1, 3 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [ -1, -3 ] ) );
	expected = [ 4, 2 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	t.end();
});

tape( 'the function returns an array-like object integer array indexing (typed)', opts, function test( t ) {
	var expected;
	var actual;
	var idx;
	var x;
	var y;

	x = new Int32Array( [ 1, 2, 3, 4 ] );
	y = array2fancy( x );

	idx = array2fancy.idx( [ 0, 1, 2, 3 ] );
	expected = new Int32Array( [ 1, 2, 3, 4 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [ 3, 1, 2, 0, 0, 1 ] );
	expected = new Int32Array( [ 4, 2, 3, 1, 1, 2 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [] );
	expected = [];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [] ) );
	expected = [];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [ 0, 1 ] );
	expected = new Int32Array( [ 1, 2 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( [ 1, 2 ] );
	expected = new Int32Array( [ 2, 3 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [ 0, 2 ] ) );
	expected = new Int32Array( [ 1, 3 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	idx = array2fancy.idx( new Int32Array( [ -1, -3 ] ) );
	expected = new Int32Array( [ 4, 2 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	t.end();
});

tape( 'by default, the function returns an array-like object which throws an error when provided an index which is out-of-bounds (generic)', opts, function test( t ) {
	var values;
	var x;
	var y;
	var i;

	x = [ 1, 2, 3, 4 ];
	y = array2fancy( x );

	values = [
		array2fancy.idx( [ 10, 20 ] ),
		array2fancy.idx( [ -20, -10 ] ),
		array2fancy.idx( new Int32Array( [ -20] ) )
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), RangeError, 'throws an error' );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			var v = y[ value ]; // eslint-disable-line no-unused-vars
		};
	}
});

tape( 'by default, the function returns an array-like object which throws an error when provided an index which is out-of-bounds (typed)', opts, function test( t ) {
	var values;
	var x;
	var y;
	var i;

	x = new Int32Array( [ 1, 2, 3, 4 ] );
	y = array2fancy( x );

	values = [
		array2fancy.idx( [ 10, 20 ] ),
		array2fancy.idx( [ -20, -10 ] ),
		array2fancy.idx( new Int32Array( [ -20] ) )
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), RangeError, 'throws an error' );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			var v = y[ value ]; // eslint-disable-line no-unused-vars
		};
	}
});

tape( 'when `strict` is `false`, the function returns an array-like object which throws an error when provided an index which is out-of-bounds (generic)', opts, function test( t ) {
	var values;
	var x;
	var y;
	var i;

	x = [ 1, 2, 3, 4 ];
	y = array2fancy( x, {
		'strict': false
	});

	values = [
		array2fancy.idx( [ 10, 20 ] ),
		array2fancy.idx( [ -20, -10 ] ),
		array2fancy.idx( new Int32Array( [ -20] ) )
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), RangeError, 'throws an error' );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			var v = y[ value ]; // eslint-disable-line no-unused-vars
		};
	}
});

tape( 'when `strict` is `false`, the function returns an array-like object which throws an error when provided an index which is out-of-bounds (typed)', opts, function test( t ) {
	var values;
	var x;
	var y;
	var i;

	x = new Int32Array( [ 1, 2, 3, 4 ] );
	y = array2fancy( x, {
		'strict': false
	});

	values = [
		array2fancy.idx( [ 10, 20 ] ),
		array2fancy.idx( [ -20, -10 ] ),
		array2fancy.idx( new Int32Array( [ -20] ) )
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), RangeError, 'throws an error' );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			var v = y[ value ]; // eslint-disable-line no-unused-vars
		};
	}
});

tape( 'when `strict` is `true`, the function returns an array-like object which throws an error when provided an index which is out-of-bounds (generic)', opts, function test( t ) {
	var values;
	var x;
	var y;
	var i;

	x = [ 1, 2, 3, 4 ];
	y = array2fancy( x, {
		'strict': true
	});

	values = [
		array2fancy.idx( [ 10, 20 ] ),
		array2fancy.idx( [ -20, -10 ] ),
		array2fancy.idx( new Int32Array( [ -20] ) )
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), RangeError, 'throws an error' );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			var v = y[ value ]; // eslint-disable-line no-unused-vars
		};
	}
});

tape( 'when `strict` is `true`, the function returns an array-like object which throws an error when provided an index which is out-of-bounds (typed)', opts, function test( t ) {
	var values;
	var x;
	var y;
	var i;

	x = new Int32Array( [ 1, 2, 3, 4 ] );
	y = array2fancy( x, {
		'strict': true
	});

	values = [
		array2fancy.idx( [ 10, 20 ] ),
		array2fancy.idx( [ -20, -10 ] ),
		array2fancy.idx( new Int32Array( [ -20] ) )
	];
	for ( i = 0; i < values.length; i++ ) {
		t.throws( badValue( values[ i ] ), RangeError, 'throws an error' );
	}
	t.end();

	function badValue( value ) {
		return function badValue() {
			var v = y[ value ]; // eslint-disable-line no-unused-vars
		};
	}
});

tape( 'the function returns an array-like object integer array indexing which can themselves support integer arrays (generic)', opts, function test( t ) {
	var expected;
	var actual;
	var idx;
	var x;
	var y;
	var z;

	x = [ 1, 2, 3, 4 ];
	y = array2fancy( x );

	idx = array2fancy.idx( [ 0, 1, 2, 3 ] );
	expected = [ 1, 2, 3, 4 ];
	actual = y[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	z = actual;

	idx = array2fancy.idx( [ -4, -2 ] );
	expected = [ 1, 3 ];
	actual = z[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.notEqual( actual, z, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	z = actual;

	idx = array2fancy.idx( new Int32Array( [ 1, 0 ] ) );
	expected = [ 3, 1 ];
	actual = z[ idx ];

	t.strictEqual( actual instanceof Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.notEqual( actual, z, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	t.end();
});

tape( 'the function returns an array-like object integer array indexing which can themselves support integer arrays (typed)', opts, function test( t ) {
	var expected;
	var actual;
	var idx;
	var x;
	var y;
	var z;

	x = new Int32Array( [ 1, 2, 3, 4 ] );
	y = array2fancy( x );

	idx = array2fancy.idx( [ 0, 1, 2, 3 ] );
	expected = new Int32Array( [ 1, 2, 3, 4 ] );
	actual = y[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	z = actual;

	idx = array2fancy.idx( [ -4, -2 ] );
	expected = new Int32Array( [ 1, 3 ] );
	actual = z[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.notEqual( actual, z, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	z = actual;

	idx = array2fancy.idx( new Int32Array( [ 1, 0 ] ) );
	expected = new Int32Array( [ 3, 1 ] );
	actual = z[ idx ];

	t.strictEqual( actual instanceof Int32Array, true, 'returns expected value' );
	t.notEqual( actual, x, 'different reference' );
	t.notEqual( actual, y, 'different reference' );
	t.notEqual( actual, z, 'different reference' );
	t.deepEqual( actual, expected, 'returns expected value' );

	t.end();
});