@stdlib/math-base-assert-is-positive-finite 0.0.2 → 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 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-2022 The Stdlib Authors.
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
  # isPositiveFinite
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] -->
@@ -127,7 +138,7 @@ See [LICENSE][stdlib-license].
127
138
 
128
139
  ## Copyright
129
140
 
130
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
141
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
131
142
 
132
143
  </section>
133
144
 
@@ -140,8 +151,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
140
151
  [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-assert-is-positive-finite.svg
141
152
  [npm-url]: https://npmjs.org/package/@stdlib/math-base-assert-is-positive-finite
142
153
 
143
- [test-image]: https://github.com/stdlib-js/math-base-assert-is-positive-finite/actions/workflows/test.yml/badge.svg?branch=v0.0.2
144
- [test-url]: https://github.com/stdlib-js/math-base-assert-is-positive-finite/actions/workflows/test.yml?query=branch:v0.0.2
154
+ [test-image]: https://github.com/stdlib-js/math-base-assert-is-positive-finite/actions/workflows/test.yml/badge.svg?branch=v0.1.0
155
+ [test-url]: https://github.com/stdlib-js/math-base-assert-is-positive-finite/actions/workflows/test.yml?query=branch:v0.1.0
145
156
 
146
157
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-assert-is-positive-finite/main.svg
147
158
  [coverage-url]: https://codecov.io/github/stdlib-js/math-base-assert-is-positive-finite?branch=main
@@ -154,7 +165,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
154
165
  -->
155
166
 
156
167
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
157
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
168
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
158
169
 
159
170
  [stdlib]: https://github.com/stdlib-js/stdlib
160
171
 
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import isPositiveFinite from '../docs/types/index';
3
+ export = isPositiveFinite;
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ "use strict";var s=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var t=s(function(c,i){
2
+ var u=require('@stdlib/constants-float64-pinf/dist');function n(r){return r>0&&r<u}i.exports=n
3
+ });var o=t();module.exports=o;
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 positive finite number.\n*\n* @param {number} x - value to test\n* @returns {boolean} boolean indicating whether the value is a positive finite number\n*\n* @example\n* var bool = isPositiveFinite( 5.0 );\n* // returns true\n*\n* @example\n* var bool = isPositiveFinite( 3.14 );\n* // returns true\n*\n* @example\n* var bool = isPositiveFinite( 0.0 );\n* // returns false\n*\n* @example\n* var bool = isPositiveFinite( Infinity );\n* // returns false\n*\n* @example\n* var bool = isPositiveFinite( -3.14 );\n* // returns false\n*\n* @example\n* var bool = isPositiveFinite( NaN );\n* // returns false\n*/\nfunction isPositiveFinite( x ) {\n\treturn ( x > 0.0 && x < PINF );\n}\n\n\n// EXPORTS //\n\nmodule.exports = isPositiveFinite;\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 positive finite number.\n*\n* @module @stdlib/math-base-assert-is-positive-finite\n*\n* @example\n* var isPositiveFinite = require( '@stdlib/math-base-assert-is-positive-finite' );\n*\n* var bool = isPositiveFinite( 3.14 );\n* // returns true\n*\n* bool = isPositiveFinite( Infinity );\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,EAAkBC,EAAI,CAC9B,OAASA,EAAI,GAAOA,EAAIF,CACzB,CAKAD,EAAO,QAAUE,IC3BjB,IAAIE,EAAO,IAKX,OAAO,QAAUA",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "PINF", "isPositiveFinite", "x", "main"]
7
+ }
@@ -16,7 +16,7 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- // TypeScript Version: 2.0
19
+ // TypeScript Version: 4.1
20
20
 
21
21
  /**
22
22
  * Tests if a double-precision floating-point numeric value is a positive finite number.
@@ -54,4 +54,3 @@ declare function isPositiveFinite( x: number ): boolean;
54
54
  // EXPORTS //
55
55
 
56
56
  export = isPositiveFinite;
57
-
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/math-base-assert-is-positive-finite",
3
- "version": "0.0.2",
3
+ "version": "0.1.0",
4
4
  "description": "Test if a double-precision floating-point numeric value is a positive 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.x"
40
+ "@stdlib/constants-float64-pinf": "^0.1.0"
41
41
  },
42
42
  "devDependencies": {
43
- "@stdlib/assert-is-boolean": "^0.0.x",
44
- "@stdlib/bench": "^0.0.x",
45
- "@stdlib/constants-float64-ninf": "^0.0.x",
46
- "@stdlib/random-base-randu": "^0.0.x",
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-spec": "5.x.x"
49
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
50
50
  },
51
51
  "engines": {
52
52
  "node": ">=0.10.0",
@@ -86,7 +86,7 @@
86
86
  "isfinite"
87
87
  ],
88
88
  "funding": {
89
- "type": "patreon",
90
- "url": "https://www.patreon.com/athan"
89
+ "type": "opencollective",
90
+ "url": "https://opencollective.com/stdlib"
91
91
  }
92
92
  }
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 positive
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 positive finite number.
15
-
16
- Examples
17
- --------
18
- > var bool = {{alias}}( 5.0 )
19
- true
20
- > bool = {{alias}}( 3.14 )
21
- true
22
- > bool = {{alias}}( 0.0 )
23
- false
24
- > bool = {{alias}}( Infinity )
25
- false
26
- > bool = {{alias}}( -3.14 )
27
- false
28
- > bool = {{alias}}( NaN )
29
- false
30
-
31
- See Also
32
- --------
33
-
@@ -1,44 +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 isPositiveFinite = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a boolean...
25
- {
26
- isPositiveFinite( 3.14 ); // $ExpectType boolean
27
- }
28
-
29
- // The compiler throws an error if the function is not provided a number...
30
- {
31
- isPositiveFinite( true ); // $ExpectError
32
- isPositiveFinite( false ); // $ExpectError
33
- isPositiveFinite( 'abc' ); // $ExpectError
34
- isPositiveFinite( [] ); // $ExpectError
35
- isPositiveFinite( {} ); // $ExpectError
36
- isPositiveFinite( ( x: number ): number => x ); // $ExpectError
37
- }
38
-
39
- // The compiler throws an error if the function is provided an incorrect number of arguments...
40
- {
41
- isPositiveFinite(); // $ExpectError
42
- isPositiveFinite( 3.14, 123 ); // $ExpectError
43
- }
44
-