feat(math): add math/base/special/expf

vivekmaurya001 · vivekmaurya001 · commit df0e6c7fbbe4 · 2024-12-06T11:42:21.000+05:30
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/README.md b/lib/node_modules/@stdlib/math/base/special/expf/README.md
@@ -20,7 +20,7 @@ limitations under the License.
 
 # expf
 
-> Natural [exponential function][exponential-function] of a single-precision floating-point number
+> Natural [exponential function][exponential-function]
 
 <section class="intro">
 
@@ -55,14 +55,14 @@ var expf = require( '@stdlib/math/base/special/expf' );
 
 #### expf( x )
 
-Evaluates the natural [exponential function][exponential-function] of a single-precision floating-point number
+Evaluates the natural [exponential function][exponential-function] as a single-precision floating-point number
 
 ```javascript
 var v = expf( 4.0 );
-// returns ~54.5982
+// returns 54.598148345947266
 
 v = expf( -9.0 );
-// returns ~1.234e-4
+// returns 0.00012340980174485594
 
 v = expf( 0.0 );
 // returns 1.0
@@ -126,14 +126,14 @@ for ( i = 0; i < 100; i++ ) {
 
 #### stdlib_base_expf( x )
 
-Evaluates the natural [exponential function][exponential-function] single-precision floating-point number
+Evaluates the natural [exponential function][exponential-function] as a single-precision floating-point number
 
 ```c
 float out = stdlib_base_expf( 4.0 );
-// returns ~54.5982
+// returns 54.598148345947266
 
 out = stdlib_base_expf( -9.0 );
