feat: add ndarray/base/complement-shape

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: passed
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: passed
  - task: lint_license_headers
    status: passed
---

Author: kgryte

lib/node_modules/@stdlib/ndarray/base/complement-shape/README.md

@@ -0,0 +1,124 @@
+<!--
+
+@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.
+
+-->
+
+# complementShape
+
+> Return the shape defined by the dimensions which are not included in a list of dimensions.
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- Package usage documentation. -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var complementShape = require( '@stdlib/ndarray/base/complement-shape' );
+```
+
+#### complementShape( shape, dims )
+
+Returns the shape defined by the dimensions which are not included in a list of dimensions.
+
+```javascript
+var sh = complementShape( [ 3, 2 ], [ -1 ] );
+// returns [ 3 ]
+```
+
+The function accepts the following parameters:
+
+-   **shape**: array shape.
+-   **dims**: list of dimensions.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- Package usage examples. -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var zip = require( '@stdlib/array/base/zip' );
+var filled = require( '@stdlib/array/base/filled' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var complementShape = require( '@stdlib/ndarray/base/complement-shape' );
+
+var opts = {
+    'dtype': 'int32'
+};
+var d1 = discreteUniform( 100, 1, 10, opts );
+var d2 = discreteUniform( d1.length, 1, 10, opts );
+var d3 = discreteUniform( d1.length, 1, 10, opts );
+var d4 = discreteUniform( d1.length, 1, 10, opts );
+
+var dims = discreteUniform( 2, -4, 3, opts );
+var shapes = zip( [ d1, d2, d3, d4 ] );
+
+logEachMap( 'shape: (%s). dims: (%s). complement: (%s).', shapes, filled( dims, d1.length ), complementShape );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+</section>
+
+<!-- /.references -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/ndarray/base/complement-shape/benchmark/benchmark.js

@@ -0,0 +1,55 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var isArray = require( '@stdlib/assert/is-array' );
+var pkg = require( './../package.json' ).name;
+var complementShape = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var shape;
+	var out;
+	var i;
+
+	shape = discreteUniform( 5, 1, 10, {
+		'dtype': 'generic'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		shape[ 0 ] += 1;
+		out = complementShape( shape, [ -1, -2, -4 ] );
+		if ( out.length !== 2 ) {
+			b.fail( 'should have expected length' );
+		}
+	}
+	b.toc();
+	if ( !isArray( out ) ) {
+		b.fail( 'should return an array' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/ndarray/base/complement-shape/docs/repl.txt

@@ -0,0 +1,27 @@
+
+{{alias}}( shape, dims )
+    Returns the shape defined by the dimensions which are not included in a list
+    of dimensions.
+
+    Parameters
+    ----------
+    shape: ArrayLike<number>
+        Array shape.
+
+    dims: ArrayLike<number>
+        List of dimensions.
+
+    Returns
+    -------
+    out: Array<number>
+        Output shape.
+
+    Examples
+    --------
+    > var sh = [ 3, 2 ];
+    > var out = {{alias}}( sh, [ 1 ] )
+    [ 3 ]
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/ndarray/base/complement-shape/docs/types/index.d.ts

@@ -0,0 +1,56 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/// <reference types="@stdlib/types"/>
+
+import { Collection } from '@stdlib/types/array';
+
+/**
+* Returns the shape defined by the dimensions which are not included in a list of dimensions.
+*
+* @param shape - array shape
+* @param dims - list of dimensions
+* @returns output shape
+*
+* @example
+* var sh = complementShape( [ 3, 2 ], [ -1 ] );
+* // returns [ 3 ]
+*
+* sh = complementShape( [ 3, 2, 1 ], [ -2 ] );
+* // returns [ 3, 1 ]
+*
+* sh = complementShape( [ 3 ], [ 0 ] );
+* // returns []
+*
+* sh = complementShape( [ 3, 2 ], [ 0 ] );
+* // returns [ 2 ]
+*
+* sh = complementShape( [ 3 ], [ 0 ] );
+* // returns []
+*
+* sh = complementShape( [], [] );
+* // returns []
+*/
+declare function complementShape( shape: Collection<number>, dims: Collection<number> ): Array<number>;
+
+
+// EXPORTS //
+
+export = complementShape;

lib/node_modules/@stdlib/ndarray/base/complement-shape/docs/types/test.ts

@@ -0,0 +1,59 @@
+/*
+* @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.
+*/
+
+import complementShape = require( './index' );
+
+
+// TESTS //
+
+// The function returns an array of numbers...
+{
+	complementShape( [ 3, 2, 1 ], [ -1 ] ); // $ExpectType number[]
+}
+
+// The compiler throws an error if the function is provided a first argument that is not an array-like object containing numbers...
+{
+	complementShape( true, [ -1 ] ); // $ExpectError
+	complementShape( false, [ -1 ] ); // $ExpectError
+	complementShape( null, [ -1 ] ); // $ExpectError
+	complementShape( undefined, [ -1 ] ); // $ExpectError
+	complementShape( '5', [ -1 ] ); // $ExpectError
+	complementShape( [ '1', '2' ], [ -1 ] ); // $ExpectError
+	complementShape( {}, [ -1 ] ); // $ExpectError
+	complementShape( ( x: number ): number => x, [ -1 ] ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a second argument that is not an array-like object containing numbers...
+{
+	complementShape( [ 2, 3 ], 5 ); // $ExpectError
+	complementShape( [ 2, 3 ], true ); // $ExpectError
+	complementShape( [ 2, 3 ], false ); // $ExpectError
+	complementShape( [ 2, 3 ], null ); // $ExpectError
+	complementShape( [ 2, 3 ], undefined ); // $ExpectError
+	complementShape( [ 2, 3 ], '5' ); // $ExpectError
+	complementShape( [ 2, 3 ], [ '1', '2' ] ); // $ExpectError
+	complementShape( [ 2, 3 ], {} ); // $ExpectError
+	complementShape( [ 2, 3 ], ( x: number ): number => x ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an unsupported number of arguments...
+{
+	complementShape(); // $ExpectError
+	complementShape( [ 3, 2 ] ); // $ExpectError
+	complementShape( [ 3, 2 ], [ -1 ], 0 ); // $ExpectError
+}

lib/node_modules/@stdlib/ndarray/base/complement-shape/examples/index.js

@@ -0,0 +1,38 @@
+/**
+* @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';
+
+var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
+var zip = require( '@stdlib/array/base/zip' );
+var filled = require( '@stdlib/array/base/filled' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var complementShape = require( './../lib' );
+
+var opts = {
+	'dtype': 'int32'
+};
+var d1 = discreteUniform( 100, 1, 10, opts );
+var d2 = discreteUniform( d1.length, 1, 10, opts );
+var d3 = discreteUniform( d1.length, 1, 10, opts );
+var d4 = discreteUniform( d1.length, 1, 10, opts );
+
+var dims = discreteUniform( 2, -4, 3, opts );
+var shapes = zip( [ d1, d2, d3, d4 ] );
+
+logEachMap( 'shape: (%s). dims: (%s). complement: (%s).', shapes, filled( dims, d1.length ), complementShape );