Merge branch 'develop' of https://github.com/stdlib-js/stdlib into refactor/plot

Author: kgryte

lib/node_modules/@stdlib/_tools/eslint/rules/jsdoc-doctest/lib/main.js

@@ -48,6 +48,7 @@ var windowShim = require( './window.js' );
 var debug = logger( 'jsdoc-doctest' );
 var RE_ANNOTATION = /(?:\n|^)(?:var|let|const)? ?([a-zA-Z0-9._]+) ?=?[^;]*;\n\/\/ ?(returns|([A-Za-z][A-Za-z_0-9]*)? ?=>|throws) {0,1}([\s\S]*?)(\n|$)/g;
 var RE_CONSOLE = /console\.(?:dir|error|log)/;
+var RE_MODULE_TAG = /\* @module[^\n]*\n/g;
 var NODE_SHEBANG = /#!\/usr\/bin\/env node/;
 var DOPTS = {
 	'sloppy': true,
@@ -220,6 +221,7 @@ function main( context ) {
 	* @param {ASTNode} node - node to examine
 	*/
 	function validate( node ) {
+		var wrapped;
 		var jsdoc;
 		var ast;
 
@@ -229,7 +231,14 @@ function main( context ) {
 		}
 		jsdoc = findJSDoc( source, node );
 		if ( isObject( jsdoc ) ) {
-			ast = parseJSDoc( jsdoc.value, DOPTS );
+			if ( contains( jsdoc.value, '@module' ) ) {
+				// Wrap with /** */ and strip @module tag for proper parsing with `doctrine`:
+				wrapped = '/**' + jsdoc.value + '*/';
+				wrapped = replace( wrapped, RE_MODULE_TAG, '' );
+				ast = parseJSDoc( wrapped, DOPTS );
+			} else {
+				ast = parseJSDoc( jsdoc.value, DOPTS );
+			}
 			processTags( jsdoc, ast.tags );
 		}
 	}

lib/node_modules/@stdlib/_tools/makie/makie/lib/index.js

@@ -24,8 +24,8 @@
 * @module @stdlib/_tools/makie/makie
 *
 * @example
-* var makie = require( '@stdlib/_tools/makie/makie' );
 * var spawn = require( 'child_process' ).spawn;
+* var makie = require( '@stdlib/_tools/makie/makie' );
 *
 * function plugin( dirpath, cwd, subpath ) {
 *     var proc = spawn( 'make', [], 'test' );

lib/node_modules/@stdlib/array/complex64/lib/index.js

@@ -59,7 +59,7 @@
 * // returns <Complex64Array>
 *
 * var len = arr.length;
-* // returns 1
+* // returns 2
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );
@@ -70,7 +70,7 @@
 * // returns <Complex64Array>
 *
 * var len = arr.length;
-* // returns 2
+* // returns 1
 *
 * @example
 * var ArrayBuffer = require( '@stdlib/array/buffer' );

lib/node_modules/@stdlib/blas/base/sdsdot/lib/index.js

@@ -31,7 +31,7 @@
 * var y = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
 *
 * var z = sdsdot( x.length, 0.0, x, 1, y, 1 );
-* // returns -12.0
+* // returns -5.0
 *
 * @example
 * var Float32Array = require( '@stdlib/array/float32' );
@@ -41,7 +41,7 @@
 * var y = new Float32Array( [ 2.0, 6.0, -1.0, -4.0, 8.0 ] );
 *
 * var z = sdsdot.ndarray( x.length, 0.0, x, 1, 0, y, 1, 0 );
-* // returns -12.0
+* // returns -5.0
 */
 
 // MODULES //

lib/node_modules/@stdlib/blas/ext/base/dsort2sh/lib/index.js

@@ -45,7 +45,7 @@
 * var x = new Float64Array( [ 1.0, -2.0, 3.0, -4.0 ] );
 * var y = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] );
 *
-* dsort2sh( x.length, 1.0, x, 1, 0, y, 1, 0 );
+* dsort2sh.ndarray( x.length, 1.0, x, 1, 0, y, 1, 0 );
 *
 * console.log( x );
 * // => <Float64Array>[ -4.0, -2.0, 1.0, 3.0 ]

lib/node_modules/@stdlib/blas/ext/base/gsort2sh/lib/index.js

@@ -43,7 +43,7 @@
 * var x = [ 1.0, -2.0, 3.0, -4.0 ];
 * var y = [ 0.0, 1.0, 2.0, 3.0 ];
 *
-* gsort2sh( x.length, 1.0, x, 1, 0, y, 1, 0 );
+* gsort2sh.ndarray( x.length, 1.0, x, 1, 0, y, 1, 0 );
 *
 * console.log( x );
 * // => [ -4.0, -2.0, 1.0, 3.0 ]

