Merge branch 'develop' of https://github.com/stdlib-js/stdlib into develop

Author: kgryte

lib/node_modules/@stdlib/math/base/special/kernel-log1p/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # kernelLog1p
 
-> Compute `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+> Evaluate a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 
 <section class="usage">
 
@@ -32,7 +32,7 @@ var kernelLog1p = require( '@stdlib/math/base/special/kernel-log1p' );
 
 #### kernelLog1p( f )
 
-Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 
 ```javascript
 var v = kernelLog1p( 1.0 );
@@ -111,7 +111,7 @@ logEachMap( 'kernelLog1p(%0.4f) = %0.4f', x, kernelLog1p );
 
 #### stdlib_base_kernel_log1p( f )
 
-Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 
 ```c
 double out = stdlib_base_kernel_log1p( 1.0 );

lib/node_modules/@stdlib/math/base/special/kernel-log1p/benchmark/benchmark.js

@@ -21,8 +21,10 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var FLOAT64_SQRT_HALF = require( '@stdlib/constants/float64/sqrt-half' );
+var FLOAT64_SQRT_TWO = require( '@stdlib/constants/float64/sqrt-two' );
 var pkg = require( './../package.json' ).name;
 var kernelLog1p = require( './../lib' );
 
@@ -34,10 +36,11 @@ bench( pkg, function benchmark( b ) {
 	var y;
 	var i;
 
+	x = uniform( 100, FLOAT64_SQRT_HALF, FLOAT64_SQRT_TWO );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu() + 1.0 ) * 0.7071067811865476;
-		y = kernelLog1p( x );
+		y = kernelLog1p( x[ i%x.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/math/base/special/kernel-log1p/benchmark/benchmark.native.js

@@ -22,9 +22,11 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/array/uniform' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var tryRequire = require( '@stdlib/utils/try-require' );
+var FLOAT64_SQRT_HALF = require( '@stdlib/constants/float64/sqrt-half' );
+var FLOAT64_SQRT_TWO = require( '@stdlib/constants/float64/sqrt-two' );
 var pkg = require( './../package.json' ).name;
 
 
@@ -43,10 +45,11 @@ bench( pkg+'::native', opts, function benchmark( b ) {
 	var y;
 	var i;
 
+	x = uniform( 100, FLOAT64_SQRT_HALF, FLOAT64_SQRT_TWO );
+
 	b.tic();
 	for ( i = 0; i < b.iterations; i++ ) {
-		x = ( randu() + 1.0 ) * 0.7071067811865476;
-		y = kernelLog1p( x );
+		y = kernelLog1p( x[ i%x.length ] );
 		if ( isnan( y ) ) {
 			b.fail( 'should not return NaN' );
 		}

lib/node_modules/@stdlib/math/base/special/kernel-log1p/benchmark/c/native/benchmark.c

@@ -75,13 +75,15 @@ static double tic( void ) {
 }
 
 /**
-* Generates a random number on the interval [0,1).
+* Generates a random number on the interval [min,max).
 *
-* @return random number
+* @param min    minimum value (inclusive)
+* @param max    maximum value (exclusive)
+* @return       random number
 */
-static double rand_double( void ) {
-	int r = rand();
-	return (double)r / ( (double)RAND_MAX + 1.0 );
+static double random_uniform( const double min, const double max ) {
+	double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+	return min + ( v*(max-min) );
 }
 
 /**
@@ -91,15 +93,18 @@ static double rand_double( void ) {
 */
 static double benchmark( void ) {
 	double elapsed;
-	double x;
+	double x[100];
 	double z;
 	double t;
 	int i;
 
+	for ( i = 0; i < 100; i++ ) {
+		x[ i ] = random_uniform( 0.7071067811865476, 1.4142135623730951 ); // ~[sqrt(2)/2, sqrt(2)]
+	}
+
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		x = ( rand_double() + 1.0 ) * 0.7071067811865476;
-		z = stdlib_base_kernel_log1p( x );
+		z = stdlib_base_kernel_log1p( x[ i%100 ] );
 		if ( z != z ) {
 			printf( "should not return NaN\n" );
 			break;
@@ -124,7 +129,7 @@ int main( void ) {
 
 	print_version();
 	for ( i = 0; i < REPEATS; i++ ) {
-		printf( "# c::%s\n", NAME );
+		printf( "# c::native::%s\n", NAME );
 		elapsed = benchmark();
 		print_results( elapsed );
 		printf( "ok %d benchmark finished\n", i+1 );

lib/node_modules/@stdlib/math/base/special/kernel-log1p/docs/repl.txt

@@ -1,6 +1,7 @@
 
 {{alias}}( f )
-    Computes `log(1+f) - f` for `1+f` in ~[sqrt(2)/2, sqrt(2)].
+    Evaluates a correction term for double-precision base-2 and base-10
+    logarithms when `1+f` is in `[√2/2, √2]`.
 
     This function provides a common means for computing logarithms in base e.
     Argument reduction and adding the final term of the polynomial must be done

lib/node_modules/@stdlib/math/base/special/kernel-log1p/docs/types/index.d.ts

@@ -19,7 +19,7 @@
 // TypeScript Version: 4.1
 
 /**
-* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 *
 * ## Notes
 *

lib/node_modules/@stdlib/math/base/special/kernel-log1p/include/stdlib/math/base/special/kernel_log1p.h

@@ -29,7 +29,7 @@ extern "C" {
 #endif
 
 /**
-* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 */
 double stdlib_base_kernel_log1p( const double f );
 

lib/node_modules/@stdlib/math/base/special/kernel-log1p/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Compute `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+* Evaluate a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 *
 * @module @stdlib/math/base/special/kernel-log1p
 *

lib/node_modules/@stdlib/math/base/special/kernel-log1p/lib/main.js

@@ -41,7 +41,7 @@ var polyvalQ = require( './polyval_q.js' );
 // MAIN //
 
 /**
-* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 *
 * ## Method
 *

lib/node_modules/@stdlib/math/base/special/kernel-log1p/lib/native.js

@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
 // MAIN //
 
 /**
-* Computes `log(1+f) - f` for `1+f` in `~[sqrt(2)/2, sqrt(2)]`.
+* Evaluates a correction term for double-precision base-2 and base-10 logarithms when `1+f` is in `[√2/2, √2]`.
 *
 * @private
 * @param {number} f - input value