refactor!: modify C implementation to accept float instead of int32 in math/base/special/lucasf

This commit updates the signature of the C API to accept a float rather than int32. The rationale was so that users get the same results/behavior in both JavaScript and C. This arose in the context of ufuncs, where the diverging type signatures meant differences in what dtypes would be permissible. Instead, we decided to unify and ensure the behavior is consistent.

BREAKING CHANGE: update signature to accept floats

User code should behave similarly in the primary case of providing integer-valued input values. However, no longer will real-values truncate. Now, real-valued inputs will result in `NaN`, which is, arguably, better behavior, as real-to-integer truncation can be a source of silent bugs.

PR-URL: #7939
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: gunjjoshi

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

@@ -164,19 +164,19 @@ logEachMap( 'lucasf(%d) = %0.1f', x, lucasf );
 Computes the nth [Lucas number][lucas-number] as a single-precision floating-point number.
 
 ```c
-float out = stdlib_base_lucasf( 0 );
+float out = stdlib_base_lucasf( 0.0f );
 // returns 2.0f
 
-out = stdlib_base_lucasf( 1 );
+out = stdlib_base_lucasf( 1.0f );
 // returns 1.0f
 ```
 
 The function accepts the following arguments:
 
--   **n**: `[in] int32_t` input value.
+-   **n**: `[in] float` input value.
 
 ```c
-float stdlib_base_lucasf( const int32_t n );
+float stdlib_base_lucasf( const float n );
 ```
 
 </section>
@@ -200,15 +200,14 @@ float stdlib_base_lucasf( const int32_t n );
 ```c
 #include "stdlib/math/base/special/lucasf.h"
 #include <stdio.h>
-#include <stdint.h>
 
 int main( void ) {
-    int32_t i;
+    float i;
     float v;
 
-    for ( i = 0; i < 35; i++ ) {
+    for ( i = 0.0f; i < 35.0f; i++ ) {
         v = stdlib_base_lucasf( i );
-        printf( "lucasf(%d) = %f\n", i, v );
+        printf( "lucasf(%f) = %f\n", i, v );
     }
 }
 ```

lib/node_modules/@stdlib/math/base/special/lucasf/benchmark/c/native/benchmark.c

@@ -91,14 +91,14 @@ static float rand_float( void ) {
 * @return elapsed time in seconds
 */
 static double benchmark( void ) {
-	int32_t x[ 100 ];
+	float x[ 100 ];
 	double elapsed;
 	double t;
 	float y;
 	int i;
 
 	for ( i = 0; i < 100; i++ ) {
-		x[ i ] = (int32_t)( 34.0f*rand_float() );
+		x[ i ] = ( 34.0f*rand_float() );
 	}
 
 	t = tic();

lib/node_modules/@stdlib/math/base/special/lucasf/examples/c/example.c

@@ -18,14 +18,13 @@
 
 #include "stdlib/math/base/special/lucasf.h"
 #include <stdio.h>
-#include <stdint.h>
 
 int main( void ) {
-	int32_t i;
+	float i;
 	float v;
 
-	for ( i = 0; i < 35; i++ ) {
+	for ( i = 0.0f; i < 35.0f; i++ ) {
 		v = stdlib_base_lucasf( i );
-		printf( "lucasf(%d) = %f\n", i, v );
+		printf( "lucasf(%f) = %f\n", i, v );
 	}
 }

lib/node_modules/@stdlib/math/base/special/lucasf/include/stdlib/math/base/special/lucasf.h

@@ -19,8 +19,6 @@
 #ifndef STDLIB_MATH_BASE_SPECIAL_LUCASF_H
 #define STDLIB_MATH_BASE_SPECIAL_LUCASF_H
 
-#include <stdint.h>
-
 /*
 * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
 */
@@ -31,7 +29,7 @@ extern "C" {
 /**
 * Computes the nth Lucas number as a single-precision floating-point number.
 */
-float stdlib_base_lucasf( const int32_t n );
+float stdlib_base_lucasf( const float n );
 
 #ifdef __cplusplus
 }

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

@@ -21,7 +21,7 @@
 // MODULES //
 
 var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
-var isIntegerf = require( '@stdlib/math/base/assert/is-integerf' );
+var isNonNegativeIntegerf = require( '@stdlib/math/base/assert/is-nonnegative-integerf' );
 var MAX_LUCAS = require( '@stdlib/constants/float32/max-safe-nth-lucas' );
 var LUCAS = require( './lucas.json' );
 
@@ -77,8 +77,7 @@ var LUCAS = require( './lucas.json' );
 function lucasf( n ) {
 	if (
 		isnanf( n ) ||
-		isIntegerf( n ) === false ||
-		n < 0 ||
+		!isNonNegativeIntegerf( n ) ||
 		n > MAX_LUCAS
 	) {
 		return NaN;

lib/node_modules/@stdlib/math/base/special/lucasf/manifest.json

@@ -37,7 +37,8 @@
       "libpath": [],
       "dependencies": [
         "@stdlib/math/base/napi/unary",
-        "@stdlib/constants/float32/max-safe-nth-lucas"
+        "@stdlib/constants/float32/max-safe-nth-lucas",
+        "@stdlib/math/base/assert/is-nonnegative-integerf"
       ]
     },
     {
@@ -51,7 +52,8 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
-        "@stdlib/constants/float32/max-safe-nth-lucas"
+        "@stdlib/constants/float32/max-safe-nth-lucas",
+        "@stdlib/math/base/assert/is-nonnegative-integerf"
       ]
     },
     {
@@ -65,7 +67,8 @@
       "libraries": [],
       "libpath": [],
       "dependencies": [
-        "@stdlib/constants/float32/max-safe-nth-lucas"
+        "@stdlib/constants/float32/max-safe-nth-lucas",
+        "@stdlib/math/base/assert/is-nonnegative-integerf"
       ]
     }
   ]

lib/node_modules/@stdlib/math/base/special/lucasf/src/addon.c

@@ -19,4 +19,4 @@
 #include "stdlib/math/base/special/lucasf.h"
 #include "stdlib/math/base/napi/unary.h"
 
-STDLIB_MATH_BASE_NAPI_MODULE_I_F( stdlib_base_lucasf )
+STDLIB_MATH_BASE_NAPI_MODULE_F_F( stdlib_base_lucasf )

lib/node_modules/@stdlib/math/base/special/lucasf/src/main.c

@@ -17,7 +17,10 @@
 */
 
 #include "stdlib/math/base/special/lucasf.h"
+#include "stdlib/math/base/assert/is_nonnegative_integerf.h"
 #include "stdlib/constants/float32/max_safe_nth_lucas.h"
+#include <stdint.h>
+#include <stdlib.h>
 
 static const int32_t lucas_value[ 35 ] = {
 	2,
@@ -64,16 +67,16 @@ static const int32_t lucas_value[ 35 ] = {
 * @return      output value
 *
 * @example
-* float out = stdlib_base_lucasf( 1 );
+* float out = stdlib_base_lucasf( 1.0f );
 * // returns 1.0f
 *
 * @example
-* float out = stdlib_base_lucasf( -1 );
+* float out = stdlib_base_lucasf( -1.0f );
 * // returns NaN
 */
-float stdlib_base_lucasf( const int32_t n ) {
-	if ( n < 0 || n > STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS ) {
+float stdlib_base_lucasf( const float n ) {
+	if ( !stdlib_base_is_nonnegative_integerf( n ) || n > STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS ) {
 		return 0.0f / 0.0f; // NaN
 	}
-	return lucas_value[ n ];
+	return lucas_value[ (size_t)n ];
 }