Merge branch 'stdlib-js:develop' into jkl

Author: JaySoni1

.github/workflows/autoclose.yml

@@ -221,3 +221,30 @@ jobs:
             We recommend opening a new pull request with only the intended changes.
 
             Thank you for your interest in stdlib, and we look forward to your future contributions.
+
+  # Define a job which closes a pull request if proposed changes duplicate already included changes:
+  already_resolved:
+
+    # Define job name:
+    name: 'Check for already resolved label'
+
+    # Only run this job if the pull request has a specific label:
+    if: "${{ github.event.label.name == 'autoclose: Already Resolved' }}"
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define the sequence of job steps:
+    steps:
+
+      # Close the pull request:
+      - name: 'Close pull request'
+        run: gh pr close "$NUMBER" --comment "$BODY"
+        env:
+          GH_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
+          GH_REPO: ${{ github.repository }}
+          NUMBER: ${{ github.event.pull_request.number }}
+          BODY: |
+            Thank you for working on this pull request. However, we cannot accept your contribution as the issue this pull request seeks to resolve has already been addressed in a different pull request or commit.
+
+            Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions.

CONTRIBUTORS

@@ -3,6 +3,7 @@
 # Contributors listed in alphabetical order.
 
 Aadish Jain <[email protected]>
+Aarya Balwadkar <[email protected]>
 Aayush Khanna <[email protected]>
 Abdelrahman Samir <[email protected]>
 Abdul Kaium <[email protected]>
@@ -77,6 +78,7 @@ Justyn Shelby <[email protected]>
 Karan Anand <[email protected]>
 Karthik Prakash <[email protected]>
 Kaushikgtm <[email protected]>
+Kavyansh-Bagdi <[email protected]>
 Kohantika Nath <[email protected]>
 Krishnam Agarwal <[email protected]>
 Krishnendu Das <[email protected]>
@@ -104,6 +106,7 @@ Ognjen Jevremović <[email protected]>
 Oneday12323 <[email protected]>
 Ori Miles <[email protected]>
 Philipp Burckhardt <[email protected]>
+Prajjwal Bajpai <[email protected]>
 Prajwal Kulkarni <[email protected]>
 Pranav Goswami <[email protected]>
 Pranjal Jha <[email protected]>

docs/contributing/FAQ.md

