Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
99 changes: 99 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<!--

@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_PHI

> The [golden ratio][phi].

<section class="usage">

## Usage

```javascript
var FLOAT16_PHI = require( '@stdlib/constants/float16/phi' );
```

#### FLOAT16_PHI

The [golden ratio][phi].

```javascript
var bool = ( FLOAT16_PHI === 1.6181640625 );
// returns true
```

</section>

<!-- /.usage -->

<section class="notes">

## Notes

The golden ratio `φ` is defined as

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is our convention to display mathematical formulas in a <section class="intro"> at the top of the README and not inside the notes. See float32/phi and float64/phi for reference.


<!-- <equation class="equation" label="eq:golden_ratio" align="center" raw="\phi = \frac{1 + \sqrt{5}}{2}" alt="Golden ratio"> -->

```math
\phi = \frac{1 + \sqrt{5}}{2}
```

<!-- </equation> -->

The value is approximately `1.6180339887498948482...` in double precision. Due to the limited precision of half-precision floating-point format (float16), the constant is rounded to `1.6181640625`.

</section>

<!-- /.notes -->

<section class="examples">

## Examples

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

```javascript
var FLOAT16_PHI = require( '@stdlib/constants/float16/phi' );

console.log( FLOAT16_PHI );
// => 1.6181640625
```

</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">

[phi]: https://en.wikipedia.org/wiki/Golden_ratio

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

{{alias}}
The golden ratio `φ`.

Examples
--------
> {{alias}}
1.6181640625

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

/**
* The golden ratio `φ`.
*
* @example
* var val = FLOAT16_PHI;
* // returns 1.6181640625
*/
declare const FLOAT16_PHI: number;


// EXPORTS //

export = FLOAT16_PHI;
28 changes: 28 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/docs/types/test.ts
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_PHI = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT16_PHI; // $ExpectType number
}
24 changes: 24 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/examples/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* @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_PHI = require( './../lib' );

console.log( FLOAT16_PHI );
// => 1.6181640625
49 changes: 49 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/lib/index.js
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';

/**
* The golden ratio `φ`.
*
* @module @stdlib/constants/float16/phi
* @type {number}
*
* @example
* var FLOAT16_PHI = require( '@stdlib/constants/float16/phi' );
* // returns 1.6181640625
*/


// MAIN //

/**
* The golden ratio `φ`.
*
* @constant
* @type {number}
* @default 1.6181640625
* @see [OEIS]{@link http://oeis.org/A001622}
* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Golden_ratio}
*/
var FLOAT16_PHI = 1.6181640625;


// EXPORTS //

module.exports = FLOAT16_PHI;
64 changes: 64 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
{
"name": "@stdlib/constants/float16/phi",
"version": "0.0.0",
"description": "Half-precision (float16) approximation of the golden ratio (φ).",
"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",
"mathematics",
"math",
"phi",
"golden-ratio",
"ieee754",
"float",
"floating-point",
"float16"
]
}
38 changes: 38 additions & 0 deletions lib/node_modules/@stdlib/constants/float16/phi/test/test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/**
* @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';

// MODULES //

var tape = require( 'tape' );
var FLOAT16_PHI = require( './../lib' );


// TESTS //

tape( 'main export is a number', function test( t ) {
t.ok( true, __filename );
t.strictEqual( typeof FLOAT16_PHI, 'number', 'main export is a number' );
t.end();
});

tape( 'export is a half-precision floating-point number equal to 1.6181640625', function test( t ) {
t.strictEqual( FLOAT16_PHI, 1.6181640625, 'returns expected value' );
t.end();
});