benchmark.ndarray.js

/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var floor = require( '@stdlib/math/base/special/floor' );
var Int32Array = require( '@stdlib/array/int32' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var dgetc2 = require( './../lib/ndarray.js' );


// VARIABLES //

var LAYOUTS = [
	'row-major',
	'column-major'
];


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {string} order - storage layout
* @param {PositiveInteger} N - matrix order (N-by-N)
* @returns {Function} benchmark function
*/
function createBenchmark( order, N ) {
	var IPIV;
	var JPIV;
	var sa1;
	var sa2;
	var A;

	if ( isColumnMajor( order ) ) {
		sa1 = 1;
		sa2 = N;
	} else {
		sa1 = N;
		sa2 = 1;
	}

	A = uniform( N*N, -1.0, 1.0, {
		'dtype': 'float64'
	});
	IPIV = new Int32Array( N );
	JPIV = new Int32Array( N );

	return benchmark;

	/**
	* Benchmark function.
	*
	* @private
	* @param {Benchmark} b - benchmark instance
	*/
	function benchmark( b ) {
		var i;

		b.tic();
		for ( i = 0; i < b.iterations; i++ ) {
			dgetc2( N, A, sa1, sa2, 0, IPIV, 1, 0, JPIV, 1, 0 );
			if ( isnan( A[ i%A.length ] ) ) {
				b.fail( 'should not return NaN' );
			}
		}
		b.toc();
		if ( isnan( A[ i%A.length ] ) ) {
			b.fail( 'should not return NaN' );
		}
		b.pass( 'benchmark finished' );
		b.end();
	}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
	var min;
	var max;
	var ord;
	var N;
	var f;
	var i;
	var k;

	min = 1; // 10^min
	max = 6; // 10^max

	for ( k = 0; k < LAYOUTS.length; k++ ) {
		ord = LAYOUTS[ k ];
		for ( i = min; i <= max; i++ ) {
			N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
			f = createBenchmark( ord, N );
			bench( format( '%s:ndarray:order=%s,size=%d', pkg, ord, (N*N) ), f );
		}
	}
}

main();