benchmark.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 Float64Array = require( '@stdlib/array/float64' );
var ndarrayBase = require( '@stdlib/ndarray/base/ctor' );
var ndarray = require( '@stdlib/ndarray/ctor' );
var isndarrayLike = require( '@stdlib/assert/is-ndarray-like' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var atleastnd = require( './../lib' );


// MAIN //

bench( format( '%s::base_ndarray:ndims=2', pkg ), function benchmark( b ) {
	var values;
	var buffer;
	var offset;
	var dtype;
	var order;
	var out;
	var i;

	dtype = 'float64';
	buffer = new Float64Array( 12 );
	offset = 0;
	order = 'row-major';

	values = [
		ndarrayBase( dtype, buffer, [ 3, 2, 2 ], [ 4, 2, 1 ], offset, order ),
		ndarrayBase( dtype, buffer, [ 4, 3 ], [ 3, 1 ], offset, order ),
		ndarrayBase( dtype, buffer, [ 12 ], [ 1 ], offset, order )
	];

	b.tic();
	for ( i = 0; i < b.iterations; i++ ) {
		out = atleastnd( 2, [ 10.0, values[ i%values.length ] ] );
		if ( typeof out !== 'object' ) {
			b.fail( 'should return an object' );
		}
	}
	b.toc();
	if ( !isndarrayLike( out[ 0 ] ) || !isndarrayLike( out[ 1 ] ) ) {
		b.fail( 'should return an array of ndarrays' );
	}
	b.pass( 'benchmark finished' );
	b.end();
});

bench( format( '%s::ndarray:ndims=2', pkg ), function benchmark( b ) {
	var values;
	var buffer;
	var offset;
	var dtype;
	var order;
	var out;
	var i;

	dtype = 'float64';
	buffer = new Float64Array( 12 );
	offset = 0;
	order = 'row-major';

	values = [
		ndarray( dtype, buffer, [ 3, 2, 2 ], [ 4, 2, 1 ], offset, order ),
		ndarray( dtype, buffer, [ 4, 3 ], [ 3, 1 ], offset, order ),
		ndarray( dtype, buffer, [ 12 ], [ 1 ], offset, order )
	];

	b.tic();
	for ( i = 0; i < b.iterations; i++ ) {
		out = atleastnd( 2, [ 10.0, values[ i%values.length ] ] );
		if ( typeof out !== 'object' ) {
			b.fail( 'should return an object' );
		}
	}
	b.toc();
	if ( !isndarrayLike( out[ 0 ] ) || !isndarrayLike( out[ 1 ] ) ) {
		b.fail( 'should return an array of ndarrays' );
	}
	b.pass( 'benchmark finished' );
	b.end();
});