Skip to content

Commit

Permalink
feat: add constants/float32/max-base10-exponent
Browse files Browse the repository at this point in the history 
PR-URL: #3091
Closes: #3090

Co-authored-by: Philipp Burckhardt <[email protected]>
Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
@gururaj1512 @Planeshifter
gururaj1512 and Planeshifter authored Nov 11, 2024
1 parent f8bcfd8 commit 5c28ab7
Show file tree
Hide file tree
Showing 10 changed files with 466 additions and 0 deletions.
153 changes: 153 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,153 @@
<!--
@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_MAX_BASE10_EXPONENT

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

## Usage

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

```javascript
var FLOAT32_MAX_BASE10_EXPONENT = require( '@stdlib/constants/float32/max-base10-exponent' );
```

#### FLOAT32_MAX_BASE10_EXPONENT

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

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

```javascript
var bool = ( FLOAT32_MAX_BASE10_EXPONENT === 38 );
// returns true
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- TODO: better example -->

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

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

```javascript
var FLOAT32_MAX_BASE10_EXPONENT = require( '@stdlib/constants/float32/max-base10-exponent' );

console.log( FLOAT32_MAX_BASE10_EXPONENT );
// => 38
```

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

#### STDLIB_CONSTANT_FLOAT32_MAX_BASE10_EXPONENT

Macro for the maximum base 10 exponent for a [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">

* * *

## See Also

- <span class="package-name">[`@stdlib/constants/float32/max-base2-exponent`][@stdlib/constants/float32/max-base2-exponent]</span><span class="delimiter">: </span><span class="description">the maximum biased base 2 exponent for a single-precision floating-point number.</span>

</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> -->

[@stdlib/constants/float32/max-base2-exponent]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/max-base2-exponent

<!-- </related-links> -->

</section>

<!-- /.links -->
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/docs/repl.txt
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

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

Examples
--------
> {{alias}}
38

See Also
--------

33 changes: 33 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/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

/**
* The maximum base 10 exponent for a single-precision floating-point number.
*
* @example
* var exp = FLOAT32_MAX_BASE10_EXPONENT;
* // returns 38
*/
declare const FLOAT32_MAX_BASE10_EXPONENT: number;


// EXPORTS //

export = FLOAT32_MAX_BASE10_EXPONENT;
28 changes: 28 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/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 FLOAT32_MAX_BASE10_EXPONENT = require( './index' );


// TESTS //

// The export is a number...
{
// eslint-disable-next-line @typescript-eslint/no-unused-expressions
FLOAT32_MAX_BASE10_EXPONENT; // $ExpectType number
}
24 changes: 24 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/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 FLOAT32_MAX_BASE10_EXPONENT = require( './../lib' );

Check warning on line 21 in lib/node_modules/@stdlib/constants/float32/max-base10-exponent/examples/index.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

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

console.log( FLOAT32_MAX_BASE10_EXPONENT );
// => 38
27 changes: 27 additions & 0 deletions ...stants/float32/max-base10-exponent/include/stdlib/constants/float32/max_base10_exponent.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_FLOAT32_MAX_BASE10_EXPONENT_H
#define STDLIB_CONSTANTS_FLOAT32_MAX_BASE10_EXPONENT_H

/**
* Macro for the maximum base 10 exponent for a single-precision floating-point number.
*/
#define STDLIB_CONSTANT_FLOAT32_MAX_BASE10_EXPONENT 38

#endif // !STDLIB_CONSTANTS_FLOAT32_MAX_BASE10_EXPONENT_H
48 changes: 48 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/lib/index.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
* @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 maximum base 10 exponent for a single-precision floating-point number.
*
* @module @stdlib/constants/float32/max-base10-exponent
* @type {integer32}
*
* @example
* var FLOAT32_MAX_BASE10_EXPONENT = require( '@stdlib/constants/float32/max-base10-exponent' );
* // returns 38
*/


// MAIN //

/**
* The maximum base 10 exponent for a single-precision floating-point number.
*
* @constant
* @type {integer32}
* @default 38
* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985}
*/
var FLOAT32_MAX_BASE10_EXPONENT = 38|0; // asm type annotation

Check warning on line 43 in lib/node_modules/@stdlib/constants/float32/max-base10-exponent/lib/index.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files 

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


// EXPORTS //

module.exports = FLOAT32_MAX_BASE10_EXPONENT;
36 changes: 36 additions & 0 deletions lib/node_modules/@stdlib/constants/float32/max-base10-exponent/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 5c28ab7

@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/max-base10-exponent $\color{green}48/48$
$\color{green}+100.00\%$ 		$\color{green}1/1$
$\color{green}+100.00\%$ 		$\color{green}0/0$
$\color{green}+100.00\%$ 		$\color{green}48/48$
$\color{green}+100.00\%$

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

Please sign in to comment.