Skip to content

Commit

Permalink
feat: add constants/float64/num-high-word-significand-bits
Browse files Browse the repository at this point in the history 
PR-URL: #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]>
  • Loading branch information
@gunjjoshi @kgryte
gunjjoshi and kgryte authored Sep 16, 2024
1 parent fadff3a commit 51787c8
Show file tree
Hide file tree
Showing 10 changed files with 457 additions and 0 deletions.
143 changes: 143 additions & 0 deletions ...node_modules/@stdlib/constants/float64/num-high-word-significand-bits/README.md
View file
Original file line number Diff line number Diff line change
@@ -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 -->
13 changes: 13 additions & 0 deletions lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/repl.txt
View file
Original file line number Diff line number Diff line change
@@ -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
--------

33 changes: 33 additions & 0 deletions ...de_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/index.d.ts
View file
Original file line number Diff line number Diff line change
@@ -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;
28 changes: 28 additions & 0 deletions lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/docs/types/test.ts
View file
Original file line number Diff line number Diff line change
@@ -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
}
24 changes: 24 additions & 0 deletions lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/examples/index.js
View file
Original file line number Diff line number Diff line change
@@ -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
27 changes: 27 additions & 0 deletions ...h-word-significand-bits/include/stdlib/constants/float64/num_high_word_significand_bits.h
View file
Original file line number Diff line number Diff line change
@@ -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
47 changes: 47 additions & 0 deletions lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/lib/index.js
View file
Original file line number Diff line number Diff line change
@@ -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;
36 changes: 36 additions & 0 deletions lib/node_modules/@stdlib/constants/float64/num-high-word-significand-bits/manifest.json
View file
Original file line number Diff line number Diff line change
@@ -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": []
}
]
}
Loading

1 comment on commit 51787c8

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

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

Coverage Report

Package Statements Branches Functions Lines
constants/float64/num-high-word-significand-bits $\color{green}47/47$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}47/47$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.