feat: add stats/base/ndarray/smeankbn2

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/README.md

@@ -89,6 +89,7 @@ declare function add( x: number, y: number ): number;
 -   The rule skips validation if the `package.json` file cannot be found or if the resolved implementation cannot be loaded.
 -   Examples are executed in a sandboxed VM context with limited globals for security.
 -   This rule is specifically designed for TypeScript declaration files and will only process files with a `*.d.ts` filename extension.
+-   You can specify a custom alias for the package export in the doctest scope using a comment in the format `// eslint-doctest-alias: <alias>`. This is useful when the TypeScript declaration uses a type name that differs from the exported identifier, or when you want to use a specific identifier in examples for clarity.
 
 </section>
 

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/lib/add_package_to_scope.js

@@ -35,6 +35,9 @@ var RE_DECLARE_CONST = /declare\s+const\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*:/;
 // Regular expression to match variable declarations with interface types such as "declare var ctor: Int32Vector;" (captures variable name and interface name):
 var RE_DECLARE_VAR_INTERFACE = /declare\s+(?:var|const)\s+([a-zA-Z_$][a-zA-Z0-9_$]*)\s*:\s*([A-Z][a-zA-Z0-9_$]*)/;
 
+// Regular expression to match custom alias comment "// eslint-doctest-alias: <alias>" capturing alias name:
+var RE_ALIAS_COMMENT = /\/\/\s*eslint-doctest-alias:\s*([a-zA-Z_$][a-zA-Z0-9_$]*)/;
+
 
 // MAIN //
 
