@lvlte/ulp 1.2.0 → 1.2.1

package/dist/cjs/index.d.ts

@@ -0,0 +1,44 @@
+/**
+ * The smallest positive normal number representable by IEEE-754 float64.
+ */
+export declare const FLOAT64_MIN: number;
+/**
+ * Return the unit in the last place or unit of least precision (ulp) of x, that
+ * is, the distance between two consecutive representable floating-point numbers
+ * at x. If x is a power of 2, the distance on either side of x is different, in
+ * which case the larger distance is returned.
+ *
+ * @param x The input number (default: 1)
+ * @returns The ulp of x, or `NaN` if `x` is not a finite number.
+ */
+export declare function eps(x?: number): number;
+/**
+ * @borrows eps as ulp
+ */
+export declare const ulp: typeof eps;
+/**
+ * Exponent of a normalized floating-point number x.
+ *
+ * @param x The input number
+ * @returns The largest integer `y` such that `2^y ≤ |x|`. If `x` is not a
+ * finite number or equals ±0, returns `NaN`.
+ */
+export declare function exponent(x: number): number;
+/**
+ * Return the smallest representable floating-point number that comes after `x`
+ * on the float64 number line (towards +∞).
+ *
+ * @param x The input number
+ * @returns The smallest floating-point number `y` such that `y > x`. If `x` is
+ * `±Infinity` or `NaN`, returns `x`.
+ */
+export declare function nextFloat(x: number): number;
+/**
+ * Return the largest representable floating-point number that comes before `x`
+ * on the float64 number line (towards -∞).
+ *
+ * @param x The input number
+ * @returns The largest floating-point number `y` such that `y < x`. If `x` is
+ * `±Infinity` or `NaN`, returns `x`.
+ */
+export declare function prevFloat(x: number): number;

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{ 
+  "type": "commonjs" 
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvlte/ulp",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Compute the ULP of a given number / Get the closest representable number that comes before/after it on the float64 number line",
   "license": "MIT",
   "author": "Eric Lavault <lvlte.code@gmail.com>",
@@ -9,13 +9,17 @@
     "url": "git+https://github.com/lvlte/ulp.git"
   },
   "type": "module",
-  "main": "./dist/index.cjs",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/cjs/index.js",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/cjs/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
     }
   },
   "engines": {
@@ -28,8 +32,8 @@
     "test": "jest",
     "prebuild": "rimraf dist && make-dir dist",
     "build": "tsc && tsc -p tsconfig-cjs.json",
-    "postbuild": "mv dist/cjs/index.js dist/index.cjs && rimraf dist/cjs",
-    "prepublishOnly": "npm test && npm run build && tsc --emitDeclarationOnly true --removeComments false"
+    "postbuild": "(echo { && echo   \"type\": \"commonjs\" && echo }) > ./dist/cjs/package.json",
+    "prepublishOnly": "npm test && npm run build && tsc --emitDeclarationOnly true --removeComments false && tsc -p tsconfig-cjs.json --emitDeclarationOnly true --removeComments false"
   },
   "keywords": [
     "number",

package/readme.md

@@ -1,9 +1,9 @@
 # ulp (epsilon function)
 
-> Compute the [unit of least precision](https://en.wikipedia.org/wiki/Unit_in_the_last_place)
-of a given IEEE-754 64-bit number : `eps(x)` (alias `ulp(x)`).<br>
+> Compute the [ULP](https://en.wikipedia.org/wiki/Unit_in_the_last_place)
+of a given IEEE-754 64-bit number: `eps(x)` (alias: `ulp(x)`).<br>
 > Get the closest representable number that comes before/after it on the float64
-number line : `nextFloat(x)`, `prevFloat(x)`.
+number line: `nextFloat(x)`, `prevFloat(x)`.
 
 
 ## Install
@@ -14,6 +14,8 @@ npm install @lvlte/ulp
 
 ## Usage
 
+### Import
+
 ```js
 // ESM
 import { eps, nextFloat, prevFloat } from '@lvlte/ulp';
@@ -22,6 +24,8 @@ import { eps, nextFloat, prevFloat } from '@lvlte/ulp';
 // CJS
 const { eps, nextFloat, prevFloat } = require('@lvlte/ulp');
 ```
+
+### eps(x) / ulp(x) (alias)
 ```js
 console.log( eps() );                               // 2.220446049250313e-16
 console.log( eps() === eps(1) );                    // true
@@ -35,6 +39,8 @@ console.log( eps(0) === Number.MIN_VALUE );         // true
 
 console.log( eps(Infinity) );                       // NaN
 ```
+
+### nextFloat(x) / prevFloat(x)
 ```js
 console.log( nextFloat(0) );                        // 5e-324
 console.log( nextFloat(0) === Number.MIN_VALUE );   // true