Merge branch 'stdlib-js:develop' into develop

Author: Kaushikgtm

docs/contributing/FAQ.md

@@ -37,6 +37,7 @@ limitations under the License.
 -   [When should I use decimals in examples, benchmarks, and documentation, and when should I avoid them?](#decimal-usage)
 -   [How should I name my pull request?](#pr-naming)
 -   [How do I call the stdlib bot on my PR?](#stdlib-bot)
+-   [Why were many unrelated files automatically pushed to my PR when I committed my changes?](#auto-push)
 -   [Frequently used `make` commands](#freq-make-commands)
 -   [Other Links](#other-links)
 
@@ -290,6 +291,32 @@ Once you have created your PR, you can call the **stdlib-bot** to perform basic
 
 To see other available bot commands, comment `/stdlib help` on your PR.
 
+<a name="auto-push"></a>
+
+## Why were many unrelated files automatically pushed to my PR when I committed my changes?
+
+When you open a pull request or push changes to your feature branch, GitHub compares your feature branch against your `develop` branch and shows all the differences. If your feature branch contains outdated or extra changes, they will appear in the PR, even if they are unrelated to your work.
+
+To fix this, ensure that your feature branch is based on the latest `develop` branch. You can do this by updating your local `develop` branch and then merging it into your feature branch:
+
+```bash
+$ git checkout develop
+$ git pull upstream develop
+$ git push origin develop
+$ git checkout feature-branch
+$ git merge develop
+```
+
+After merging, push your changes to the remote repository:
+
+```bash
+$ git push origin feature-branch # git push also works
+```
+
+> **Note**: When developing stdlib, we recommend using `merge` instead of `rebase` once a PR is open. Rebasing rewrites your branch history, which usually requires a force-push to update the remote branch. This can disrupt other contributors who are reviewing or collaborating on your PR. Since stdlib uses squash and merge for PRs, we don't require a clean, linear commit history. Merge commits are acceptable as long as your diff only contains relevant changes. If you want to learn more about rebasing/merging, you can refer to our [Git guide][git-guide].
+
+Alternatively, you can call the **stdlib-bot** to merge changes from the `develop` branch into your PR. To do this, comment `/stdlib merge` on your PR.
+
 <a name="freq-make-commands"></a>
 
 ## Frequently used `make` commands
@@ -355,6 +382,7 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
 ## Other Links:
 
 - [Style Guide][style-guide]
+- [Git Cheatsheet][git-guide]
 - [Other make commands][make-commands]
 
 <section class="links">
@@ -367,6 +395,8 @@ For more `make` commands, refer to the [documentation][benchmark] on running ben
 
 [github-fork]: https://help.github.com/articles/fork-a-repo/
 
+[git-guide]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/git_cheatsheet.md#integration
+
 [development-guide]: https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md
 
 [contributing-guide]: https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md

docs/contributing/git_cheatsheet.md

@@ -452,28 +452,29 @@ Assuming you've already cloned the repository and set up your identity:
 
     ```bash
     $ git checkout develop
-    $ git pull --ff-only upstream develop # Update local develop first
+    $ git pull upstream develop # Update local develop first
+    $ git push origin develop
     $ git checkout feature/is-even
-    $ git rebase develop # or git merge develop
+    $ git merge develop
     ```
 
-    Resolve any conflicts with the steps mentioned earlier, then continue the rebase:
+    Resolve any conflicts with the steps mentioned earlier, then continue the merge:
 
     <!-- run-disable -->
 
     ```bash
-    $ git rebase --continue
+    $ git merge --continue
     ```
 
     Finally, push your changes:
 
     <!-- run-disable -->
 
     ```bash
-    $ git push --force # Force push after rebasing
+    $ git push origin feature/is-even
     ```
 
-    > **Note:** Force pushing is required after rebasing because it rewrites history. This is safe as long as you're the only one working on the branch. If you want to avoid force pushing, use merge instead of rebase.
+    > **Note:** When developing stdlib, we recommend using `merge` instead of `rebase` once a PR is open. Rebasing rewrites your branch history, which usually requires a force-push to update the remote branch. This can disrupt other contributors who are reviewing or collaborating on your PR. Since stdlib uses squash and merge for PRs, we don't require a clean, linear commit history. Merge commits are acceptable as long as your diff only contains relevant changes.
 
 8.  **Repeat**: After resolving conflicts and updating your branch, you can continue making changes, committing, and pushing until your PR is ready to be merged.
 

lib/node_modules/@stdlib/_tools/pkgs/includes/lib/config.json

@@ -1,4 +1,4 @@
 {
-	"pattern": "**/package.json",
-	"ignore": []
+  "pattern": "**/package.json",
+  "ignore": []
 }

lib/node_modules/@stdlib/blas/ext/base/dsnansum/README.md

@@ -284,7 +284,7 @@ int main( void ) {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats/base/dsnanmean`][@stdlib/stats/base/dsnanmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values, using extended accumulation, and returning an extended precision result.</span>
+-   <span class="package-name">[`@stdlib/stats/strided/dsnanmean`][@stdlib/stats/strided/dsnanmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values, using extended accumulation, and returning an extended precision result.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/dssum`][@stdlib/blas/ext/base/dssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation and returning an extended precision result.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/sdsnansum`][@stdlib/blas/ext/base/sdsnansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring NaN values and using extended accumulation.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/snansum`][@stdlib/blas/ext/base/snansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring NaN values.</span>
@@ -303,7 +303,7 @@ int main( void ) {
 
 <!-- <related-links> -->
 
-[@stdlib/stats/base/dsnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dsnanmean
+[@stdlib/stats/strided/dsnanmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dsnanmean
 
 [@stdlib/blas/ext/base/dssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dssum
 

lib/node_modules/@stdlib/blas/ext/base/dsnansumors/README.md

@@ -279,7 +279,7 @@ int main( void ) {
 
 ## See Also
 
--   <span class="package-name">[`@stdlib/stats/base/dsnanmeanors`][@stdlib/stats/base/dsnanmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values, using ordinary recursive summation with extended accumulation, and returning an extended precision result.</span>
+-   <span class="package-name">[`@stdlib/stats/strided/dsnanmeanors`][@stdlib/stats/strided/dsnanmeanors]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array, ignoring NaN values, using ordinary recursive summation with extended accumulation, and returning an extended precision result.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/dssum`][@stdlib/blas/ext/base/dssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation and returning an extended precision result.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/dssumors`][@stdlib/blas/ext/base/dssumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using ordinary recursive summation with extended accumulation and returning an extended precision result.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/snansumors`][@stdlib/blas/ext/base/snansumors]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring NaN values and using ordinary recursive summation.</span>
@@ -298,7 +298,7 @@ int main( void ) {
 
 <!-- <related-links> -->
 
-[@stdlib/stats/base/dsnanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dsnanmeanors
+[@stdlib/stats/strided/dsnanmeanors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dsnanmeanors
 
 [@stdlib/blas/ext/base/dssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/dssum
 

lib/node_modules/@stdlib/blas/ext/base/dssum/README.md

@@ -280,7 +280,7 @@ int main( void ) {
 -   <span class="package-name">[`@stdlib/blas/ext/base/dsnansum`][@stdlib/blas/ext/base/dsnansum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements, ignoring NaN values, using extended accumulation, and returning an extended precision result.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/sdssum`][@stdlib/blas/ext/base/sdssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements using extended accumulation.</span>
 -   <span class="package-name">[`@stdlib/blas/ext/base/ssum`][@stdlib/blas/ext/base/ssum]</span><span class="delimiter">: </span><span class="description">calculate the sum of single-precision floating-point strided array elements.</span>
--   <span class="package-name">[`@stdlib/stats/base/dsmean`][@stdlib/stats/base/dsmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array using extended accumulation and returning an extended precision result.</span>
+-   <span class="package-name">[`@stdlib/stats/strided/dsmean`][@stdlib/stats/strided/dsmean]</span><span class="delimiter">: </span><span class="description">calculate the arithmetic mean of a single-precision floating-point strided array using extended accumulation and returning an extended precision result.</span>
 
 </section>
 
@@ -302,7 +302,7 @@ int main( void ) {
 
 [@stdlib/blas/ext/base/ssum]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/blas/ext/base/ssum
 
-[@stdlib/stats/base/dsmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/base/dsmean
+[@stdlib/stats/strided/dsmean]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/stats/strided/dsmean
 
 <!-- </related-links> -->
 

lib/node_modules/@stdlib/constants/float32/max-safe-nth-double-factorial/README.md

@@ -0,0 +1,166 @@
+<!--
+
+@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.
+
+-->
+
+# FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL
+
+> Maximum safe nth [double factorial][double-factorial] when stored in [single-precision floating-point][ieee754] format.
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL = require( '@stdlib/constants/float32/max-safe-nth-double-factorial' );
+```
+
+#### FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL
+
+The maximum [safe][safe-integers] nth [double factorial][double-factorial] when stored in [single-precision floating-point][ieee754] format.
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var bool = ( FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL === 56 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable id-length -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL = require( '@stdlib/constants/float32/max-safe-nth-double-factorial' );
+
+function factorial2( n ) {
+    var a;
+    var i;
+
+    a = 1;
+    for ( i = n; i >= 2; i -= 2 ) {
+        a *= i;
+    }
+    return a;
+}
+
+var v;
+var i;
+for ( i = 0; i < 100; i++ ) {
+    v = factorial2( i );
+    if ( i > FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL ) {
+        console.log( 'Unsafe: %d', v );
+    } else {
+        console.log( 'Safe:   %d', v );
+    }
+}
+```
+
+</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/constants/float32/max_safe_nth_double_factorial.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL
+
+Macro for the maximum [safe][safe-integers] nth [double factorial][double-factorial] when stored in [single-precision floating-point][ieee754] format.
+
+</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">
+
+</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">
+
+[safe-integers]: http://www.2ality.com/2013/10/safe-integers.html
+
+[double-factorial]: https://en.wikipedia.org/wiki/Double_factorial
+
+[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/constants/float32/max-safe-nth-double-factorial/docs/repl.txt

@@ -0,0 +1,13 @@
+
+{{alias}}
+    Maximum safe nth double factorial when stored in single-precision floating-
+    point format.
+
+    Examples
+    --------
+    > {{alias}}
+    56
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/constants/float32/max-safe-nth-double-factorial/docs/types/index.d.ts

@@ -0,0 +1,33 @@
+/*
+* @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.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Maximum safe nth double factorial when stored in single-precision floating-point format.
+*
+* @example
+* var max = FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL;
+* // returns 56
+*/
+declare const FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL: number;
+
+
+// EXPORTS //
+
+export = FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL;

lib/node_modules/@stdlib/constants/float32/max-safe-nth-double-factorial/docs/types/test.ts

@@ -0,0 +1,28 @@
+/*
+* @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.
+*/
+
+import FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT32_MAX_SAFE_NTH_DOUBLE_FACTORIAL; // $ExpectType number
+}