Skip to content

Commit

Permalink
Auto-generated commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stdlib-bot committed Nov 12, 2024
1 parent e7b1810 commit 79dddda
Show file tree
Hide file tree
Showing 11 changed files with 501 additions and 4 deletions.
44 changes: 40 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<section class="release" id="unreleased">

## Unreleased (2024-11-11)
## Unreleased (2024-11-12)

<section class="packages">

Expand Down Expand Up @@ -110,6 +110,40 @@ This release closes the following issue:

<!-- /.package -->

<section class="package" id="constants-float32-min-base10-exponent-subnormal-unreleased">

#### [@stdlib/constants/float32/min-base10-exponent-subnormal](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent-subnormal)

<details>

<section class="features">

##### Features

- [`a4ca598`](https://github.com/stdlib-js/stdlib/commit/a4ca5986c4a9816d627387004026ec96539c81f9) - add `constants/float32/min-base10-exponent-subnormal` [(#3100)](https://github.com/stdlib-js/stdlib/pull/3100)

</section>

<!-- /.features -->

<section class="issues">

##### Closed Issues

This release closes the following issue:

[#3094](https://github.com/stdlib-js/stdlib/issues/3094)

</section>

<!-- /.issues -->

</details>

</section>

<!-- /.package -->

</section>

<!-- /.packages -->
Expand All @@ -118,9 +152,9 @@ This release closes the following issue:

### Closed Issues

This release closes the following issue:
A total of 2 issues were closed in this release:

[#3090](https://github.com/stdlib-js/stdlib/issues/3090)
[#3090](https://github.com/stdlib-js/stdlib/issues/3090), [#3094](https://github.com/stdlib-js/stdlib/issues/3094)

</section>

Expand All @@ -130,8 +164,9 @@ This release closes the following issue:

### Contributors

A total of 3 people contributed to this release. Thank you to the following contributors:
A total of 4 people contributed to this release. Thank you to the following contributors:

- Aayush Khanna
- Gunj Joshi
- Gururaj Gurram
- Philipp Burckhardt
Expand All @@ -146,6 +181,7 @@ A total of 3 people contributed to this release. Thank you to the following cont

<details>

- [`a4ca598`](https://github.com/stdlib-js/stdlib/commit/a4ca5986c4a9816d627387004026ec96539c81f9) - **feat:** add `constants/float32/min-base10-exponent-subnormal` [(#3100)](https://github.com/stdlib-js/stdlib/pull/3100) _(by Aayush Khanna)_
- [`951fbd2`](https://github.com/stdlib-js/stdlib/commit/951fbd24ae17d11d75cb4a9c321ddc2e62eecd30) - **feat:** add `constants/float32/e` [(#3101)](https://github.com/stdlib-js/stdlib/pull/3101) _(by Gururaj Gurram, Philipp Burckhardt)_
- [`824d519`](https://github.com/stdlib-js/stdlib/commit/824d5196406ebb5c9f73aedfd69d30fd6df0e2e0) - **feat:** add `constants/float32/min-base10-exponent` [(#3092)](https://github.com/stdlib-js/stdlib/pull/3092) _(by Gururaj Gurram, Philipp Burckhardt)_
- [`5c28ab7`](https://github.com/stdlib-js/stdlib/commit/5c28ab71e29097ff04c6c4de0038b4f6b733a68c) - **feat:** add `constants/float32/max-base10-exponent` [(#3091)](https://github.com/stdlib-js/stdlib/pull/3091) _(by Gururaj Gurram, Philipp Burckhardt)_
Expand Down
145 changes: 145 additions & 0 deletions float32/min-base10-exponent-subnormal/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
<!--
@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_BASE10_EXPONENT_SUBNORMAL

> The minimum base 10 exponent for a subnormal [single-precision floating-point number][ieee754].
<section class="usage">

## Usage

<!-- eslint-disable id-length -->

```javascript
var FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL = require( '@stdlib/constants/float32/min-base10-exponent-subnormal' );
```

#### FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL

The minimum base 10 exponent for a subnormal [single-precision floating-point number][ieee754].

<!-- eslint-disable id-length -->

```javascript
var bool = ( FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL === -45 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

<!-- eslint no-undef: "error" -->

<!-- eslint-disable id-length -->

```javascript
var FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL = require( '@stdlib/constants/float32/min-base10-exponent-subnormal' );

console.log( FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL );
// => -45
```

</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_base10_exponent_subnormal.h"
```

#### STDLIB_CONSTANT_FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL

Macro for the minimum base 10 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 float32/min-base10-exponent-subnormal/docs/repl.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

{{alias}}
The minimum base 10 exponent for a subnormal single-precision floating-
point number.

Examples
--------
> {{alias}}
-45

See Also
--------

33 changes: 33 additions & 0 deletions float32/min-base10-exponent-subnormal/docs/types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2019 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 base 10 exponent for a subnormal single-precision floating-point number.
*
* @example
* var min = FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL;
* // returns -45
*/
declare const FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL: number;


// EXPORTS //

export = FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL;
28 changes: 28 additions & 0 deletions float32/min-base10-exponent-subnormal/docs/types/test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* @license Apache-2.0
*
* Copyright (c) 2019 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_BASE10_EXPONENT_SUBNORMAL = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL; // $ExpectType number
}
24 changes: 24 additions & 0 deletions float32/min-base10-exponent-subnormal/examples/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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_BASE10_EXPONENT_SUBNORMAL = require( './../lib' );

console.log( FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL );
// => -45
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_BASE10_EXPONENT_SUBNORMAL_H
#define STDLIB_CONSTANTS_FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL_H

/**
* Macro for the minimum base 10 exponent for a subnormal single-precision floating-point number.
*/
#define STDLIB_CONSTANT_FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL -45

#endif // !STDLIB_CONSTANTS_FLOAT32_MIN_BASE10_EXPONENT_SUBNORMAL_H
Loading

0 comments on commit 79dddda

Please sign in to comment.