Auto-generated commit

stdlib-js · Sep 27, 2023 · 36b03b2 · 36b03b2
1 parent 10092df
commit 36b03b2
Show file tree

Hide file tree

Showing 780 changed files with 15,757 additions and 2,926 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -179,3 +179,8 @@ indent_size = 2
 [*.gypi]
 indent_style = space
 indent_size = 2
+
+# Set properties for citation files:
+[*.{cff,cff.txt}]
+indent_style = space
+indent_size = 2
diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml
@@ -82,21 +82,6 @@ jobs:
         id: transform-error-messages
         uses: stdlib-js/transform-errors-action@main
 
-      # Format error messages:
-      - name: 'Replace double quotes with single quotes in rewritten format string error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \;
-
-      # Format string literal error messages:
-      - name: 'Replace double quotes with single quotes in rewritten string literal error messages'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \;
-
-      # Format code:
-      - name: 'Replace double quotes with single quotes in inserted `require` calls'
-        run: |
-          find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \;
-
       # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency:
       - name: 'Update dependencies in package.json'
         run: |

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016
diff --git a/LICENSE b/LICENSE
@@ -229,9 +229,39 @@ comes with no support or guarantee.
 Stephen L. Moshier
 [email protected]
 
-* FDLIBM <http://www.netlib.org/fdlibm/>
+* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
 
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
+Copyright (c) 2009 The Go Authors. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+   * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+   * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+   * Neither the name of Google Inc. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
+
+Public domain.
 
 * SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
 SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
@@ -260,6 +290,10 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
+* FDLIBM <http://www.netlib.org/fdlibm/>
+
+Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
+
 * Faddeeva <http://ab-initio.mit.edu/wiki/index.php/Faddeeva_Package#License>
 
 Copyright (c) 2012 Massachusetts Institute of Technology
@@ -283,40 +317,6 @@ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
-
-Public domain.
-
 Developed at SunPro, a Sun Microsystems, Inc. business.
 Permission to use, copy, modify, and distribute this
 software is freely granted, provided that this notice

diff --git a/README.md b/README.md
@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # Math
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->

diff --git a/base/assert/docs/types/index.d.ts b/base/assert/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /* tslint:disable:max-line-length */
 /* tslint:disable:max-file-line-count */

diff --git a/base/assert/int32-is-even/docs/types/index.d.ts b/base/assert/int32-is-even/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a 32-bit integer is even.

diff --git a/base/assert/int32-is-odd/docs/types/index.d.ts b/base/assert/int32-is-odd/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a 32-bit integer is odd.

diff --git a/base/assert/is-composite/docs/types/index.d.ts b/base/assert/is-composite/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a number is composite.

diff --git a/base/assert/is-coprime/docs/types/index.d.ts b/base/assert/is-coprime/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if two numbers are coprime.

diff --git a/base/assert/is-even/docs/types/index.d.ts b/base/assert/is-even/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a finite numeric value is an even number.

diff --git a/base/assert/is-finite/docs/types/index.d.ts b/base/assert/is-finite/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is finite.

diff --git a/base/assert/is-finitef/docs/types/index.d.ts b/base/assert/is-finitef/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a single-precision floating-point numeric value is finite.

diff --git a/base/assert/is-infinite/docs/types/index.d.ts b/base/assert/is-infinite/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is infinite.

diff --git a/base/assert/is-infinitef/docs/types/index.d.ts b/base/assert/is-infinitef/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a single-precision floating-point numeric value is infinite.

diff --git a/base/assert/is-integer/docs/types/index.d.ts b/base/assert/is-integer/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a finite double-precision floating-point number is an integer.

diff --git a/base/assert/is-nan/docs/types/index.d.ts b/base/assert/is-nan/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is `NaN`.

diff --git a/base/assert/is-nanf/docs/types/index.d.ts b/base/assert/is-nanf/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a single-precision floating-point numeric value is `NaN`.

diff --git a/base/assert/is-negative-finite/docs/types/index.d.ts b/base/assert/is-negative-finite/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is a negative finite number.
@@ -50,4 +50,3 @@ declare function isNegativeFinite( x: number ): boolean;
 // EXPORTS //
 
 export = isNegativeFinite;
-
diff --git a/base/assert/is-negative-integer/docs/types/index.d.ts b/base/assert/is-negative-integer/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a finite double-precision floating-point number is a negative integer.

diff --git a/base/assert/is-negative-zero/docs/types/index.d.ts b/base/assert/is-negative-zero/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is negative zero.

diff --git a/base/assert/is-negative-zerof/docs/types/index.d.ts b/base/assert/is-negative-zerof/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a single-precision floating-point numeric value is negative zero.

diff --git a/base/assert/is-nonnegative-finite/docs/types/index.d.ts b/base/assert/is-nonnegative-finite/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is a nonnegative finite number.
@@ -54,4 +54,3 @@ declare function isNonNegativeFinite( x: number ): boolean;
 // EXPORTS //
 
 export = isNonNegativeFinite;
-
diff --git a/base/assert/is-nonnegative-finite/docs/types/test.ts b/base/assert/is-nonnegative-finite/docs/types/test.ts
@@ -43,4 +43,4 @@ import isNonNegativeFinite = require( './index' );
 // The compiler throws an error if the function is provided insufficient arguments...
 {
 	isNonNegativeFinite(); // $ExpectError
-}
+}
diff --git a/base/assert/is-nonnegative-integer/docs/types/index.d.ts b/base/assert/is-nonnegative-integer/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a finite double-precision floating-point number is a nonnegative integer.

diff --git a/base/assert/is-nonpositive-finite/docs/types/index.d.ts b/base/assert/is-nonpositive-finite/docs/types/index.d.ts
@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Tests if a double-precision floating-point numeric value is a nonpositive finite number.
@@ -50,4 +50,3 @@ declare function isNonPositiveFinite( x: number ): boolean;
 // EXPORTS //
 
 export = isNonPositiveFinite;
-
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,4 +43,4 @@ import isNonNegativeFinite = require( './index' ); @@
     // The compiler throws an error if the function is provided insufficient arguments...
     {
     	isNonNegativeFinite(); // $ExpectError
-    }
+    }