chore: clean-up

Author: kgryte

lib/node_modules/@stdlib/math/base/special/heavisidef/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # Heaviside Function
 
-> Evaluate the [Heaviside function][heaviside-function] for a single-precision floating-point numeric value.
+> Evaluate the [Heaviside function][heaviside-function] for a single-precision floating-point number.
 
 <section class="intro">
 
@@ -98,7 +98,7 @@ var heavisidef = require( '@stdlib/math/base/special/heavisidef' );
 
 #### heavisidef( x\[, continuity] )
 
-Evaluates the [Heaviside function][heaviside-function] for a single-precision floating-point numeric value.
+Evaluates the [Heaviside function][heaviside-function] for a single-precision floating-point number.
 
 ```javascript
 var v = heavisidef( 3.14 );
@@ -167,12 +167,6 @@ for ( i = 0; i < x.length; i++ ) {
 
 <section class="related">
 
-* * *
-
-## See Also
-
--   <span class="package-name">[`@stdlib/math/base/special/ramp`][@stdlib/math/base/special/ramp]</span><span class="delimiter">: </span><span class="description">evaluate the ramp function.</span>
-
 </section>
 
 <!-- /.related -->
@@ -183,12 +177,6 @@ for ( i = 0; i < x.length; i++ ) {
 
 [heaviside-function]: https://en.wikipedia.org/wiki/Heaviside_step_function
 
-<!-- <related-links> -->
-
-[@stdlib/math/base/special/ramp]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/math/base/special/ramp
-
-<!-- </related-links> -->
-
 </section>
 
 <!-- /.links -->

lib/node_modules/@stdlib/math/base/special/heavisidef/benchmark/benchmark.js

@@ -21,8 +21,8 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 var pkg = require( './../package.json' ).name;
 var heavisidef = require( './../lib' );
 
@@ -34,7 +34,8 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
-	x = randu( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		y = heavisidef( x[ i % x.length ] );
@@ -55,16 +56,17 @@ bench( pkg+'::left-continuous', function benchmark( b ) {
 	var y;
 	var i;
 
-	x = randu( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		y = heavisidef( x[ i % x.length ], 'left-continuous' );
-		if ( isnan( y ) ) {
+		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
 	}
 	b.toc();
-	if ( isnan( y ) ) {
+	if ( isnanf( y ) ) {
 		b.fail( 'should not return NaN' );
 	}
 	b.pass( 'benchmark finished' );
@@ -76,16 +78,17 @@ bench( pkg+'::right-continuous', function benchmark( b ) {
 	var y;
 	var i;
 
-	x = randu( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		y = heavisidef( x[ i % x.length ], 'right-continuous' );
-		if ( isnan( y ) ) {
+		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
 	}
 	b.toc();
-	if ( isnan( y ) ) {
+	if ( isnanf( y ) ) {
 		b.fail( 'should not return NaN' );
 	}
 	b.pass( 'benchmark finished' );
@@ -97,16 +100,17 @@ bench( pkg+'::half-maximum', function benchmark( b ) {
 	var y;
 	var i;
 
-	x = randu( 100, -50.0, 50.0 );
+	x = uniform( 100, -50.0, 50.0 );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
 		y = heavisidef( x[ i % x.length ], 'half-maximum' );
-		if ( isnan( y ) ) {
+		if ( isnanf( y ) ) {
 			b.fail( 'should not return NaN' );
 		}
 	}
 	b.toc();
-	if ( isnan( y ) ) {
+	if ( isnanf( y ) ) {
 		b.fail( 'should not return NaN' );
 	}
 	b.pass( 'benchmark finished' );

lib/node_modules/@stdlib/math/base/special/heavisidef/docs/repl.txt

@@ -1,7 +1,7 @@
 
 {{alias}}( x[, continuity] )
-    Evaluates the Heaviside function for a 
-    single-precision floating-point numeric value.
+    Evaluates the Heaviside function for a single-precision floating-point
+    number.
 
     The `continuity` parameter may be one of the following:
 

lib/node_modules/@stdlib/math/base/special/heavisidef/docs/types/index.d.ts

@@ -19,7 +19,7 @@
 // TypeScript Version: 4.1
 
 /**
-* Evaluates the Heaviside function for a single-precision floating-point numeric value.
+* Evaluates the Heaviside function for a single-precision floating-point number.
 *
 * ## Notes
 *

lib/node_modules/@stdlib/math/base/special/heavisidef/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Evaluate the Heaviside function for a single-precision floating-point numeric value.
+* Evaluate the Heaviside function for a single-precision floating-point number.
 *
 * @module @stdlib/math/base/special/heavisidef
 *

lib/node_modules/@stdlib/math/base/special/heavisidef/lib/main.js

@@ -20,13 +20,13 @@
 
 // MODULES //
 
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
 
 
 // MAIN //
 
 /**
-* Evaluates the Heaviside function for a single-precision floating-point numeric value.
+* Evaluates the Heaviside function for a single-precision floating-point number.
 *
 * @param {number} x - input value
 * @param {string} [continuity] - continuity option
@@ -61,7 +61,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
 * // returns NaN
 */
 function heavisidef( x, continuity ) {
-	if ( isnan( x ) ) {
+	if ( isnanf( x ) ) {
 		return NaN;
 	}
 	if ( x > 0.0 ) {

lib/node_modules/@stdlib/math/base/special/heavisidef/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdlib/math/base/special/heavisidef",
   "version": "0.0.0",
-  "description": "Evaluate the Heaviside function for a single-precision floating-point numeric value.",
+  "description": "Evaluate the Heaviside function for a single-precision floating-point number.",
   "license": "Apache-2.0",
   "author": {
     "name": "The Stdlib Authors",

lib/node_modules/@stdlib/math/base/special/heavisidef/test/test.js

@@ -21,8 +21,8 @@
 // MODULES //
 
 var tape = require( 'tape' );
-var isnan = require( '@stdlib/math/base/assert/is-nan' );
-var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' );
 var PINF = require( '@stdlib/constants/float32/pinf' );
 var NINF = require( '@stdlib/constants/float32/ninf' );
 var EPS = require( '@stdlib/constants/float32/eps' );
@@ -46,7 +46,7 @@ tape( 'the function returns `0` if `x` is negative', function test( t ) {
 	for ( i = 0; i < 1e3; i++ ) {
 		x = -( randu()*100.0 ) - EPS;
 		v = heavisidef( x );
-		t.equal( isPositiveZero( v ), true, 'returns 0 when provided '+x );
+		t.equal( isPositiveZerof( v ), true, 'returns expected value when provided '+x );
 	}
 	t.end();
 });
@@ -59,7 +59,7 @@ tape( 'the function returns `1` if `x` is positive', function test( t ) {
 	for ( i = 0; i < 1e3; i++ ) {
 		x = ( randu()*100.0 ) + EPS;
 		v = heavisidef( x );
-		t.equal( v, 1.0, 'returns 1 when provided '+x );
+		t.equal( v, 1.0, 'returns expected value when provided '+x );
 	}
 	t.end();
 });
@@ -68,10 +68,10 @@ tape( 'by default, the function returns `NaN` if provided `+-0`', function test(
 	var v;
 
 	v = heavisidef( -0.0 );
-	t.equal( isnan( v ), true, 'returns NaN' );
+	t.equal( isnanf( v ), true, 'returns expected value' );
 
 	v = heavisidef( +0.0 );
-	t.equal( isnan( v ), true, 'returns NaN' );
+	t.equal( isnanf( v ), true, 'returns expected value' );
 
 	t.end();
 });
@@ -80,10 +80,10 @@ tape( 'if the `continuity` option is `half-maximum`, the function returns `0.5`
 	var v;
 
 	v = heavisidef( -0.0, 'half-maximum' );
-	t.equal( v, 0.5, 'returns 1/2' );
+	t.equal( v, 0.5, 'returns expected value' );
 
 	v = heavisidef( +0.0, 'half-maximum' );
-	t.equal( v, 0.5, 'returns 1/2' );
+	t.equal( v, 0.5, 'returns expected value' );
 
 	t.end();
 });
@@ -92,10 +92,10 @@ tape( 'if the `continuity` option is `left-continuous`, the function returns `0.
 	var v;
 
 	v = heavisidef( -0.0, 'left-continuous' );
