feat: add constants/float32/sqrt-phi

PR-URL: #3351

Co-authored-by: stdlib-bot <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>

lib/node_modules/@stdlib/constants/float32/sqrt-phi/README.md

@@ -0,0 +1,139 @@
+<!--
+
+@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_SQRT_PHI
+
+> Square root of the [Golden ratio][@stdlib/constants/float32/phi] (φ) as a single-precision floating-point number.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var FLOAT32_SQRT_PHI = require( '@stdlib/constants/float32/sqrt-phi' );
+```
+
+#### FLOAT32_SQRT_PHI
+
+Square root of the [golden ratio][@stdlib/constants/float32/phi] as a single-precision floating-point number.
+
+```javascript
+var bool = ( FLOAT32_SQRT_PHI === 1.272019624710083 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- TODO: better example -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT32_SQRT_PHI = require( '@stdlib/constants/float32/sqrt-phi' );
+
+console.log( FLOAT32_SQRT_PHI );
+// => 1.272019624710083
+```
+
+</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/sqrt_phi.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT32_SQRT_PHI
+
+Macro for the square root of the [golden ratio][@stdlib/constants/float32/phi] as a single-precision floating-point number.
+
+</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">
+
+[@stdlib/constants/float32/phi]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/phi
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/constants/float32/sqrt-phi/docs/repl.txt

@@ -0,0 +1,12 @@
+
+{{alias}}
+    Square root of the golden ratio as a single-precision floating-point number.
+
+    Examples
+    --------
+    > {{alias}}
+    1.272019624710083
+
+    See Also
+    --------
+

lib/node_modules/@stdlib/constants/float32/sqrt-phi/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
+
+/**
+* Square root of the golden ratio as a single-precision floating-point number.
+*
+* @example
+* var val = FLOAT32_SQRT_PHI;
+* // returns 1.272019624710083
+*/
+declare const FLOAT32_SQRT_PHI: number;
+
+
+// EXPORTS //
+
+export = FLOAT32_SQRT_PHI;

lib/node_modules/@stdlib/constants/float32/sqrt-phi/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_SQRT_PHI = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+	// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+	FLOAT32_SQRT_PHI; // $ExpectType number
+}

lib/node_modules/@stdlib/constants/float32/sqrt-phi/examples/index.js

@@ -0,0 +1,24 @@
+/**
+* @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_SQRT_PHI = require( './../lib' );
+
+console.log( FLOAT32_SQRT_PHI );
+// => 1.272019624710083

lib/node_modules/@stdlib/constants/float32/sqrt-phi/include/stdlib/constants/float64/sqrt_phi.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_SQRT_PHI_H
+#define STDLIB_CONSTANTS_FLOAT32_SQRT_PHI_H
+
+/**
+* Macro for the square root of the golden ratio as a single-precision floating-point number.
+*/
+#define STDLIB_CONSTANT_FLOAT32_SQRT_PHI 1.272019624710083f
+
+#endif // !STDLIB_CONSTANTS_FLOAT32_SQRT_PHI_H

lib/node_modules/@stdlib/constants/float32/sqrt-phi/lib/index.js

@@ -0,0 +1,49 @@
+/**
+* @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';
+
+/**
+* Square root of the golden ratio as a single-precision floating-point number.
+*
+* @module @stdlib/constants/float32/sqrt-phi
+* @type {number}
+*
+* @example
+* var FLOAT32_SQRT_PHI = require( '@stdlib/constants/float32/sqrt-phi' );
+* // returns 1.272019624710083
+*/
+
+
+// MAIN //
+
+/**
+* Square root of the golden ratio as a single-precision floating-point number.
+*
+* @constant
+* @type {number}
+* @default 1.272019624710083
+* @see [OEIS]{@link http://oeis.org/A139339}
+* @see [Wikipedia]{@link https://en.wikipedia.org/wiki/Golden_ratio}
+*/
+var FLOAT32_SQRT_PHI = 1.272019624710083;
+
+
+// EXPORTS //
+
+module.exports = FLOAT32_SQRT_PHI;

lib/node_modules/@stdlib/constants/float32/sqrt-phi/manifest.json

@@ -0,0 +1,36 @@
+{
+  "options": {},
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "src": [],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": []
+    }
+  ]
+}