-
-
Notifications
You must be signed in to change notification settings - Fork 456
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add
constants/float32/min-base2-exponent-subnormal
- Loading branch information
Showing
10 changed files
with
467 additions
and
0 deletions.
There are no files selected for viewing
143 changes: 143 additions & 0 deletions
143
lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
--> | ||
|
||
# FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL | ||
|
||
> The minimum biased base 2 exponent for a subnormal [single-precision floating-point number][ieee754]. | ||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
<!-- eslint-disable id-length --> | ||
|
||
```javascript | ||
var FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = require( '@stdlib/constants/float32/min-base2-exponent-subnormal' ); | ||
``` | ||
|
||
#### FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL | ||
|
||
The minimum biased base 2 exponent for a subnormal [single-precision floating-point number][ieee754]. | ||
|
||
<!-- eslint-disable id-length --> | ||
|
||
```javascript | ||
var bool = ( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL === -149 ); | ||
// returns true | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
<!-- eslint no-undef: "error" --> | ||
|
||
<!-- eslint-disable id-length --> | ||
|
||
```javascript | ||
var FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = require( '@stdlib/constants/float32/min-base2-exponent-subnormal' ); | ||
|
||
console.log( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL ); | ||
// => -149 | ||
``` | ||
|
||
</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/min_base2_exponent_subnormal.h" | ||
``` | ||
|
||
#### STDLIB_CONSTANT_FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL | ||
|
||
Macro for the minimum biased base 2 exponent for a subnormal [single-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
13
lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/repl.txt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
|
||
{{alias}} | ||
The minimum biased base 2 exponent for a subnormal single-precision | ||
floating-point number. | ||
|
||
Examples | ||
-------- | ||
> {{alias}} | ||
-149 | ||
|
||
See Also | ||
-------- | ||
|
33 changes: 33 additions & 0 deletions
33
...node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/index.d.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
||
/** | ||
* The minimum biased base 2 exponent for a subnormal single-precision floating-point number. | ||
* | ||
* @example | ||
* var min = FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL; | ||
* // returns -149 | ||
*/ | ||
declare const FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL: number; | ||
|
||
|
||
// EXPORTS // | ||
|
||
export = FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL; |
28 changes: 28 additions & 0 deletions
28
lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = require( './index' ); | ||
|
||
|
||
// TESTS // | ||
|
||
// The export is a number... | ||
{ | ||
// eslint-disable-next-line @typescript-eslint/no-unused-expressions | ||
FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL; // $ExpectType number | ||
} |
24 changes: 24 additions & 0 deletions
24
lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/examples/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = require( './../lib' ); | ||
|
||
console.log( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL ); | ||
// => -149 |
27 changes: 27 additions & 0 deletions
27
...-base2-exponent-subnormal/include/stdlib/constants/float64/min_base2_exponent_subnormal.h
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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_FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL_H | ||
#define STDLIB_CONSTANTS_FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL_H | ||
|
||
/** | ||
* Macro for the minimum biased base 2 exponent for a subnormal single-precision floating-point number. | ||
*/ | ||
#define STDLIB_CONSTANT_FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL -149 | ||
|
||
#endif // !STDLIB_CONSTANTS_FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL_H |
54 changes: 54 additions & 0 deletions
54
lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/lib/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
/** | ||
* @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'; | ||
|
||
/** | ||
* The minimum biased base 2 exponent for a subnormal single-precision floating-point number. | ||
* | ||
* @module @stdlib/constants/float32/min-base2-exponent-subnormal | ||
* @type {integer32} | ||
* | ||
* @example | ||
* var FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = require( '@stdlib/constants/float32/min-base2-exponent-subnormal' ); | ||
* // returns -149 | ||
*/ | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* The minimum biased base 2 exponent for a subnormal single-precision floating-point number. | ||
* | ||
* ```text | ||
* -(BIAS+(23-1)) = -(127+22) = -149 | ||
* ``` | ||
* | ||
* where `BIAS = 127` and `23` is the number of digits in the significand. | ||
* | ||
* @constant | ||
* @type {integer32} | ||
* @default -149 | ||
* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} | ||
*/ | ||
var FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = -149|0; // asm type annotation | ||
|
||
|
||
// EXPORTS // | ||
|
||
module.exports = FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL; |
36 changes: 36 additions & 0 deletions
36
lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/manifest.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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": [] | ||
} | ||
] | ||
} |
Oops, something went wrong.
7b77290
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Coverage Report
The above coverage report was generated for the changes in this push.