Merge branch 'develop' of https://github.com/stdlib-js/stdlib into pr/headlessNode/8110

Author: kgryte

.github/workflows/namespace_declarations.yml

@@ -65,8 +65,11 @@ jobs:
           # Specify whether to download Git-LFS files:
           lfs: false
 
-          # Avoid storing GitHub token in local Git configuration:
-          persist-credentials: false
+          # Provide a GitHub token for authentication
+          token: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
+
+          # Store GitHub token in local Git configuration:
+          persist-credentials: true
         timeout-minutes: 10
 
       # Install Node.js:
@@ -107,7 +110,11 @@ jobs:
           # Process each namespace:
           while IFS= read -r namespace; do
             if [ -n "$namespace" ] && [[ $namespace != *"_tools"* ]]; then
-              branch_name="update-$(echo "$namespace" | sed 's/@stdlib\///' | sed 's/\//-/g')-declarations"
+              # Namespace without the '@stdlib/' scope for display in commit messages and PR titles:
+              display_namespace="${namespace#@stdlib/}"
+
+              # Branch name slug with slashes replaced by dashes:
+              branch_name="update-${display_namespace//\//-}-declarations"
               git checkout -b "$branch_name"
 
               # Generate declarations for this namespace:
@@ -119,13 +126,13 @@ jobs:
                 git add lib/node_modules/@stdlib
 
                 # Commit changes:
-                git commit -m "feat: update \`${namespace}\` TypeScript declarations" --signoff
+                git commit -m "feat: update \`${display_namespace}\` TypeScript declarations" --signoff
 
                 # Push branch and create PR:
                 git push origin "$branch_name"
 
                 gh pr create \
-                  --title "feat: update \`${namespace}\` TypeScript declarations" \
+                  --title "feat: update \`${display_namespace}\` TypeScript declarations" \
                   --body "This PR updates TypeScript declarations for the \`${namespace}\` namespace.
 
           ## Reviewer Checklist
@@ -138,7 +145,7 @@ jobs:
           - [ ] Approve the PR once you are confident about the classification and changes made." \
                   --label "Documentation" \
                   --label "automated-pr" \
-                  --reviewer "reviewers" \
+                  --reviewer "@stdlib-js/reviewers" \
                   --base develop \
                   --head "$branch_name"
               fi

lib/node_modules/@stdlib/_tools/scripts/create_namespace_types.js

@@ -301,8 +301,10 @@ function create( fullPath ) {
 		var RE;
 
 		match = replace( match, mainExport[ 1 ], name );
-		RE = new RegExp( '([^a-zA-Z@])'+name, 'g' );
-		return replace( match, RE, '$1ns.'+name );
+
+		// Only match the standalone identifier `name`:
+		RE = new RegExp( '(^|[^a-zA-Z0-9_@])' + name + '(?![a-zA-Z0-9_])', 'g' );
+		return replace( match, RE, '$1ns.' + name );
 	}
 }
 

lib/node_modules/@stdlib/array/base/assert/docs/types/index.d.ts

@@ -21,6 +21,7 @@
 /* eslint-disable max-lines */
 
 import contains = require( '@stdlib/array/base/assert/contains' );
+import hasAlmostEqualValues = require( '@stdlib/array/base/assert/has-almost-equal-values' );
 import hasEqualValues = require( '@stdlib/array/base/assert/has-equal-values' );
 import hasEqualValuesIndexed = require( '@stdlib/array/base/assert/has-equal-values-indexed' );
 import hasSameValues = require( '@stdlib/array/base/assert/has-same-values' );
