@stdlib/math-base-assert-is-nonnegative-finite 0.0.1 → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CITATION.cff +30 -0
- package/NOTICE +1 -1
- package/README.md +15 -4
- package/dist/index.d.ts +3 -0
- package/dist/index.js +5 -0
- package/dist/index.js.map +7 -0
- package/docs/types/index.d.ts +1 -2
- package/package.json +9 -9
- package/docs/repl.txt +0 -33
- package/docs/types/test.ts +0 -46
package/CITATION.cff
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
title: stdlib
|
|
3
|
+
message: >-
|
|
4
|
+
If you use this software, please cite it using the
|
|
5
|
+
metadata from this file.
|
|
6
|
+
|
|
7
|
+
type: software
|
|
8
|
+
|
|
9
|
+
authors:
|
|
10
|
+
- name: The Stdlib Authors
|
|
11
|
+
url: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
12
|
+
|
|
13
|
+
repository-code: https://github.com/stdlib-js/stdlib
|
|
14
|
+
url: https://stdlib.io
|
|
15
|
+
|
|
16
|
+
abstract: |
|
|
17
|
+
Standard library for JavaScript and Node.js.
|
|
18
|
+
|
|
19
|
+
keywords:
|
|
20
|
+
- JavaScript
|
|
21
|
+
- Node.js
|
|
22
|
+
- TypeScript
|
|
23
|
+
- standard library
|
|
24
|
+
- scientific computing
|
|
25
|
+
- numerical computing
|
|
26
|
+
- statistical computing
|
|
27
|
+
|
|
28
|
+
license: Apache-2.0 AND BSL-1.0
|
|
29
|
+
|
|
30
|
+
date-released: 2016
|
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
1
|
+
Copyright (c) 2016-2023 The Stdlib Authors.
|
package/README.md
CHANGED
|
@@ -18,6 +18,17 @@ limitations under the License.
|
|
|
18
18
|
|
|
19
19
|
-->
|
|
20
20
|
|
|
21
|
+
|
|
22
|
+
<details>
|
|
23
|
+
<summary>
|
|
24
|
+
About stdlib...
|
|
25
|
+
</summary>
|
|
26
|
+
<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>
|
|
27
|
+
<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>
|
|
28
|
+
<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>
|
|
29
|
+
<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>
|
|
30
|
+
</details>
|
|
31
|
+
|
|
21
32
|
# isNonNegativeFinite
|
|
22
33
|
|
|
23
34
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
@@ -130,7 +141,7 @@ See [LICENSE][stdlib-license].
|
|
|
130
141
|
|
|
131
142
|
## Copyright
|
|
132
143
|
|
|
133
|
-
Copyright © 2016-
|
|
144
|
+
Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
|
|
134
145
|
|
|
135
146
|
</section>
|
|
136
147
|
|
|
@@ -143,8 +154,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
143
154
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-assert-is-nonnegative-finite.svg
|
|
144
155
|
[npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-nonnegative-finite
|
|
145
156
|
|
|
146
|
-
[test-image]: https://github.com/stdlib-js/math-base-assert-is-nonnegative-finite/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
147
|
-
[test-url]: https://github.com/stdlib-js/math-base-assert-is-nonnegative-finite/actions/workflows/test.yml?query=branch:v0.0
|
|
157
|
+
[test-image]: https://github.com/stdlib-js/math-base-assert-is-nonnegative-finite/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
158
|
+
[test-url]: https://github.com/stdlib-js/math-base-assert-is-nonnegative-finite/actions/workflows/test.yml?query=branch:v0.1.0
|
|
148
159
|
|
|
149
160
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-nonnegative-finite/main.svg
|
|
150
161
|
[coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-nonnegative-finite?branch=main
|
|
@@ -157,7 +168,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
157
168
|
-->
|
|
158
169
|
|
|
159
170
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
160
|
-
[chat-url]: https://gitter.im
|
|
171
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
161
172
|
|
|
162
173
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
163
174
|
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
"use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var t=s(function(c,i){
|
|
2
|
+
var n=require('@stdlib/constants-float64-pinf/dist');function u(e){return e>=0&&e<n}i.exports=u
|
|
3
|
+
});var a=t();module.exports=a;
|
|
4
|
+
/** @license Apache-2.0 */
|
|
5
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/main.js", "../lib/index.js"],
|
|
4
|
+
"sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Tests if a double-precision floating-point numeric value is a nonnegative finite number.\n*\n* @param {number} x - value to test\n* @returns {boolean} boolean indicating whether the value is a nonnegative finite number\n*\n* @example\n* var bool = isNonNegativeFinite( 5.0 );\n* // returns true\n*\n* @example\n* var bool = isNonNegativeFinite( 3.14 );\n* // returns true\n*\n* @example\n* var bool = isNonNegativeFinite( 0.0 );\n* // returns true\n*\n* @example\n* var bool = isNonNegativeFinite( Infinity );\n* // returns false\n*\n* @example\n* var bool = isNonNegativeFinite( -3.14 );\n* // returns false\n*\n* @example\n* var bool = isNonNegativeFinite( NaN );\n* // returns false\n*/\nfunction isNonNegativeFinite( x ) {\n\treturn ( x >= 0.0 && x < PINF );\n}\n\n\n// EXPORTS //\n\nmodule.exports = isNonNegativeFinite;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2022 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Test if a double-precision floating-point numeric value is a nonnegative finite number.\n*\n* @module @stdlib/math-base-assert-is-nonnegative-finite\n*\n* @example\n* var isNonNegativeFinite = require( '@stdlib/math-base-assert-is-nonnegative-finite' );\n*\n* var bool = isNonNegativeFinite( 5.0 );\n* // returns true\n*\n* bool = isNonNegativeFinite( -3.14 );\n* // returns false\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
|
|
5
|
+
"mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAO,QAAS,gCAAiC,EAmCrD,SAASC,EAAqBC,EAAI,CACjC,OAASA,GAAK,GAAOA,EAAIF,CAC1B,CAKAD,EAAO,QAAUE,IC3BjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "PINF", "isNonNegativeFinite", "x", "main"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
* limitations under the License.
|
|
17
17
|
*/
|
|
18
18
|
|
|
19
|
-
// TypeScript Version:
|
|
19
|
+
// TypeScript Version: 4.1
|
|
20
20
|
|
|
21
21
|
/**
|
|
22
22
|
* Tests if a double-precision floating-point numeric value is a nonnegative finite number.
|
|
@@ -54,4 +54,3 @@ declare function isNonNegativeFinite( x: number ): boolean;
|
|
|
54
54
|
// EXPORTS //
|
|
55
55
|
|
|
56
56
|
export = isNonNegativeFinite;
|
|
57
|
-
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/math-base-assert-is-nonnegative-finite",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Test if a numeric value is a nonnegative finite number.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,16 +37,16 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/constants-float64-pinf": "^0.0
|
|
40
|
+
"@stdlib/constants-float64-pinf": "^0.1.0"
|
|
41
41
|
},
|
|
42
42
|
"devDependencies": {
|
|
43
|
-
"@stdlib/assert-is-boolean": "^0.0
|
|
44
|
-
"@stdlib/bench": "^0.0
|
|
45
|
-
"@stdlib/constants-float64-ninf": "^0.0.
|
|
46
|
-
"@stdlib/random-base-randu": "^0.0.
|
|
43
|
+
"@stdlib/assert-is-boolean": "^0.1.0",
|
|
44
|
+
"@stdlib/bench": "^0.1.0",
|
|
45
|
+
"@stdlib/constants-float64-ninf": "^0.0.8",
|
|
46
|
+
"@stdlib/random-base-randu": "^0.0.8",
|
|
47
47
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
48
48
|
"istanbul": "^0.4.1",
|
|
49
|
-
"tap-
|
|
49
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
|
|
50
50
|
},
|
|
51
51
|
"engines": {
|
|
52
52
|
"node": ">=0.10.0",
|
|
@@ -85,7 +85,7 @@
|
|
|
85
85
|
"isfinite"
|
|
86
86
|
],
|
|
87
87
|
"funding": {
|
|
88
|
-
"type": "
|
|
89
|
-
"url": "https://
|
|
88
|
+
"type": "opencollective",
|
|
89
|
+
"url": "https://opencollective.com/stdlib"
|
|
90
90
|
}
|
|
91
91
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x )
|
|
3
|
-
Tests if a double-precision floating-point numeric value is a nonnegative
|
|
4
|
-
finite number.
|
|
5
|
-
|
|
6
|
-
Parameters
|
|
7
|
-
----------
|
|
8
|
-
x: number
|
|
9
|
-
Value to test.
|
|
10
|
-
|
|
11
|
-
Returns
|
|
12
|
-
-------
|
|
13
|
-
bool: boolean
|
|
14
|
-
Boolean indicating whether the value is a nonnegative finite number.
|
|
15
|
-
|
|
16
|
-
Examples
|
|
17
|
-
--------
|
|
18
|
-
> var out = {{alias}}( 5.0 )
|
|
19
|
-
true
|
|
20
|
-
> out = {{alias}}( 3.14 )
|
|
21
|
-
true
|
|
22
|
-
> out = {{alias}}( 0.0 )
|
|
23
|
-
true
|
|
24
|
-
> out = {{alias}}( Infinity )
|
|
25
|
-
false
|
|
26
|
-
> out = {{alias}}( -3.14 )
|
|
27
|
-
false
|
|
28
|
-
> out = {{alias}}( NaN )
|
|
29
|
-
false
|
|
30
|
-
|
|
31
|
-
See Also
|
|
32
|
-
--------
|
|
33
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,46 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* @license Apache-2.0
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) 2022 The Stdlib Authors.
|
|
5
|
-
*
|
|
6
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
-
* you may not use this file except in compliance with the License.
|
|
8
|
-
* You may obtain a copy of the License at
|
|
9
|
-
*
|
|
10
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
-
*
|
|
12
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
-
* See the License for the specific language governing permissions and
|
|
16
|
-
* limitations under the License.
|
|
17
|
-
*/
|
|
18
|
-
|
|
19
|
-
import isNonNegativeFinite = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a boolean...
|
|
25
|
-
{
|
|
26
|
-
isNonNegativeFinite( 2 ); // $ExpectType boolean
|
|
27
|
-
isNonNegativeFinite( 0 ); // $ExpectType boolean
|
|
28
|
-
isNonNegativeFinite( Infinity ); // $ExpectType boolean
|
|
29
|
-
isNonNegativeFinite( -2 ); // $ExpectType boolean
|
|
30
|
-
isNonNegativeFinite( NaN ); // $ExpectType boolean
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
// The compiler throws an error if the function is provided a value other than a number...
|
|
34
|
-
{
|
|
35
|
-
isNonNegativeFinite( true ); // $ExpectError
|
|
36
|
-
isNonNegativeFinite( false ); // $ExpectError
|
|
37
|
-
isNonNegativeFinite( '5' ); // $ExpectError
|
|
38
|
-
isNonNegativeFinite( [] ); // $ExpectError
|
|
39
|
-
isNonNegativeFinite( {} ); // $ExpectError
|
|
40
|
-
isNonNegativeFinite( ( x: number ): number => x ); // $ExpectError
|
|
41
|
-
}
|
|
42
|
-
|
|
43
|
-
// The compiler throws an error if the function is provided insufficient arguments...
|
|
44
|
-
{
|
|
45
|
-
isNonNegativeFinite(); // $ExpectError
|
|
46
|
-
}
|