benchmark.ndarray.js

/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 Complex64Array = require( '@stdlib/array/complex64' );
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
var floor = require( '@stdlib/math/base/special/floor' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var claswp = require( './../lib/ndarray.js' );


// VARIABLES //

var LAYOUTS = [
	'row-major',
	'column-major'
];
var opts = {
	'dtype': 'float32'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {string} order - storage layout
* @param {PositiveInteger} N - number of elements along each dimension
* @param {PositiveInteger} nrows - number of rows to interchange
* @returns {Function} benchmark function
*/
function createBenchmark( order, N, nrows ) {
	var IPIV;
	var abuf;
	var sa1;
	var sa2;
	var A;

	if ( isColumnMajor( order ) ) {
		sa1 = 1;
		sa2 = N;
	} else { // order === 'row-major'
		sa1 = N;
		sa2 = 1;
	}
	IPIV = discreteUniform( nrows, 0, N-1, {
		'dtype': 'int32'
	});

	abuf = uniform( 2*N*N, -10.0, 10.0, opts );
	A = new Complex64Array( abuf );

	return benchmark;

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

		b.tic();
		for ( i = 0; i < b.iterations; i++ ) {
			claswp( N, A, sa1, sa2, 0, 0, nrows-1, 1, IPIV, 1, 0 );
			if ( isnanf( abuf[ i%abuf.length ] ) ) {
				b.fail( 'should not return NaN' );
			}
		}
		b.toc();
		if ( isnanf( abuf[ i%abuf.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 j;
	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 ) );
			j = 1;
			while ( j <= N ) {
				f = createBenchmark( ord, N, j );
				bench( format( '%s::square_matrix:ndarray:order=%s,nrows=%d,size=%d', pkg, ord, j, N*N ), f );
				j *= 2;
			}
		}
	}
}

main();