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 AccessorArray = require( '@stdlib/array/base/accessor' );
var Float64Array = require( '@stdlib/array/float64' );
var Complex64Array = require( '@stdlib/array/complex64' );
var Complex128Array = require( '@stdlib/array/complex128' );
var BooleanArray = require( '@stdlib/array/bool' );
var none = require( './../lib' );


// TESTS //

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

tape( 'if provided an empty collection, the function returns `true` (generic)', function test( t ) {
	var out;
	var arr;

	arr = [];
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'if provided an empty collection, the function returns `true` (real typed array)', function test( t ) {
	var out;
	var arr;

	arr = new Float64Array( [] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'if provided an empty collection, the function returns `true` (complex typed array)', function test( t ) {
	var out;
	var arr;

	arr = new Complex64Array( [] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );

	arr = new Complex128Array( [] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'if provided an empty collection, the function returns `true` (boolean array)', function test( t ) {
	var out;
	var arr;

	arr = new BooleanArray( [] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'if provided an empty collection, the function returns `true` (accessor)', function test( t ) {
	var out;
	var arr;

	arr = new AccessorArray( [] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `true` if all elements are falsy (generic)', function test( t ) {
	var out;
	var arr;

	arr = [ 0, 0, 0 ];
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `true` if all elements are falsy (real typed array)', function test( t ) {
	var out;
	var arr;

	arr = new Float64Array( [ 0.0, 0.0, 0.0 ] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `true` if all elements are falsy (complex typed array)', function test( t ) {
	var out;
	var arr;

	arr = new Complex64Array( [ 0.0, 0.0, 0.0, 0.0 ] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );

	arr = new Complex128Array( [ 0.0, 0.0, 0.0, 0.0 ] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `true` if all elements are falsy (boolean array)', function test( t ) {
	var out;
	var arr;

	arr = new BooleanArray( [ false, false, false, false ] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `true` if all elements are falsy (accessor)', function test( t ) {
	var out;
	var arr;

	arr = new AccessorArray( [ 0, 0, 0 ] );
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `true` if all elements are falsy (array-like object)', function test( t ) {
	var out;
	var arr;

	arr = {
		'length': 3,
		'0': 0,
		'1': 0,
		'2': 0
	};
	out = none( arr );

	t.strictEqual( out, true, 'returns expected value' );
	t.end();
});

tape( 'the function returns `false` if one or more elements are truthy (generic)', function test( t ) {
	var out;
	var arr;

	arr = [ 1, 0, 3 ];
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'the function returns `false` if one or more elements are truthy (real typed array)', function test( t ) {
	var out;
	var arr;

	arr = new Float64Array( [ 0.0, 0.0, 3.0 ] );
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'the function returns `false` if one or more elements are truthy (complex typed array)', function test( t ) {
	var out;
	var arr;

	arr = new Complex64Array( [ 1.0, 0.0, 0.0, 0.0 ] );
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );

	arr = new Complex128Array( [ 0.0, 0.0, 0.0, 4.0 ] );
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'the function returns `false` if one or more elements are truthy (boolean array)', function test( t ) {
	var out;
	var arr;

	arr = new BooleanArray( [ false, true, false, false ] );
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'the function returns `false` if one or more elements are truthy (accessor)', function test( t ) {
	var out;
	var arr;

	arr = new AccessorArray( [ 0, 0, 3 ] );
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'the function returns `false` if one or more elements are truthy (array-like object)', function test( t ) {
	var out;
	var arr;

	arr = {
		'length': 3,
		'0': 1,
		'1': 0,
		'2': 0
	};
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'when performing a linear scan, the function does not skip empty elements (generic)', function test( t ) {
	var out;
	var arr;

	arr = [ 0, , , 4 ]; // eslint-disable-line no-sparse-arrays
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});

tape( 'when performing a linear scan, the function does not skip empty elements (accessor)', function test( t ) {
	var out;
	var arr;

	arr = new AccessorArray( [ 0, , , 4 ] ); // eslint-disable-line no-sparse-arrays
	out = none( arr );

	t.strictEqual( out, false, 'returns expected value' );
	t.end();
});