refactor: avoid assertion duplication and update examples

Ref: 50616dc
Ref: #1354

Author: kgryte

lib/node_modules/@stdlib/assert/is-nonnegative-finite/README.md

@@ -32,7 +32,7 @@ var isNonNegativeFinite = require( '@stdlib/assert/is-nonnegative-finite' );
 
 #### isNonNegativeFinite( value )
 
-Tests if a `value` is a `number` having a nonnegative finite value.
+Tests if a value is a number having a nonnegative finite value.
 
 <!-- eslint-disable no-new-wrappers -->
 
@@ -54,13 +54,13 @@ bool = isNonNegativeFinite( -5.0 );
 bool = isNonNegativeFinite( null );
 // returns false
 
-bool = isNonNegativeFinite( Infinity );
+bool = isNonNegativeFinite( 1.0/0.0 );
 // returns false
 ```
 
 #### isNonNegativeFinite.isPrimitive( value )
 
-Tests if a `value` is a primitive `number` having a nonnegative finite value.
+Tests if a value is a primitive number having a nonnegative finite value.
 
 <!-- eslint-disable no-new-wrappers -->
 
@@ -76,7 +76,7 @@ bool = isNonNegativeFinite.isPrimitive( new Number( 3.0 ) );
 
 #### isNonNegativeFinite.isObject( value )
 
-Tests if a `value` is a `Number` object having a nonnegative finite value.
+Tests if a value is a `Number` object having a nonnegative finite value.
 
 <!-- eslint-disable no-new-wrappers -->
 
@@ -112,6 +112,12 @@ var bool = isNonNegativeFinite( 5.0 );
 bool = isNonNegativeFinite( new Number( 5.0 ) );
 // returns true
 
+bool = isNonNegativeFinite( new Number( 1.0/0.0 ) );
+// returns false
+
+bool = isNonNegativeFinite( 1.0/0.0 );
+// returns false
+
 bool = isNonNegativeFinite( 0.0 );
 // returns true
 
@@ -136,13 +142,6 @@ bool = isNonNegativeFinite( null );
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/assert/is-number`][@stdlib/assert/is-number]</span><span class="delimiter">: </span><span class="description">test if a value is a number.</span>
--   <span class="package-name">[`@stdlib/assert/is-finite`][@stdlib/assert/is-finite]</span><span class="delimiter">: </span><span class="description">test if a value is a finite number.</span>
-
 </section>
 
 <!-- /.related -->
@@ -151,13 +150,6 @@ bool = isNonNegativeFinite( null );
 
 <section class="links">
 
-<!-- <related-links> -->
-
-[@stdlib/assert/is-number]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-number
-[@stdlib/assert/is-finite]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/assert/is-finite
-
-<!-- </related-links> -->
-
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/assert/is-nonnegative-finite/benchmark/benchmark.js

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-/* eslint-disable no-undefined, no-empty-function */
+/* eslint-disable no-empty-function */
 
 'use strict';
 
@@ -25,6 +25,8 @@
 var bench = require( '@stdlib/bench' );
 var Number = require( '@stdlib/number/ctor' );
 var isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
+var PINF = require( '@stdlib/constants/float64/pinf' );
+var NINF = require( '@stdlib/constants/float64/ninf' );
 var pkg = require( './../package.json' ).name;
 var isNonNegativeFinite = require( './../lib' );
 