-// returns ~1.234e-4
+// returns 0.00012340980174485594
 ```
 
 The function accepts the following arguments:
@@ -173,7 +173,7 @@ int main( void ) {
     int i;
     
     for ( i = 0; i < 100; i++ ) {
-        x = ( (float)rand() / (float)RAND_MAX ) * 100.0;
+        x = ( (float)rand() / (float)RAND_MAX ) * 100.0f;
         v = stdlib_base_expf( x );
         printf( "e^%f = %f\n", x, v );
     }
@@ -211,7 +211,7 @@ int main( void ) {
 
 [exponential-function]: https://en.wikipedia.org/wiki/Exponential_function
 
-[@stdlib/constants/float64/e]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float64/e
+[@stdlib/constants/float32/e]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/e
 
 <!-- <related-links> -->
 
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/benchmark/c/cephes/benchmark.c b/lib/node_modules/@stdlib/math/base/special/expf/benchmark/c/cephes/benchmark.c
@@ -16,11 +16,11 @@
 * limitations under the License.
 */
 
-#include <stdlib.h>
-#include <stdio.h>
+#include <sys/time.h>
 #include <math.h>
+#include <stdio.h>
+#include <stdlib.h>
 #include <time.h>
-#include <sys/time.h>
 
 #define NAME "expf"
 #define ITERATIONS 1000000
@@ -75,7 +75,7 @@ static void print_results( double elapsed ) {
 static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
-	return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
+	return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
 }
 
 /**
@@ -102,7 +102,7 @@ static double benchmark( void ) {
 
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		x = ( 100.0f *rand_float() ) - 50.0f;
+		x = ( 100.0f * rand_float() ) - 50.0f;
 		y = expf( x );
 		if ( y != y ) {
 			printf( "should not return NaN\n" );
@@ -123,15 +123,15 @@ int main( void ) {
 	double elapsed;
 	int i;
 
-	// Use the current time to seed the random number generator:
+ // Use the current time to seed the random number generator:
 	srand( time( NULL ) );
 
 	print_version();
 	for ( i = 0; i < REPEATS; i++ ) {
 		printf( "# c::cephes::%s\n", NAME );
 		elapsed = benchmark();
 		print_results( elapsed );
-		printf( "ok %d benchmark finished\n", i+1 );
+		printf( "ok %d benchmark finished\n", i + 1 );
 	}
 	print_summary( REPEATS, REPEATS );
 }
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/benchmark/c/native/benchmark.c b/lib/node_modules/@stdlib/math/base/special/expf/benchmark/c/native/benchmark.c
@@ -16,12 +16,12 @@
 * limitations under the License.
 */
 
+#include <sys/time.h>
 #include "stdlib/math/base/special/expf.h"
-#include <stdlib.h>
-#include <stdio.h>
 #include <math.h>
+#include <stdio.h>
+#include <stdlib.h>
 #include <time.h>
-#include <sys/time.h>
 
 #define NAME "expf"
 #define ITERATIONS 1000000
@@ -71,7 +71,7 @@ static void print_results( double elapsed ) {
 static double tic( void ) {
 	struct timeval now;
 	gettimeofday( &now, NULL );
-	return (double)now.tv_sec + (double)now.tv_usec/1.0e6;
+	return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
 }
 
 /**
@@ -119,15 +119,15 @@ int main( void ) {
 	double elapsed;
 	int i;
 
-	// Use the current time to seed the random number generator:
+ // Use the current time to seed the random number generator:
 	srand( time( NULL ) );
 
 	print_version();
 	for ( i = 0; i < REPEATS; i++ ) {
 		printf( "# c::native::%s\n", NAME );
 		elapsed = benchmark();
 		print_results( elapsed );
-		printf( "ok %d benchmark finished\n", i+1 );
+		printf( "ok %d benchmark finished\n", i + 1 );
 	}
 	print_summary( REPEATS, REPEATS );
 }
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/docs/repl.txt b/lib/node_modules/@stdlib/math/base/special/expf/docs/repl.txt
@@ -1,6 +1,6 @@
 
 {{alias}}( x )
-    Evaluates the natural exponential function.
+    Evaluates the natural exponential function (single-precision).
 
     Parameters
     ----------
@@ -15,9 +15,9 @@
     Examples
     --------
     > var y = {{alias}}( 4.0 )
-    ~54.5982
+    54.598148345947266
     > y = {{alias}}( -9.0 )
-    ~1.234e-4
+    0.00012340980174485594
     > y = {{alias}}( 0.0 )
     1.0
     > y = {{alias}}( NaN )
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/special/expf/docs/types/index.d.ts
@@ -19,7 +19,7 @@
 // TypeScript Version: 4.1
 
 /**
-* Evaluates the natural exponential function.
+* Evaluates the natural exponential function as a single-precision floating-point number.
 *
 * @param x - input value
 * @returns function value
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/examples/c/example.c b/lib/node_modules/@stdlib/math/base/special/expf/examples/c/example.c
@@ -17,17 +17,17 @@
 */
 
 #include "stdlib/math/base/special/expf.h"
-#include <stdlib.h>
 #include <stdio.h>
+#include <stdlib.h>
 
 int main( void ) {
-    float x;
-    float v;
-    int i;
+	float x;
+	float v;
+	int i;
 
-    for ( i = 0; i < 100; i++ ) {
-        x = ( (float)rand() / (float)RAND_MAX ) * 100.0f;
-        v = stdlib_base_expf( x );
-        printf( "e^%f = %f\n", x, v );
-    }
+	for ( i = 0; i < 100; i++ ) {
+		x = ( (float)rand() / (float)RAND_MAX ) * 100.0f;
+		v = stdlib_base_expf( x );
+		printf( "e^%f = %f\n", x, v );
+	}
 }
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/lib/index.js b/lib/node_modules/@stdlib/math/base/special/expf/lib/index.js
@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* Evaluate the natural exponential function.
+* Evaluate the natural exponential function as a single-precision floating-point number.
 *
 * @module @stdlib/math/base/special/expf
 *
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/lib/main.js b/lib/node_modules/@stdlib/math/base/special/expf/lib/main.js
@@ -57,7 +57,7 @@ var NEG_NEARZERO = -NEARZERO;
 // MAIN //
 
 /**
-* Evaluates the natural exponential function for single-precision.
+* Evaluates the natural exponential function as a single-precision floating-point number.
 *
 * ## Method
 *
@@ -144,11 +144,11 @@ var NEG_NEARZERO = -NEARZERO;
 *
 * @example
 * var v = expf( 4.0 );
-* // returns ~54.598
+* // returns 54.598148345947266
 *
 * @example
 * var v = expf( -9.0 );
-* // returns ~1.234e-4
+* // returns 0.00012340980174485594
 *
 * @example
 * var v = expf( 0.0 );
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/lib/native.js b/lib/node_modules/@stdlib/math/base/special/expf/lib/native.js
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
 // MAIN //
 
 /**
-* Evaluates the natural exponential function for single-precision.
+* Evaluates the natural exponential function as a single-precision floating-point number.
 *
 * @private
 * @param {number} x - input value
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/package.json b/lib/node_modules/@stdlib/math/base/special/expf/package.json
@@ -60,20 +60,21 @@
     "special",
     "function",
     "math.exp",
-    "exp",
+    "expf",
     "natural",
     "exponential",
     "euler",
     "power",
+    "float",
     "number"
   ],
   "__stdlib__": {
     "scaffold": {
       "$schema": "math/base@v1.0",
       "base_alias": "expf",
       "alias": "expf",
-      "pkg_desc": "evaluate the natural exponential function (single-precision)",
-      "desc": "evaluates the natural exponential function using single-precision floating-point numbers",
+      "pkg_desc": "evaluate the natural exponential function as a single-precision floating-point number",
+      "desc": "evaluates the natural exponential function as a single-precision floating-point number",
       "short_desc": "natural exponential function  (single-precision)",
       "parameters": [
         {
@@ -134,7 +135,7 @@
       "keywords": [
         "natural",
         "exponential",
-        "exp",
+        "expf",
         "power"
       ],
       "extra_keywords": [
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/scripts/precision.js b/lib/node_modules/@stdlib/math/base/special/expf/scripts/precision.js
@@ -18,14 +18,11 @@
 
 'use strict';
 
-// TODO: clean-up
-
 // MODULES //
 
-var divide = require( 'compute-divide' );
-var mean = require( 'compute-mean' );
-var subtract = require( 'compute-subtract' );
+var mean = require( '@stdlib/stats/base/mean' );
 var absf = require( '@stdlib/math/base/special/absf' );
+var exp = require( '@stdlib/math/base/special/exp' );
 var expf = require( './../lib' );
 
 
@@ -50,11 +47,16 @@ ycustom = new Array( x.length );
 ynative = new Array( x.length );
 for ( i = 0; i < x.length; i++ ) {
 	ycustom[ i ] = expf( x[ i ] );
-	ynative[ i ] = Math.expf( x[ i ] );
+	ynative[ i ] = exp( x[ i ] );
 }
 
-customErrs = absf( divide( subtract( ycustom, yexpected ), yexpected ) );
-nativeErrs = absf( divide( subtract( ynative, yexpected ), yexpected ) );
+customErrs = new Array(x.length);
+nativeErrs = new Array(x.length);
+
+for (i = 0; i < x.length; i++) {
+	customErrs[i] = absf((ycustom[i] - yexpected[i]) / yexpected[i]);
+	nativeErrs[i] = absf((ynative[i] - yexpected[i]) / yexpected[i]);
+}
 
-console.log( 'The mean relative error of Math.expf compared to Julia is %d', mean( nativeErrs ) );
-console.log( 'The mean relative error of this module compared to Julia is %d', mean( customErrs ) );
+console.log( 'The mean relative error of exp compared to Julia is %d', mean( x.length, nativeErrs, 1 ) );
+console.log( 'The mean relative error of this module compared to Julia is %d', mean( x.length, customErrs, 1 ) );
diff --git a/lib/node_modules/@stdlib/math/base/special/expf/src/main.c b/lib/node_modules/@stdlib/math/base/special/expf/src/main.c
@@ -65,7 +65,7 @@ static const float NEG_NEARZERO = -1.0 / ( 1 << 14 );
 * @return     evaluated polynomial
 */
 static float polyval_p( const float x ) {
-	return 0.1666662544f + (x * -0.0027667332906f);
+	return 0.1666662544f + ( x * -0.0027667332906f );
 }
 
 // END: polyval_p
@@ -100,7 +100,7 @@ static float expmulti( const float hi, const float lo, const int32_t k ) {
 }
 
 /**
-* Evaluates the natural exponential function.
+* Evaluates the natural exponential function as a single-precision floating-point number.
 *
 * ## Method
 *
@@ -181,13 +181,6 @@ static float expmulti( const float hi, const float lo, const int32_t k ) {
 *
 * ## Notes
 *
-* -   According to an error analysis, the error is always less than \\(1\\) ulp (unit in the last place).
-*
-* -   For an IEEE double,
-*
-*     -   if \\(x > 7.09782712893383973096\mbox{e+}02\\), then \\(e^{x}\\) overflows
-*     -   if \\(x < -7.45133219101941108420\mbox{e+}02\\), then \\(e^{x}\\) underflows
-*
 * -   The hexadecimal values included in the source code are the intended ones for the used constants. Decimal values may be used, provided that the compiler will convert from decimal to binary accurately enough to produce the intended hexadecimal values.
 *
 * @param x    input value

Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`// TypeScript Version: 4.1`
`20`	`20`
`21`	`21`	`/**`
`22`		`-* Evaluates the natural exponential function.`
	`22`	`+* Evaluates the natural exponential function as a single-precision floating-point number.`
