Merge remote-tracking branch 'upstream/develop' into ml-strided-dkmeanspp

Author: stdlib-bot

lib/node_modules/@stdlib/_tools/licenses/licenses/README.md

@@ -97,11 +97,22 @@ function onResults( error, results ) {
 
 <section class="examples">
 
-<!-- ## Examples
+## Examples
 
-``` javascript
+<!-- eslint no-undef: "error" -->
 
-``` -->
+```javascript
+var licenses = require( '@stdlib/_tools/licenses/licenses' );
+
+licenses( onResults );
+
+function onResults( error, results ) {
+    if ( error ) {
+        throw error;
+    }
+    console.log( JSON.stringify( results ) );
+}
+```
 
 </section>
 

lib/node_modules/@stdlib/_tools/licenses/licenses/package.json

@@ -20,7 +20,8 @@
   "directories": {
     "doc": "./docs",
     "example": "./examples",
-    "lib": "./lib"
+    "lib": "./lib",
+    "test": "./test"
   },
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",

lib/node_modules/@stdlib/_tools/licenses/licenses/test/test.js

@@ -0,0 +1,61 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2026 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 tape = require( 'tape' );
+var licenses = require( './../lib' );
+
+
+// TESTS //
+
+tape( 'main export is a function', function test( t ) {
+	t.ok( true, __filename );
+	t.strictEqual( typeof licenses, 'function', 'main export is a function' );
+	t.end();
+});
+
+tape( 'the function throws an error if not provided a callback argument which is a function', function test( t ) {
+	var values;
+	var i;
+
+	values = [
+		'5',
+		5,
+		NaN,
+		true,
+		false,
+		null,
+		undefined,
+		[],
+		{}
+	];
+
+	for ( i = 0; i < values.length; i++ ) {
+		t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided '+values[ i ] );
+	}
+	t.end();
+
+	function badValue( value ) {
+		return function badValue() {
+			licenses( value );
+		};
+	}
+});

lib/node_modules/@stdlib/array/float64/README.md

@@ -1432,6 +1432,7 @@ console.log( arr );
 ## See Also
 
 -   <span class="package-name">[`@stdlib/array/buffer`][@stdlib/array/buffer]</span><span class="delimiter">: </span><span class="description">ArrayBuffer.</span>
+-   <span class="package-name">[`@stdlib/array/float16`][@stdlib/array/float16]</span><span class="delimiter">: </span><span class="description">Float16Array.</span>
 -   <span class="package-name">[`@stdlib/array/float32`][@stdlib/array/float32]</span><span class="delimiter">: </span><span class="description">Float32Array.</span>
 -   <span class="package-name">[`@stdlib/array/int16`][@stdlib/array/int16]</span><span class="delimiter">: </span><span class="description">Int16Array.</span>
 -   <span class="package-name">[`@stdlib/array/int32`][@stdlib/array/int32]</span><span class="delimiter">: </span><span class="description">Int32Array.</span>
@@ -1455,6 +1456,8 @@ console.log( arr );
 
 [@stdlib/array/buffer]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/buffer
 
+[@stdlib/array/float16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float16
+
 [@stdlib/array/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float32
 
 [@stdlib/array/int16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/int16

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

@@ -2755,10 +2755,11 @@ interface Namespace {
 	* @returns boolean indicating if a value is a 2-dimensional ndarray-like object whose underlying data type is `complex128`
 	*
 	* @example
-	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var ndarray = require( '@stdlib/ndarray/ctor' );
+	* var zeros = require( '@stdlib/ndarray/zeros' );
 	*
-	* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+	* var arr = zeros( [ 2, 2 ], {
+	*     'dtype': 'complex128'
+	* });
 	*
 	* var bool = ns.isComplex128MatrixLike( arr );
 	* // returns true
@@ -2775,10 +2776,11 @@ interface Namespace {
 	* @returns boolean indicating if a value is an ndarray-like object whose underlying data type is `complex128`
 	*
 	* @example
-	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var ndarray = require( '@stdlib/ndarray/ctor' );
+	* var zeros = require( '@stdlib/ndarray/zeros' );
 	*
-	* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+	* var arr = zeros( [ 2, 2 ], {
+	*     'dtype': 'complex128'
+	* });
 	*
 	* var bool = ns.isComplex128ndarrayLike( arr );
 	* // returns true
@@ -2795,10 +2797,11 @@ interface Namespace {
 	* @returns boolean indicating if a value is a 1-dimensional ndarray-like object whose underlying data type is `complex128`
 	*
 	* @example
-	* var Complex128Array = require( '@stdlib/array/complex128' );
-	* var ndarray = require( '@stdlib/ndarray/ctor' );
+	* var zeros = require( '@stdlib/ndarray/zeros' );
 	*
-	* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 4 ], [ 1 ], 0, 'row-major' );
+	* var arr = zeros( [ 4 ], {
+	*     'dtype': 'complex128'
+	* });
 	*
 	* var bool = ns.isComplex128VectorLike( arr );
 	* // returns true

lib/node_modules/@stdlib/assert/is-complex128matrix-like/README.md

@@ -35,10 +35,11 @@ var isComplex128MatrixLike = require( '@stdlib/assert/is-complex128matrix-like'
 Tests if a value is a 2-dimensional [ndarray][@stdlib/ndarray/ctor]-like object whose underlying data type is `complex128`.
 
 ```javascript
-var Complex128Array = require( '@stdlib/array/complex128' );
-var ndarray = require( '@stdlib/ndarray/ctor' );
+var zeros = require( '@stdlib/ndarray/zeros' );
 
-var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var arr = zeros( [ 2, 2 ], {
+    'dtype': 'complex128'
+});
 
 var bool = isComplex128MatrixLike( arr );
 // returns true
@@ -55,12 +56,12 @@ var bool = isComplex128MatrixLike( arr );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var ndarray = require( '@stdlib/ndarray/ctor' );
-var Complex128Array = require( '@stdlib/array/complex128' );
+var zeros = require( '@stdlib/ndarray/zeros' );
 var isComplex128MatrixLike = require( '@stdlib/assert/is-complex128matrix-like' );
 
-var buffer = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
-var arr = ndarray( 'complex128', buffer, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var arr = zeros( [ 2, 2 ], {
+    'dtype': 'complex128'
+});
 
 var out = isComplex128MatrixLike( arr );
 // returns true

lib/node_modules/@stdlib/assert/is-complex128matrix-like/benchmark/benchmark.js

@@ -22,8 +22,7 @@
 
 var bench = require( '@stdlib/bench' );
 var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
-var ndarray = require( '@stdlib/ndarray/ctor' );
-var Complex128Array = require( '@stdlib/array/complex128' );
+var zeros = require( '@stdlib/ndarray/zeros' );
 var format = require( '@stdlib/string/format' );
 var pkg = require( './../package.json' ).name;
 var isComplex128MatrixLike = require( './../lib' );
@@ -32,23 +31,14 @@ var isComplex128MatrixLike = require( './../lib' );
 // MAIN //
 
 bench( format( '%s::true', pkg ), function benchmark( b ) {
-	var strides;
-	var offset;
-	var buffer;
 	var values;
-	var shape;
-	var order;
 	var bool;
 	var arr;
 	var i;
 
-	buffer = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
-	shape = [ 2, 2 ];
-	strides = [ 2, 1 ];
-	offset = 0;
-	order = 'row-major';
-
-	arr = ndarray( 'complex128', buffer, shape, strides, offset, order );
+	arr = zeros( [ 2, 2 ], {
+		'dtype': 'complex128'
+	});
 
 	values = [
 		arr,

lib/node_modules/@stdlib/assert/is-complex128matrix-like/docs/repl.txt

@@ -16,18 +16,8 @@
 
     Examples
     --------
-    > var M = {};
-    > M.data = new {{alias:@stdlib/array/complex128}}( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
-    > M.ndims = 2;
-    > M.shape = [ 2, 2 ];
-    > M.strides = [ 2, 1 ];
-    > M.offset = 0;
-    > M.order = 'row-major';
-    > M.dtype = 'complex128';
-    > M.length = 4;
-    > M.flags = {};
-    > M.get = function get( i, j ) {};
-    > M.set = function set( i, j ) {};
+    > var opts = { 'dtype': 'complex128' };
+    > var M = {{alias:@stdlib/ndarray/zeros}}( [ 2, 2 ], opts );
     > var bool = {{alias}}( M )
     true
     > bool = {{alias}}( [ 1, 2, 3, 4 ] )

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

@@ -25,10 +25,11 @@
 * @returns boolean indicating if a value is a 2-dimensional ndarray-like object whose underlying data type is `complex128`
 *
 * @example
-* var Complex128Array = require( '@stdlib/array/complex128' );
-* var ndarray = require( '@stdlib/ndarray/ctor' );
+* var zeros = require( '@stdlib/ndarray/zeros' );
 *
-* var arr = ndarray( 'complex128', new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+* var arr = zeros( [ 2, 2 ], {
+*     'dtype': 'complex128'
+* });
 *
 * var bool = isComplex128MatrixLike( arr );
 * // returns true

lib/node_modules/@stdlib/assert/is-complex128matrix-like/examples/index.js

@@ -18,12 +18,12 @@
 
 'use strict';
 
-var ndarray = require( '@stdlib/ndarray/ctor' );
-var Complex128Array = require( '@stdlib/array/complex128' );
+var zeros = require( '@stdlib/ndarray/zeros' );
 var isComplex128MatrixLike = require( './../lib' );
 
-var buffer = new Complex128Array( [ 0, 0, 0, 0, 0, 0, 0, 0 ] );
-var arr = ndarray( 'complex128', buffer, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
+var arr = zeros( [ 2, 2 ], {
+	'dtype': 'complex128'
+});
 
 console.log( isComplex128MatrixLike( arr ) );
 // => true