smath 1.11.0 → 1.12.1

package/dist/bin.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 "use strict";
-var _a, _b, _c, _d;
+var _a, _b, _c, _d, _e;
 Object.defineProperty(exports, "__esModule", { value: true });
 var _1 = require(".");
 var func = ((_a = process.argv[2]) !== null && _a !== void 0 ? _a : '').toLowerCase(), nums = process.argv.slice(3).map(function (arg, i) {
@@ -27,6 +27,7 @@ if (func.includes('help')) {
     console.log('  logspace <min> <max> <n> : Generate `n` logarithmically spaced numbers between `min` and `max`');
     console.log('  factorial <n>            : Compute `n!` (factorial)');
     console.log('  factors <n>              : List the prime factors of `n`');
+    console.log('  round2 <n> <base>        : Round `n` to a multiple of any `base`');
     console.log('  error <exp> <act>        : Calculate the normaized percent error between `exp` and `act`');
     console.log('  sum <c0> [c1] ... [cn]   : Compute a total of `n` numbers');
     console.log('  prod <c0> [c1] ... [cn]  : Compute a product of `n` numbers');
@@ -42,6 +43,7 @@ if (func.includes('help')) {
     console.log('  rdist <n> [mean] [stdev] : Generate `n` normally-distributed random floats');
     console.log('  rat <n> [eps]            : Decompose `n` into a ratio');
     console.log('  mixed <n> [eps]          : Decompose `n` into a mixed number');
+    console.log('  toHex <n> [length]       : Convert decimal `n` into hexadecimal');
     process.exit(1);
 }
 switch (func) {
@@ -81,6 +83,10 @@ switch (func) {
         console.log(_1.SMath.factors(nums[0]));
         break;
     }
+    case ('round2'): {
+        console.log(_1.SMath.round2(nums[0], nums[1]));
+        break;
+    }
     case ('error'): {
         console.log(_1.SMath.error(nums[0], nums[1]));
         break;
@@ -141,6 +147,10 @@ switch (func) {
         console.log(_1.SMath.mixed(nums[0], (_d = nums[1]) !== null && _d !== void 0 ? _d : 1e-6));
         break;
     }
+    case ('tohex'): {
+        console.log(_1.SMath.toHex(nums[0], (_e = nums[1]) !== null && _e !== void 0 ? _e : 0));
+        break;
+    }
     case (''): {
         console.error('Missing argument. Use with "help" for a list of commands.');
         process.exit(1);

package/dist/index.js

@@ -17,6 +17,7 @@ exports.SMath = void 0;
  * Small math function library
  *
  * ![NPM Downloads](https://img.shields.io/npm/d18m/smath)
+ * ![NPM Last Update](https://img.shields.io/npm/last-update/smath)
  */
 /**
  * Contains a small math function library including
@@ -204,6 +205,21 @@ var SMath;
         return f;
     }
     SMath.factors = factors;
+    /**
+     * Round a number to the nearest multiple of an arbitrary
+     * base. Does not round when the base is set to zero.
+     * @param n Any number to round
+     * @param base Any base to round to
+     * @returns `n` rounded to the nearest multiple of `base`
+     * @example
+     * ```js
+     * const y = SMath.round2(Math.PI, 0.2); // 3.2
+     * ```
+     */
+    function round2(n, base) {
+        return base ? base * Math.round(n / base) : n;
+    }
+    SMath.round2 = round2;
     /**
      * Calculate the relative normalized error or deviation from any
      * value to an accepted value. An error of 0 indicates that the
@@ -576,4 +592,19 @@ var SMath;
         return __assign({ whole: n | 0 }, rat(n < -1 ? (n | 0) - n : n - (n | 0), epsilon));
     }
     SMath.mixed = mixed;
+    /**
+     * Convert any number to its hexadecimal equivalent.
+     * @param n A decimal number to convert
+     * @param length The minimum number of digits to show
+     * @returns The number `n` converted to hexadecimal
+     * @example
+     * ```js
+     * const hex = SMath.toHex(10, 2); // '0A'
+     * ```
+     */
+    function toHex(n, length) {
+        if (length === void 0) { length = 0; }
+        return (n < 0 ? '-' : '') + (n < 0 ? -n : n).toString(16).padStart(length, '0').toUpperCase();
+    }
+    SMath.toHex = toHex;
 })(SMath || (exports.SMath = SMath = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smath",
-  "version": "1.11.0",
+  "version": "1.12.1",
   "description": "Small math function library",
   "homepage": "https://npm.nicfv.com/",
   "bin": "dist/bin.js",

package/types/index.d.ts

@@ -3,6 +3,7 @@
  * Small math function library
  *
  * ![NPM Downloads](https://img.shields.io/npm/d18m/smath)
+ * ![NPM Last Update](https://img.shields.io/npm/last-update/smath)
  */
 /**
  * Contains a small math function library including
@@ -120,6 +121,18 @@ export declare namespace SMath {
      * ```
      */
     function factors(n: number): Array<number>;
+    /**
+     * Round a number to the nearest multiple of an arbitrary
+     * base. Does not round when the base is set to zero.
+     * @param n Any number to round
+     * @param base Any base to round to
+     * @returns `n` rounded to the nearest multiple of `base`
+     * @example
+     * ```js
+     * const y = SMath.round2(Math.PI, 0.2); // 3.2
+     * ```
+     */
+    function round2(n: number, base: number): number;
     /**
      * Calculate the relative normalized error or deviation from any
      * value to an accepted value. An error of 0 indicates that the
@@ -344,4 +357,15 @@ export declare namespace SMath {
         num: number;
         den: number;
     };
+    /**
+     * Convert any number to its hexadecimal equivalent.
+     * @param n A decimal number to convert
+     * @param length The minimum number of digits to show
+     * @returns The number `n` converted to hexadecimal
+     * @example
+     * ```js
+     * const hex = SMath.toHex(10, 2); // '0A'
+     * ```
+     */
+    function toHex(n: number, length?: number): string;
 }