Skip to content

Commit

Permalink
feat: add constants/float32/min-base2-exponent-subnormal
Browse files Browse the repository at this point in the history
PR-URL: #2750
Ref: #649

Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
  • Loading branch information
gunjjoshi authored Aug 6, 2024
1 parent 130c7a5 commit 7b77290
Show file tree
Hide file tree
Showing 10 changed files with 467 additions and 0 deletions.
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 -->
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
--------

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;
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
}
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' );

Check warning on line 21 in lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/examples/index.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Identifier name 'FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL' is too long (> 25)

console.log( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL );
// => -149
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
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

Check warning on line 49 in lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/lib/index.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

Identifier name 'FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL' is too long (> 25)


// EXPORTS //

module.exports = FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL;
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 7b77290

@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/float32/min-base2-exponent-subnormal $\color{green}54/54$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}54/54$
$\color{green}+100.00\%$

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

Please sign in to comment.