test.js

/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 minViewBufferIndex = require( './../lib' );


// TESTS //

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

tape( 'the function computes the minimum linear index in an underlying array buffer which is accessible to an array view', function test( t ) {
	var strides;
	var offset;
	var shape;
	var idx;

	shape = [ 3, 2 ];

	strides = [ 2, 1 ];
	offset = 0;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ -2, 1 ];
	offset = 4;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ 2, -1 ];
	offset = 1;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ -2, -1 ];
	offset = 5;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ 1, 3 ];
	offset = 0;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ -1, 3 ];
	offset = 2;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ 1, -3 ];
	offset = 3;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ -1, -3 ];
	offset = 5;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	// 3d array...
	shape = [ 2, 3, 10 ];

	strides = [ 30, 10, 1 ];
	offset = 0;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	strides = [ 30, -10, 1 ];
	offset = 20;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 0, 'returns expected value' );

	t.end();
});

tape( 'the function computes the minimum linear index in an underlying array buffer which is accessible to an array view (buffer offset)', function test( t ) {
	var strides;
	var offset;
	var shape;
	var idx;

	shape = [ 3, 2 ];

	strides = [ 2, 1 ];
	offset = 10;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 10, 'returns expected value' );

	strides = [ -2, 1 ];
	offset = 14;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 10, 'returns expected value' );

	strides = [ 2, -1 ];
	offset = 11;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 10, 'returns expected value' );

	strides = [ -2, -1 ];
	offset = 15;
	idx = minViewBufferIndex( shape, strides, offset );
	t.strictEqual( idx, 10, 'returns expected value' );

	t.end();
});