All files / fill-between/lib broadcast_index.js

87.5% Statements 49/56
100% Branches 1/1
0% Functions 0/1
87.5% Lines 49/56

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 571x 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 isInteger = require( '@stdlib/assert/is-integer' ).isPrimitive;
var broadcastScalar = require( '@stdlib/ndarray/base/broadcast-scalar' );
var maybeBroadcastArray = require( '@stdlib/ndarray/base/maybe-broadcast-array' );
var getDefault = require( '@stdlib/ndarray/defaults' ).get;
 
 
// VARIABLES //
 
var DEFAULT_DTYPE = getDefault( 'dtypes.integer_index' );
 
 
// MAIN //
 
/**
* Broadcasts an index argument to match the shape of the non-core dimensions.
*
* @private
* @param {(ndarray|NonNegativeInteger)} idx - index argument
* @param {NonNegativeIntegerArray} shape - shape of the non-core dimensions
* @param {string} order - memory layout order
* @returns {ndarray} ndarray containing index values
*/
function broadcastIndex( idx, shape, order ) {
	// FIXME: this breaks for large integer/array sizes (e.g., casting idx > 2^32 to int32). We also need to update in the future to accommodate 64-bit integer values.
	if ( isInteger( idx ) ) {
		return broadcastScalar( idx, DEFAULT_DTYPE, shape, order );
	}
	return maybeBroadcastArray( idx, shape );
}
 
 
// EXPORTS //
 
module.exports = broadcastIndex;