From 7b7729066379e5ac5f56add760821ef1f62c6db8 Mon Sep 17 00:00:00 2001 From: Gunj Joshi Date: Tue, 6 Aug 2024 19:18:06 +0530 Subject: [PATCH] feat: add `constants/float32/min-base2-exponent-subnormal` PR-URL: #2750 Ref: #649 Reviewed-by: Philipp Burckhardt --- .../min-base2-exponent-subnormal/README.md | 143 ++++++++++++++++++ .../docs/repl.txt | 13 ++ .../docs/types/index.d.ts | 33 ++++ .../docs/types/test.ts | 28 ++++ .../examples/index.js | 24 +++ .../float64/min_base2_exponent_subnormal.h | 27 ++++ .../min-base2-exponent-subnormal/lib/index.js | 54 +++++++ .../manifest.json | 36 +++++ .../min-base2-exponent-subnormal/package.json | 71 +++++++++ .../min-base2-exponent-subnormal/test/test.js | 38 +++++ 10 files changed, 467 insertions(+) create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/examples/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/include/stdlib/constants/float64/min_base2_exponent_subnormal.h create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/lib/index.js create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/manifest.json create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/package.json create mode 100644 lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/test/test.js diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md new file mode 100644 index 00000000000..7a6b803de19 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/README.md @@ -0,0 +1,143 @@ + + +# FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL + +> The minimum biased base 2 exponent for a subnormal [single-precision floating-point number][ieee754]. + +
+ +## Usage + + + +```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]. + + + +```javascript +var bool = ( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL === -149 ); +// returns true +``` + +
+ + + +
+ +## Examples + + + + + +```javascript +var FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL = require( '@stdlib/constants/float32/min-base2-exponent-subnormal' ); + +console.log( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL ); +// => -149 +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### 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]. + +
+ + + + + +
+ +
+ + + + + +
+ +
+ + + +
+ + + + + +
+ +
+ + + + + +
+ +[ieee754]: https://en.wikipedia.org/wiki/IEEE_754-1985 + + + + + +
+ + diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/repl.txt b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/repl.txt new file mode 100644 index 00000000000..be8390ce756 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/repl.txt @@ -0,0 +1,13 @@ + +{{alias}} + The minimum biased base 2 exponent for a subnormal single-precision + floating-point number. + + Examples + -------- + > {{alias}} + -149 + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/index.d.ts b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/index.d.ts new file mode 100644 index 00000000000..3492fd376b7 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/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 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; diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/test.ts b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/docs/types/test.ts new file mode 100644 index 00000000000..b9753741cbc --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/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_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 +} diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/examples/index.js b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/examples/index.js new file mode 100644 index 00000000000..c0a9ba9ec6f --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/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_BASE2_EXPONENT_SUBNORMAL = require( './../lib' ); + +console.log( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL ); +// => -149 diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/include/stdlib/constants/float64/min_base2_exponent_subnormal.h b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/include/stdlib/constants/float64/min_base2_exponent_subnormal.h new file mode 100644 index 00000000000..96fb45fac8d --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/include/stdlib/constants/float64/min_base2_exponent_subnormal.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_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 diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/lib/index.js b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/lib/index.js new file mode 100644 index 00000000000..56185eb42f6 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/lib/index.js @@ -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; diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/manifest.json b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/manifest.json new file mode 100644 index 00000000000..844d692f643 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/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/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/package.json b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/package.json new file mode 100644 index 00000000000..a9bac4248d9 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/package.json @@ -0,0 +1,71 @@ +{ + "name": "@stdlib/constants/float32/min-base2-exponent-subnormal", + "version": "0.0.0", + "description": "The minimum biased base 2 exponent for a subnormal 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", + "float", + "flt", + "floating-point", + "ieee754", + "bias", + "exponent", + "min", + "minimum", + "binary", + "subnormal", + "denormalized", + "base 2" + ] +} diff --git a/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/test/test.js b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/test/test.js new file mode 100644 index 00000000000..bf608dae273 --- /dev/null +++ b/lib/node_modules/@stdlib/constants/float32/min-base2-exponent-subnormal/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_BASE2_EXPONENT_SUBNORMAL = require( './../lib' ); + + +// TESTS // + +tape( 'main export is a number', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL, 'number', 'main export is a number' ); + t.end(); +}); + +tape( 'the exported value is -149', function test( t ) { + t.equal( FLOAT32_MIN_BASE2_EXPONENT_SUBNORMAL, -149, 'equals -149' ); + t.end(); +});