smath 1.11.0 → 1.12.0

package/dist/bin.js

@@ -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');
@@ -81,6 +82,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;

package/dist/index.js

@@ -204,6 +204,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

package/package.json

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

package/types/index.d.ts

@@ -120,6 +120,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