`23`	`23`	`*`
`24`	`24`	`* @param x - input value`
`25`	`25`	`* @returns function value`
Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,7 @@ var NEG_NEARZERO = -NEARZERO;`
`57`	`57`	`// MAIN //`
`58`	`58`
`59`	`59`	`/**`
`60`		`-* Evaluates the natural exponential function for single-precision.`
	`60`	`+* Evaluates the natural exponential function as a single-precision floating-point number.`
`61`	`61`	`*`
`62`	`62`	`* ## Method`
`63`	`63`	`*`
`@@ -144,11 +144,11 @@ var NEG_NEARZERO = -NEARZERO;`
`144`	`144`	`*`
`145`	`145`	`* @example`
`146`	`146`	`* var v = expf( 4.0 );`
`147`		`-* // returns ~54.598`
	`147`	`+* // returns 54.598148345947266`
`148`	`148`	`*`
`149`	`149`	`* @example`
`150`	`150`	`* var v = expf( -9.0 );`
`151`		`-* // returns ~1.234e-4`
	`151`	`+* // returns 0.00012340980174485594`
`152`	`152`	`*`
`153`	`153`	`* @example`
`154`	`154`	`* var v = expf( 0.0 );`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );`
`26`	`26`	`// MAIN //`
`27`	`27`
`28`	`28`	`/**`
`29`		`-* Evaluates the natural exponential function for single-precision.`
	`29`	`+* Evaluates the natural exponential function as a single-precision floating-point number.`
`30`	`30`	`*`
`31`	`31`	`* @private`
`32`	`32`	`* @param {number} x - input value`