@@ -47,9 +49,9 @@ bench( pkg+'::primitives', function benchmark( b ) {
 		true,
 		false,
 		null,
-		Infinity,
-		-Infinity,
-		undefined
+		PINF,
+		NINF,
+		void 0
 	];
 
 	b.tic();
@@ -112,9 +114,9 @@ bench( pkg+'::primitives:isPrimitive', function benchmark( b ) {
 		true,
 		false,
 		null,
-		undefined,
-		Infinity,
-		-Infinity
+		void 0,
+		PINF,
+		NINF
 	];
 
 	b.tic();
@@ -177,9 +179,9 @@ bench( pkg+'::primitives:isObject', function benchmark( b ) {
 		true,
 		false,
 		null,
-		undefined,
-		Infinity,
-		-Infinity
+		void 0,
+		PINF,
+		NINF
 	];
 
 	b.tic();
@@ -209,7 +211,7 @@ bench( pkg+'::objects:isObject', function benchmark( b ) {
 		new Number( 2.0 ),
 		new Number( -3.0 ),
 		new Number( 3.14 ),
-		new Number( Infinity )
+		new Number( PINF )
 	];
 
 	b.tic();

lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/repl.txt

@@ -24,7 +24,7 @@
     false
     > bool = {{alias}}( null )
     false
-    > bool = {{alias}}( Infinity )
+    > bool = {{alias}}( {{alias:@stdlib/constants/float64/pinf}} )
     false
 
 

lib/node_modules/@stdlib/assert/is-nonnegative-finite/docs/types/index.d.ts

@@ -26,7 +26,7 @@ interface IsNonNegativeFinite {
 	* Tests if a value is a nonnegative finite number.
 	*
 	* @param {*} value - value to test
-	* @returns {boolean} boolean indicating whether value is a nonnegative number
+	* @returns {boolean} boolean indicating whether value is a nonnegative finite number
 	*
 	* @example
 	* var bool = isNonNegativeFinite( 5.0 );
@@ -41,7 +41,7 @@ interface IsNonNegativeFinite {
 	* // returns true
 	*
 	* @example
-	* var bool = isNonNegativeFinite( Infinity );
+	* var bool = isNonNegativeFinite( 1.0/0.0 );
 	* // returns false
 	*
 	* @example
@@ -73,7 +73,7 @@ interface IsNonNegativeFinite {
 	* // returns false
 	*
 	* @example
-	* var bool = isNonNegativeFinite( Infinity );
+	* var bool = isNonNegativeFinite( 1.0/0.0 );
 	* // returns false
 	*/
 	isPrimitive( value: any ): value is number;
@@ -97,7 +97,7 @@ interface IsNonNegativeFinite {
 	* // returns false
 	*
 	* @example
-	* var bool = isNonNegativeFinite( Infinity );
+	* var bool = isNonNegativeFinite( 1.0/0.0 );
 	* // returns false
 	*/
 	isObject( value: any ): value is Number;
@@ -107,7 +107,7 @@ interface IsNonNegativeFinite {
 * Tests if a value is a nonnegative finite number.
 *
 * @param {*} value - value to test
-* @returns {boolean} boolean indicating whether value is a nonnegative number
+* @returns {boolean} boolean indicating whether value is a nonnegative finite number
 *
 * @example
 * var bool = isNonNegativeFinite( 5.0 );
@@ -122,7 +122,7 @@ interface IsNonNegativeFinite {
 * // returns true
 *
 * @example
-* var bool = isNonNegativeFinite( Infinity );
+* var bool = isNonNegativeFinite( 1.0/0.0 );
 * // returns false
 *
 * @example

lib/node_modules/@stdlib/assert/is-nonnegative-finite/examples/index.js

@@ -27,10 +27,10 @@ console.log( isNonNegativeFinite( 5.0 ) );
 console.log( isNonNegativeFinite( new Number( 5.0 ) ) );
 // => true
 
-console.log( isNonNegativeFinite( new Number( Infinity ) ) );
+console.log( isNonNegativeFinite( new Number( 1.0/0.0 ) ) );
 // => false
 
-console.log( isNonNegativeFinite( Infinity ) );
+console.log( isNonNegativeFinite( 1.0/0.0 ) );
 // => false
 
 console.log( isNonNegativeFinite( 0.0 ) );

lib/node_modules/@stdlib/assert/is-nonnegative-finite/lib/index.js

@@ -35,7 +35,7 @@
 * bool = isNonNegativeFinite( 3.14 );
 * // returns true
 *
-* var bool = isNonNegativeFinite( Infinity );
+* var bool = isNonNegativeFinite( 1.0/0.0 );
 * // returns false
 *
 * bool = isNonNegativeFinite( -5.0 );
@@ -59,7 +59,7 @@
 * var bool = isNonNegativeFinite( 3.0 );
 * // returns false
 *
-* var bool = isNonNegativeFinite( Infinity );
+* var bool = isNonNegativeFinite( 1.0/0.0 );
 * // returns false
 *
 * bool = isNonNegativeFinite( new Number( 3.0 ) );

lib/node_modules/@stdlib/assert/is-nonnegative-finite/lib/main.js

@@ -30,7 +30,7 @@ var isObject = require( './object.js' );
 * Tests if a value is a nonnegative finite number.
 *
 * @param {*} value - value to test
-* @returns {boolean} boolean indicating whether value is a nonnegative number
+* @returns {boolean} boolean indicating whether value is a nonnegative finite number
 *
 * @example
 * var bool = isNonNegativeFinite( 5.0 );
@@ -45,7 +45,7 @@ var isObject = require( './object.js' );
 * // returns true
 *
 * @example
-* var bool = isNonNegativeFinite( Infinity );
+* var bool = isNonNegativeFinite( 1.0/0.0 );
 * // returns false
 *
 * @example

lib/node_modules/@stdlib/assert/is-nonnegative-finite/lib/object.js

@@ -21,7 +21,7 @@
 // MODULES //
 
 var isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number').isObject;
-var isFinite = require( '@stdlib/assert/is-finite' ).isObject; // eslint-disable-line stdlib/no-redeclare
+var PINF = require( '@stdlib/constants/float64/pinf' );
 
 
 // MAIN //
@@ -45,13 +45,13 @@ var isFinite = require( '@stdlib/assert/is-finite' ).isObject; // eslint-disable
 * // returns false
 *
 * @example
-* var bool = isNonNegativeFinite( Infinity );
+* var bool = isNonNegativeFinite( 1.0/0.0 );
 * // returns false
 */
 function isNonNegativeFinite( value ) {
 	return (
 		isNonNegativeNumber( value ) &&
-		isFinite( value )
+		value < PINF
 	);
 }
 

lib/node_modules/@stdlib/assert/is-nonnegative-finite/lib/primitive.js

@@ -21,7 +21,7 @@
 // MODULES //
 
 var isNonNegativeNumber = require( '@stdlib/assert/is-nonnegative-number' ).isPrimitive;
-var isFinite = require( '@stdlib/assert/is-finite' ).isPrimitive; // eslint-disable-line stdlib/no-redeclare
+var PINF = require( '@stdlib/constants/float64/pinf' );
 
 
 // MAIN //
@@ -45,13 +45,13 @@ var isFinite = require( '@stdlib/assert/is-finite' ).isPrimitive; // eslint-disa
 * // returns false
 *
 * @example
-* var bool = isNonNegativeFinite( Infinity );
+* var bool = isNonNegativeFinite( 1.0/0.0 );
 * // returns false
 */
 function isNonNegativeFinite( value ) {
 	return (
 		isNonNegativeNumber( value ) &&
-		isFinite( value )
+		value < PINF
 	);
 }
 

lib/node_modules/@stdlib/assert/is-nonnegative-finite/package.json

@@ -61,7 +61,6 @@
     "numeric",
     "nonnegative",
     "finite",
-    "nonnegativefinite",
     "is",
     "isnumber",
     "isnumeric",

lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.js

@@ -32,12 +32,12 @@ tape( 'main export is a function', function test( t ) {
 	t.end();
 });
 
-tape( 'attached to the main export is a method to test for a primitive number having a nonnegative number value', function test( t ) {
+tape( 'attached to the main export is a method to test for a primitive number having a nonnegative finite number value', function test( t ) {
 	t.equal( typeof isNonNegativeFinite.isPrimitive, 'function', 'export is a function' );
 	t.end();
 });
 
-tape( 'attached to the main export is a method to test for a number object having a nonnegative number value', function test( t ) {
+tape( 'attached to the main export is a method to test for a number object having a nonnegative finite number value', function test( t ) {
 	t.equal( typeof isNonNegativeFinite.isObject, 'function', 'export is a function' );
 	t.end();
 });

lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.main.js

@@ -53,8 +53,8 @@ tape( 'the function returns `false` if not provided a number having a nonnegativ
 		[],
 		{},
 		function noop() {},
-		Infinity,
-		-Infinity
+		1.0/0.0,
+		-1.0/0.0
 	];
 
 	for ( i = 0; i < values.length; i++ ) {

lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.object.js

@@ -38,13 +38,8 @@ tape( 'the function returns `true` if provided a number object having a nonnegat
 	t.end();
 });
 
-tape( 'the function returns `false` if provided Infinity, even if it is positive infinity', function test( t ) {
-	t.equal( isNonNegativeFinite( Infinity ), false, 'returns false' );
-	t.end();
-});
-
-tape( 'the function returns `false` if provided Infinity, even if it is positive infinity', function test( t ) {
-	t.equal( isNonNegativeFinite( Infinity ), false, 'returns false' );
+tape( 'the function returns `false` if provided positive infinity', function test( t ) {
+	t.equal( isNonNegativeFinite( 1.0/0.0 ), false, 'returns false' );
 	t.end();
 });
 

lib/node_modules/@stdlib/assert/is-nonnegative-finite/test/test.primitive.js

@@ -43,13 +43,13 @@ tape( 'the function returns `false` if provided a number object, even if the num
 	t.end();
 });
 
-tape( 'the function returns `false` if provided Infinity, even if it is positive infinity', function test( t ) {
-	t.equal( isNonNegativeFinite( Infinity ), false, 'returns false' );
+tape( 'the function returns `false` if provided positive infinity', function test( t ) {
+	t.equal( isNonNegativeFinite( 1.0/0.0 ), false, 'returns false' );
 	t.end();
 });
 
-tape( 'the function returns `false` if provided a number object with Infinity', function test( t ) {
-	t.equal( isNonNegativeFinite( new Number( Infinity ) ), false, 'returns false' );
+tape( 'the function returns `false` if provided a number object with positive infinity', function test( t ) {
+	t.equal( isNonNegativeFinite( new Number( 1.0/0.0 ) ), false, 'returns false' );
 	t.end();
 });