@stdlib/math-base-special-min - npm Package Compare versions

Comparing version 0.0.7 to 0.1.0

docs/types/index.d.ts

@@ -19,3 +19,3 @@ /*
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
@@ -25,9 +25,4 @@ /**
 *
-* ## Notes
-*
-* -   When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, if not provided any arguments, the function returns positive infinity.
-*
 * @param x - first number
 * @param y - second number
-* @param args - numbers
 * @returns minimum value
@@ -40,6 +35,2 @@ *
 * @example
-* var v = min( 5.9, 3.14, 4.2 );
-* // returns 3.14
-*
-* @example
 * var v = min( 3.14, NaN );
@@ -52,3 +43,3 @@ * // returns NaN
 */
-declare function min( x?: number, y?: number, ...args: Array<number> ): number;
+declare function min( x: number, y: number ): number;
 
@@ -55,0 +46,0 @@

lib/index.js

@@ -32,5 +32,2 @@ /**
 *
-* v = min( 5.9, 3.14, 4.2 );
-* // returns 3.14
-*
 * v = min( 3.14, NaN );
@@ -45,3 +42,3 @@ * // returns NaN
 
-var min = require( './min.js' );
+var min = require( './main.js' );
 
@@ -48,0 +45,0 @@

package.json

 {
   "name": "@stdlib/math-base-special-min",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Return the minimum value.",
@@ -40,15 +40,14 @@ "license": "Apache-2.0",
   "dependencies": {
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-negative-zero": "^0.0.x"
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-negative-zero": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/math-base-assert-is-positive-zero": "^0.0.x",
-    "@stdlib/random-base-minstd-shuffle": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/math-base-assert-is-positive-zero": "^0.1.0",
+    "@stdlib/random-base-minstd-shuffle": "^0.0.6",
+    "@stdlib/random-base-randu": "^0.0.8",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
@@ -81,5 +80,5 @@ "engines": {
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

README.md

@@ -21,2 +21,13 @@ <!--
 
+
+<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>
+
 # min
@@ -56,3 +67,3 @@
 
-#### min( \[x\[, y\[, ...args]]] )
+#### min( x, y )
 
@@ -67,5 +78,2 @@ Returns the minimum value.
 // returns -0.0
-
-v = min( 4.2, 3.14, -1.0, 6.8 );
-// returns -1.0
 ```
@@ -83,9 +91,2 @@
 
-If not provided any arguments, the function returns `+infinity`.
-
-```javascript
-var v = min();
-// returns Infinity
-```
-
 </section>
@@ -99,6 +100,2 @@
 
-## Notes
-
--   When an empty set is considered a subset of the extended reals (all real numbers, including positive and negative infinity), positive infinity is the greatest lower bound. Similar to zero being the identity element for the sum of an empty set and to one being the identity element for the product of an empty set, positive infinity is the identity element for the minimum, and thus, `min() = +infinity`.
-
 </section>
@@ -153,4 +150,4 @@
 
--   <span class="package-name">[`@stdlib/math/base/special/max`][@stdlib/math/base/special/max]</span><span class="delimiter">: </span><span class="description">return the maximum value.</span>
--   <span class="package-name">[`@stdlib/math/base/special/minabs`][@stdlib/math/base/special/minabs]</span><span class="delimiter">: </span><span class="description">return the minimum absolute value.</span>
+-   <span class="package-name">[`@stdlib/math-base/special/max`][@stdlib/math/base/special/max]</span><span class="delimiter">: </span><span class="description">return the maximum value.</span>
+-   <span class="package-name">[`@stdlib/math-base/special/minabs`][@stdlib/math/base/special/minabs]</span><span class="delimiter">: </span><span class="description">return the minimum absolute value.</span>
 
@@ -187,3 +184,3 @@ </section>
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
@@ -201,4 +198,4 @@ </section>
 
-[test-image]: https://github.com/stdlib-js/math-base-special-min/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/math-base-special-min/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/math-base-special-min/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/math-base-special-min/actions/workflows/test.yml?query=branch:v0.1.0
 
@@ -215,2 +212,9 @@ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-min/main.svg
 
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
 [umd]: https://github.com/umdjs/umd
@@ -222,10 +226,4 @@ [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 [esm-url]: https://github.com/stdlib-js/math-base-special-min/tree/esm
+[branches-url]: https://github.com/stdlib-js/math-base-special-min/blob/main/branches.md
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
-
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/math-base-special-min/main/LICENSE
@@ -232,0 +230,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Dependency count

3

decreased by-25%

Number of package files

11

increased by22.22%

Worsened metrics

Total package byte prevSize

27069

decreased by-32.2%

Lines of code

148

decreased by-37.55%

Number of lines in readme file

232

decreased by-0.85%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@stdlib/assert-has-own-property@0.1.1(transitive)

• + Added@stdlib/assert-has-symbol-support@0.1.1(transitive)

• + Added@stdlib/assert-has-tostringtag-support@0.1.1(transitive)

• + Added@stdlib/assert-is-array@0.1.1(transitive)

• + Added@stdlib/assert-is-boolean@0.1.1(transitive)

• + Added@stdlib/assert-is-buffer@0.1.1(transitive)

• + Added@stdlib/assert-is-function@0.1.1(transitive)

• + Added@stdlib/assert-is-object@0.1.1(transitive)

• + Added@stdlib/assert-is-object-like@0.1.1(transitive)

• + Added@stdlib/assert-is-plain-object@0.1.1(transitive)

• + Added@stdlib/assert-is-regexp@0.1.1(transitive)

• + Added@stdlib/assert-is-string@0.1.1(transitive)

• + Added@stdlib/assert-tools-array-function@0.1.1(transitive)

• + Added@stdlib/boolean-ctor@0.1.1(transitive)

• + Added@stdlib/constants-float64-ninf@0.1.1(transitive)

• + Added@stdlib/error-tools-fmtprodmsg@0.1.1(transitive)

• + Added@stdlib/fs-exists@0.1.1(transitive)

• + Added@stdlib/fs-resolve-parent-path@0.1.1(transitive)

• + Added@stdlib/math-base-assert-is-nan@0.1.1(transitive)

• + Added@stdlib/math-base-assert-is-negative-zero@0.1.1(transitive)

• + Added@stdlib/number-ctor@0.1.1(transitive)

• + Added@stdlib/object-ctor@0.1.1(transitive)

• + Added@stdlib/process-cwd@0.1.1(transitive)

• + Added@stdlib/regexp-extended-length-path@0.1.1(transitive)

• + Added@stdlib/regexp-function-name@0.1.1(transitive)

• + Added@stdlib/string-base-format-interpolate@0.1.1(transitive)

• + Added@stdlib/string-base-format-tokenize@0.1.1(transitive)

• + Added@stdlib/string-base-lowercase@0.2.1(transitive)

• + Added@stdlib/string-base-replace@0.1.1(transitive)

• + Added@stdlib/string-format@0.1.1(transitive)

• + Added@stdlib/string-replace@0.1.1(transitive)

• + Added@stdlib/symbol-ctor@0.1.1(transitive)

• + Added@stdlib/types@0.1.0(transitive)

• + Added@stdlib/utils-constructor-name@0.1.1(transitive)

• + Added@stdlib/utils-convert-path@0.1.1(transitive)

• + Added@stdlib/utils-define-nonenumerable-read-only-property@0.1.1(transitive)

• + Added@stdlib/utils-define-property@0.1.1(transitive)

• + Added@stdlib/utils-escape-regexp-string@0.1.1(transitive)

• + Added@stdlib/utils-get-prototype-of@0.1.1(transitive)

• + Added@stdlib/utils-global@0.1.1(transitive)

• + Added@stdlib/utils-library-manifest@0.1.1(transitive)

• + Added@stdlib/utils-native-class@0.1.1(transitive)

• + Added@stdlib/utils-type-of@0.1.2(transitive)

• - Removed@stdlib/constants-float64-pinf@^0.0.x

• - Removed@stdlib/assert-has-node-buffer-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-own-property@0.0.7(transitive)

• - Removed@stdlib/assert-has-symbol-support@0.0.8(transitive)

• - Removed@stdlib/assert-has-tostringtag-support@0.0.9(transitive)

• - Removed@stdlib/assert-is-array@0.0.7(transitive)

• - Removed@stdlib/assert-is-boolean@0.0.8(transitive)

• - Removed@stdlib/assert-is-buffer@0.0.8(transitive)

• - Removed@stdlib/assert-is-function@0.0.8(transitive)

• - Removed@stdlib/assert-is-object@0.0.8(transitive)

• - Removed@stdlib/assert-is-object-like@0.0.8(transitive)

• - Removed@stdlib/assert-is-plain-object@0.0.7(transitive)

• - Removed@stdlib/assert-is-regexp@0.0.7(transitive)

• - Removed@stdlib/assert-is-regexp-string@0.0.9(transitive)

• - Removed@stdlib/assert-is-string@0.0.8(transitive)

• - Removed@stdlib/assert-tools-array-function@0.0.7(transitive)

• - Removed@stdlib/buffer-ctor@0.0.7(transitive)

• - Removed@stdlib/buffer-from-string@0.0.8(transitive)

• - Removed@stdlib/cli-ctor@0.0.3(transitive)

• - Removed@stdlib/constants-float64-ninf@0.0.8(transitive)

• - Removed@stdlib/constants-float64-pinf@0.0.8(transitive)

• - Removed@stdlib/fs-exists@0.0.8(transitive)

• - Removed@stdlib/fs-read-file@0.0.8(transitive)

• - Removed@stdlib/fs-resolve-parent-path@0.0.8(transitive)

• - Removed@stdlib/math-base-assert-is-nan@0.0.8(transitive)

• - Removed@stdlib/math-base-assert-is-negative-zero@0.0.8(transitive)

• - Removed@stdlib/number-ctor@0.0.7(transitive)

• - Removed@stdlib/process-cwd@0.0.8(transitive)

• - Removed@stdlib/process-read-stdin@0.0.7(transitive)

• - Removed@stdlib/regexp-eol@0.0.7(transitive)

• - Removed@stdlib/regexp-extended-length-path@0.0.7(transitive)

• - Removed@stdlib/regexp-function-name@0.0.7(transitive)

• - Removed@stdlib/regexp-regexp@0.0.8(transitive)

• - Removed@stdlib/streams-node-stdin@0.0.7(transitive)

• - Removed@stdlib/string-base-format-interpolate@0.0.4(transitive)

• - Removed@stdlib/string-base-format-tokenize@0.0.4(transitive)

• - Removed@stdlib/string-format@0.0.3(transitive)

• - Removed@stdlib/string-lowercase@0.0.9(transitive)

• - Removed@stdlib/string-replace@0.0.11(transitive)

• - Removed@stdlib/types@0.0.14(transitive)

• - Removed@stdlib/utils-constructor-name@0.0.8(transitive)

• - Removed@stdlib/utils-convert-path@0.0.8(transitive)

• - Removed@stdlib/utils-define-nonenumerable-read-only-property@0.0.7(transitive)

• - Removed@stdlib/utils-define-property@0.0.9(transitive)

• - Removed@stdlib/utils-escape-regexp-string@0.0.9(transitive)

• - Removed@stdlib/utils-get-prototype-of@0.0.7(transitive)

• - Removed@stdlib/utils-global@0.0.7(transitive)

• - Removed@stdlib/utils-library-manifest@0.0.8(transitive)

• - Removed@stdlib/utils-native-class@0.0.8(transitive)

• - Removed@stdlib/utils-next-tick@0.0.8(transitive)

• - Removed@stdlib/utils-noop@0.0.14(transitive)

• - Removed@stdlib/utils-regexp-from-string@0.0.9(transitive)

• - Removed@stdlib/utils-type-of@0.0.8(transitive)

• - Removedminimist@1.2.8(transitive)

• Updated@stdlib/constants-float64-ninf@^0.1.0

• Updated@stdlib/math-base-assert-is-nan@^0.1.0

• Updated@stdlib/math-base-assert-is-negative-zero@^0.1.0