feat: add constants/float64/num-high-word-significand-bits

PR-URL: stdlib-js#2889 Ref: https://github.com/stdlib-js/stdlib/blob/fadff3a44660678d9ccce8bb101f579ca1913a64/lib/node_modules/%40stdlib/math/base/special/pow/src/main.c#L52 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]>
gunjjoshi · Sep 16, 2024 · 51787c8 · 51787c8
1 parent fadff3a
commit 51787c8
Show file tree

Hide file tree

Showing 10 changed files with 457 additions and 0 deletions.
diff --git a/...node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md b/...node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md
@@ -0,0 +1,143 @@
+<!--
+
+@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.
+
+-->
+
+# FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS
+
+> Number of significand bits in the high word of a [double-precision floating-point number][ieee754].
+
+<section class="usage">
+
+## Usage
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( '@stdlib/constants/float64/num-high-word-significand-bits' );
+```
+
+#### FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS
+
+Number of significand bits in the high word of a [double-precision floating-point number][ieee754].
+
+<!-- eslint-disable id-length -->
+
+```javascript
+var bool = ( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS === 20 );
+// returns true
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint-disable id-length -->
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( '@stdlib/constants/float64/num-high-word-significand-bits' );
+
+console.log( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS );
+// => 20
+```
+
+</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/float64/num_high_word_significand_bits.h"
+```
+
+#### STDLIB_CONSTANT_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS
+
+Number of significand bits in the high word of a [double-precision floating-point number][ieee754].
+
+</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">
+
+[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
+
+<!-- <related-links> -->
+
+<!-- </related-links> -->
+
+</section>
+
+<!-- /.links -->
diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt
@@ -0,0 +1,13 @@
+
+{{alias}}
+ Number of significand bits in the high word of a double-precision floating-
+ point number.
+
+ Examples
+ --------
+ > {{alias}}
+ 20
+
+ See Also
+ --------
+
diff --git a/...de_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/index.d.ts b/...de_modules/@stdlib/constants/float64/num-high-word-significand-bits/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
+
+/**
+* Number of significand bits in the high word of a double-precision floating-point number.
+*
+* @example
+* var bits = FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS;
+* // returns 20
+*/
+declare const FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS: number;
+
+
+// EXPORTS //
+
+export = FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS;
diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/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 FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( './index' );
+
+
+// TESTS //
+
+// The export is a number...
+{
+ // eslint-disable-next-line @typescript-eslint/no-unused-expressions
+ FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS; // $ExpectType number
+}
diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/examples/index.js b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/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 FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( './../lib' ); // eslint-disable-line id-length
+
+console.log( FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS );
+// => 20
diff --git a/...h-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.h b/...h-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.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_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS_H
+#define STDLIB_CONSTANTS_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS_H
+
+/**
+* Number of significand bits in the high word of a double-precision floating-point number.
+*/
+#define STDLIB_CONSTANT_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS 20
+
+#endif // !STDLIB_CONSTANTS_FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS_H
diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js
@@ -0,0 +1,47 @@
+/**
+* @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';
+
+/**
+* Number of significand bits in the high word of a double-precision floating-point number.
+*
+* @module @stdlib/constants/float64/num-high-word-significand-bits
+* @type {integer32}
+*
+* @example
+* var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = require( '@stdlib/constants/float64/num-high-word-significand-bits' );
+* // returns 20
+*/
+
+
+// MAIN //
+
+/**
+* Number of significand bits in the high word of a double-precision floating-point number.
+*
+* @constant
+* @type {integer32}
+* @default 20
+*/
+var FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS = 20|0; // eslint-disable-line id-length
+
+
+// EXPORTS //
+
+module.exports = FLOAT64_NUM_HIGH_WORD_SIGNIFICAND_BITS;
diff --git a/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/manifest.json b/lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/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": []
+ }
+ ]
+}