diff --git a/CHANGELOG.md b/CHANGELOG.md index 5c4ddc2..cf8805b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -66,6 +66,28 @@ This release closes the following issue: +
+ +#### [@stdlib/constants/float32/min-base10-exponent](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/constants/float32/min-base10-exponent) + +
+ +
+ +##### Features + +- [`824d519`](https://github.com/stdlib-js/stdlib/commit/824d5196406ebb5c9f73aedfd69d30fd6df0e2e0) - add `constants/float32/min-base10-exponent` [(#3092)](https://github.com/stdlib-js/stdlib/pull/3092) + +
+ + + +
+ +
+ + + @@ -102,6 +124,7 @@ A total of 3 people contributed to this release. Thank you to the following cont
+- [`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)_ - [`893cb1b`](https://github.com/stdlib-js/stdlib/commit/893cb1b86ececb01085118705c19a842f70da511) - **feat:** add `constants/float32/ln-two` [(#3079)](https://github.com/stdlib-js/stdlib/pull/3079) _(by Gunj Joshi)_ diff --git a/float32/min-base10-exponent/README.md b/float32/min-base10-exponent/README.md new file mode 100644 index 0000000..dfc7386 --- /dev/null +++ b/float32/min-base10-exponent/README.md @@ -0,0 +1,147 @@ + + +# FLOAT32_MIN_BASE10_EXPONENT + +> The minimum base 10 exponent for a normal [single-precision floating-point number][ieee754]. + +
+ +## Usage + + + +```javascript +var FLOAT32_MIN_BASE10_EXPONENT = require( '@stdlib/constants/float32/min-base10-exponent' ); +``` + +#### FLOAT32_MIN_BASE10_EXPONENT + +The minimum base 10 exponent for a normal [single-precision floating-point number][ieee754]. + + + +```javascript +var bool = ( FLOAT32_MIN_BASE10_EXPONENT === -37 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + + + +```javascript +var FLOAT32_MIN_BASE10_EXPONENT = require( '@stdlib/constants/float32/min-base10-exponent' ); + +console.log( FLOAT32_MIN_BASE10_EXPONENT ); +// => -37 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/constants/float32/min_base10_exponent.h" +``` + +#### STDLIB_CONSTANT_FLOAT32_MIN_BASE10_EXPONENT + +Macro for the minimum base 10 exponent for a normal [single-precision floating-point number][ieee754]. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + +
+ +* * * + +
+ + + + + +
+ +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + + + + +
+ + diff --git a/float32/min-base10-exponent/docs/repl.txt b/float32/min-base10-exponent/docs/repl.txt new file mode 100644 index 0000000..a8b236b --- /dev/null +++ b/float32/min-base10-exponent/docs/repl.txt @@ -0,0 +1,13 @@ + +{{alias}} + The minimum base 10 exponent for a normalized single-precision floating- + point number. + + Examples + -------- + > {{alias}} + -37 + + See Also + -------- + diff --git a/float32/min-base10-exponent/docs/types/index.d.ts b/float32/min-base10-exponent/docs/types/index.d.ts new file mode 100644 index 0000000..9830930 --- /dev/null +++ b/float32/min-base10-exponent/docs/types/index.d.ts @@ -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 base 10 exponent for a normal single-precision floating-point number. +* +* @example +* var min = FLOAT32_MIN_BASE10_EXPONENT; +* // returns -37 +*/ +declare const FLOAT32_MIN_BASE10_EXPONENT: number; + + +// EXPORTS // + +export = FLOAT32_MIN_BASE10_EXPONENT; diff --git a/float32/min-base10-exponent/docs/types/test.ts b/float32/min-base10-exponent/docs/types/test.ts new file mode 100644 index 0000000..426d34b --- /dev/null +++ b/float32/min-base10-exponent/docs/types/test.ts @@ -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_BASE10_EXPONENT = require( './index' ); + + +// TESTS // + +// The export is a number... +{ + // eslint-disable-next-line @typescript-eslint/no-unused-expressions + FLOAT32_MIN_BASE10_EXPONENT; // $ExpectType number +} diff --git a/float32/min-base10-exponent/examples/index.js b/float32/min-base10-exponent/examples/index.js new file mode 100644 index 0000000..a2a7cb6 --- /dev/null +++ b/float32/min-base10-exponent/examples/index.js @@ -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_BASE10_EXPONENT = require( './../lib' ); + +console.log( FLOAT32_MIN_BASE10_EXPONENT ); +// => -37 diff --git a/float32/min-base10-exponent/include/stdlib/constants/float32/min_base10_exponent.h b/float32/min-base10-exponent/include/stdlib/constants/float32/min_base10_exponent.h new file mode 100644 index 0000000..770b8d9 --- /dev/null +++ b/float32/min-base10-exponent/include/stdlib/constants/float32/min_base10_exponent.h @@ -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_H +#define STDLIB_CONSTANTS_FLOAT32_MIN_BASE10_EXPONENT_H + +/** +* Macro for the minimum base 10 exponent for a normal single-precision floating-point number. +*/ +#define STDLIB_CONSTANT_FLOAT32_MIN_BASE10_EXPONENT -37 + +#endif // !STDLIB_CONSTANTS_FLOAT32_MIN_BASE10_EXPONENT_H diff --git a/float32/min-base10-exponent/lib/index.js b/float32/min-base10-exponent/lib/index.js new file mode 100644 index 0000000..33473bb --- /dev/null +++ b/float32/min-base10-exponent/lib/index.js @@ -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 minimum base 10 exponent for a normal single-precision floating-point number. +* +* @module @stdlib/constants/float32/min-base10-exponent +* @type {integer32} +* +* @example +* var FLOAT32_MIN_BASE10_EXPONENT = require( '@stdlib/constants/float32/min-base10-exponent' ); +* // returns -37 +*/ + + +// MAIN // + +/** +* The minimum base 10 exponent for a normal single-precision floating-point number. +* +* @constant +* @type {integer32} +* @default -37 +* @see [IEEE 754]{@link https://en.wikipedia.org/wiki/IEEE_754-1985} +*/ +var FLOAT32_MIN_BASE10_EXPONENT = -37|0; // asm type annotation + + +// EXPORTS // + +module.exports = FLOAT32_MIN_BASE10_EXPONENT; diff --git a/float32/min-base10-exponent/manifest.json b/float32/min-base10-exponent/manifest.json new file mode 100644 index 0000000..844d692 --- /dev/null +++ b/float32/min-base10-exponent/manifest.json @@ -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": [] + } + ] +} diff --git a/float32/min-base10-exponent/package.json b/float32/min-base10-exponent/package.json new file mode 100644 index 0000000..fe6b54a --- /dev/null +++ b/float32/min-base10-exponent/package.json @@ -0,0 +1,68 @@ +{ + "name": "@stdlib/constants/float32/min-base10-exponent", + "version": "0.0.0", + "description": "The minimum base 10 exponent for a normal single-precision floating-point number.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "directories": { + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "constant", + "const", + "mathematics", + "math", + "single", + "floating-point", + "float", + "ieee754", + "exponent", + "min", + "minimum", + "normal", + "base 10" + ] +} diff --git a/float32/min-base10-exponent/test/test.js b/float32/min-base10-exponent/test/test.js new file mode 100644 index 0000000..164401b --- /dev/null +++ b/float32/min-base10-exponent/test/test.js @@ -0,0 +1,38 @@ +/** +* @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'; + +// MODULES // + +var tape = require( 'tape' ); +var FLOAT32_MIN_BASE10_EXPONENT = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_MIN_BASE10_EXPONENT, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is `-37`', function test( t ) { + t.equal( FLOAT32_MIN_BASE10_EXPONENT, -37, 'equals -37' ); + t.end(); +});