smath 2.1.0 → 2.2.0

package/dist/bin.js

@@ -47,6 +47,7 @@ if (func.includes('help')) {
     console.log('                           : Select an index at random from a list of weights');
     console.log('  rat <n> [eps]            : Decompose `n` into a ratio');
     console.log('  mixed <n> [eps]          : Decompose `n` into a mixed number');
+    console.log('  gcd <a> <b>              : Compute the greatest common denominator of two numbers');
     process.exit(1);
 }
 switch (func) {
@@ -166,6 +167,10 @@ switch (func) {
         console.log(SMath.mixed(nums[0], nums[1] ?? 1e-6));
         break;
     }
+    case ('gcd'): {
+        console.log(SMath.gcd(nums[0], nums[1]));
+        break;
+    }
     case (''): {
         console.error('Missing argument. Use with "help" for a list of commands.');
         process.exit(1);

package/dist/smath.js

@@ -110,7 +110,7 @@ export function logspace(min, max, count) {
  * const y = SMath.factorial(5); // 120
  */
 export function factorial(n) {
-    if (n < 0 || (n | 0) !== n) {
+    if (n < 0 || n % 1 !== 0) {
         throw new Error('Input must be a positive integer.');
     }
     else if (n === 0) {
@@ -131,8 +131,8 @@ export function factorial(n) {
  * const y = SMath.factors(12); // [ 2, 2, 3 ]
  */
 export function factors(n) {
-    if (n < 0 || (n | 0) !== n) {
-        throw new Error('Input must be a positive integer!');
+    if (n < 0 || n % 1 !== 0) {
+        throw new Error('Input must be a positive integer.');
     }
     if (n <= 3) {
         return [n];
@@ -140,7 +140,7 @@ export function factors(n) {
     const f = [];
     let i = 2;
     while (n > 1 && i <= n) {
-        if ((n / i) === ((n / i) | 0)) {
+        if (n % i === 0) {
             n /= i;
             f.push(i);
         }
@@ -154,6 +154,8 @@ export function factors(n) {
  * An optimized algorithm to determine if any number is prime.
  * @param n Any positive integer
  * @returns `true` if `n` is prime
+ * @example
+ * const b = SMath.isPrime(5); // true
  */
 export function isPrime(n) {
     if (n <= 1 || (n | 0) !== n) {
@@ -527,3 +529,31 @@ export function rat(n, epsilon = 1e-6) {
 export function mixed(n, epsilon = 1e-6) {
     return { whole: n | 0, ...rat(n < -1 ? (n | 0) - n : n - (n | 0), epsilon) };
 }
+/**
+ * Get the greatest common denominator (GCD) of two numbers.
+ * @param a Any positive integer
+ * @param b Any positive integer
+ * @returns The GCD of two numbers
+ * @example
+ * const y = SMath.gcd(42, 30); // 6
+ */
+export function gcd(a, b) {
+    // Make sure input is valid
+    if (a < 0 || a % 1 !== 0 || b < 0 || b % 1 !== 0) {
+        throw new Error('Input must be a positive integer.');
+    }
+    // Reached the end
+    if (a === 0) {
+        return b;
+    }
+    else if (b === 0) {
+        return a;
+    }
+    // Compute the algorithm
+    if (a > b) {
+        return gcd(a % b, b);
+    }
+    else {
+        return gcd(a, b % a);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smath",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Small math function library",
   "homepage": "https://npm.nicfv.com/",
   "type": "module",

package/types/smath.d.ts

@@ -95,6 +95,8 @@ export declare function factors(n: number): number[];
  * An optimized algorithm to determine if any number is prime.
  * @param n Any positive integer
  * @returns `true` if `n` is prime
+ * @example
+ * const b = SMath.isPrime(5); // true
  */
 export declare function isPrime(n: number): boolean;
 /**
@@ -309,3 +311,12 @@ export declare function mixed(n: number, epsilon?: number): {
     num: number;
     den: number;
 };
+/**
+ * Get the greatest common denominator (GCD) of two numbers.
+ * @param a Any positive integer
+ * @param b Any positive integer
+ * @returns The GCD of two numbers
+ * @example
+ * const y = SMath.gcd(42, 30); // 6
+ */
+export declare function gcd(a: number, b: number): number;