@@ -49,9 +52,16 @@ var RE_DECLARE_VAR_INTERFACE = /declare\s+(?:var|const)\s+([a-zA-Z_$][a-zA-Z0-9_
 function addPackageToScope( scope, pkg, sourceText ) {
 	var interfaceMatch;
 	var namespaceMatch;
+	var aliasMatch;
 	var pkgType;
 	var match;
 
+	// Check for custom alias comment first...
+	aliasMatch = sourceText.match( RE_ALIAS_COMMENT );
+	if ( aliasMatch ) {
+		scope[ aliasMatch[1] ] = pkg;
+	}
+
 	pkgType = typeof pkg;
 	if ( pkgType === 'function' ) {
 		match = sourceText.match( RE_DECLARE_FUNCTION ) || sourceText.match( RE_DECLARE_VAR ) || sourceText.match( RE_DECLARE_CLASS ); // eslint-disable-line max-len

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/test/fixtures/packages/@stdlib/array/index/_package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@stdlib/array/index",
+  "version": "0.0.0",
+  "description": "Create an array index.",
+  "license": "Apache-2.0",
+  "author": {
+    "name": "The Stdlib Authors",
+    "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+  },
+  "contributors": [
+    {
+      "name": "The Stdlib Authors",
+      "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
+    }
+  ],
+  "main": "./lib",
+  "directories": {
+    "doc": "./docs",
+    "example": "./examples",
+    "lib": "./lib",
+    "test": "./test"
+  },
+  "types": "./docs/types",
+  "scripts": {},
+  "homepage": "https://github.com/stdlib-js/stdlib",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/stdlib-js/stdlib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/stdlib-js/stdlib/issues"
+  },
+  "dependencies": {},
+  "devDependencies": {},
+  "engines": {
+    "node": ">=0.10.0",
+    "npm": ">2.7.0"
+  },
+  "keywords": [
+    "stdlib",
+    "array",
+    "index",
+    "indexing"
+  ]
+}

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/test/fixtures/packages/@stdlib/array/index/lib/index.js

@@ -0,0 +1,30 @@
+/**
+* @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';
+
+/* eslint-disable stdlib/jsdoc-main-export */
+
+// MODULES //
+
+var ArrayIndex = require( '@stdlib/array/index' );
+
+
+// EXPORTS //
+
+module.exports = ArrayIndex;

lib/node_modules/@stdlib/_tools/eslint/rules/tsdoc-declarations-doctest/test/fixtures/valid.js

@@ -185,6 +185,34 @@ test = {
 };
 valid.push( test );
 
+test = {
+	'code': [
+		'// eslint-doctest-alias: ArrayIndex',
+		'',
+		'/**',
+		'* Array index constructor.',
+		'*',
+		'* @param x - input array',
+		'* @returns ArrayIndex instance',
+		'*',
+		'* @example',
+		'* var x = [ 1, 2, 3, 4 ];',
+		'*',
+		'* var idx = new ArrayIndex( x );',
+		'* // returns <ArrayIndex>',
+		'*/',
+		'interface Constructor {',
+		'    new( x: Array<number> ): any;',
+		'}',
+		'',
+		'declare var ctor: Constructor;',
+		'',
+		'export = ctor;'
+	].join( '\n' ),
+	'filename': join( __dirname, 'packages/@stdlib/array/index/docs/types/index.d.ts' )
+};
+valid.push( test );
+
 
 // EXPORTS //
 

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

@@ -157,7 +157,7 @@ interface CuanyByRight {
 	* var y = [ false, null, false, null, false, null, false, null, false, null ];
 	*
 	* var arr = cuanyByRight.assign( x, y, 2, 0, isPositive );
-	* // returns [ false, null, false, null, false, null, true, null, true, null ]
+	* // returns [ false, null, ..., true, 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>;
 }
@@ -187,7 +187,7 @@ interface CuanyByRight {
 * var y = [ false, null, false, null, false, null, false, null, false, null ];
 *
 * var arr = cuanyByRight.assign( x, y, 2, 0, isPositive );
-* // returns [ false, null, false, null, false, null, true, null, true, null ]
+* // returns [ false, null, ..., true, null ]
 */
 declare var cuanyByRight: CuanyByRight;
 

lib/node_modules/@stdlib/array/base/resolve-setter/docs/types/index.d.ts

@@ -201,16 +201,16 @@ declare function resolveSetter( x: Float32Array ): SetFloat32;
 * var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
 * var Complex128Array = require( '@stdlib/array/complex128' );
 * var Complex128 = require( '@stdlib/complex/float64/ctor' );
-* var real = require( '@stdlib/array/real' );
-* var imag = require( '@stdlib/array/imag' );
+* var real = require( '@stdlib/complex/float64/real' );
+* var imag = require( '@stdlib/complex/float64/imag' );
 *
 * var arr = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 *
 * var set = resolveSetter( arr );
 * set( arr, 1, new Complex128( 10.0, 11.0 ) );
 *
 * var get = resolveGetter( arr );
-* var v = get( arr, 2 );
+* var v = get( arr, 1 );
 * // returns <Complex128>
 *
 * var re = real( v );
@@ -231,16 +231,16 @@ declare function resolveSetter( x: Complex128Array ): SetComplex128;
 * var resolveGetter = require( '@stdlib/array/base/resolve-getter' );
 * var Complex64Array = require( '@stdlib/array/complex64' );
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var realf = require( '@stdlib/array/realf' );
-* var imagf = require( '@stdlib/array/imagf' );
+* var realf = require( '@stdlib/complex/float32/real' );
+* var imagf = require( '@stdlib/complex/float32/imag' );
 *
 * var arr = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
 *
 * var set = resolveSetter( arr );
 * set( arr, 1, new Complex64( 10.0, 11.0 ) );
 *
 * var get = resolveGetter( arr );
-* var v = get( arr, 2 );
+* var v = get( arr, 1 );
 * // returns <Complex64>
 *
 * var re = realf( v );

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

@@ -104,7 +104,7 @@ type Unary<U, V> = ( value: U ) => V;
 * var x = ones4d( shape );
 * var y = zeros4d( shape );
 *
-* unary4dBy( [ x, y ], shape, scale );
+* unary4dBy( [ x, y ], shape, scale, accessor );
 *
 * console.log( y );
 * // => [ [ [ [ -10.0, -10.0 ], [ -10.0, -10.0 ] ] ] ]

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

@@ -357,8 +357,8 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* arr.set( [ 1.0, -1.0 ], 0 );
 	* arr.set( [ 9.0, -9.0 ], 9 );
 	*
-	* z = arr.get( -1 )
-	* // return <Complex64>
+	* z = arr.at( -1 );
+	* // returns <Complex64>
 	*
 	* z = arr.at( 100 );
 	* // returns undefined
@@ -732,9 +732,6 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* arr.set( [ 3.0, 3.0 ], 2 );
 	*
 	* arr.forEach( log );
-	* // => 0: 1 + 1i
-	* // => 1: 2 + 2i
-	* // => 2: 3 + 3i
 	*/
 	forEach<U = unknown>( fcn: Callback<U>, thisArg?: ThisParameterType<Callback<U>> ): void;
 
@@ -801,13 +798,13 @@ declare class Complex64Array implements Complex64ArrayInterface {
 	* arr.set( [ 2.0, 2.0 ], 3 );
 	* arr.set( [ 5.0, 5.0 ], 4 );
 	*
-	* var idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ) );
+	* var idx = arr.indexOf( new Complex64( 2.0, 2.0 ) );
 	* // returns 1
 	*
-	* idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ), 2 );
+	* idx = arr.indexOf( new Complex64( 2.0, 2.0 ), 2 );
 	* // returns 3
 	*
-	* idx = arr.indexOf( new Complex64( [ 2.0, 2.0 ] ), -3 );
+	* idx = arr.indexOf( new Complex64( 2.0, 2.0 ), -3 );
 	* // returns 3
 	*/
 	indexOf( searchElement: ComplexLike, fromIndex?: number ): number;
@@ -1843,3 +1840,5 @@ declare var ctor: Complex64ArrayConstructor;
 // EXPORTS //
 
 export = ctor;
+
+// eslint-doctest-alias: Complex64Array

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

@@ -357,21 +357,21 @@ interface Namespace {
 	*
 	* @example
 	* var arr = new ns.Complex128Array();
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 0
 	*
 	* @example
 	* var arr = new ns.Complex128Array( 2 );
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 2
 	*
 	* @example
 	* var arr = new ns.Complex128Array( [ 1.0, -1.0 ] );
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 1
@@ -381,27 +381,27 @@ interface Namespace {
 	*
 	* var buf = new ArrayBuffer( 16 );
 	* var arr = new ns.Complex128Array( buf );
-	* // returns <ns.Complex128Array>
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
-	* // returns 2
+	* // returns 1
 	*
 	* @example
 	* var ArrayBuffer = require( '@stdlib/array/buffer' );
 	*
-	* var buf = new ArrayBuffer( 16 );
-	* var arr = new ns.Complex128Array( buf, 8 );
-	* // returns <ns.Complex128Array>
+	* var buf = new ArrayBuffer( 32 );
+	* var arr = new ns.Complex128Array( buf, 16 );
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 1
 	*
 	* @example
 	* var ArrayBuffer = require( '@stdlib/array/buffer' );
 	*
-	* var buf = new ArrayBuffer( 32 );
-	* var arr = new ns.Complex128Array( buf, 8, 2 );
-	* // returns <ns.Complex128Array>
+	* var buf = new ArrayBuffer( 48 );
+	* var arr = new ns.Complex128Array( buf, 16, 2 );
+	* // returns <Complex128Array>
 	*
 	* var len = arr.length;
 	* // returns 2
@@ -668,7 +668,7 @@ interface Namespace {
 	*
 	* var out = new Float64Array( 10 );
 	* var arr = ns.iterator2array( iter, out, scale );
-	* // returns <Array>
+	* // returns <Float64Array>
 	*/
 	iterator2array: typeof iterator2array;
 
@@ -1287,19 +1287,19 @@ interface Namespace {
 	* @example
 	* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8, 9 ] ];
 	*
-	* var ns.shape = ns.shape( arr );
+	* var sh = ns.shape( arr );
 	* // returns [ 3, 3 ]
 	*
 	* @example
 	* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], [ 7, 8 ] ];
 	*
-	* var ns.shape = ns.shape( arr );
+	* var sh = ns.shape( arr );
 	* // returns [ 3 ]
 	*
 	* @example
 	* var arr = [ [ 1, 2, 3 ], [ 4, 5, 6 ], null ];
 	*
-	* var ns.shape = ns.shape( arr );
+	* var sh = ns.shape( arr );
 	* // returns [ 3 ]
 	*/
 	shape: typeof shape;

lib/node_modules/@stdlib/array/from-iterator/docs/types/index.d.ts

@@ -118,7 +118,7 @@ declare function iterator2array<T = unknown, U = unknown, W = unknown>( iterator
 *
 * var out = new Float64Array( 10 );
 * var arr = iterator2array( iter, out );
-* // returns <Array>
+* // returns <Float64Array>
 */
 declare function iterator2array<T = unknown, U = unknown>( iterator: Iterator<T>, out: Collection<U> ): Collection<T | U>;
 
@@ -145,7 +145,7 @@ declare function iterator2array<T = unknown, U = unknown>( iterator: Iterator<T>
 *
 * var out = new Float64Array( 10 );
 * var arr = iterator2array( iter, out, scale );
-* // returns <Array>
+* // returns <Float64Array>
 */
 declare function iterator2array<T = unknown, U = unknown, V = unknown, W = unknown>( iterator: Iterator<T>, out: Collection<V>, mapFcn: MapFunction<T, U, W>, thisArg?: ThisParameterType<MapFunction<T, U, W>> ): Collection<U | V>;
 

lib/node_modules/@stdlib/array/from-scalar/docs/types/index.d.ts

@@ -191,7 +191,7 @@ declare function scalar2array( value: number, dtype: 'uint8' ): Uint8Array;
 *
 * @example
 * var x = scalar2array( 1, 'uint8c' );
-* // returns <Uint8ClampedArray>[]
+* // returns <Uint8ClampedArray>[ 1 ]
 */
 declare function scalar2array( value: number, dtype: 'uint8c' ): Uint8ClampedArray;
 

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

@@ -323,3 +323,5 @@ declare var ctor: Constructor;
 // EXPORTS //
 
 export = ctor;
+
+// eslint-doctest-alias: ArrayIndex

lib/node_modules/@stdlib/assert/is-constantcase/docs/types/index.d.ts

@@ -41,7 +41,7 @@
 * // returns false
 *
 * bool = isConstantcase( '' );
-* // returns false
+* // returns true
 *
 * bool = isConstantcase( null );
 * // returns false