Auto-generated commit

CHANGELOG.md

@@ -4,12 +4,57 @@
 
 <section class="release" id="unreleased">
 
-## Unreleased (2024-09-08)
+## Unreleased (2024-09-09)
 
 <section class="packages">
 
 ### Packages
 
+<section class="package" id="ndarray-base-assert-unreleased">
+
+#### [@stdlib/ndarray/base/assert](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`98e4809`](https://github.com/stdlib-js/stdlib/commit/98e480997058c3f21d3016b97d25f4c4e62231b9) - add `isBooleanDataType` to namespace
+-   [`3e7f2ca`](https://github.com/stdlib-js/stdlib/commit/3e7f2ca3c987040575b732129281c384c453e0b8) - add `hasEqualShape` to namespace
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
+<section class="package" id="ndarray-base-assert-has-equal-shape-unreleased">
+
+#### [@stdlib/ndarray/base/assert/has-equal-shape](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assert/has-equal-shape)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`6e74647`](https://github.com/stdlib-js/stdlib/commit/6e74647839e3ca184dd7df80df9bd0ede9505469) - add `ndarray/base/assert/has-equal-shape`
+
+</section>
+
+<!-- /.features -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="ndarray-base-fill-unreleased">
 
 #### [@stdlib/ndarray/base/fill](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/fill)
@@ -100,6 +145,9 @@ A total of 3 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`98e4809`](https://github.com/stdlib-js/stdlib/commit/98e480997058c3f21d3016b97d25f4c4e62231b9) - **feat:** add `isBooleanDataType` to namespace _(by Athan Reines)_
+-   [`3e7f2ca`](https://github.com/stdlib-js/stdlib/commit/3e7f2ca3c987040575b732129281c384c453e0b8) - **feat:** add `hasEqualShape` to namespace _(by Athan Reines)_
+-   [`6e74647`](https://github.com/stdlib-js/stdlib/commit/6e74647839e3ca184dd7df80df9bd0ede9505469) - **feat:** add `ndarray/base/assert/has-equal-shape` _(by Athan Reines)_
 -   [`5debe82`](https://github.com/stdlib-js/stdlib/commit/5debe8216a1449be68fad01af52d896e63163191) - **test:** add tests to `ndarray/base/map` [(#2810)](https://github.com/stdlib-js/stdlib/pull/2810) _(by Muhammad Haris, Athan Reines)_
 -   [`0c5f1bc`](https://github.com/stdlib-js/stdlib/commit/0c5f1bc12678832bf4aafddbf2a960e98612327b) - **chore:** rename folder from benchmarks to benchmark _(by Philipp Burckhardt)_
 -   [`6a6bc1d`](https://github.com/stdlib-js/stdlib/commit/6a6bc1da925c3c3f24463cf0d381d0d38e84868b) - **feat:** add `ndarray/base/fill` [(#2817)](https://github.com/stdlib-js/stdlib/pull/2817) _(by Muhammad Haris, Athan Reines)_

base/assert/has-equal-shape/README.md

@@ -0,0 +1,120 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# hasEqualShape
+
+> Test if two ndarrays have the same shape.
+
+<!-- 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 hasEqualShape = require( '@stdlib/ndarray/base/assert/has-equal-shape' );
+```
+
+#### hasEqualShape( x, y )
+
+Tests if two ndarrays have the same shape.
+
+```javascript
+var array = require( '@stdlib/ndarray/array' );
+
+var x = array( [ 1, 2, 3, 4 ] );
+var y = array( [ 5, 6, 7, 8 ] );
+
+var bool = hasEqualShape( x, y );
+// returns true
+```
+
+</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 array = require( '@stdlib/ndarray/array' );
+var hasEqualShape = require( '@stdlib/ndarray/base/assert/has-equal-shape' );
+
+var x1 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+var y1 = array( [ [ 5, 6 ], [ 7, 8 ] ] );
+
+var bool = hasEqualShape( x1, y1 );
+// returns true
+
+var x2 = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+var y2 = array( [ [ 5, 6 ], [ 7, 8 ], [ 9, 10 ] ] );
+
+bool = hasEqualShape( x2, y2 );
+// returns false
+```
+
+</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/assert/has-equal-shape/benchmark/benchmark.js

@@ -0,0 +1,86 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var array = require( './../../../../array' );
+var pkg = require( './../package.json' ).name;
+var hasEqualShape = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg+'::true', function benchmark( b ) {
+	var values;
+	var out;
+	var v;
+	var i;
+
+	values = [
+		array( [ [ 1, 2 ], [ 3, 4 ] ] ),
+		array( [ [ 1, 2 ], [ 3, 4 ] ] )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v = values[ i%values.length ];
+		out = hasEqualShape( v, v );
+		if ( typeof out !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( out ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+'::false', function benchmark( b ) {
+	var values;
+	var out;
+	var v1;
+	var v2;
+	var i;
+
+	values = [
+		array( [ [ 1, 2 ], [ 3, 4 ] ] ),
+		array( [ [ 1, 2 ], [ 3, 4 ], [ 5, 6 ] ] )
+	];
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		v1 = values[ i%values.length ];
+		v2 = values[ (i+1)%values.length ];
+		out = hasEqualShape( v1, v2 );
+		if ( typeof out !== 'boolean' ) {
+			b.fail( 'should return a boolean' );
+		}
+	}
+	b.toc();
+	if ( !isBoolean( out ) ) {
+		b.fail( 'should return a boolean' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

base/assert/has-equal-shape/docs/repl.txt

@@ -0,0 +1,27 @@
+
+{{alias}}( x, y )
+    Tests if two ndarrays have the same shape.
+
+    Parameters
+    ----------
+    x: ndarray
+        First input ndarray.
+
+    y: ndarray
+        Second input ndarray.
+
+    Returns
+    -------
+    bool: boolean
+        Boolean indicating if both ndarrays have the same shape.
+
+    Examples
+    --------
+    > var x = {{alias:@stdlib/ndarray/array}}( [ 1, 2, 3, 4 ] );
+    > var y = {{alias:@stdlib/ndarray/array}}( [ 5, 6, 7, 8 ] );
+    > var bool = {{alias}}( x, y )
+    true
+
+    See Also
+    --------
+

base/assert/has-equal-shape/docs/types/index.d.ts

@@ -0,0 +1,46 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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 { ndarray } from '@stdlib/types/ndarray';
+
+/**
+* Tests whether two ndarrays have the same shape.
+*
+* @param x - first input ndarray
+* @param y - second input ndarray
+* @returns boolean indicating whether two ndarrays have the same shape
+*
+* @example
+* var array = require( '@stdlib/ndarray/array' );
+*
+* var x = array( [ [ 1, 2 ], [ 3, 4 ] ] );
+* var y = array( [ [ 5, 6 ], [ 7, 8 ] ] );
+*
+* var bool = hasEqualShape( x, y );
+* // returns true
+*/
+declare function hasEqualShape( x: ndarray, y: ndarray ): boolean;
+
+
+// EXPORTS //
+
+export = hasEqualShape;