Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
<!--

@license Apache-2.0

Copyright (c) 2025 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_NTH_FIBONACCI

> Maximum safe nth [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_NTH_FIBONACCI = require( '@stdlib/constants/float16/max-safe-nth-fibonacci' );
```

#### FLOAT16_MAX_SAFE_NTH_FIBONACCI

The maximum [safe][safe-integers] nth [Fibonacci number][fibonacci-number] when stored in [half-precision floating-point][ieee754] format.

<!-- eslint-disable id-length -->

```javascript
var bool = ( FLOAT16_MAX_SAFE_NTH_FIBONACCI === 24 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint-disable id-length -->

<!-- eslint no-undef: "error" -->

```javascript
var FLOAT16_MAX_SAFE_NTH_FIBONACCI = require( '@stdlib/constants/float16/max-safe-nth-fibonacci' );

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;
}

var v;
var i;
for ( i = 0; i < 50; i++ ) {
v = fibonacci( i );
if ( i > FLOAT16_MAX_SAFE_NTH_FIBONACCI ) {
console.log( 'Unsafe: %d', v );
} else {
console.log( 'Safe: %d', v );
}
}
```

</section>

<!-- /.examples -->

<!-- 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 -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

{{alias}}
Maximum safe nth Fibonacci number when stored in half-precision floating-
point format.

Examples
--------
> {{alias}}
24

See Also
--------

Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2025 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 Fibonacci number when stored in half-precision floating-point format.
*
* @example
* var max = FLOAT16_MAX_SAFE_NTH_FIBONACCI;
* // returns 24
*/
declare const FLOAT16_MAX_SAFE_NTH_FIBONACCI: number;


// EXPORTS //

export = FLOAT16_MAX_SAFE_NTH_FIBONACCI;
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2025 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_NTH_FIBONACCI = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_MAX_SAFE_NTH_FIBONACCI; // $ExpectType number
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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_NTH_FIBONACCI = require( './../lib' );

Check warning on line 21 in lib/node_modules/@stdlib/constants/float16/max-safe-nth-fibonacci/examples/index.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Identifier name 'FLOAT16_MAX_SAFE_NTH_FIBONACCI' is too long (> 25)

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;
}

var v;
var i;
for ( i = 0; i < 50; i++ ) {
v = fibonacci( i );
if ( i > FLOAT16_MAX_SAFE_NTH_FIBONACCI ) {
console.log( 'Unsafe: %d', v );
} else {
console.log( 'Safe: %d', v );
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2025 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 nth Fibonacci number when stored in half-precision floating-point format.
*
* @module @stdlib/constants/float16/max-safe-nth-fibonacci
* @type {integer}
*
* @example
* var FLOAT16_MAX_SAFE_NTH_FIBONACCI = require( '@stdlib/constants/float16/max-safe-nth-fibonacci' );
* // returns 24
*/


// MAIN //

/**
* The maximum safe nth Fibonacci number when stored in half-precision floating-point format.
*
* @constant
* @type {integer}
* @default 24
* @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_NTH_FIBONACCI = 24|0; // asm type annotation

Check warning on line 44 in lib/node_modules/@stdlib/constants/float16/max-safe-nth-fibonacci/lib/index.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Identifier name 'FLOAT16_MAX_SAFE_NTH_FIBONACCI' is too long (> 25)


// EXPORTS //

module.exports = FLOAT16_MAX_SAFE_NTH_FIBONACCI;
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
{
"name": "@stdlib/constants/float16/max-safe-nth-fibonacci",
"version": "0.0.0",
"description": "Maximum safe nth Fibonacci number when stored in half-precision floating-point format.",
"license": "Apache-2.0",
"author": {
"name": "The Stdlib Authors",
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
},
"contributors": [
{
"name": "The Stdlib Authors",
"url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
}
],
"main": "./lib",
"directories": {
"doc": "./docs",
"example": "./examples",
"lib": "./lib",
"test": "./test"
},
"types": "./docs/types",
"scripts": {},
"homepage": "https://github.com/stdlib-js/stdlib",
"repository": {
"type": "git",
"url": "git://github.com/stdlib-js/stdlib.git"
},
"bugs": {
"url": "https://github.com/stdlib-js/stdlib/issues"
},
"dependencies": {},
"devDependencies": {},
"engines": {
"node": ">=0.10.0",
"npm": ">2.7.0"
},
"os": [
"aix",
"darwin",
"freebsd",
"linux",
"macos",
"openbsd",
"sunos",
"win32",
"windows"
],
"keywords": [
"stdlib",
"stdmath",
"constant",
"const",
"max",
"maximum",
"fibonacci",
"number",
"fib",
"safe",
"integer",
"flt",
"floating",
"point",
"floating-point",
"float",
"float16",
"f16",
"ieee754"
]
}
Loading