Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -4,12 +4,14 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2025-11-13)
+## Unreleased (2025-11-15)
 
 <section class="features">
 
 ### Features
 
+- [`4b6f051`](https://github.com/stdlib-js/stdlib/commit/4b6f0510d4773574101122924f20cb4d987c2b38) - add `complementShape` to namespace
+- [`903f141`](https://github.com/stdlib-js/stdlib/commit/903f1415351afbabd33b859b0888ad2daa02ecc0) - add `ndarray/base/complement-shape`
 - [`ba6c568`](https://github.com/stdlib-js/stdlib/commit/ba6c568030bf47a3b8c8b2297e5d87fc093ed93b) - add `toReversed` to namespace
 - [`853fe75`](https://github.com/stdlib-js/stdlib/commit/853fe75bce7b8374fd7545c493cc89391b20636f) - add `shift` to namespace
 - [`e7715c7`](https://github.com/stdlib-js/stdlib/commit/e7715c7f1f74f3734ba9b7d5d367ea02b415b66e) - add `reverseDimension` to namespace
@@ -638,6 +640,8 @@ A total of 33 issues were closed in this release:
 
 <details>
 
+- [`4b6f051`](https://github.com/stdlib-js/stdlib/commit/4b6f0510d4773574101122924f20cb4d987c2b38) - **feat:** add `complementShape` to namespace _(by Athan Reines)_
+- [`903f141`](https://github.com/stdlib-js/stdlib/commit/903f1415351afbabd33b859b0888ad2daa02ecc0) - **feat:** add `ndarray/base/complement-shape` _(by Athan Reines)_
 - [`37b26e6`](https://github.com/stdlib-js/stdlib/commit/37b26e6c62ada82439096f343c855bf1e80ef438) - **chore:** fix JavaScript lint errors [(#8519)](https://github.com/stdlib-js/stdlib/pull/8519) _(by kaushal-kumar-it, Athan Reines)_
 - [`c934b79`](https://github.com/stdlib-js/stdlib/commit/c934b79b7fef69aa707c58f8042648e3c7aa5925) - **docs:** update namespace table of contents [(#8517)](https://github.com/stdlib-js/stdlib/pull/8517) _(by stdlib-bot)_
 - [`037800a`](https://github.com/stdlib-js/stdlib/commit/037800a4294184df000d19e2ded62351016dce42) - **test:** use assertion utility and update example _(by Athan Reines)_

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 -->

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();
+});

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
+ --------
+

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;

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
+}

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 );