@@ -73,6 +74,27 @@ interface Namespace {
 	*/
 	contains: typeof contains;
 
+	/**
+	* Tests if two arrays have respective elements which are approximately equal within a specified number of ULPs (units in the last place).
+	*
+	* ## Notes
+	*
+	* -   If provided arrays of unequal length, the function returns `false`.
+	*
+	* @param x - first input array
+	* @param y - second input array
+	* @param maxULP - maximum allowed ULP difference
+	* @returns boolean indicating whether both arrays are approximately equal
+	*
+	* @example
+	* var x = [ 0, 0, 1, 0 ];
+	* var y = [ 0, 0, 1, 0 ];
+	*
+	* var out = ns.hasAlmostEqualValues( x, y, 0 );
+	* // returns true
+	*/
+	hasAlmostEqualValues: typeof hasAlmostEqualValues;
+
 	/**
 	* Tests if two arrays have equal values.
 	*

lib/node_modules/@stdlib/array/base/banded/docs/types/index.d.ts

@@ -21,15 +21,63 @@
 /* eslint-disable max-lines */
 
 import filled2dBy = require( '@stdlib/array/base/banded/filled2d-by' );
+import toCompact = require( '@stdlib/array/base/banded/to-compact' );
 
 /**
-* Interface describing a namespace.
+* Interface describing the `banded` namespace.
 */
 interface Namespace {
 	/**
-	* TODO
+	* Returns a filled two-dimensional banded nested array according to a provided callback function.
+	*
+	* @param shape - array shape
+	* @param ku - number of super-diagonals
+	* @param kl - number of sub-diagonals
+	* @param fill - fill value for values outside the band
+	* @param clbk - callback function
+	* @param thisArg - callback function execution context
+	* @returns output array
+	*
+	* @example
+	* function clbk( indices ) {
+	*     return indices[ 0 ] + indices[ 1 ];
+	* }
+	*
+	* var out = ns.filled2dBy( [ 3, 3 ], 1, 1, 0, clbk );
+	* // returns [ [ 0, 1, 0 ], [ 1, 2, 3 ], [ 0, 3, 4 ] ]
 	*/
 	filled2dBy: typeof filled2dBy;
+
+	/**
+	* Converts a two-dimensional banded nested array to compact banded storage.
+	*
+	* @param arr - input two-dimensional array
+	* @param ku - number of super-diagonals
+	* @param kl - number of sub-diagonals
+	* @param colexicographic - specifies whether to store diagonals in colexicographic access order
+	* @returns output array
+	*
+	* @example
+	* var M = [
+	*     [ 11, 2, 0 ],
+	*     [ 3, 12, 4 ],
+	*     [ 0, 5, 13 ]
+	* ];
+	*
+	* var out = ns.toCompact( M, 1, 1, false );
+	* // returns [ [ 0, 2, 4 ], [ 11, 12, 13 ], [ 3, 5, 0 ] ]
+	*
+	* @example
+	* var M = [
+	*     [ 11, 2, 0 ],
+	*     [ 3, 12, 4 ],
+	*     [ 0, 5, 13 ]
+	* ];
+	*
+	* var out = ns.toCompact( M, 1, 1, true );
+	* // returns [ [ 0, 11, 3 ], [ 2, 12, 5 ], [ 4, 13, 0 ] ]
+	*/
+	toCompact: typeof toCompact;
 }
 
 /**

lib/node_modules/@stdlib/array/base/bifurcate-entries/docs/types/index.d.ts

@@ -38,7 +38,7 @@ type Results<T> = [ Array<[ number, T ]>, Array<[ number, T ]> ];
 * var x = [ 'beep', 'boop', 'foo', 'bar' ];
 * var filter = [ true, true, false, true ];
 *
-* var out = bifurcateEntries( arr, filter );
+* var out = bifurcateEntries( x, filter );
 * // returns [ [ [ 0, 'beep' ], [ 1, 'boop' ], [ 3, 'bar' ] ], [ [ 2, 'foo' ] ] ]
 */
 declare function bifurcateEntries<T = unknown>( x: Collection<T> | AccessorArrayLike<T>, filter: Collection | AccessorArrayLike<any> ): Results<T>; // eslint-disable-line @typescript-eslint/no-explicit-any

lib/node_modules/@stdlib/array/base/bifurcate-values/docs/types/index.d.ts

@@ -33,7 +33,7 @@ import { Collection, AccessorArrayLike } from '@stdlib/types/array';
 * var x = [ 'beep', 'boop', 'foo', 'bar' ];
 * var filter = [ true, true, false, true ];
 *
-* var out = bifurcateValues( arr, filter );
+* var out = bifurcateValues( x, filter );
 * // returns [ [ 'beep', 'boop', 'bar' ], [ 'foo' ] ]
 */
 declare function bifurcateValues<T = unknown>( x: Collection<T> | AccessorArrayLike<T>, filter: Collection | AccessorArrayLike<any> ): [ Array<T>, Array<T> ]; // eslint-disable-line @typescript-eslint/no-explicit-any

lib/node_modules/@stdlib/array/base/broadcasted-ternary5d/docs/types/index.d.ts

@@ -88,7 +88,6 @@ type InOutShapes = [
 * var ones5d = require( '@stdlib/array/base/ones5d' );
 * var zeros5d = require( '@stdlib/array/base/zeros5d' );
 * var add = require( '@stdlib/number/float64/base/add3' );
-* var bternary5d = require( '@stdlib/array/base/broadcasted-ternary5d' );
 * var shapes = [
 *     [ 1, 2, 1, 1, 1 ],
 *     [ 2, 1, 1, 1, 1 ],

lib/node_modules/@stdlib/array/base/cunone-by-right/docs/types/index.d.ts

@@ -80,7 +80,7 @@ interface CunoneByRight {
 	*
 	* @example
 	* function fcn( v ) {
-	*  return v > 0;
+	*     return v > 0;
 	* }
 	* var x = [ 0, 1, 1, 0, 0 ];
 	*
@@ -102,7 +102,7 @@ interface CunoneByRight {
 	*
 	* @example
 	* function fcn( v ) {
-	* 	return v > 0;
+	*     return v > 0;
 	* }
 	* var x = [ 1, 1, 0, 0, 0 ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
@@ -158,7 +158,7 @@ interface CunoneByRight {
 	* var x = [ 0, 0, 0, 1, 0 ];
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
 	*
-	* var arr = cunoneBy.assign( x, y, 2, 0, isPositive );
+	* var arr = cunoneByRight.assign( x, y, 2, 0, isPositive );
 	* // returns [ true, null, false, null, false, null, false, null, false, null ]
 	*/
 	assign<T = unknown, U = unknown, V = unknown>( x: Collection<T> | AccessorArrayLike<T>, out: Collection<U> | AccessorArrayLike<U>, stride: number, offset: number, predicate: Predicate<T, V>, thisArg?: ThisParameterType<Predicate<T, V>> ): Collection<U | boolean> | AccessorArrayLike<U | boolean>;
@@ -174,16 +174,16 @@ interface CunoneByRight {
 *
 * @example
 * function fcn( v ) {
-* 	return v > 0;
+*     return v > 0;
 * }
 * var x = [ 1, 1, 0, 0, 0 ];
 *
-* var result = cunoneByright( x, fcn );
+* var result = cunoneByRight( x, fcn );
 * // returns [ true, true, true, false, false ]
 *
 * @example
 * function fcn( v ) {
-* 	return v > 0;
+*     return v > 0;
 * }
 * var x = [ 0, 1, 1, 0, 0 ];
 * var y = [ false, null, false, null, false, null, false, null, false, null ];