All files normalizeslices.js

100% Statements 67/67
100% Branches 4/4
100% Functions 1/1
100% Lines 67/67

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 681x 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 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 127x 21x 21x 50x 127x 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 args2multislice = require( '@stdlib/slice/base/args2multislice' );
var normalizeMultiSlice = require( '@stdlib/slice/base/normalize-multi-slice' );
var getShape = require( '@stdlib/ndarray/shape' );
var filled = require( '@stdlib/array/filled' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
 
 
// MAIN //
 
/**
* Returns normalized slice regions for a list of slices along a specified dimension.
*
* @private
* @param {ndarray} x - input array
* @param {Array<(Slice|integer|null|void)>} sliceList - list of slices
* @param {integer} dim - dimension along which to normalize slices
* @throws {RangeError} slice exceeds array bounds
* @returns {Array<Slice>} array of normalized slices
*/
function normalizeSlices( x, sliceList, dim ) {
	var sh;
	var ms;
	var S;
 
	sh = getShape( x );
 
	// Create a "shape" for the express purpose of validating each of the slice arguments:
	sh = filled( sh[ dim ], sliceList.length, 'generic' );
 
	// Create an un-normalized multislice:
	ms = args2multislice( sliceList );
 
	// Normalize the multislice:
	S = normalizeMultiSlice( ms, sh, true );
	if ( S.code ) {
		throw new RangeError( format( 'invalid argument. Slice exceeds array bounds. Array shape: (%s).', join( sh, ',' ) ) );
	}
	return S.data;
}
 
 
// EXPORTS //
 
module.exports = normalizeSlices;