@@ -27,7 +27,8 @@ limitations under the License.
 -   [How can I set up my development environment to contribute to stdlib?](#setup-dev-environment)
 -   [How can I install cppcheck?](#install-cppcheck)
 -   [I am seeing different return values in the JavaScript and C implementation for the same implementation.](#js-vs-c-return-values)
--   [What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?](#markdown-heading-length)
+-   [What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?](#markdown-heading-length)
+-   [What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?](#max-params)
 -   [I have opened a pull request, where can I seek feedback?](#pr-feedback)
 -   [I need to generate fixtures for my tests. How can I do that, and what are the best references for inspiration?](#generate-fixtures)
 -   [I am facing a `Shadowed declaration` linting error in my C files, how can I fix it?](#shadowed-declaration)
@@ -64,8 +65,6 @@ There are primarily two options for setting up your development environment to c
 
 Note: The dev container does not yet support ARM64 architectures. For more information, or if you're interested in adding ARM64 support, you can visit this [issue][devcontainer-issue].
 
-TODO: Modify the dev container setup link to the exact file link once it is merged.
-
 <a name="install-cppcheck"></a>
 
 ## How can I install cppcheck?
@@ -101,15 +100,37 @@ If they pass, adjust the tolerance and add a note to the C tests indicating that
 
 <a name="markdown-heading-length"></a>
 
-## What should I do if Markdown linting on my commits fails because my headings exceed the maximum permissible length?
+## What should I do if linting on my commits fails because my headings or lines exceed the maximum permissible length?
+
+Consider whether the heading/line can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using:
+
+- For JavaScript files:
 
-Consider whether the heading can be shortened by renaming variables (e.g., changing `strideX` to `sx`). If shortening is not possible, disable the lint rule at the top level using:
+```javascript
+// eslint-disable-line max-len
+```
+
+[Reference Comment][javascript-len-ref]
+
+- For Markdown files:
 
 ```markdown
 <!-- lint disable maximum-heading-length -->
 ```
 
-TODO: Can we add a reference PR link?
+[Reference Comment][markdown-len-ref]
+
+<a name="markdown-heading-length"></a>
+
+## What should I do if JavaScript linting on my commits fails because my function exceeds the maximum permissible number of parameters?
+
+Consider whether the number of parameters can be reduced. If reduction is not possible, disable the lint rule at the top level using:
+
+```javascript
+// eslint-disable-line max-params
+```
+
+[Reference Comment][javascript-params-ref]
 
 <a name="pr-feedback"></a>
 
@@ -386,6 +407,12 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
 
 [make-commands]: https://github.com/stdlib-js/stdlib/tree/develop/tools/make/lib
 
+[markdown-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/README.md?plain=1#L94
+
+[javascript-len-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L111
+
+[javascript-params-ref]: https://github.com/stdlib-js/stdlib/blob/78e0cfd8b6c0429a443b07fd39fa9dd53bf44d23/lib/node_modules/%40stdlib/lapack/base/dgttrf/lib/base.js#L75
+
 </section>
 
 <!-- /.links -->

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

@@ -59,6 +59,20 @@ interface Namespace {
 	*
 	* ns.logEach( '%d < %d ', x, y );
 	* // e.g., => '1 < 4\n2 < 5\n3 < 6\n'
+	*
+	* @example
+	* var x = [ 0.5, 1.0, 1.5 ];
+	* var y = [ 0.25, 0.5, 0.75 ];
+	*
+	* ns.logEach( '%0.2f > %0.2f', x, y );
+	* // e.g., => '0.50 > 0.25\n1.00 > 0.50\n1.50 > 0.75\n'
+	*
+	* @example
+	* var x = [ 'foo', 'bar' ];
+	* var y = [ 'beep', 'boop' ];
+	*
+	* ns.logEach( 'x: %s, y: %s', x, y );
+	* // e.g., => 'x: foo, y: beep\nx: bar, y: boop\n'
 	*/
 	logEach: typeof logEach;
 

lib/node_modules/@stdlib/console/log-each-map/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # logEachMap
 
-> Insert array element values and the result of a callback function into a format string and print the result.
+> Insert array element values and the result of a callback function into a [format string][@stdlib/string/format] and print the result.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -42,7 +42,7 @@ var logEachMap = require( '@stdlib/console/log-each-map' );
 
 #### logEachMap( str\[, ...args], clbk\[, thisArg] )
 
-Inserts array element values and the result of a callback function into a format string and prints the result.
+Inserts array element values and the result of a callback function into a [format string][@stdlib/string/format] and prints the result.
 
 ```javascript
 function add( a, b ) {
@@ -95,10 +95,10 @@ function multiply( x, y ) {
 }
 
 var x = [ 1, 2, 3 ];
-var y = 2;
+var y = 0.5;
 
-logEachMap( '%d * %d = %d', x, y, multiply );
-// e.g., => '1 * 2 = 2\n2 * 2 = 4\n3 * 2 = 6\n'
+logEachMap( '%0.1f * %0.1f = %0.1f', x, y, multiply );
+// e.g., => '1.0 * 0.5 = 0.5\n2.0 * 0.5 = 1.0\n3.0 * 0.5 = 1.5\n'
 ```
 
 The callback function is provided the following arguments:
@@ -182,6 +182,8 @@ logEachMap( '%d + %d = %d', x, y, add );
 
 [@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
 
+[@stdlib/string/format]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/format
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/console/log-each-map/docs/repl.txt

@@ -27,5 +27,15 @@
     > function f( x, y ) { return x + y; };
     > {{alias}}( '%d + %d = %d', x, y, f );
 
+    > var x = [ 0.5, 1.0, 1.5 ];
+    > var y = [ 0.5, 0.75, 1.0 ];
+    > function f( x, y ) { return x * y; };
+    > {{alias}}( '%0.2f * %0.2f = %0.2f', x, y, f );
+
+    > var x = [ 'foo', 'bar' ];
+    > var y = [ 'baz', 'beep' ];
+    > function f( x, y ) { return x + y; };
+    > {{alias}}( '%s+%s = %s', x, y, f );
+
     See Also
     --------

lib/node_modules/@stdlib/console/log-each-map/lib/index.js

@@ -35,6 +35,26 @@
 *
 * logEachMap( '%d + %d = %d', x, y, add );
 * // e.g., => '1 + 4 = 5\n2 + 5 = 7\n3 + 6 = 9\n'
+*
+* function multiply( x, y ) {
+*     return x * y;
+* }
+*
+* var x = [ 0.5, 1.0, 1.5 ];
+* var y = [ 0.5, 0.75, 1.0 ];
+*
+* logEachMap( '%0.2f * %0.2f = %0.2f', x, y, multiply );
+* // e.g., => '0.50 * 0.50 = 0.25\n1.00 * 0.75 = 0.75\n1.50 * 1.00 = 1.50\n'
+*
+* function append( x, y ) {
+*     return x + y;
+* }
+*
+* var x = [ 'foo', 'bar' ];
+* var y = [ 'baz', 'beep' ];
+*
+* logEachMap( '%s+%s = %s', x, y, append );
+* // e.g., => 'foo+baz = foobaz\nbar+beep = barbeep\n'
 */
 
 // MODULES //

lib/node_modules/@stdlib/console/log-each-map/lib/main.js

@@ -54,6 +54,28 @@ var logger = require( '@stdlib/console/log' );
 *
 * logEachMap( '%d + %d = %d', x, y, add );
 * // e.g., => '1 + 4 = 5\n2 + 5 = 7\n3 + 6 = 9\n'
+*
+* @example
+* function multiply( x, y ) {
+*     return x * y;
+* }
+*
+* var x = [ 0.5, 1.0, 1.5 ];
+* var y = [ 0.5, 0.75, 1.0 ];
+*
+* logEachMap( '%0.2f * %0.2f = %0.2f', x, y, multiply );
+* // e.g., => '0.50 * 0.50 = 0.25\n1.00 * 0.75 = 0.75\n1.50 * 1.00 = 1.50\n'
+*
+* @example
+* function append( x, y ) {
+*     return x + y;
+* }
+*
+* var x = [ 'foo', 'bar' ];
+* var y = [ 'baz', 'beep' ];
+*
+* logEachMap( '%s+%s = %s', x, y, append );
+* // e.g., => 'foo+baz = foobaz\nbar+beep = barbeep\n'
 */
 function logEachMap( str ) {
 	var strides;

lib/node_modules/@stdlib/console/log-each/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # logEach
 
-> Insert array element values into a format string and print the result.
+> Insert array element values into a [format string][@stdlib/string/format] and print the result.
 
 <!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
 
@@ -42,7 +42,7 @@ var logEach = require( '@stdlib/console/log-each' );
 
 #### logEach( str\[, ...args] )
 
-Inserts array element values into a format string and prints the result.
+Inserts array element values into a [format string][@stdlib/string/format] and prints the result.
 
 ```javascript
 var x = [ 1, 2, 3 ];
@@ -56,10 +56,10 @@ If an interpolated argument is not an array-like object, the argument is broadca
 
 ```javascript
 var x = [ 1, 2, 3 ];
-var y = 4;
+var y = 0.5;
 
-logEach( '%d < %d', x, y );
-// e.g., => '1 < 4\n2 < 4\n3 < 4\n'
+logEach( '%0.1f > %0.1f', x, y );
+// e.g., => '1.0 > 0.5\n2.0 > 0.5\n3.0 > 0.5\n'
 ```
 
 </section>
@@ -130,6 +130,8 @@ logEach( 'abs(%d) = %d', x, y );
 
 [@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
 
+[@stdlib/string/format]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/string/format
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/console/log-each/docs/repl.txt

@@ -19,6 +19,14 @@
     > var y = [ 4, 5, 6 ];
     > {{alias}}( '%d < %d ', x, y );
 
+    > var x = [ 0.5, 1.0, 1.5 ];
+    > var y = [ 0.25, 0.5, 0.75 ];
+    > {{alias}}( '%0.2f > %0.2f', x, y );
+
+    > var x = [ 'foo', 'bar' ];
+    > var y = [ 'beep', 'boop' ];
+    > {{alias}}( 'x: %s, y: %s', x, y );
+
     See Also
     --------