-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat: add constants/float16/max-safe-fibonacci
#9000
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sagar7162
wants to merge
7
commits into
stdlib-js:develop
Choose a base branch
from
sagar7162:maxsafefibn
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
9653c35
feat: add `constants/float16/max-safe-fibonacci`
sagar7162 2f55b0f
fix: update package.json
sagar7162 80acced
fix: fix README.MD
sagar7162 a38a6bf
fix: update value
sagar7162 ddfe2e9
fix: add c headers file
sagar7162 a0560c3
fix: update copyright year
sagar7162 0fccaf7
fix: update package.json
sagar7162 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
168 changes: 168 additions & 0 deletions
168
lib/node_modules/@stdlib/constants/float16/max-safe-fibonacci/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| <!-- | ||
|
|
||
| @license Apache-2.0 | ||
|
|
||
| Copyright (c) 2026 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. | ||
|
|
||
| --> | ||
|
|
||
| # FLOAT16_MAX_SAFE_FIBONACCI | ||
|
|
||
| > Maximum safe [Fibonacci number][fibonacci-number] when stored in [half-precision floating-point][ieee754] format. | ||
|
|
||
| <section class="usage"> | ||
|
|
||
| ## Usage | ||
|
|
||
| <!-- eslint-disable id-length --> | ||
|
|
||
| ```javascript | ||
| var FLOAT16_MAX_SAFE_FIBONACCI = require( '@stdlib/constants/float16/max-safe-fibonacci' ); | ||
| ``` | ||
|
|
||
| #### FLOAT16_MAX_SAFE_FIBONACCI | ||
|
|
||
| The maximum [safe][safe-integers] [Fibonacci number][fibonacci-number] when stored in [half-precision floating-point][ieee754] format. | ||
|
|
||
| <!-- eslint-disable id-length --> | ||
|
|
||
| ```javascript | ||
| var bool = ( FLOAT16_MAX_SAFE_FIBONACCI === 1597 ); | ||
| // returns true | ||
| ``` | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.usage --> | ||
|
|
||
| <section class="examples"> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- eslint-disable id-length --> | ||
|
|
||
| <!-- eslint no-undef: "error" --> | ||
|
|
||
| ```javascript | ||
| var FLOAT16_MAX_SAFE_FIBONACCI = require( '@stdlib/constants/float16/max-safe-fibonacci' ); | ||
|
|
||
| var v; | ||
| var i; | ||
|
|
||
| function fibonacci( n ) { | ||
| var a; | ||
| var b; | ||
| var c; | ||
| var i; | ||
|
|
||
| a = 1; | ||
| b = 1; | ||
| for ( i = 3; i <= n; i++ ) { | ||
| c = a + b; | ||
| a = b; | ||
| b = c; | ||
| } | ||
| return b; | ||
| } | ||
|
|
||
| for ( i = 0; i < 50; i++ ) { | ||
| v = fibonacci( i ); | ||
| if ( v > FLOAT16_MAX_SAFE_FIBONACCI ) { | ||
| 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/float16/max_safe_fibonacci.h" | ||
| ``` | ||
|
|
||
| #### STDLIB_CONSTANT_FLOAT16_MAX_SAFE_FIBONACCI | ||
|
|
||
| Macro for the maximum safe [Fibonacci number][fibonacci-number] when stored in [half-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 | ||
|
|
||
| [fibonacci-number]: https://en.wikipedia.org/wiki/Fibonacci_number | ||
|
|
||
| [ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 | ||
|
|
||
| </section> | ||
|
|
||
| <!-- /.links --> | ||
13 changes: 13 additions & 0 deletions
13
lib/node_modules/@stdlib/constants/float16/max-safe-fibonacci/docs/repl.txt
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
|
|
||
| {{alias}} | ||
| Maximum safe Fibonacci number when stored in half-precision floating-point | ||
| format. | ||
|
|
||
| Examples | ||
| -------- | ||
| > {{alias}} | ||
| 1597 | ||
|
|
||
| See Also | ||
| -------- | ||
|
|
33 changes: 33 additions & 0 deletions
33
lib/node_modules/@stdlib/constants/float16/max-safe-fibonacci/docs/types/index.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| /* | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 Fibonacci number when stored in half-precision floating-point format. | ||
| * | ||
| * @example | ||
| * var max = FLOAT16_MAX_SAFE_FIBONACCI; | ||
| * // returns 1597 | ||
| */ | ||
| declare const FLOAT16_MAX_SAFE_FIBONACCI: number; | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| export = FLOAT16_MAX_SAFE_FIBONACCI; |
28 changes: 28 additions & 0 deletions
28
lib/node_modules/@stdlib/constants/float16/max-safe-fibonacci/docs/types/test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 FLOAT16_MAX_SAFE_FIBONACCI = require( './index' ); | ||
|
|
||
|
|
||
| // TESTS // | ||
|
|
||
| // The export is a number... | ||
| { | ||
| // eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
| FLOAT16_MAX_SAFE_FIBONACCI; // $ExpectType number | ||
| } |
49 changes: 49 additions & 0 deletions
49
lib/node_modules/@stdlib/constants/float16/max-safe-fibonacci/examples/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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 FLOAT16_MAX_SAFE_FIBONACCI = require( './../lib' ); // eslint-disable-line id-length | ||
|
|
||
| var v; | ||
| var i; | ||
|
|
||
| function fibonacci( n ) { | ||
| var a; | ||
| var b; | ||
| var c; | ||
| var i; | ||
|
|
||
| a = 1; | ||
| b = 1; | ||
| for ( i = 3; i <= n; i++ ) { | ||
| c = a + b; | ||
| a = b; | ||
| b = c; | ||
| } | ||
| return b; | ||
| } | ||
|
|
||
| for ( i = 0; i < 50; i++ ) { | ||
| v = fibonacci( i ); | ||
| if ( v > FLOAT16_MAX_SAFE_FIBONACCI ) { | ||
| console.log( 'Unsafe: %d', v ); | ||
| } else { | ||
| console.log( 'Safe: %d', v ); | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletions
27
...onstants/float16/max-safe-fibonacci/include/stdlib/constants/float16/max_safe_fibonacci.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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_FLOAT16_MAX_SAFE_FIBONACCI_H | ||
| #define STDLIB_CONSTANTS_FLOAT16_MAX_SAFE_FIBONACCI_H | ||
|
|
||
| /** | ||
| * Macro for the maximum safe Fibonacci number when stored in half-precision floating-point format. | ||
| */ | ||
| #define STDLIB_CONSTANT_FLOAT16_MAX_SAFE_FIBONACCI 1597 | ||
|
|
||
| #endif // !STDLIB_CONSTANTS_FLOAT16_MAX_SAFE_FIBONACCI_H |
49 changes: 49 additions & 0 deletions
49
lib/node_modules/@stdlib/constants/float16/max-safe-fibonacci/lib/index.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /** | ||
| * @license Apache-2.0 | ||
| * | ||
| * Copyright (c) 2026 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'; | ||
|
|
||
| /** | ||
| * Maximum safe Fibonacci number when stored in half-precision floating-point format. | ||
| * | ||
| * @module @stdlib/constants/float16/max-safe-fibonacci | ||
| * @type {integer} | ||
| * | ||
| * @example | ||
| * var FLOAT16_MAX_SAFE_FIBONACCI = require( '@stdlib/constants/float16/max-safe-fibonacci' ); | ||
| * // returns 1597 | ||
| */ | ||
|
|
||
|
|
||
| // MAIN // | ||
|
|
||
| /** | ||
| * The maximum safe Fibonacci number when stored in half-precision floating-point format. | ||
| * | ||
| * @constant | ||
| * @type {integer} | ||
| * @default 1597 | ||
| * @see [Fibonacci number]{@link https://en.wikipedia.org/wiki/Fibonacci_number} | ||
| * @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} | ||
| */ | ||
| var FLOAT16_MAX_SAFE_FIBONACCI = 1597; // eslint-disable-line id-length | ||
|
|
||
|
|
||
| // EXPORTS // | ||
|
|
||
| module.exports = FLOAT16_MAX_SAFE_FIBONACCI; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.