lib/node_modules/@stdlib/constants/float16/ninf/lib/index.js

@@ -26,7 +26,7 @@
 *
 * @example
 * var FLOAT16_NINF = require( '@stdlib/constants/float16/ninf' );
-* // returns -infinity
+* // returns -Infinity
 */
 
 // MODULES //

lib/node_modules/@stdlib/fs/lib/index.js

@@ -36,6 +36,15 @@ var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
 */
 var fs = {};
 
+/**
+* @name appendFile
+* @memberof fs
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/fs/append-file}
+*/
+setReadOnly( fs, 'appendFile', require( '@stdlib/fs/append-file' ) );
+
 /**
 * @name close
 * @memberof fs
@@ -99,6 +108,15 @@ setReadOnly( fs, 'readFileList', require( '@stdlib/fs/read-file-list' ) );
 */
 setReadOnly( fs, 'readJSON', require( '@stdlib/fs/read-json' ) );
 
+/**
+* @name readNDJSON
+* @memberof fs
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/fs/read-ndjson}
+*/
+setReadOnly( fs, 'readNDJSON', require( '@stdlib/fs/read-ndjson' ) );
+
 /**
 * @name readWASM
 * @memberof fs
@@ -135,6 +153,15 @@ setReadOnly( fs, 'resolveParentPath', require( '@stdlib/fs/resolve-parent-path'
 */
 setReadOnly( fs, 'resolveParentPathBy', require( '@stdlib/fs/resolve-parent-path-by' ) );
 
+/**
+* @name resolveParentPaths
+* @memberof fs
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/fs/resolve-parent-paths}
+*/
+setReadOnly( fs, 'resolveParentPaths', require( '@stdlib/fs/resolve-parent-paths' ) );
+
 /**
 * @name unlink
 * @memberof fs

lib/node_modules/@stdlib/math/base/special/cotdf/README.md

@@ -0,0 +1,190 @@
+<!--
+
+@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.
+
+-->
+
+# cotdf
+
+> Compute the [cotangent][trigonometric-functions] of a single-precision floating-point number (in degrees).
+
+<section class="intro">
+
+</section>
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cotdf = require( '@stdlib/math/base/special/cotdf' );
+```
+
+#### cotdf( x )
+
+Evaluates the [cotangent][trigonometric-functions] of a single-precision floating-point number (in degrees).
+
+```javascript
+var v = cotdf( 0.0 );
+// returns Infinity
+
+v = cotdf( 60.0 );
+// returns ~0.58
+
+v = cotdf( 90.0 );
+// returns 0.0
+
+v = cotdf( NaN );
+// returns NaN
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var uniform = require( '@stdlib/random/array/uniform' );
+var logEachMap = require( '@stdlib/console/log-each-map' );
+var cotdf = require( '@stdlib/math/base/special/cotdf' );
+
+var opts = {
+    'dtype': 'float32'
+};
+var x = uniform( 100, -180.0, 180.0, opts );
+
+logEachMap( 'cotdf(%0.4f) = %0.4f', x, cotdf );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- 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 -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/math/base/special/cotdf.h"
+```
+
+#### stdlib_base_cotdf( x )
+
+Evaluates the [cotangent][trigonometric-functions] of a single-precision floating-point number (in degrees).
+
+```c
+float out = stdlib_base_cotdf( 0.0f );
+// returns Infinity
+
+out = stdlib_base_cotdf( 60.0f );
+// returns ~0.58f
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] float` input value.
+
+```c
+float stdlib_base_cotdf( const float x );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/math/base/special/cotdf.h"
+#include <stdio.h>
+
+int main( void ) {
+    const float x[] = { 0.0f, 30.0f, 45.0f, 60.0f, 90.0f };
+
+    float y;
+    int i;
+    for ( i = 0; i < 5; i++ ) {
+        y = stdlib_base_cotdf( x[ i ] );
+        printf( "cotdf(%f) = %f\n", x[ i ], y );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- 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">
+
+[trigonometric-functions]: https://en.wikipedia.org/wiki/Trigonometric_functions
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/math/base/special/cotdf/benchmark/benchmark.js

@@ -0,0 +1,54 @@
+/**
+* @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 uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pkg = require( './../package.json' ).name;
+var cotdf = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var x;
+	var y;
+	var i;
+
+	x = uniform( 100, -180.0, 180.0, {
+		'dtype': 'float32'
+	});
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		y = cotdf( x[ i%x.length ] );
+		if ( isnanf( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnanf( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});