-	t.equal( isPositiveZero( v ), true, 'returns 0' );
+	t.equal( isPositiveZerof( v ), true, 'returns expected value' );
 
 	v = heavisidef( +0.0, 'left-continuous' );
-	t.equal( isPositiveZero( v ), true, 'returns 0' );
+	t.equal( isPositiveZerof( v ), true, 'returns expected value' );
 
 	t.end();
 });
@@ -104,28 +104,28 @@ tape( 'if the `continuity` option is `right-continuous`, the function returns `1
 	var v;
 
 	v = heavisidef( -0.0, 'right-continuous' );
-	t.equal( v, 1, 'returns 1' );
+	t.equal( v, 1.0, 'returns expected value' );
 
 	v = heavisidef( +0.0, 'right-continuous' );
-	t.equal( v, 1, 'returns 1' );
+	t.equal( v, 1.0, 'returns expected value' );
 
 	t.end();
 });
 
 tape( 'the function returns `NaN` if provided `NaN`', function test( t ) {
 	var v = heavisidef( NaN );
-	t.equal( isnan( v ), true, 'returns NaN' );
+	t.equal( isnanf( v ), true, 'returns expected value' );
 	t.end();
 });
 
 tape( 'the function returns `0` if provided `-infinity`', function test( t ) {
 	var v = heavisidef( NINF );
-	t.equal( v, 0.0, 'returns 0' );
+	t.equal( v, 0.0, 'returns expected value' );
 	t.end();
 });
 
 tape( 'the function returns `+1` if provided `+infinity`', function test( t ) {
 	var v = heavisidef( PINF );
-	t.equal( v, 1.0, 'returns 1' );
+	t.equal( v, 1.0, 'returns expected value' );
 	t.end();
 });