All files / complement-shape/lib main.js

84.9% Statements 45/53
100% Branches 1/1
0% Functions 0/1
84.9% Lines 45/53

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 541x 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) 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 normalizeIndices = require( '@stdlib/ndarray/base/to-unique-normalized-indices' );
var indicesComplement = require( '@stdlib/array/base/indices-complement' );
var takeIndexed = require( '@stdlib/array/base/take-indexed' );
 
 
// MAIN //
 
/**
* Returns the shape defined by the dimensions which are **not** included in a list of dimensions.
*
* @param {NonNegativeIntegerArray} shape - input shape
* @param {IntegerArray} dims - list of dimensions
* @returns {NonNegativeIntegerArray} shape
*
* @example
* var sh = complementShape( [ 3, 2 ], [ 0 ] );
* // returns [ 2 ]
*/
function complementShape( shape, dims ) {
	var ind = normalizeIndices( dims, shape.length-1 );
	if ( ind === null ) {
		// Note: this is an error condition, as `null` is returned when provided out-of-bounds indices...
		return [];
	}
	return takeIndexed( shape, indicesComplement( shape.length, ind ) );
}
 
 
// EXPORTS //
 
module.exports = complementShape;