All files / output-order/lib main.js

72.6% Statements 53/73
100% Branches 1/1
0% Functions 0/1
72.6% Lines 53/73

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 741x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x                                         1x 1x 1x 1x 1x  
/**
* @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 getOrder = require( '@stdlib/ndarray/base/order' );
var defaults = require( '@stdlib/ndarray/defaults' );
 
 
// VARIABLES //
 
var DEFAULT_ORDER = defaults.get( 'order' );
 
 
// MAIN //
 
/**
* Resolves the order (i.e. memory layout) of an output ndarray according to a list of input ndarrays.
*
* @param {ArrayLikeObject<ndarrayLike>} arrays - list of input ndarrays
* @returns {string} storage layout
*
* @example
* var zeros = require( '@stdlib/ndarray/zeros' );
*
* var x = zeros( [ 2, 2 ] );
* var y = zeros( [ 2, 2 ] );
*
* var order = outputOrder( [ x, y ] );
* // returns <string>
*/
function outputOrder( arrays ) {
	var N;
	var o;
	var i;

	N = arrays.length;
	if ( N === 0 ) {
		return DEFAULT_ORDER;
	}
	// Resolve the order of the first ndarray:
	o = getOrder( arrays[ 0 ] );

	// If a subsequent input ndarray has a different order, return the default memory layout...
	for ( i = 1; i < N; i++ ) {
		if ( getOrder( arrays[ i ] ) !== o ) {
			return DEFAULT_ORDER;
		}
	}
	return o;
}
 
 
// EXPORTS //
 
module.exports = outputOrder;