Skip to content

Commit f4acf70

Browse files
gunjjoshigunjjoshi
authored
feat: add constants/float32/max-safe-nth-fibonacci
PR-URL: #2836 Ref: #649 Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 1f7fd37 commit f4acf70

File tree

10 files changed

+515
-0
lines changed

10 files changed

+515
-0
lines changed

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/README.md

+171
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2024 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# FLOAT32_MAX_SAFE_NTH_FIBONACCI
22+
23+
> Maximum safe nth [Fibonacci number][fibonacci-number] when stored in [single-precision floating-point][ieee754] format.
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
<!-- eslint-disable id-length -->
30+
31+
```javascript
32+
var FLOAT32_MAX_SAFE_NTH_FIBONACCI = require( '@stdlib/constants/float32/max-safe-nth-fibonacci' );
33+
```
34+
35+
#### FLOAT32_MAX_SAFE_NTH_FIBONACCI
36+
37+
The maximum [safe][safe-integers] nth [Fibonacci number][fibonacci-number] when stored in [single-precision floating-point][ieee754] format.
38+
39+
<!-- eslint-disable id-length -->
40+
41+
```javascript
42+
var bool = ( FLOAT32_MAX_SAFE_NTH_FIBONACCI === 36 );
43+
// returns true
44+
```
45+
46+
</section>
47+
48+
<!-- /.usage -->
49+
50+
<section class="examples">
51+
52+
## Examples
53+
54+
<!-- eslint-disable id-length -->
55+
56+
<!-- eslint no-undef: "error" -->
57+
58+
```javascript
59+
var FLOAT32_MAX_SAFE_NTH_FIBONACCI = require( '@stdlib/constants/float32/max-safe-nth-fibonacci' );
60+
61+
function fibonacci( n ) {
62+
var a;
63+
var b;
64+
var c;
65+
var i;
66+
67+
a = 1;
68+
b = 1;
69+
for ( i = 3; i <= n; i++ ) {
70+
c = a + b;
71+
a = b;
72+
b = c;
73+
}
74+
return b;
75+
}
76+
77+
var v;
78+
var i;
79+
for ( i = 0; i < 50; i++ ) {
80+
v = fibonacci( i );
81+
if ( i > FLOAT32_MAX_SAFE_NTH_FIBONACCI ) {
82+
console.log( 'Unsafe: %d', v );
83+
} else {
84+
console.log( 'Safe: %d', v );
85+
}
86+
}
87+
```
88+
89+
</section>
90+
91+
<!-- /.examples -->
92+
93+
<!-- C interface documentation. -->
94+
95+
* * *
96+
97+
<section class="c">
98+
99+
## C APIs
100+
101+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
102+
103+
<section class="intro">
104+
105+
</section>
106+
107+
<!-- /.intro -->
108+
109+
<!-- C usage documentation. -->
110+
111+
<section class="usage">
112+
113+
### Usage
114+
115+
```c
116+
#include "stdlib/constants/float32/max_safe_nth_fibonacci.h"
117+
```
118+
119+
#### STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_FIBONACCI
120+
121+
Macro for the maximum [safe][safe-integers] nth [Fibonacci number][fibonacci-number] when stored in [single-precision floating-point][ieee754] format.
122+
123+
</section>
124+
125+
<!-- /.usage -->
126+
127+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
128+
129+
<section class="notes">
130+
131+
</section>
132+
133+
<!-- /.notes -->
134+
135+
<!-- C API usage examples. -->
136+
137+
<section class="examples">
138+
139+
</section>
140+
141+
<!-- /.examples -->
142+
143+
</section>
144+
145+
<!-- /.c -->
146+
147+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
148+
149+
<section class="related">
150+
151+
</section>
152+
153+
<!-- /.related -->
154+
155+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
156+
157+
<section class="links">
158+
159+
[safe-integers]: http://www.2ality.com/2013/10/safe-integers.html
160+
161+
[fibonacci-number]: https://en.wikipedia.org/wiki/Fibonacci_number
162+
163+
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
164+
165+
<!-- <related-links> -->
166+
167+
<!-- </related-links> -->
168+
169+
</section>
170+
171+
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/docs/repl.txt

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
2+
{{alias}}
3+
Maximum safe nth Fibonacci number when stored in single-precision floating-
4+
point format.
5+
6+
Examples
7+
--------
8+
> {{alias}}
9+
36
10+
11+
See Also
12+
--------
13+

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/docs/types/index.d.ts

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Maximum safe nth Fibonacci number when stored in single-precision floating-point format.
23+
*
24+
* @example
25+
* var max = FLOAT32_MAX_SAFE_NTH_FIBONACCI;
26+
* // returns 36
27+
*/
28+
declare const FLOAT32_MAX_SAFE_NTH_FIBONACCI: number;
29+
30+
31+
// EXPORTS //
32+
33+
export = FLOAT32_MAX_SAFE_NTH_FIBONACCI;

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/docs/types/test.ts

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import FLOAT32_MAX_SAFE_NTH_FIBONACCI = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The export is a number...
25+
{
26+
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
27+
FLOAT32_MAX_SAFE_NTH_FIBONACCI; // $ExpectType number
28+
}

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/examples/index.js

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
var FLOAT32_MAX_SAFE_NTH_FIBONACCI = require( './../lib' );
22+
23+
function fibonacci( n ) {
24+
var a;
25+
var b;
26+
var c;
27+
var i;
28+
29+
a = 1;
30+
b = 1;
31+
for ( i = 3; i <= n; i++ ) {
32+
c = a + b;
33+
a = b;
34+
b = c;
35+
}
36+
return b;
37+
}
38+
39+
var v;
40+
var i;
41+
for ( i = 0; i < 50; i++ ) {
42+
v = fibonacci( i );
43+
if ( i > FLOAT32_MAX_SAFE_NTH_FIBONACCI ) {
44+
console.log( 'Unsafe: %d', v );
45+
} else {
46+
console.log( 'Safe: %d', v );
47+
}
48+
}

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/include/stdlib/constants/float64/max_safe_nth_fibonacci.h

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#ifndef STDLIB_CONSTANTS_FLOAT32_MAX_SAFE_NTH_FIBONACCI_H
20+
#define STDLIB_CONSTANTS_FLOAT32_MAX_SAFE_NTH_FIBONACCI_H
21+
22+
/**
23+
* Macro for the maximum safe nth Fibonacci number when stored in single-precision floating-point format.
24+
*/
25+
#define STDLIB_CONSTANT_FLOAT32_MAX_SAFE_NTH_FIBONACCI 36
26+
27+
#endif // !STDLIB_CONSTANTS_FLOAT32_MAX_SAFE_NTH_FIBONACCI_H

‎lib/node_modules/@stdlib/constants/float32/max-safe-nth-fibonacci/lib/index.js

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2024 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
/**
22+
* Maximum safe nth Fibonacci number when stored in single-precision floating-point format.
23+
*
24+
* @module @stdlib/constants/float32/max-safe-nth-fibonacci
25+
* @type {integer}
26+
*
27+
* @example
28+
* var FLOAT32_MAX_SAFE_NTH_FIBONACCI = require( '@stdlib/constants/float32/max-safe-nth-fibonacci' );
29+
* // returns 36
30+
*/
31+
32+
33+
// MAIN //
34+
35+
/**
36+
* The maximum safe nth Fibonacci number when stored in single-precision floating-point format.
37+
*
38+
* @constant
39+
* @type {integer}
40+
* @default 36
41+
* @see [Fibonacci number]{@link https://en.wikipedia.org/wiki/Fibonacci_number}
42+
* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
43+
*/
44+
var FLOAT32_MAX_SAFE_NTH_FIBONACCI = 36|0; // asm type annotation
45+
46+
47+
// EXPORTS //
48+
49+
module.exports = FLOAT32_MAX_SAFE_NTH_FIBONACCI;

0 commit comments

Comments
 (0)