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 constructorName = require( '@stdlib/utils/constructor-name' );
var Int8Array = require( '@stdlib/array/int8' );
var Uint8Array = require( '@stdlib/array/uint8' );
var Uint8ClampedArray = require( '@stdlib/array/uint8c' );
var Int16Array = require( '@stdlib/array/int16' );
var Uint16Array = require( '@stdlib/array/uint16' );
var Int32Array = require( '@stdlib/array/int32' );
var Uint32Array = require( '@stdlib/array/uint32' );
var Float32Array = require( '@stdlib/array/float32' );
var Float64Array = require( '@stdlib/array/float64' );
var Complex128Array = require( '@stdlib/array/complex128' );
var Complex64Array = require( '@stdlib/array/complex64' );
var allocUnsafe = require( '@stdlib/buffer/alloc-unsafe' );
var isComplex128Array = require( './../lib' );


// TESTS //

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

tape( 'the function returns `true` if provided a Complex128Array', function test( t ) {
	var values;
	var i;

	values = [
		new Complex128Array( 20 ),
		new Complex128Array( 10 )
	];

	for ( i = 0; i < values.length; i++ ) {
		t.strictEqual( isComplex128Array( values[i] ), true, 'returns expected value when provided '+constructorName( values[i] ) );
	}
	t.end();
});

tape( 'the function returns `false` if not provided a Complex128Array', function test( t ) {
	var values;
	var i;

	values = [
		void 0,
		null,
		{},
		[],
		{ 'length': 10 }, // eslint-disable-line object-curly-newline
		new Float64Array( 10 ),
		new Float32Array( 10 ),
		new Int32Array( 10 ),
		new Uint32Array( 10 ),
		new Int16Array( 10 ),
		new Uint16Array( 10 ),
		new Int8Array( 10 ),
		new Uint8Array( 10 ),
		new Uint8ClampedArray( 10 ),
		new Complex64Array( 10 ),
		allocUnsafe( 10 )
	];

	for ( i = 0; i < values.length; i++ ) {
		t.strictEqual( isComplex128Array( values[i] ), false, 'returns expected value when provided '+constructorName( values[i] ) );
	}
	t.end();
});