Merge branch 'f/mode' of https://github.com/vivekmaurya001/stdlib into f/mode

Author: vivekmaurya001

.github/workflows/labeler_needs_changes.yml

@@ -0,0 +1,62 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2024 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.
+#/
+
+# Workflow name:
+name: labeler_needs_changes
+
+# Workflow triggers:
+on:
+  pull_request_review:
+    types: [submitted]
+
+# Workflow jobs:
+jobs:
+
+  # Define a job which automatically labels pull requests as needing changes when a reviewer requests changes:
+  add-needs-changes-label:
+
+    # Define job name:
+    name: 'Add "Needs Changes" Label when Reviewer Requests Changes'
+
+    # Only run this job if the reviewer requested changes:
+    if: ${{ github.event.review.state == 'changes_requested' }}
+
+    # Define job permissions:
+    permissions:
+      contents: read
+      pull-requests: write
+
+    # Define the type of virtual host machine:
+    runs-on: ubuntu-latest
+
+    # Define the sequence of job steps:
+    steps:
+
+      # Add "Needs Changes" label:
+      - name: 'Add "Needs Changes" label'
+        # Pin action to a known commit SHA for reproducibility:
+        uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
+        with:
+          github-token: ${{ secrets.CHATBOT_GITHUB_TOKEN }}
+          script: |
+            await github.rest.issues.addLabels({
+              'owner': context.repo.owner,
+              'repo': context.repo.repo,
+              'issue_number': context.payload.pull_request.number,
+              'labels': [ 'Needs Changes' ]
+            })

.github/workflows/run_tests_coverage.yml

@@ -292,6 +292,9 @@ jobs:
             BRANCH_NAME="pr-${{ github.event.pull_request.number }}"
             git fetch origin $BRANCH_NAME || true
             git checkout $BRANCH_NAME || git checkout -b $BRANCH_NAME
+
+            # Remove all files from the branch:
+            git rm -rf .
           else
             BRANCH_NAME="main"
           fi

lib/node_modules/@stdlib/array/base/filled5d-by/README.md

@@ -134,6 +134,12 @@ out = filled5dBy( [ 1, 1, 1, 1, 3 ], constantFunction( void 0 ) );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/base/filled5d`][@stdlib/array/base/filled5d]</span><span class="delimiter">: </span><span class="description">create a filled five-dimensional nested array.</span>
+
 </section>
 
 <!-- /.related -->
@@ -142,6 +148,12 @@ out = filled5dBy( [ 1, 1, 1, 1, 3 ], constantFunction( void 0 ) );
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/array/base/filled5d]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/filled5d
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/array/base/flatten5d/README.md

@@ -154,6 +154,12 @@ out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/array/base/flatten5d-by`][@stdlib/array/base/flatten5d-by]</span><span class="delimiter">: </span><span class="description">flatten a five-dimensional nested array according to a callback function.</span>
+
 </section>
 
 <!-- /.related -->
@@ -162,6 +168,12 @@ out = flatten5d( x, [ 2, 2, 1, 2, 2 ], true );
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/array/base/flatten5d-by]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/assert/is-camelcase/README.md

@@ -169,6 +169,13 @@ false
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/assert/is-string`][@stdlib/assert/is-string]</span><span class="delimiter">: </span><span class="description">test if a value is a string.</span>
+-   <span class="package-name">[`@stdlib/assert/is-constantcase`][@stdlib/assert/is-constantcase]</span><span class="delimiter">: </span><span class="description">test if a value is a constant-case string.</span>
+
 </section>
 
 <!-- /.related -->
@@ -183,6 +190,10 @@ false
 
 <!-- <related-links> -->
 
+[@stdlib/assert/is-string]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-string
+
+[@stdlib/assert/is-constantcase]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-constantcase
+
 <!-- </related-links> -->
 
 </section>

lib/node_modules/@stdlib/iter/do-until-each/README.md

@@ -223,6 +223,14 @@ while ( true ) {
 
 <section class="related">
 
+* * *
+
+## See Also
+
+-   <span class="package-name">[`@stdlib/iter/do-while-each`][@stdlib/iter/do-while-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.</span>
+-   <span class="package-name">[`@stdlib/iter/until-each`][@stdlib/iter/until-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is false, invokes a function for each iterated value before returning the iterated value.</span>
+-   <span class="package-name">[`@stdlib/iter/while-each`][@stdlib/iter/while-each]</span><span class="delimiter">: </span><span class="description">create an iterator which, while a test condition is true, invokes a function for each iterated value before returning the iterated value.</span>
+
 </section>
 
 <!-- /.related -->
@@ -231,6 +239,16 @@ while ( true ) {
 
 <section class="links">
 
+<!-- <related-links> -->
+
+[@stdlib/iter/do-while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/do-while-each
+
+[@stdlib/iter/until-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/until-each
+
+[@stdlib/iter/while-each]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/iter/while-each
+
+<!-- </related-links> -->
+
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/math/base/special/negalucasf/lib/main.js

@@ -23,14 +23,10 @@
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var isIntegerf = require( '@stdlib/math/base/assert/is-integerf' );
 var absf = require( '@stdlib/math/base/special/absf' );
+var MAX_LUCAS = require( '@stdlib/constants/float32/max-safe-nth-lucas' );
 var NEGALUCAS = require( './negalucas.json' );
 
 
-// VARIABLES //
-
-var MAX_LUCAS = 34;
-
-
 // MAIN //
 
 /**

lib/node_modules/@stdlib/math/base/special/negalucasf/manifest.json

@@ -37,7 +37,8 @@
       "libpath": [],
       "dependencies": [
         "@stdlib/math/base/napi/unary",
-        "@stdlib/math/base/special/labs"
+        "@stdlib/math/base/special/labs",
+        "@stdlib/constants/float32/max-safe-nth-lucas"
       ]
     },
     {
@@ -51,7 +52,8 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
-        "@stdlib/math/base/special/labs"
+        "@stdlib/math/base/special/labs",
+        "@stdlib/constants/float32/max-safe-nth-lucas"
       ]
     },
     {
@@ -65,7 +67,8 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
-        "@stdlib/math/base/special/labs"
+        "@stdlib/math/base/special/labs",
+        "@stdlib/constants/float32/max-safe-nth-lucas"
       ]
     }
   ]

lib/node_modules/@stdlib/math/base/special/negalucasf/src/main.c

@@ -18,7 +18,7 @@
 
 #include "stdlib/math/base/special/negalucasf.h"
 #include "stdlib/math/base/special/labs.h"
-#define STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS 34
+#include "stdlib/constants/float32/max_safe_nth_lucas.h"
 
 static const int32_t negalucasf_value[ 35 ] = {
 	2,

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

@@ -182,10 +182,10 @@ int main( void ) {
 
 <section class="links">
 
-<!-- <related-links> -->
-
 [@stdlib/math/base/special/sqrt]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/sqrt
 
+<!-- <related-links> -->
+
 <!-- </related-links> -->
 
 </section>