Auto-generated commit

Author: stdlib-bot

CHANGELOG.md

@@ -220,6 +220,10 @@
 
 ### BREAKING CHANGES
 
+-   [`3d340e2`](https://github.com/stdlib-js/stdlib/commit/3d340e2d72c1601c2286210f89d182e4132befed): update signature to accept doubles
+
+    -   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.
+
 -   [`709c1ab`](https://github.com/stdlib-js/stdlib/commit/709c1abf833a21997dd32edb395649e0a9e925df): 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.
@@ -573,6 +577,7 @@ A total of 62 issues were closed in this release:
 
 <details>
 
+-   [`3d340e2`](https://github.com/stdlib-js/stdlib/commit/3d340e2d72c1601c2286210f89d182e4132befed) - **refactor:** modify C implementation to accept `double` instead of `int32` in `math/base/special/lucas` [(#7936)](https://github.com/stdlib-js/stdlib/pull/7936) _(by Gunj Joshi)_
 -   [`709c1ab`](https://github.com/stdlib-js/stdlib/commit/709c1abf833a21997dd32edb395649e0a9e925df) - **refactor:** modify C implementation to accept `float` instead of `int32` in `math/base/special/fibonaccif` [(#7938)](https://github.com/stdlib-js/stdlib/pull/7938) _(by Gunj Joshi)_
 -   [`c5b3e0a`](https://github.com/stdlib-js/stdlib/commit/c5b3e0a0dab79dd39984f0a6bf45cd1a80f1f865) - **docs:** replace integers with doubles in `math/base/special/fibonacci` [(#7937)](https://github.com/stdlib-js/stdlib/pull/7937) _(by Gunj Joshi)_
 -   [`0283804`](https://github.com/stdlib-js/stdlib/commit/02838049b98a8ae3c595714e397364aace06f7b9) - **chore:** add structured package data for `math/base/special/absgammalnf` [(#7925)](https://github.com/stdlib-js/stdlib/pull/7925) _(by Gunj Joshi, Athan Reines)_

base/special/lucas/README.md

@@ -174,19 +174,19 @@ for ( i = 0; i < 77; i++ ) {
 Computes the nth [Lucas number][lucas-number].
 
 ```c
-double out = stdlib_base_lucas( 0 );
-// returns 2
+double out = stdlib_base_lucas( 0.0 );
+// returns 2.0
 
-out = stdlib_base_lucas( 1 );
-// returns 1
+out = stdlib_base_lucas( 1.0 );
+// returns 1.0
 ```
 
 The function accepts the following arguments:
 
--   **n**: `[in] int32_t` input value.
+-   **n**: `[in] double` input value.
 
 ```c
-double stdlib_base_lucas( const int32_t n );
+double stdlib_base_lucas( const double n );
 ```
 
 </section>
@@ -210,15 +210,14 @@ double stdlib_base_lucas( const int32_t n );
 ```c
 #include "stdlib/math/base/special/lucas.h"
 #include <stdio.h>
-#include <stdint.h>
 
 int main( void ) {
-    int32_t i;
+    double i;
     double v;
 
-    for ( i = 0; i < 77; i++ ) {
+    for ( i = 0.0; i < 77.0; i++ ) {
         v = stdlib_base_lucas( i );
-        printf( "lucas(%d) = %lf\n", i, v );
+        printf( "lucas(%lf) = %lf\n", i, v );
     }
 }
 ```

base/special/lucas/benchmark/c/native/benchmark.c

@@ -30,7 +30,7 @@
 /**
 * Prints the TAP version.
 */
-void print_version() {
+static void print_version( void ) {
 	printf( "TAP version 13\n" );
 }
 
@@ -91,14 +91,14 @@ static double rand_double( void ) {
 */
 static double benchmark( void ) {
 	double elapsed;
-	int32_t x;
+	double x;
 	double t;
 	double y;
 	int i;
 
 	t = tic();
 	for ( i = 0; i < ITERATIONS; i++ ) {
-		x = (int32_t)( 76.0*rand_double() );
+		x = ( 76.0*rand_double() );
 		y = stdlib_base_lucas( x );
 		if ( y != y ) {
 			printf( "should not return NaN\n" );

base/special/lucas/examples/c/example.c

@@ -18,14 +18,13 @@
 
 #include "stdlib/math/base/special/lucas.h"
 #include <stdio.h>
-#include <stdint.h>
 
 int main( void ) {
-	int32_t i;
+	double i;
 	double v;
 
-	for ( i = 0; i < 77; i++ ) {
+	for ( i = 0.0; i < 77.0; i++ ) {
 		v = stdlib_base_lucas( i );
-		printf( "lucas(%d) = %lf\n", i, v );
+		printf( "lucas(%lf) = %lf\n", i, v );
 	}
 }

base/special/lucas/include/stdlib/math/base/special/lucas.h

@@ -19,8 +19,6 @@
 #ifndef STDLIB_MATH_BASE_SPECIAL_LUCAS_H
 #define STDLIB_MATH_BASE_SPECIAL_LUCAS_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.
 */
-double stdlib_base_lucas( const int32_t n );
+double stdlib_base_lucas( const double n );
 
 #ifdef __cplusplus
 }

base/special/lucas/lib/main.js

@@ -21,7 +21,7 @@
 // MODULES //
 
 var isnan = require( './../../../../base/assert/is-nan' );
-var isInteger = require( './../../../../base/assert/is-integer' );
+var isNonNegativeInteger = require( './../../../../base/assert/is-nonnegative-integer' );
 var MAX_LUCAS = require( '@stdlib/constants/float64/max-safe-nth-lucas' );
 var LUCAS = require( './lucas.json' );
 
@@ -77,8 +77,7 @@ var LUCAS = require( './lucas.json' );
 function lucas( n ) {
 	if (
 		isnan( n ) ||
-		isInteger( n ) === false ||
-		n < 0 ||
+		!isNonNegativeInteger( n ) ||
 		n > MAX_LUCAS
 	) {
 		return NaN;

base/special/lucas/manifest.json

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

base/special/lucas/src/addon.c

@@ -19,4 +19,4 @@
 #include "stdlib/math/base/special/lucas.h"
 #include "stdlib/math/base/napi/unary.h"
 
-STDLIB_MATH_BASE_NAPI_MODULE_I_D( stdlib_base_lucas )
+STDLIB_MATH_BASE_NAPI_MODULE_D_D( stdlib_base_lucas )

base/special/lucas/src/main.c

@@ -17,7 +17,10 @@
 */
 
 #include "stdlib/math/base/special/lucas.h"
+#include "stdlib/math/base/assert/is_nonnegative_integer.h"
 #include "stdlib/constants/float64/max_safe_nth_lucas.h"
+#include <stdint.h>
+#include <stdlib.h>
 
 static const int64_t lucas_value[ 77 ] = {
 	2,
@@ -106,16 +109,16 @@ static const int64_t lucas_value[ 77 ] = {
 * @return      output value
 *
 * @example
-* double out = stdlib_base_lucas( 1 );
-* // returns 1
+* double out = stdlib_base_lucas( 1.0 );
+* // returns 1.0
 *
 * @example
-* double out = stdlib_base_lucas( -1 );
+* double out = stdlib_base_lucas( -1.0 );
 * // returns NaN
 */
-double stdlib_base_lucas( const int32_t n ) {
-	if ( n < 0 || n > STDLIB_CONSTANT_FLOAT64_MAX_SAFE_NTH_LUCAS ) {
+double stdlib_base_lucas( const double n ) {
+	if ( !stdlib_base_is_nonnegative_integer( n ) || n > STDLIB_CONSTANT_FLOAT64_MAX_SAFE_NTH_LUCAS ) {
 		return 0.0 / 0.0; // NaN
 	}
-	return lucas_value[ n ];
+	return lucas_value[ (size_t)n ];
 }