Skip to content

Commit 56b84a4

Browse files
hrshyahrshya
authored
feat: add constants/float32/num-significand-bits
PR-URL: #6284 Ref: #649 Reviewed-by: Athan Reines <kgryte@gmail.com> Signed-off-by: Harsh <149176984+hrshya@users.noreply.github.com>
1 parent 876aac6 commit 56b84a4

File tree

10 files changed

+456
-0
lines changed

10 files changed

+456
-0
lines changed

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/README.md

+143
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!--
2+
3+
@license Apache-2.0
4+
5+
Copyright (c) 2025 The Stdlib Authors.
6+
7+
Licensed under the Apache License, Version 2.0 (the "License");
8+
you may not use this file except in compliance with the License.
9+
You may obtain a copy of the License at
10+
11+
http://www.apache.org/licenses/LICENSE-2.0
12+
13+
Unless required by applicable law or agreed to in writing, software
14+
distributed under the License is distributed on an "AS IS" BASIS,
15+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16+
See the License for the specific language governing permissions and
17+
limitations under the License.
18+
19+
-->
20+
21+
# FLOAT32_NUM_SIGNIFICAND_BITS
22+
23+
> Number of significand bits for a [single-precision floating-point number][ieee754].
24+
25+
<section class="usage">
26+
27+
## Usage
28+
29+
<!-- eslint-disable id-length -->
30+
31+
```javascript
32+
var FLOAT32_NUM_SIGNIFICAND_BITS = require( '@stdlib/constants/float32/num-significand-bits' );
33+
```
34+
35+
#### FLOAT32_NUM_SIGNIFICAND_BITS
36+
37+
Number of significand bits for a [single-precision floating-point number][ieee754].
38+
39+
<!-- eslint-disable id-length -->
40+
41+
```javascript
42+
var bool = ( FLOAT32_NUM_SIGNIFICAND_BITS === 23 );
43+
// returns true
44+
```
45+
46+
</section>
47+
48+
<!-- /.usage -->
49+
50+
<section class="examples">
51+
52+
## Examples
53+
54+
<!-- eslint-disable id-length -->
55+
56+
<!-- eslint no-undef: "error" -->
57+
58+
```javascript
59+
var FLOAT32_NUM_SIGNIFICAND_BITS = require( '@stdlib/constants/float32/num-significand-bits' );
60+
61+
console.log( FLOAT32_NUM_SIGNIFICAND_BITS );
62+
// => 23
63+
```
64+
65+
</section>
66+
67+
<!-- /.examples -->
68+
69+
<!-- C interface documentation. -->
70+
71+
* * *
72+
73+
<section class="c">
74+
75+
## C APIs
76+
77+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
78+
79+
<section class="intro">
80+
81+
</section>
82+
83+
<!-- /.intro -->
84+
85+
<!-- C usage documentation. -->
86+
87+
<section class="usage">
88+
89+
### Usage
90+
91+
```c
92+
#include "stdlib/constants/float32/num_significand_bits.h"
93+
```
94+
95+
#### STDLIB_CONSTANT_FLOAT32_NUM_SIGNIFICAND_BITS
96+
97+
Number of significand bits for a [single-precision floating-point number][ieee754].
98+
99+
</section>
100+
101+
<!-- /.usage -->
102+
103+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
104+
105+
<section class="notes">
106+
107+
</section>
108+
109+
<!-- /.notes -->
110+
111+
<!-- C API usage examples. -->
112+
113+
<section class="examples">
114+
115+
</section>
116+
117+
<!-- /.examples -->
118+
119+
</section>
120+
121+
<!-- /.c -->
122+
123+
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
124+
125+
<section class="related">
126+
127+
</section>
128+
129+
<!-- /.related -->
130+
131+
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
132+
133+
<section class="links">
134+
135+
[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985
136+
137+
<!-- <related-links> -->
138+
139+
<!-- </related-links> -->
140+
141+
</section>
142+
143+
<!-- /.links -->

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/docs/repl.txt

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
2+
{{alias}}
3+
Number of significand bits for a single-precision floating-
4+
point number.
5+
6+
Examples
7+
--------
8+
> {{alias}}
9+
23
10+
11+
See Also
12+
--------

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/docs/types/index.d.ts

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
// TypeScript Version: 4.1
20+
21+
/**
22+
* Number of significand bits for a single-precision floating-point number.
23+
*
24+
* @example
25+
* var bits = FLOAT32_NUM_SIGNIFICAND_BITS;
26+
* // returns 23
27+
*/
28+
declare const FLOAT32_NUM_SIGNIFICAND_BITS: number;
29+
30+
31+
// EXPORTS //
32+
33+
export = FLOAT32_NUM_SIGNIFICAND_BITS;

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/docs/types/test.ts

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
/*
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
import FLOAT32_NUM_SIGNIFICAND_BITS = require( './index' );
20+
21+
22+
// TESTS //
23+
24+
// The export is a number...
25+
{
26+
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
27+
FLOAT32_NUM_SIGNIFICAND_BITS; // $ExpectType number
28+
}

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/examples/index.js

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
var FLOAT32_NUM_SIGNIFICAND_BITS = require( './../lib' );
22+
23+
console.log( FLOAT32_NUM_SIGNIFICAND_BITS );
24+
// => 23

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/include/stdlib/constants/float32/num_significand_bits.h

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
#ifndef STDLIB_CONSTANTS_FLOAT32_NUM_SIGNIFICAND_BITS_H
20+
#define STDLIB_CONSTANTS_FLOAT32_NUM_SIGNIFICAND_BITS_H
21+
22+
/**
23+
* Number of significand bits for a single-precision floating-point number.
24+
*/
25+
#define STDLIB_CONSTANT_FLOAT32_NUM_SIGNIFICAND_BITS 23
26+
27+
#endif // !STDLIB_CONSTANTS_FLOAT32_NUM_SIGNIFICAND_BITS_H

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/lib/index.js

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
/**
22+
* Number of significand bits for a single-precision floating-point number.
23+
*
24+
* @module @stdlib/constants/float32/num-significand-bits
25+
* @type {integer32}
26+
*
27+
* @example
28+
* var FLOAT32_NUM_SIGNIFICAND_BITS = require( '@stdlib/constants/float32/num-significand-bits' );
29+
* // returns 23
30+
*/
31+
32+
33+
// MAIN //
34+
35+
/**
36+
* Number of significand bits for a single-precision floating-point number.
37+
*
38+
* @constant
39+
* @type {integer32}
40+
* @default 23
41+
*/
42+
var FLOAT32_NUM_SIGNIFICAND_BITS = 23|0;
43+
44+
45+
// EXPORTS //
46+
47+
module.exports = FLOAT32_NUM_SIGNIFICAND_BITS;

‎lib/node_modules/@stdlib/constants/float32/num-significand-bits/manifest.json

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"options": {},
3+
"fields": [
4+
{
5+
"field": "src",
6+
"resolve": true,
7+
"relative": true
8+
},
9+
{
10+
"field": "include",
11+
"resolve": true,
12+
"relative": true
13+
},
14+
{
15+
"field": "libraries",
16+
"resolve": false,
17+
"relative": false
18+
},
19+
{
20+
"field": "libpath",
21+
"resolve": true,
22+
"relative": false
23+
}
24+
],
25+
"confs": [
26+
{
27+
"src": [],
28+
"include": [
29+
"./include"
30+
],
31+
"libraries": [],
32+
"libpath": [],
33+
"dependencies": []
34+
}
35+
]
36+
}

0 commit comments

Comments
 (0)