Auto-generated commit

CHANGELOG.md

@@ -200,6 +200,40 @@ This release closes the following issue:
 
 <!-- /.package -->
 
+<section class="package" id="constants-float32-max-safe-nth-lucas-unreleased">
+
+#### [@stdlib/constants/float32/max-safe-nth-lucas](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-safe-nth-lucas)
+
+<details>
+
+<section class="features">
+
+##### Features
+
+-   [`ed63505`](https://github.com/stdlib-js/stdlib/commit/ed6350530cfae8d685f02987681d7933b83d88b7) - add `constants/float32/max-safe-nth-lucas` [(#3337)](https://github.com/stdlib-js/stdlib/pull/3337)
+
+</section>
+
+<!-- /.features -->
+
+<section class="issues">
+
+##### Closed Issues
+
+This release closes the following issue:
+
+[#3336](https://github.com/stdlib-js/stdlib/issues/3336)
+
+</section>
+
+<!-- /.issues -->
+
+</details>
+
+</section>
+
+<!-- /.package -->
+
 <section class="package" id="constants-float32-min-base10-exponent-unreleased">
 
 #### [@stdlib/constants/float32/min-base10-exponent](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent)
@@ -482,9 +516,9 @@ This release closes the following issue:
 
 ### Closed Issues
 
-A total of 7 issues were closed in this release:
+A total of 8 issues were closed in this release:
 
-[#3090](https://github.com/stdlib-js/stdlib/issues/3090), [#3093](https://github.com/stdlib-js/stdlib/issues/3093), [#3094](https://github.com/stdlib-js/stdlib/issues/3094), [#3325](https://github.com/stdlib-js/stdlib/issues/3325), [#3327](https://github.com/stdlib-js/stdlib/issues/3327), [#3332](https://github.com/stdlib-js/stdlib/issues/3332), [#3344](https://github.com/stdlib-js/stdlib/issues/3344)
+[#3090](https://github.com/stdlib-js/stdlib/issues/3090), [#3093](https://github.com/stdlib-js/stdlib/issues/3093), [#3094](https://github.com/stdlib-js/stdlib/issues/3094), [#3325](https://github.com/stdlib-js/stdlib/issues/3325), [#3327](https://github.com/stdlib-js/stdlib/issues/3327), [#3332](https://github.com/stdlib-js/stdlib/issues/3332), [#3336](https://github.com/stdlib-js/stdlib/issues/3336), [#3344](https://github.com/stdlib-js/stdlib/issues/3344)
 
 </section>
 
@@ -514,6 +548,7 @@ A total of 7 people contributed to this release. Thank you to the following cont
 
 <details>
 
+-   [`ed63505`](https://github.com/stdlib-js/stdlib/commit/ed6350530cfae8d685f02987681d7933b83d88b7) - **feat:** add `constants/float32/max-safe-nth-lucas` [(#3337)](https://github.com/stdlib-js/stdlib/pull/3337) _(by Aayush Khanna, Athan Reines)_
 -   [`5a4f6ed`](https://github.com/stdlib-js/stdlib/commit/5a4f6edd9eb9e71c3b86e37bebc0d9125efe4931) - **feat:** add `constants/float32/ln-half` [(#3333)](https://github.com/stdlib-js/stdlib/pull/3333) _(by Vivek maurya, Athan Reines, Gunj Joshi, stdlib-bot)_
 -   [`fc8571d`](https://github.com/stdlib-js/stdlib/commit/fc8571d4e2f7981711a85db47ef8d4acfecfba32) - **feat:** add `constants/float32/ln-pi` [(#3342)](https://github.com/stdlib-js/stdlib/pull/3342) _(by Vivek maurya, Athan Reines, stdlib-bot)_
 -   [`d7dc119`](https://github.com/stdlib-js/stdlib/commit/d7dc1197d55a17e6d3f9df1c17b2e13fe57df916) - **fix:** ensure header files reside in correct directories _(by Philipp Burckhardt)_

float32/max-safe-nth-lucas/README.md

@@ -0,0 +1,174 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# FLOAT32_MAX_SAFE_NTH_LUCAS
+
+> Maximum safe nth [Lucas number][lucas-number] when stored in [single-precision floating-point][ieee754] format.
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var FLOAT32_MAX_SAFE_NTH_LUCAS = require( '@stdlib/constants/float32/max-safe-nth-lucas' );
+```
+
+#### FLOAT32_MAX_SAFE_NTH_LUCAS
+
+The maximum [safe][safe-integers] nth [Lucas number][lucas-number] when stored in [single-precision floating-point][ieee754] format.
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var bool = ( FLOAT32_MAX_SAFE_NTH_LUCAS === 34 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable id-length -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT32_MAX_SAFE_NTH_LUCAS = require( '@stdlib/constants/float32/max-safe-nth-lucas' );
+
+function lucas( n ) {
+    var a;
+    var b;
+    var c;
+    var i;
+
+    a = 2;
+    if ( n === 0 ) {
+        return a;
+    }
+    b = 1;
+    for ( i = 2; i <= n; i++ ) {
+        c = a + b;
+        a = b;
+        b = c;
+    }
+    return b;
+}
+
+var v;
+var i;
+for ( i = 0; i < 100; i++ ) {
+    v = lucas( i );
+    if ( i > FLOAT32_MAX_SAFE_NTH_LUCAS ) {
+        console.log( 'Unsafe: %d', v );
+    } else {
+        console.log( 'Safe:   %d', v );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/constants/float32/max_safe_nth_lucas.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_LUCAS
+
+Macro for the maximum [safe][safe-integers] nth [Lucas number][lucas-number] when stored in [single-precision floating-point][ieee754] format.
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[safe-integers]: http://www.2ality.com/2013/10/safe-integers.html
+
+[lucas-number]: https://en.wikipedia.org/wiki/Lucas_number
+
+[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

float32/max-safe-nth-lucas/docs/repl.txt

@@ -0,0 +1,13 @@
+
+{{alias}}
+    Maximum safe nth Lucas number when stored in single-precision floating-point
+    format.
+
+    Examples
+    --------
+    > {{alias}}
+    34
+
+    See Also
+    --------
+

float32/max-safe-nth-lucas/docs/types/index.d.ts

@@ -0,0 +1,33 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/**
+* Maximum safe nth Lucas number when stored in single-precision floating-point format.
+*
+* @example
+* var max = FLOAT32_MAX_SAFE_NTH_LUCAS;
+* // returns 34
+*/
+declare const FLOAT32_MAX_SAFE_NTH_LUCAS: number;
+
+
+// EXPORTS //
+
+export = FLOAT32_MAX_SAFE_NTH_LUCAS;

float32/max-safe-nth-lucas/docs/types/test.ts

@@ -0,0 +1,28 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import FLOAT32_MAX_SAFE_NTH_LUCAS = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT32_MAX_SAFE_NTH_LUCAS; // $ExpectType number
+}

float32/max-safe-nth-lucas/examples/index.js

@@ -0,0 +1,51 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+var FLOAT32_MAX_SAFE_NTH_LUCAS = require( './../lib' ); // eslint-disable-line id-length
+
+function lucas( n ) {
+	var a;
+	var b;
+	var c;
+	var i;
+
+	a = 2;
+	if ( n === 0 ) {
+		return a;
+	}
+	b = 1;
+	for ( i = 2; i <= n; i++ ) {
+		c = a + b;
+		a = b;
+		b = c;
+	}
+	return b;
+}
+
+var v;
+var i;
+for ( i = 0; i < 100; i++ ) {
+	v = lucas( i );
+	if ( i > FLOAT32_MAX_SAFE_NTH_LUCAS ) {
+		console.log( 'Unsafe: %d', v );
+	} else {
+		console.log( 'Safe:   %d', v );
+	}
+}

float32/max-safe-nth-lucas/include/stdlib/constants/float32/max_safe_nth_lucas.h

@@ -0,0 +1,27 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+#ifndef STDLIB_CONSTANTS_FLOAT32_MAX_SAFE_NTH_LUCAS_H
+#define STDLIB_CONSTANTS_FLOAT32_MAX_SAFE_NTH_LUCAS_H
+
+/**
+* Macro for the maximum safe nth Lucas number when stored in single-precision floating-point format.
+*/
+#define STDLIB_CONSTANT_FLOAT64_MAX_SAFE_NTH_LUCAS 34
+
+#endif // !STDLIB_CONSTANTS_FLOAT32_MAX_SAFE_NTH_LUCAS_H