test.js

/**
* @license Apache-2.0
*
* Copyright (c) 2023 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 add = require( '@stdlib/math/base/ops/add' );
var zeros4d = require( '@stdlib/array/base/zeros4d' );
var bbinary4d = require( './../lib' );


// TESTS //

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

tape( 'the function applies a provided callback to broadcasted input arrays and assigns results to a nested output array', function test( t ) {
	var expected;
	var shapes;
	var x;
	var y;
	var z;

	shapes = [
		[ 2 ],
		[ 2, 1 ],
		[ 2, 2, 2, 2 ]
	];
	x = [ 1.0, 2.0 ];
	y = [
		[ 3.0 ],
		[ 4.0 ]
	];
	z = zeros4d( shapes[ 2 ] );

	expected = [
		[
			[
				[ 4.0, 5.0 ],
				[ 5.0, 6.0 ]
			],
			[
				[ 4.0, 5.0 ],
				[ 5.0, 6.0 ]
			]
		],
		[
			[
				[ 4.0, 5.0 ],
				[ 5.0, 6.0 ]
			],
			[
				[ 4.0, 5.0 ],
				[ 5.0, 6.0 ]
			]
		]
	];
	bbinary4d( [ x, y, z ], shapes, add );
	t.deepEqual( z, expected, 'returns expected value' );

	shapes = [
		[ 1, 2 ],
		[ 2 ],
		[ 2, 2, 2, 2 ]
	];
	x = [
		[ 1.0, 2.0 ]
	];
	y = [ 3.0, 4.0 ];
	z = zeros4d( shapes[ 2 ] );

	expected = [
		[
			[
				[ 4.0, 6.0 ],
				[ 4.0, 6.0 ]
			],
			[
				[ 4.0, 6.0 ],
				[ 4.0, 6.0 ]
			]
		],
		[
			[
				[ 4.0, 6.0 ],
				[ 4.0, 6.0 ]
			],
			[
				[ 4.0, 6.0 ],
				[ 4.0, 6.0 ]
			]
		]
	];
	bbinary4d( [ x, y, z ], shapes, add );
	t.deepEqual( z, expected, 'returns expected value' );

	// Same shapes:
	shapes = [
		[ 2, 2, 2, 2 ],
		[ 2, 2, 2, 2 ],
		[ 2, 2, 2, 2 ]
	];
	x = [
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			],
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		],
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			],
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		]
	];
	y = [
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			],
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		],
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			],
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		]
	];
	z = zeros4d( shapes[ 2 ] );

	expected = [
		[
			[
				[ 2.0, 4.0 ],
				[ 6.0, 8.0 ]
			],
			[
				[ 2.0, 4.0 ],
				[ 6.0, 8.0 ]
			]
		],
		[
			[
				[ 2.0, 4.0 ],
				[ 6.0, 8.0 ]
			],
			[
				[ 2.0, 4.0 ],
				[ 6.0, 8.0 ]
			]
		]
	];
	bbinary4d( [ x, y, z ], shapes, add );
	t.deepEqual( z, expected, 'returns expected value' );

	t.end();
});

tape( 'the function does not invoke a provided callback if provided an output shape having a first element equal to zero', function test( t ) {
	var expected;
	var shapes;
	var x;
	var y;
	var z;

	shapes = [
		[ 1, 1, 2, 2 ],
		[ 1, 1, 2, 2 ],
		[ 0, 2, 2, 2 ]
	];
	x = [
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		]
	];
	y = x;
	z = zeros4d( [ 2, 2, 2, 2 ] );

	expected = zeros4d( [ 2, 2, 2, 2 ] );
	bbinary4d( [ x, y, z ], shapes, clbk );
	t.deepEqual( z, expected, 'returns expected value' );

	t.end();

	function clbk() {
		t.ok( false, 'should not invoke callback' );
	}
});

tape( 'the function does not invoke a provided callback if provided an output shape having a second element equal to zero', function test( t ) {
	var expected;
	var shapes;
	var x;
	var y;
	var z;

	shapes = [
		[ 1, 1, 2, 2 ],
		[ 1, 1, 2, 2 ],
		[ 2, 0, 2, 2 ]
	];
	x = [
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		]
	];
	y = x;
	z = zeros4d( [ 2, 2, 2, 2 ] );

	expected = zeros4d( [ 2, 2, 2, 2 ] );
	bbinary4d( [ x, y, z ], shapes, clbk );
	t.deepEqual( z, expected, 'returns expected value' );

	t.end();

	function clbk() {
		t.ok( false, 'should not invoke callback' );
	}
});

tape( 'the function does not invoke a provided callback if provided an output shape having a third element equal to zero', function test( t ) {
	var expected;
	var shapes;
	var x;
	var y;
	var z;

	shapes = [
		[ 1, 1, 2, 2 ],
		[ 1, 1, 2, 2 ],
		[ 2, 2, 0, 2 ]
	];
	x = [
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		]
	];
	y = x;
	z = zeros4d( [ 2, 2, 2, 2 ] );

	expected = zeros4d( [ 2, 2, 2, 2 ] );
	bbinary4d( [ x, y, z ], shapes, clbk );
	t.deepEqual( z, expected, 'returns expected value' );

	t.end();

	function clbk() {
		t.ok( false, 'should not invoke callback' );
	}
});

tape( 'the function does not invoke a provided callback if provided an output shape having a four element equal to zero', function test( t ) {
	var expected;
	var shapes;
	var x;
	var y;
	var z;

	shapes = [
		[ 1, 1, 2, 2 ],
		[ 1, 1, 2, 2 ],
		[ 2, 2, 2, 0 ]
	];
	x = [
		[
			[
				[ 1.0, 2.0 ],
				[ 3.0, 4.0 ]
			]
		]
	];
	y = x;
	z = zeros4d( [ 2, 2, 2, 2 ] );

	expected = zeros4d( [ 2, 2, 2, 2 ] );
	bbinary4d( [ x, y, z ], shapes, clbk );
	t.deepEqual( z, expected, 'returns expected value' );

	t.end();

	function clbk() {
		t.ok( false, 'should not invoke callback' );
	}
});